Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.204
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.196 jnemeth 33: <div><p class="copyright">Copyright © 1994-2021 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.39 2021/01/02 08:32:15 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>
163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
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.184 rillig 224: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
225: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
226: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
227: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
1.6 rillig 228: </dl></dd>
1.184 rillig 229: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
230: <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 231: </dl></dd>
1.184 rillig 232: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 233: <dd><dl>
1.184 rillig 234: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
235: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
236: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
237: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 238: <dd><dl>
1.184 rillig 239: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
240: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
241: <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>
242: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 243: </dl></dd>
244: </dl></dd>
1.184 rillig 245: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 246: <dd><dl>
1.184 rillig 247: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
248: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
249: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
250: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 251: </dl></dd>
1.184 rillig 252: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 253: <dd><dl>
1.184 rillig 254: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
255: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
256: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
257: </dl></dd>
258: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
259: <dd><dl>
260: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
261: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 262: <dd><dl>
1.184 rillig 263: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
264: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 265: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
266: and
267: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
268: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 269: </dl></dd>
1.184 rillig 270: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
271: <dd><dl>
272: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
273: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
274: </dl></dd>
275: </dl></dd>
276: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 277: <dd><dl>
1.184 rillig 278: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
279: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
280: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
281: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
282: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
283: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
284: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
285: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
286: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 287: </dl></dd>
1.184 rillig 288: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
289: <dd><dl>
290: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
291: <dd><dl>
292: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
293: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 294: </dl></dd>
1.184 rillig 295: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 296: <dd><dl>
1.184 rillig 297: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
298: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
299: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
300: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
301: </dl></dd>
302: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
303: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
304: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
305: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
306: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
307: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
308: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.154 rillig 309: </dl></dd>
310: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
311: <dd><dl>
312: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
313: <dd><dl>
314: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
315: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
316: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
317: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
318: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
319: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
320: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
321: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
322: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
323: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
324: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
325: </dl></dd>
326: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
327: <dd><dl>
328: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
329: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
330: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
331: </dl></dd>
332: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
333: <dd><dl>
334: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
336: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
337: </dl></dd>
338: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
339: <dd><dl>
340: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
341: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.203 nia 342: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing Perl scripts</a></span></dt>
1.154 rillig 343: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
344: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
345: </dl></dd>
346: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
347: <dd><dl>
348: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
349: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 350: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
351: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
352: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 353: </dl></dd>
354: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
355: <dd><dl>
356: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
357: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
358: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
359: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
360: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 361: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154 rillig 362: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
363: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203 nia 364: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
365: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
366: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
367: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
368: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
369: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
370: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1 dsieger 371: emulation</a></span></dt>
1.203 nia 372: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
373: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1 dsieger 374: </dl></dd>
1.154 rillig 375: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 376: </dl></dd>
1.184 rillig 377: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
378: <dd><dl>
379: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
380: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
381: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
382: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
383: </dl></dd>
1.154 rillig 384: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 385: <dd><dl>
1.154 rillig 386: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
387: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
388: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
389: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
390: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
391: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
392: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
393: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
394: </dl></dd>
395: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 396: </dl></dd>
397: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
398: <dd><dl>
1.184 rillig 399: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 400: <dd><dl>
1.184 rillig 401: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
402: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
403: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 404: <dd><dl>
1.184 rillig 405: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
406: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 407: </dl></dd>
1.184 rillig 408: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
409: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 410: <dd><dl>
1.184 rillig 411: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
412: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 413: </dl></dd>
1.184 rillig 414: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 415: <dd><dl>
1.184 rillig 416: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
417: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 418: </dl></dd>
419: </dl></dd>
1.184 rillig 420: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 421: <dd><dl>
1.184 rillig 422: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
423: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 424: <dd><dl>
1.184 rillig 425: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
426: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 427: </dl></dd>
428: </dl></dd>
1.184 rillig 429: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
430: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 431: </dl></dd>
432: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
433: <dd><dl>
434: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
435: <dd><dl>
436: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
437: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
438: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 439: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 440: </dl></dd>
441: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
442: </dl></dd>
443: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
444: <dd><dl>
445: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
446: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
447: </dl></dd>
448: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
449: <dd><dl>
1.23 wiz 450: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
451: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
452: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
453: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
454: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148 leot 455: <code class="filename">stable</code>,
1.23 wiz 456: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 457: source packages</a></span></dt>
458: </dl></dd>
1.154 rillig 459: <dt><span class="appendix"><a href="#help-topics">D. Help topics</a></span></dt>
460: <dt><span class="appendix"><a href="#editing">E. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1 dsieger 461: <dd><dl>
1.154 rillig 462: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
463: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1 dsieger 464: </dl></dd>
465: </dl>
466: </div>
467: <div class="list-of-tables">
468: <p><b>List of Tables</b></p>
469: <dl>
470: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
471: </dt>
1.184 rillig 472: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 473: </dt>
1.184 rillig 474: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 475: </dt>
476: </dl>
477: </div>
1.41 asau 478: <div class="chapter">
479: <div class="titlepage"><div><div><h1 class="title">
480: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 481: <div class="toc">
482: <p><b>Table of Contents</b></p>
1.100 leot 483: <dl class="toc">
1.1 dsieger 484: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
485: <dd><dl>
486: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
487: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
488: </dl></dd>
489: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
490: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
491: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
492: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
493: </dl>
494: </div>
1.41 asau 495: <div class="sect1">
1.1 dsieger 496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
497: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
498: <p>There is a lot of software freely available for Unix-based
499: systems, which is usually available in form of the source code. Before
500: such software can be used, it needs to be configured to the local
501: system, compiled and installed, and this is exactly what The NetBSD
502: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
503: to handle binary packages, so that not every user has to build the
504: packages for himself, which is a time-costly task.</p>
505: <p>pkgsrc currently contains several thousand packages,
506: including:</p>
1.41 asau 507: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 508: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.1 dsieger 509: web server</p></li>
1.137 leot 510: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1 dsieger 511: web browser</p></li>
1.137 leot 512: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1 dsieger 513: Desktop Environment</p></li>
1.137 leot 514: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.1 dsieger 515: Desktop Environment</p></li>
516: </ul></div>
1.108 rillig 517: <p>… just to name a few.</p>
1.1 dsieger 518: <p>pkgsrc has built-in support for handling varying dependencies,
519: such as pthreads and X11, and extended features such as IPv6 support on
520: a range of platforms.</p>
1.41 asau 521: <div class="sect2">
1.1 dsieger 522: <div class="titlepage"><div><div><h3 class="title">
523: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
524: <p>
525: pkgsrc provides the following key features:
526: </p>
1.41 asau 527: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 528: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 529: and installation of binary packages. The source and latest
530: patches are retrieved from a master or mirror download site, checksum
531: verified, then built on your system. Support for binary-only
532: distributions is available for both native platforms and NetBSD
533: emulated platforms.</p></li>
1.23 wiz 534: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 535: including binaries, libraries, man pages and other
536: documentation.</p></li>
1.104 sevan 537: <li class="listitem"><p>Tracking of package dependencies automatically, including when
538: performing updates, to ensure required packages are installed. The
539: configuration files of various packages are handled automatically during
540: updates, so local changes are preserved.</p></li>
1.23 wiz 541: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 542: consists of highly portable code. This allows the greatest speed of
1.25 spz 543: development when porting to a new platform. This portability also
1.1 dsieger 544: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
545: platforms</em></span>.</p></li>
1.23 wiz 546: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 547: international encryption requirements and build-time options for a
548: large number of packages are all set in a simple, central
549: configuration file.</p></li>
1.23 wiz 550: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 551: freely available under a BSD license, so you may extend and adapt
552: pkgsrc to your needs. Support for local packages and patches is
553: available right out of the box, so you can configure it specifically
554: for your environment.</p></li>
555: </ul></div>
556: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 557: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 558: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 559: — That means, if a package contains bugs, it's better to find
1.1 dsieger 560: them and to complain about them rather than to just install the package
561: and hope that it works. There are numerous checks in pkgsrc that try to
1.175 gutterid 562: find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.1 dsieger 563: of shell scripts), and post-installation checks (installed files,
564: references to shared libraries, script interpreters).</p></li>
1.23 wiz 565: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 566: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 567: pkgsrc has been ported to many operating systems. Care is taken that
568: packages behave the same on all platforms.</p></li>
569: </ul></div>
570: </div>
1.41 asau 571: <div class="sect2">
1.1 dsieger 572: <div class="titlepage"><div><div><h3 class="title">
573: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
574: <p>pkgsrc consists of both a source distribution and a binary
575: distribution for these operating systems. After retrieving the required
576: source or binaries, you can be up and running with pkgsrc in just
577: minutes!</p>
578: <p>pkgsrc was derived from FreeBSD's ports system, and
579: initially developed for NetBSD only. Since then, pkgsrc has
580: grown a lot, and now supports the following platforms:</p>
581: <div class="table">
582: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 583: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 584: <colgroup>
585: <col>
586: <col>
1.92 sevan 587: <col>
1.1 dsieger 588: </colgroup>
589: <thead><tr>
590: <th>Platform</th>
591: <th>Date Support Added</th>
1.92 sevan 592: <th>Notes</th>
1.1 dsieger 593: </tr></thead>
594: <tbody>
595: <tr>
1.174 leot 596: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 597: <td align="center">Aug 1997</td>
1.92 sevan 598: <td class="auto-generated"> </td>
1.1 dsieger 599: </tr>
600: <tr>
1.10 hubertf 601: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 602: <td align="center">Mar 1999</td>
1.151 sevan 603: <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 604: </tr>
605: <tr>
1.174 leot 606: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 607: <td align="center">Jun 1999</td>
1.151 sevan 608: <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 609: </tr>
610: <tr>
611: <td>
1.118 sevan 612: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 613: </td>
614: <td align="center">Oct 2001</td>
1.191 bacon 615: <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 616: </tr>
617: <tr>
1.174 leot 618: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 619: <td align="center">Nov 2002</td>
1.151 sevan 620: <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 621: </tr>
622: <tr>
1.174 leot 623: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 624: <td align="center">Nov 2002</td>
1.151 sevan 625: <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 626: </tr>
627: <tr>
1.174 leot 628: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 629: <td align="center">Dec 2002</td>
1.92 sevan 630: <td>
1.151 sevan 631: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
632: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.92 sevan 633: </td>
1.1 dsieger 634: </tr>
635: <tr>
636: <td>BSD/OS</td>
637: <td align="center">Dec 2003</td>
1.92 sevan 638: <td class="auto-generated"> </td>
1.1 dsieger 639: </tr>
640: <tr>
1.174 leot 641: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 642: <td align="center">Dec 2003</td>
1.151 sevan 643: <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 644: </tr>
645: <tr>
646: <td>
1.174 leot 647: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 648: (Microsoft Windows Services for Unix)
649: </td>
650: <td align="center">Mar 2004</td>
1.151 sevan 651: <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 652: </tr>
653: <tr>
1.174 leot 654: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 655: <td align="center">Oct 2004</td>
1.92 sevan 656: <td class="auto-generated"> </td>
1.1 dsieger 657: </tr>
658: <tr>
1.10 hubertf 659: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 660: <td align="center">Nov 2004</td>
1.151 sevan 661: <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 662: </tr>
663: <tr>
1.174 leot 664: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 665: <td align="center">Apr 2007</td>
1.151 sevan 666: <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 667: </tr>
1.23 wiz 668: <tr>
1.174 leot 669: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.23 wiz 670: <td align="center">Sep 2010</td>
1.151 sevan 671: <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 672: </tr>
1.45 obache 673: <tr>
1.174 leot 674: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 675: <td align="center">Jan 2011</td>
1.92 sevan 676: <td class="auto-generated"> </td>
1.45 obache 677: </tr>
678: <tr>
1.174 leot 679: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.45 obache 680: <td align="center">Nov 2011</td>
1.151 sevan 681: <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 682: </tr>
683: <tr>
1.174 leot 684: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.45 obache 685: <td align="center">Mar 2013</td>
1.151 sevan 686: <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 687: </tr>
1.58 ryoon 688: <tr>
1.174 leot 689: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.58 ryoon 690: <td align="center">Jul 2013</td>
1.151 sevan 691: <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 692: </tr>
1.104 sevan 693: <tr>
1.174 leot 694: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.104 sevan 695: <td align="center">Jun 2014</td>
1.151 sevan 696: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
1.104 sevan 697: </tr>
1.1 dsieger 698: </tbody>
699: </table></div>
700: </div>
701: <br class="table-break">
702: </div>
703: </div>
1.41 asau 704: <div class="sect1">
1.1 dsieger 705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
706: <a name="overview"></a>1.2. Overview</h2></div></div></div>
707: <p>This document is divided into three parts. The first,
1.10 hubertf 708: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 709: describes how one can use one of the packages in the Package
710: Collection, either by installing a precompiled binary package,
711: or by building one's own copy using the NetBSD package system.
1.10 hubertf 712: 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 713: package so it can be easily built by other NetBSD users without
714: knowing about the package's building details. The third part,
1.10 hubertf 715: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 716: is intended for those who want to understand how pkgsrc is
717: implemented.</p>
718: <p>This document is available in various formats:
1.10 hubertf 719: <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 720: </div>
1.41 asau 721: <div class="sect1">
1.1 dsieger 722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
723: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 724: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
725: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 726: terminology used within this document.</p>
1.41 asau 727: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 728: <dt><span class="term">Package</span></dt>
729: <dd><p>A set of files and building instructions
730: that describe what's necessary
731: to build a certain piece of software using
732: pkgsrc. Packages are traditionally stored under
1.123 wiz 733: <code class="filename">/usr/pkgsrc</code>,
734: but may be stored in any location,
735: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1 dsieger 736: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 737: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 738: is part of the NetBSD operating system and can be bootstrapped
739: to run on non-NetBSD operating systems as well. It handles
740: building (compiling), installing, and removing of
741: packages.</p></dd>
742: <dt><span class="term">Distfile</span></dt>
743: <dd><p>This term describes the file or files that are
744: provided by the author of the piece of software to
745: distribute his work. All the changes necessary to build on
746: NetBSD are reflected in the corresponding package. Usually
747: the distfile is in the form of a compressed tar-archive,
748: but other types are possible, too. Distfiles are usually
749: stored below
750: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
751: <dt><span class="term">Port</span></dt>
752: <dd><p>This is the term used by FreeBSD and OpenBSD people
753: for what we call a package.
1.23 wiz 754: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 755: architecture.</p></dd>
756: <dt><span class="term">Precompiled/binary package</span></dt>
757: <dd>
758: <p>A set of binaries built with pkgsrc from a distfile
759: and stuffed together in a single <code class="filename">.tgz</code>
760: file so it can be installed on machines of the same
761: machine architecture without the need to
762: recompile. Packages are usually generated in
763: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 764: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 765: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 766: especially in the context of precompiled packages.</p>
767: </dd>
768: <dt><span class="term">Program</span></dt>
769: <dd><p>The piece of software to be installed which will be
770: constructed from all the files in the distfile by the
771: actions defined in the corresponding package.</p></dd>
772: </dl></div>
1.41 asau 773: <div class="sect2">
1.1 dsieger 774: <div class="titlepage"><div><div><h3 class="title">
775: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 776: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 777: <dt><span class="term">pkgsrc users</span></dt>
778: <dd>
779: <p>The
780: pkgsrc users are people who use the packages provided by pkgsrc.
781: Typically they are system administrators. The people using the
1.23 wiz 782: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
783: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 784: <p>There are two kinds of pkgsrc users: Some only want to
785: install pre-built binary packages. Others build the pkgsrc
786: packages from source, either for installing them directly or for
1.10 hubertf 787: 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 788: documentation.</p>
789: </dd>
790: <dt><span class="term">package maintainers</span></dt>
791: <dd><p>A
1.10 hubertf 792: 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 793: <dt><span class="term">infrastructure developers</span></dt>
794: <dd><p>These people are involved in all those files
795: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 796: 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 797: too.</p></dd>
798: </dl></div>
799: </div>
800: </div>
1.41 asau 801: <div class="sect1">
1.1 dsieger 802: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
803: <a name="typography"></a>1.4. Typography</h2></div></div></div>
804: <p>When giving examples for commands, shell prompts are used to
805: show if the command should/can be issued as root, or if
1.23 wiz 806: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 807: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
808: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
809: bourne shell and derivatives.</p>
1.1 dsieger 810: </div>
811: </div>
1.41 asau 812: <div class="part">
1.1 dsieger 813: <div class="titlepage"><div><div><h1 class="title">
814: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
815: <div class="toc">
816: <p><b>Table of Contents</b></p>
1.100 leot 817: <dl class="toc">
1.154 rillig 818: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
819: <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 820: <dd><dl>
1.154 rillig 821: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 822: <dd><dl>
1.154 rillig 823: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
824: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 825: </dl></dd>
1.154 rillig 826: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 827: <dd><dl>
1.154 rillig 828: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
829: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 830: </dl></dd>
831: </dl></dd>
1.154 rillig 832: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 833: <dd><dl>
1.154 rillig 834: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
835: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 836: </dl></dd>
1.154 rillig 837: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 838: <dd><dl>
1.154 rillig 839: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 840: <dd><dl>
1.154 rillig 841: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
842: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 843: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
844: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
845: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
846: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
847: <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>
848: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1 dsieger 849: </dl></dd>
1.154 rillig 850: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 851: <dd><dl>
1.154 rillig 852: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
853: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
854: <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 855: </dl></dd>
856: </dl></dd>
1.154 rillig 857: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 858: <dd><dl>
1.154 rillig 859: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
860: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
861: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
862: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 863: <dd><dl>
1.154 rillig 864: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
865: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
866: <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 867: </dl></dd>
1.154 rillig 868: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
869: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 870: </dl></dd>
1.154 rillig 871: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 872: <dd><dl>
1.154 rillig 873: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
874: <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 875: </dl></dd>
1.154 rillig 876: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 877: builds)</a></span></dt>
1.1 dsieger 878: <dd><dl>
1.154 rillig 879: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 880: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 881: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
882: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 883: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
884: <dd><dl>
1.179 rillig 885: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
886: <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 887: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
888: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
889: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
890: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
891: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
892: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
893: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
894: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 895: </dl></dd>
896: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
897: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 898: </dl></dd>
899: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
900: <dd><dl>
901: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
902: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
903: </dl></dd>
904: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
905: <dd><dl>
906: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
907: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
908: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
909: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
910: <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>
911: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
912: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
913: <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>
914: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
915: <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 916: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 917: <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>
918: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
919: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
920: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
921: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
922: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
923: <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 924: </dl></dd>
925: </dl>
926: </div>
1.41 asau 927: <div class="chapter">
1.1 dsieger 928: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 929: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
930: <p>
931: To get help when using pkgsrc, the definitive source is this
932: document, the pkgsrc guide. If you don't find anything here,
933: there are alternatives:
934: </p>
935: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
936: <li class="listitem">
937: <p>
938: The built-in pkgsrc help, which is available after bootstrapping
939: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
940: help for any topic, such as a variable name like
941: <code class="varname">BUILD_DEFS</code>, a make target like
942: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
943: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
944: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix D. Help topics">Appendix D, <i>Help topics</i></a>.</p>
945: </li>
946: <li class="listitem"><p>
1.163 rillig 947: To see the value of a single variable, run <span class="command"><strong>bmake
948: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
949: </p></li>
950: <li class="listitem"><p>
951: To see the values of the most common variables, run
952: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
953: topic. To see the variables for a single topic, run
954: <span class="command"><strong>bmake
955: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
956: <span class="command"><strong>bmake show-all-fetch</strong></span>.
957: </p></li>
958: <li class="listitem"><p>
1.154 rillig 959: The pkgsrc-users mailing list, to which
960: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
961: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
962: questions</a>.</p></li>
963: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
964: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
965: or by using a specialized chat program such as
966: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
967: Pick any user name and join the channel #pkgsrc.</p></li>
968: </ul></div>
969: </div>
970: <div class="chapter">
971: <div class="titlepage"><div><div><h2 class="title">
972: <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 973: <div class="toc">
974: <p><b>Table of Contents</b></p>
1.100 leot 975: <dl class="toc">
1.154 rillig 976: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 977: <dd><dl>
1.154 rillig 978: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
979: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 980: </dl></dd>
1.154 rillig 981: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 982: <dd><dl>
1.154 rillig 983: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
984: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 985: </dl></dd>
986: </dl>
987: </div>
988: <p>Before you download and extract the files, you need to decide
989: where you want to extract them. When using pkgsrc as root user, pkgsrc
990: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
991: free to install the sources and binary packages wherever you want in
992: your filesystem, provided that the pathname does not contain white-space
993: or other characters that are interpreted specially by the shell and some
994: other programs. A safe bet is to use only letters, digits, underscores
995: and dashes.</p>
1.41 asau 996: <div class="sect1">
1.1 dsieger 997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 998: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 999: <p>Before you download any pkgsrc files, you should decide
1000: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1001: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1002: quarterly basis from the current branch and only gets modified
1003: for security updates. The names of the stable branches are built
1004: from the year and the quarter, for example
1.198 leot 1005: <code class="literal">2021Q1</code>.</p>
1.1 dsieger 1006: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 1007: want to download pkgsrc. You can get it as a tar file or via CVS.
1008: Both ways are described here.</p>
1.51 asau 1009: <p>Note that tar archive contains CVS working copy.
1010: Thus you can switch to using CVS at any later time.</p>
1.41 asau 1011: <div class="sect2">
1.1 dsieger 1012: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1013: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 1014: <p>The primary download location for all pkgsrc files is
1.151 sevan 1015: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 1016: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1017: (it points to the same location).
1018: There are a number of subdirectories for different purposes,
1019: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1020: <p>The tar archive for the current branch is in the directory
1.151 sevan 1021: <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 1022: It is autogenerated weekly.</p>
1.51 asau 1023: <p>To save download time we provide bzip2- and
1024: xz-compressed archives which are published at
1.151 sevan 1025: <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 1026: and
1.151 sevan 1027: <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 1028: respectively.
1029: </p>
1030: <p>You can fetch the same files using FTP.</p>
1.198 leot 1031: <p>The tar file for the stable branch 2021Q1 is in the
1032: directory <code class="filename">pkgsrc-2021Q1</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q1/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136 leot 1033: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 1034: <pre class="screen">
1.198 leot 1035: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q1/pkgsrc.tar.gz</code></strong></pre>
1.78 snj 1036: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1037: or your web browser.</p>
1.12 weinem 1038: <p>Then, extract it with:</p>
1.78 snj 1039: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1040: <p>This will create the directory <code class="filename">pkgsrc/</code>
1041: in <code class="filename">/usr/</code> and all the package source will be
1042: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1043: <p>To download pkgsrc-current, run:</p>
1044: <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 1045: </div>
1.41 asau 1046: <div class="sect2">
1.1 dsieger 1047: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1048: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1049: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.198 leot 1050: <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-2021Q1 -P pkgsrc</code></strong>
1.23 wiz 1051: </pre>
1052: <p>This will create the directory <code class="filename">pkgsrc/</code>
1053: in your <code class="filename">/usr/</code> directory and all the package source
1054: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1055: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1056: <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 1057: </pre>
1.174 leot 1058: <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 1059: <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 1060: <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 1061: </pre>
1062: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1063: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1064: or better globally in <code class="filename">/etc/profile</code>:</p>
1065: <pre class="programlisting">
1066: # set CVS remote shell command
1067: CVS_RSH=ssh
1068: export CVS_RSH
1069: </pre>
1070: <p>By default, CVS doesn't do things like most people would expect it to do.
1071: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1072: in your home directory and saving the following lines to it.
1073: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1074: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1075: <pre class="programlisting">
1076: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1077: cvs -q
1.2 rillig 1078: checkout -P
1.4 rillig 1079: update -dP
1080: diff -upN
1.2 rillig 1081: rdiff -u
1.23 wiz 1082: release -d
1.2 rillig 1083: </pre>
1.1 dsieger 1084: </div>
1085: </div>
1.41 asau 1086: <div class="sect1">
1.1 dsieger 1087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1088: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1089: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1090: (which also works if you have first installed it via a tar
1091: file). It saves bandwidth and hard disk activity, compared to
1092: downloading the tar file again.</p>
1.41 asau 1093: <div class="sect2">
1.1 dsieger 1094: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1095: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1096: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1097: <h3 class="title">Warning</h3>
1098: <p>When updating from a tar file, you first need to
1099: completely remove the old pkgsrc directory. Otherwise those
1100: files that have been removed from pkgsrc in the mean time will
1101: not be removed on your local disk, resulting in inconsistencies.
1102: When removing the old files, any changes that you have done to
1103: the pkgsrc files will be lost after updating. Therefore updating
1104: via CVS is strongly recommended.</p>
1105: </div>
1106: <p>Note that by default the distfiles and the binary packages
1107: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1108: before updating. You can also configure pkgsrc to store distfiles
1109: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1110: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154 rillig 1111: 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 1112: <p>To update pkgsrc from a tar file, download the tar file as
1113: explained above. Then, make sure that you have not made any
1114: changes to the files in the pkgsrc directory. Remove the pkgsrc
1115: directory and extract the new tar file. Done.</p>
1116: </div>
1.41 asau 1117: <div class="sect2">
1.1 dsieger 1118: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1119: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1120: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1121: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1122: </pre>
1123: <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>
1124: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1125: </pre>
1.41 asau 1126: <div class="sect3">
1.1 dsieger 1127: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1128: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1129: <p>When updating pkgsrc, the CVS program keeps track of the
1130: branch you selected. But if you, for whatever reason, want to
1131: switch from the stable branch to the current one, you can do it
1.23 wiz 1132: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1133: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1134: back to the stable branch, add the
1.198 leot 1135: <span class="quote">“<span class="quote">-rpkgsrc-2021Q1</span>”</span> option.</p>
1.1 dsieger 1136: </div>
1.41 asau 1137: <div class="sect3">
1.1 dsieger 1138: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1139: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1140: <p>When you update pkgsrc, the CVS program will only touch
1141: those files that are registered in the CVS repository. That
1142: means that any packages that you created on your own will stay
1143: unmodified. If you change files that are managed by CVS, later
1144: updates will try to merge your changes with those that have been
1145: done by others. See the CVS manual, chapter
1.23 wiz 1146: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1147: </div>
1148: </div>
1149: </div>
1150: </div>
1.41 asau 1151: <div class="chapter">
1.1 dsieger 1152: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1153: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1154: <div class="toc">
1155: <p><b>Table of Contents</b></p>
1.100 leot 1156: <dl class="toc">
1.154 rillig 1157: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1158: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1159: </dl>
1160: </div>
1.41 asau 1161: <div class="sect1">
1.1 dsieger 1162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1163: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1164: <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 1165: </div>
1.41 asau 1166: <div class="sect1">
1.1 dsieger 1167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1168: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1169: <p>pkgsrc can be bootstrapped for use in two different modes:
1170: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1171: to privileged one all programs are installed under one particular user
1.43 asau 1172: and cannot utilise privileged operations (packages don't create
1173: special users and all special file permissions like setuid are ignored).
1174: </p>
1.1 dsieger 1175: <p>Installing the bootstrap kit from source should be as simple as:</p>
1176: <pre class="screen">
1.60 asau 1177: <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 1178: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1179: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1180: </pre>
1.43 asau 1181: <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>
1182: <p>By default, in privileged mode pkgsrc uses
1183: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1184: where programs will be installed in,
1.118 sevan 1185: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1186: directory where pkgsrc will do its internal bookkeeping,
1187: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1188: where packages install their persistent data.
1189: In unprivileged mode pkgsrc uses
1190: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1191: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1192: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1193: </p>
1194: <p>You can change default layout using command-line arguments.
1195: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1196: </p>
1.41 asau 1197: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1198: <h3 class="title">Note</h3>
1.10 hubertf 1199: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1200: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1201: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1202: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1203: </div>
1.43 asau 1204: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1205: <h3 class="title">Note</h3>
1206: <p>It is possible to bootstrap multiple instances of pkgsrc
1207: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1208: corresponding to the installation you're working with to build
1209: and install packages.
1210: </p>
1211: </div>
1.1 dsieger 1212: </div>
1213: </div>
1.41 asau 1214: <div class="chapter">
1.1 dsieger 1215: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1216: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1217: <div class="toc">
1218: <p><b>Table of Contents</b></p>
1.100 leot 1219: <dl class="toc">
1.154 rillig 1220: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1221: <dd><dl>
1.154 rillig 1222: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1223: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 1224: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1225: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1226: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1227: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1228: <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>
1229: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.154 rillig 1230: </dl></dd>
1231: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1232: <dd><dl>
1233: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1234: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1235: <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 1236: </dl></dd>
1237: </dl>
1238: </div>
1239: <p>Basically, there are two ways of using pkgsrc. The first
1240: is to only install the package tools and to use binary packages
1.23 wiz 1241: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1242: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1243: of pkgsrc, too. Then you are able to build your own packages,
1244: and you can still use binary packages from someone else.</p>
1.41 asau 1245: <div class="sect1">
1.1 dsieger 1246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1247: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.202 nia 1248: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.151 sevan 1249: site and mirrors, there are collections of binary packages,
1.9 rillig 1250: ready to be installed. These binary packages have been built using the
1251: default settings for the directories, that is:</p>
1.41 asau 1252: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1253: <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>
1254: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1255: <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 1256: </ul></div>
1257: <p>If you cannot use these directories for whatever reasons (maybe
1258: because you're not root), you cannot use these binary packages, but
1.154 rillig 1259: 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 1260: <div class="sect2">
1.1 dsieger 1261: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1262: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1263: <p>To install binary packages, you first need to know from where
1264: to get them. The first place where you should look is on the main
1.202 nia 1265: 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 1266: <p>This directory contains binary packages for multiple
1267: platforms. First, select your operating system. (Ignore the
1268: directories with version numbers attached to it, they just exist for
1269: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1270: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1271: <p>In this directory, you often find a file called
1272: <code class="filename">bootstrap.tar.gz</code> which contains the package
1273: management tools. If the file is missing, it is likely that your
1274: operating system already provides those tools. Download the file and
1275: extract it in the <code class="filename">/</code> directory. It will create
1276: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1277: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1278: </div>
1.41 asau 1279: <div class="sect2">
1.1 dsieger 1280: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1281: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1282: <p>In the directory from the last section, there is a
1.85 wiz 1283: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1284: binary packages that are available for the platform, excluding those
1.202 nia 1285: that may not be distributed via HTTP or FTP.</p>
1.9 rillig 1286: <p>To install packages directly from an FTP or HTTP server, run
1287: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1288: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1289: <pre class="screen">
1.202 nia 1290: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1291: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.169 rillig 1292: <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 1293: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.202 nia 1294: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.9 rillig 1295: </pre>
1296: <p>Instead of URLs, you can also use local paths, for example if
1297: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1298: repository. If you want to install packages from multiple sources,
1299: you can separate them by a semicolon in
1300: <code class="varname">PKG_PATH</code>.</p>
1301: <p>After these preparations, installing a package is very
1302: easy:</p>
1303: <pre class="screen">
1.202 nia 1304: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1305: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1306: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1307: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1308: </pre>
1309: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1310: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1311: <p>Any prerequisite packages needed to run the
1.1 dsieger 1312: package in question will be installed, too, assuming they are
1.202 nia 1313: present in the repository.</p>
1.1 dsieger 1314: <p>After you've installed packages, be sure to have
1315: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1316: <code class="varname">PATH</code> so you can actually start the just
1317: installed program.</p>
1318: </div>
1.41 asau 1319: <div class="sect2">
1.1 dsieger 1320: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1321: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1322: <p>To update binary packages, it is recommended that you use
1323: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1324: package repository to your locally installed packages and safely
1325: replace any older packages.</p>
1326: <p>Note that pkgsrc is released as quarterly branches.
1327: If you are updating to a newer quarterly branch of pkgsrc, you may
1328: need to adjust the repository in
1329: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1330: </div>
1331: <div class="sect2">
1332: <div class="titlepage"><div><div><h3 class="title">
1333: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1334: <p>To deinstall a package, it does not matter whether it was
1.202 nia 1335: installed from source code or from a binary package. Neither the
1336: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1337: command need to know.</p>
1338: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.1 dsieger 1339: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.202 nia 1340: name can be given with or without version number.</p>
1.1 dsieger 1341: </div>
1.41 asau 1342: <div class="sect2">
1.1 dsieger 1343: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1344: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1345: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.202 nia 1346: installed packages or binary package files.
1347: As with other management tools, it works with packages installed
1348: from source or binaries.</p>
1.1 dsieger 1349: </div>
1.41 asau 1350: <div class="sect2">
1.1 dsieger 1351: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1352: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1353: <p>
1.164 leot 1354: The pkgsrc Security Team and Packages Groups maintain a list of
1.202 nia 1355: known vulnerabilities to packages which are (or have been)
1.1 dsieger 1356: included in pkgsrc. The list is available from the NetBSD
1.202 nia 1357: 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>.
1358: </p>
1359: <p>
1360: Please note that not every "vulnerability" with a CVE assignment is
1361: exploitable in every configuration.
1362: Some bugs are marked as active simply because an fix was not
1363: marked as such.
1364: Operating system specific hardening and mitigation features may also
1365: reduce the impact of bugs.
1.1 dsieger 1366: </p>
1367: <p>
1.22 jakllsch 1368: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1369: this list can be downloaded
1370: automatically, and a security audit of all packages installed on a system
1371: can take place.
1372: </p>
1373: <p>
1.22 jakllsch 1374: There are two components to auditing. The first
1375: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1376: is for downloading
1.1 dsieger 1377: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1378: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1379: installed packages are vulnerable. If a package is vulnerable, you
1380: will see output similar to the following:
1381: </p>
1382: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1383: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.1 dsieger 1384: <p>
1.22 jakllsch 1385: You may wish to have the
1.202 nia 1386: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1387: file downloaded daily so that
1388: it remains current. This may be done by adding an appropriate entry
1.197 leot 1389: to the root users <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1390: </p>
1391: <pre class="screen">
1.121 sevan 1392: # Download vulnerabilities file
1.118 sevan 1393: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1394: # Audit the installed packages and email results to root
1395: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1396: root >/dev/null 2>&1
1.22 jakllsch 1397: </pre>
1398: <p>
1.118 sevan 1399: will update the vulnerability list every day at 3AM, followed by an audit
1400: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1401:
1.118 sevan 1402: On NetBSD this may be accomplished instead by adding the following
1403: line to <code class="filename">/etc/daily.conf</code>:
1404: </p>
1405: <pre class="screen">
1406: fetch_pkg_vulnerabilities=YES
1407: </pre>
1408: <p>
1409: to fetch the vulnerability list from the daily security script. The system
1410: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1411: desired (not required), by adding the following line to
1.118 sevan 1412: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1413: </p>
1414: <pre class="screen">
1.118 sevan 1415: check_pkg_vulnerabilities=YES
1.22 jakllsch 1416: </pre>
1417: <p>
1.197 leot 1418: see <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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.1/i386/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.1 dsieger 1419: </p>
1420: </div>
1.41 asau 1421: <div class="sect2">
1.1 dsieger 1422: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1423: <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 1424: <p>
1.137 leot 1425: Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23 wiz 1426: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.202 nia 1427: argument to check if any packages are stale, e.g.
1.1 dsieger 1428: </p>
1429: <pre class="screen">
1430: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1431: ...
1432: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1433: </pre>
1434: </div>
1.41 asau 1435: <div class="sect2">
1.1 dsieger 1436: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1437: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.10 hubertf 1438: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1439: administrative functions on the package system.</p>
1440: </div>
1441: </div>
1.41 asau 1442: <div class="sect1">
1.1 dsieger 1443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1444: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1 dsieger 1445: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1446: directory now contains a set of packages, organized into
1447: categories. You can browse the online index of packages, or run
1.10 hubertf 1448: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1449: directory to build local <code class="filename">README.html</code> files for
1.137 leot 1450: all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.1 dsieger 1451: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1452: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1453: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1454: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1455: different <code class="varname">LOCALBASE</code> definitions on the same
1456: system (inside a chroot is an exception). </p>
1457: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1458: 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 1459: instructions how to create your own packages.</p>
1.41 asau 1460: <div class="sect2">
1.1 dsieger 1461: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1462: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1 dsieger 1463: <p>To build packages from source, you need a working C
1464: compiler. On NetBSD, you need to install the
1.23 wiz 1465: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1466: sets. If you want to build X11-related packages, the
1.23 wiz 1467: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1468: sets are required, too.</p>
1469: </div>
1.41 asau 1470: <div class="sect2">
1.1 dsieger 1471: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1472: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1 dsieger 1473: <p>The first step for building a package is downloading the
1474: distfiles (i.e. the unmodified source). If they have not yet been
1475: downloaded, pkgsrc will fetch them automatically.</p>
1476: <p>If you have all files that you need in the
1477: <code class="filename">distfiles</code> directory,
1478: you don't need to connect. If the distfiles are on CD-ROM, you can
1479: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1480: </p>
1481: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1482: <p>
1.10 hubertf 1483: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1484: <p>By default a list of distribution sites will be randomly
1485: intermixed to prevent huge load on servers which holding popular
1486: packages (for example, SourceForge.net mirrors). Thus, every
1487: time when you need to fetch yet another distfile all the mirrors
1488: will be tried in new (random) order. You can turn this feature
1489: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1490: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1491: <p>You can overwrite some of the major distribution sites to
1492: fit to sites that are close to your own. By setting one or two
1493: variables you can modify the order in which the master sites are
1494: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1495: delimited list of domain suffixes.
1496: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1497: contains a whitespace delimited list of regular expressions. It
1498: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1499: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1500: some examples. This may save some of your bandwidth and
1501: time.</p>
1502: <p>You can change these settings either in your shell's environment, or,
1503: if you want to keep the settings, by editing the
1.10 hubertf 1504: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1505: and adding the definitions there.</p>
1506: <p>
1507: If a package depends on many other packages (such as
1.137 leot 1508: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.1 dsieger 1509: alternate between periods of
1510: downloading source, and compiling. To ensure you have all the source
1511: downloaded initially you can run the command:
1512: </p>
1513: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1514: <p>
1515: which will output and run a set of shell commands to fetch the
1516: necessary files into the <code class="filename">distfiles</code> directory. You can
1517: also choose to download the files manually.
1518: </p>
1519: </div>
1.41 asau 1520: <div class="sect2">
1.1 dsieger 1521: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1522: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1 dsieger 1523: <p>
1524: Once the software has downloaded, any patches will be applied, then it
1525: will be compiled for you. This may take some time depending on your
1526: computer, and how many other packages the software depends on and their
1527: compile time.
1528: </p>
1.41 asau 1529: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1530: <h3 class="title">Note</h3>
1531: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1532: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1533: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1534: </div>
1535: <p>For example, type</p>
1536: <pre class="screen">
1537: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1538: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1539: </pre>
1540: <p>at the shell prompt to build the various components of the
1541: package.</p>
1542: <p>The next stage is to actually install the newly compiled
1543: program onto your system. Do this by entering:
1544:
1545: </p>
1546: <pre class="screen">
1547: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1548: </pre>
1549: <p>
1550:
1551: while you are still in the directory for whatever package you
1552: are installing.</p>
1553: <p>Installing the package on your system may require you to
1554: be root. However, pkgsrc has a
1555: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1556: to only become root for the actual installation step.</p>
1557: <p>That's it, the software should now be installed and setup for use.
1558: You can now enter:
1559:
1560: </p>
1561: <pre class="screen">
1562: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1563: </pre>
1564: <p>
1565:
1566: to remove the compiled files in the work directory, as you shouldn't need
1567: them any more. If other packages were also added to your system
1568: (dependencies) to allow your program to compile, you can tidy these up
1569: also with the command:</p>
1570: <pre class="screen">
1571: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1572: </pre>
1573: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 1574: system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1 dsieger 1575: <p>The program is installed under the default root of the
1576: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1577: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1578: variable in your environment, and it will use that value as the
1579: root of your packages tree. So, to use
1580: <code class="filename">/usr/local</code>, set
1581: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1582: Please note that you should use a directory which is dedicated to
1583: packages and not shared with other programs (i.e., do not try and
1584: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1585: to add any of your own files or directories (such as
1586: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1587: <code class="filename">pkgsrc/</code>) below the
1588: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1589: conflicts between programs and other files installed by the
1590: package system and whatever else may have been installed
1591: there.</p>
1.10 hubertf 1592: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1593: alter some configuration options at build time. Have a look at
1594: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1595: of what will be set there by default. Environment variables such
1596: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1597: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1598: set them each time you want to use pkgsrc.</p>
1.23 wiz 1599: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1600: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1601: or being installed. This may be for debugging purposes, or out of
1602: simple curiosity. A number of utility values have been added to
1603: help with this.</p>
1.23 wiz 1604: <div class="orderedlist"><ol class="orderedlist" type="1">
1605: <li class="listitem">
1.197 leot 1606: <p>If you invoke the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 1607: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1608: information will be displayed. For example,</p>
1609: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1610: <p>will show all the commands that are invoked, up to and
1.23 wiz 1611: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1612: </li>
1.23 wiz 1613: <li class="listitem">
1.197 leot 1614: <p>If you want to know the value of a certain <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1615: definition, then the <code class="varname">VARNAME</code> definition
1616: should be used, in conjunction with the show-var
1.197 leot 1617: target. e.g. to show the expansion of the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1618: variable <code class="varname">LOCALBASE</code>:</p>
1619: <pre class="screen">
1620: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1621: /usr/pkg
1622: <code class="prompt">%</code>
1623: </pre>
1624: </li>
1625: </ol></div>
1626: <p>If you want to install a binary package that you've either
1627: created yourself (see next section), that you put into
1628: pkgsrc/packages manually or that is located on a remote FTP
1629: server, you can use the "bin-install" target. This target will
1.197 leot 1630: install a binary package - if available - via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 1631: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1632: sites searched is kept in the variable
1633: <code class="varname">BINPKG_SITES</code>, which defaults to
1.197 leot 1634: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 1635: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1636: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1637: details.</p>
1638: <p>A final word of warning: If you set up a system that has a
1639: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1640: set that before any packages are installed, as you cannot use
1641: several directories for the same purpose. Doing so will result in
1642: pkgsrc not being able to properly detect your installed packages,
1643: and fail miserably. Note also that precompiled binary packages are
1644: usually built with the default <code class="varname">LOCALBASE</code> of
1645: <code class="filename">/usr/pkg</code>, and that you should
1646: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1647: <code class="varname">LOCALBASE</code>.</p>
1648: </div>
1649: </div>
1650: </div>
1.41 asau 1651: <div class="chapter">
1.1 dsieger 1652: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1653: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1 dsieger 1654: <div class="toc">
1655: <p><b>Table of Contents</b></p>
1.100 leot 1656: <dl class="toc">
1.154 rillig 1657: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1658: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1659: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
1660: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1661: <dd><dl>
1662: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
1663: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1664: <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 1665: </dl></dd>
1.154 rillig 1666: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
1667: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 1668: </dl>
1669: </div>
1.4 rillig 1670: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1671: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1672: that file depends on the installation. On NetBSD, when you use
1.197 leot 1673: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 1674: <code class="filename">/etc/</code>. In all other cases the default location is
1675: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1676: bootstrap program to install the binary packages.</p>
1677: <p>The format of the configuration file is that of the usual
1678: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1679: is done by setting variables in this file. Note that you can define all
1680: kinds of variables, and no special error checking (for example for
1.112 rillig 1681: spelling mistakes) takes place.</p>
1.41 asau 1682: <div class="sect1">
1.1 dsieger 1683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1684: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112 rillig 1685: <p>The following variables apply to all
1.1 dsieger 1686: pkgsrc packages. A complete list of the variables that can be
1687: configured by the user is available in
1688: <code class="filename">mk/defaults/mk.conf</code>, together with some
1689: comments that describe each variable's intent.</p>
1.41 asau 1690: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1691: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1692: packages will be installed. The default is
1693: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1694: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1695: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1696: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1697: installed. The default is
1698: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1699: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1700: X11 is installed on the system. The default is
1.84 wiz 1701: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1702: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1703: downloaded copies of the original source distributions used
1704: for building pkgsrc packages. The default is
1705: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1706: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1707: database about installed packages is stored. The default is
1.118 sevan 1708: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1709: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1710: If set, override the packages'
1711: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1712: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1713: Backup location(s) for distribution files and patch files
1714: if not found locally or in
1715: <code class="filename">${MASTER_SITES}</code> or
1716: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1717: The defaults is
1718: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1719: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1720: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1721: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1722: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1723: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1724: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1725: List of acceptable licenses. License names are case-sensitive.
1726: Whenever you try to build a package whose license is not in this
1727: list, you will get an error message. If the license condition is
1728: simple enough, the error message will include specific
1729: instructions on how to change this variable.</p></li>
1.1 dsieger 1730: </ul></div>
1731: </div>
1.41 asau 1732: <div class="sect1">
1.1 dsieger 1733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1734: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1735: <p>
1.1 dsieger 1736: </p>
1.41 asau 1737: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1738: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1739: directory for the binary packages. The default is
1740: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1741: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1742: The top level directory where, if defined, the separate
1743: working directories will get created, and symbolically
1744: linked to from <code class="filename">${WRKDIR}</code> (see below).
1745: This is useful for building packages on several
1746: architectures, then <code class="filename">${PKGSRCDIR}</code>
1747: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1748: is local to every architecture. (It should be noted that
1749: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1750: — it is an internal definition which refers to the
1.1 dsieger 1751: root of the pkgsrc tree. It is possible to have many
1752: pkgsrc tree instances.)</p></li>
1.23 wiz 1753: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1754: Directory for local patches that aren't part of pkgsrc.
1.184 rillig 1755: 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 1756: information.</p></li>
1.23 wiz 1757: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1758: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1759: BSD-style Makefile. If this is not set,
1760: <code class="varname">MAKECONF</code> is set to
1761: <code class="filename">/dev/null</code> to avoid picking up
1762: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1763: </ul></div>
1764: </div>
1.41 asau 1765: <div class="sect1">
1.1 dsieger 1766: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1767: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.198 leot 1768: <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 1769: By default, binary packages of built packages are
1.150 leot 1770: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143 maya 1771: this variable to "no" prevents this.</p></li></ul></div>
1.107 jnemeth 1772: <p>Packages have to support installation into a
1.4 rillig 1773: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1774: to be built, before the actual filesystem is touched. DESTDIR
1775: support exists in two variations:</p>
1.41 asau 1776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1777: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1778: installation and packaging is still run as root.</p></li>
1779: <li class="listitem"><p>Full DESTDIR support can run the complete
1780: build, installation and packaging as normal user. Root
1781: privileges are only needed to add packages.</p></li>
1782: </ul></div>
1.4 rillig 1783: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1784: clean</code></strong> needs to be run as root.</p>
1.17 imil 1785: <p>Considering the <code class="filename">foo/bar</code> package,
1786: DESTDIR full support can be tested using the following commands
1787:
1788: </p>
1789: <pre class="programlisting">
1790: <code class="prompt">$</code> id
1791: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1792: <code class="prompt">$</code> mkdir $HOME/packages
1793: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1794: </pre>
1795: <p>
1796:
1797: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1798: should be needed
1799:
1800: </p>
1801: <pre class="programlisting">
1.66 asau 1802: <code class="prompt">$</code> make stage-install
1.17 imil 1803: </pre>
1804: <p>
1805:
1806: Create a package without root privileges
1807:
1808: </p>
1809: <pre class="programlisting">
1.66 asau 1810: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1811: </pre>
1812: <p>
1813:
1814: For the following command, you must be able to gain root
1.197 leot 1815: privileges using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 1816:
1817: </p>
1818: <pre class="programlisting">
1.66 asau 1819: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1820: </pre>
1821: <p>
1822:
1823: Then, as a simple user
1824:
1825: </p>
1826: <pre class="programlisting">
1827: <code class="prompt">$</code> make clean
1828: </pre>
1829: <p>
1830:
1831: </p>
1.4 rillig 1832: </div>
1.41 asau 1833: <div class="sect1">
1.4 rillig 1834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1835: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1836: <div class="sect2">
1.1 dsieger 1837: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1838: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1839: <p>By default, pkgsrc will use GCC to build packages. This may be
1840: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1841: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1842: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1843: <dd>
1844: <p>This is a list of values specifying the chain of
1845: compilers to invoke when building packages. Valid values
1846: are:</p>
1.41 asau 1847: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1848: <li class="listitem"><p><code class="varname">ccc</code>:
1849: Compaq C Compilers (Tru64)</p></li>
1850: <li class="listitem"><p><code class="varname">ccache</code>:
1851: compiler cache (chainable)</p></li>
1852: <li class="listitem"><p><code class="varname">clang</code>:
1853: Clang C and Objective-C compiler</p></li>
1.23 wiz 1854: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1855: distributed C/C++ (chainable)</p></li>
1.66 asau 1856: <li class="listitem"><p><code class="varname">f2c</code>:
1857: Fortran 77 to C compiler (chainable)</p></li>
1858: <li class="listitem"><p><code class="varname">icc</code>:
1859: Intel C++ Compiler (Linux)</p></li>
1860: <li class="listitem"><p><code class="varname">ido</code>:
1861: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1862: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1863: GNU C/C++ Compiler</p></li>
1.66 asau 1864: <li class="listitem"><p><code class="varname">hp</code>:
1865: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1866: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1867: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1868: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1869: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1870: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1871: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1872: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1873: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1874: </ul></div>
1875: <p>The default is
1.23 wiz 1876: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1877: <code class="varname">ccache</code> and/or
1878: <code class="varname">distcc</code> with an appropriate
1879: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1880: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1881: variable should always be terminated with a value for
1882: a real compiler. Note that only one real compiler
1.23 wiz 1883: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1884: is not allowed).</p>
1885: </dd>
1886: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1887: <dd><p>This specifies the minimum version of GCC to use
1888: when building packages. If the system GCC doesn't
1889: satisfy this requirement, then pkgsrc will build and
1890: install one of the GCC packages to use instead.</p></dd>
1.153 leot 1891: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114 maya 1892: <dd><p>Specifies which version of python to use when several
1893: options are available.</p></dd>
1894: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.176 gutterid 1895: <dd><p>Specifies the Fortran compiler to use.
1896: The default is <code class="varname">gfortran</code>.</p></dd>
1.114 maya 1897: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1898: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1899: <code class="varname">gfortran</code> is used, this option specifies which
1900: version to use.</p></dd>
1.1 dsieger 1901: </dl></div>
1902: </div>
1.41 asau 1903: <div class="sect2">
1.1 dsieger 1904: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1905: <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 1906: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1907: please make sure to use the <code class="literal">+=</code> operator
1908: instead of the <code class="literal">=</code> operator:</p>
1909: <pre class="programlisting">
1910: CFLAGS+= -your -flags
1911: </pre>
1912: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1913: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1914: need to add their own flags. You may want to take a look
1.137 leot 1915: at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23 wiz 1916: package if you're interested in optimization specifically
1917: for the current CPU. </p>
1.1 dsieger 1918: </div>
1.41 asau 1919: <div class="sect2">
1.1 dsieger 1920: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1921: <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 1922: <p>If you want to pass flags to the linker, both in the configure
1923: step and the build step, you can do this in two ways. Either set
1924: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1925: between the two is that <code class="varname">LIBS</code> will be appended to
1926: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1927: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1928: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1929: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1930: <code class="varname">CFLAGS</code>, if you do not wish to override these
1931: settings, use the <code class="literal">+=</code> operator:</p>
1932: <pre class="programlisting">
1933: LDFLAGS+= -your -linkerflags
1934: </pre>
1935: </div>
1936: </div>
1.41 asau 1937: <div class="sect1">
1.1 dsieger 1938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1939: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1940: <p>
1.1 dsieger 1941: </p>
1.41 asau 1942: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1943: <li class="listitem">
1.1 dsieger 1944: <p><code class="varname">PKG_DEVELOPER</code>:
1945: Run some sanity checks that package developers want:
1946: </p>
1.41 asau 1947: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1948: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 1949: fuzz</p></li>
1.23 wiz 1950: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 1951: binaries will find their shared libs.</p></li>
1952: </ul></div>
1953: <p>
1954: </p>
1955: </li>
1.23 wiz 1956: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 1957: of debugging output which is displayed whilst making and
1958: installing the package. The default value for this is 0,
1959: which will not display the commands as they are executed
1960: (normal, default, quiet operation); the value 1 will display
1961: all shell commands before their invocation, and the value 2
1962: will display both the shell commands before their invocation,
1.112 rillig 1963: as well as their actual execution progress with <span class="command"><strong>set
1964: -x</strong></span>.</p></li>
1.1 dsieger 1965: </ul></div>
1966: <p>
1967: </p>
1968: </div>
1.41 asau 1969: <div class="sect1">
1.1 dsieger 1970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1971: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1972: <p>Some packages have build time options, usually to select
1973: between different dependencies, enable optional support for big
1974: dependencies or enable experimental features.</p>
1975: <p>To see which options, if any, a package supports, and which
1.10 hubertf 1976: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 1977: show-options</strong></span>, for example:</p>
1978: <pre class="programlisting">
1979: The following options are supported by this package:
1980: ssl Enable SSL support.
1981: Exactly one of the following gecko options is required:
1982: firefox Use firefox as gecko rendering engine.
1983: mozilla Use mozilla as gecko rendering engine.
1984: At most one of the following database options may be selected:
1985: mysql Enable support for MySQL database.
1986: pgsql Enable support for PostgreSQL database.
1987:
1988: These options are enabled by default: firefox
1989: These options are currently enabled: mozilla ssl
1990: </pre>
1991: <p>The following variables can be defined in
1.10 hubertf 1992: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 1993: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1994: which can be used to select or disable options for all packages
1995: that support them, and
1996: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1997: which can be used to select or disable options specifically for
1998: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 1999: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2000: are disabled. A few examples:</p>
2001: <pre class="screen">
1.10 hubertf 2002: <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 2003: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2004: PKG_OPTIONS.kdebase= debug -sasl
2005: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2006: <p>It is important to note that options that were specifically
1.18 snj 2007: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2008: you do not wish to include the option. If you are unsure you can view
2009: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2010: <p>The following settings are consulted in the order given, and
2011: the last setting that selects or disables an option is
2012: used:</p>
1.23 wiz 2013: <div class="orderedlist"><ol class="orderedlist" type="1">
2014: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2015: maintainer</p></li>
1.23 wiz 2016: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2017: variables (see below)</p></li>
1.23 wiz 2018: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2019: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2020: </ol></div>
2021: <p>For groups of mutually exclusive options, the last option
2022: selected is used, all others are automatically disabled. If an
2023: option of the group is explicitly disabled, the previously
2024: selected option, if any, is used. It is an error if no option
2025: from a required group of options is selected, and building the
2026: package will fail.</p>
2027: <p>Before the options framework was introduced, build options
2028: were selected by setting a variable (often named
2029: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2030: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2031: transition to the options framework for the user, these legacy
2032: variables are converted to the appropriate options setting
2033: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2034: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2035: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2036: directly. Support for the legacy variables will be removed
2037: eventually.</p>
2038: </div>
2039: </div>
1.41 asau 2040: <div class="chapter">
1.1 dsieger 2041: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2042: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1 dsieger 2043: <div class="toc">
2044: <p><b>Table of Contents</b></p>
1.100 leot 2045: <dl class="toc">
1.154 rillig 2046: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2047: <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 2048: </dl>
2049: </div>
1.41 asau 2050: <div class="sect1">
1.1 dsieger 2051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2052: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1 dsieger 2053: <p>Once you have built and installed a package, you can create
2054: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.197 leot 2055: another system with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 2056: the same package on a group of hosts and wasting CPU time. It also
2057: provides a simple means for others to install your package, should
2058: you distribute it.</p>
2059: <p>To create a binary package, change into the appropriate
1.10 hubertf 2060: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2061: package</strong></span>:</p>
2062: <pre class="screen">
1.112 rillig 2063: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2064: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2065: </pre>
1.1 dsieger 2066: <p>This will build and install your package (if not already done),
2067: and then build a binary package from what was installed. You can
1.10 hubertf 2068: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2069: it. Binary packages are created by default in
2070: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2071: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.137 leot 2072: continuation of the above <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.154 rillig 2073: <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 2074: such a binary package.</p>
2075: </div>
1.41 asau 2076: <div class="sect1">
1.1 dsieger 2077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2078: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.184 rillig 2079: <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 2080: </div>
2081: </div>
1.41 asau 2082: <div class="chapter">
1.6 rillig 2083: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2084: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 2085: builds)</h2></div></div></div>
2086: <div class="toc">
2087: <p><b>Table of Contents</b></p>
1.100 leot 2088: <dl class="toc">
1.154 rillig 2089: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 2090: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 2091: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2092: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 2093: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2094: <dd><dl>
1.179 rillig 2095: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2096: <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 2097: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
2098: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
2099: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
2100: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
2101: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
2102: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
2103: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
2104: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 2105: </dl></dd>
2106: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2107: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2108: </dl>
2109: </div>
1.175 gutterid 2110: <p>For a number of reasons, you may want to build binary packages
2111: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.71 wiz 2112: For instance, when you have multiple machines that should run the same software,
2113: it is wasted time if they all build their packages themselves from source.
2114: Or you may want to build a list of packages you want and check them before
1.175 gutterid 2115: deploying onto production systems.
1.71 wiz 2116: There is a way of getting a set of binary packages:
1.175 gutterid 2117: the bulk build system, or pbulk ("p" stands for "parallel").
1.112 rillig 2118: This chapter describes how to set it up.</p>
1.41 asau 2119: <div class="sect1">
1.6 rillig 2120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2121: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71 wiz 2122: <p>First of all, you have to decide whether you build all packages
2123: or a limited set of them. Full bulk builds usually consume a lot more resources,
2124: both space and time, than builds for some practical sets of packages.
1.175 gutterid 2125: A number of particularly heavy packages exist that are not actually
2126: interesting to a wide audience. (The approximate resource consumption for a
2127: 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>.)
2128: For limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2129: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2130: </p>
2131: <p>During bulk builds various packages are installed and deinstalled
2132: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2133: so make sure that you don't need any package during the builds.
1.112 rillig 2134: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2135: or something even more restrictive, depending on what the operating system provides,
2136: or dedicate the whole physical machine.
2137: As a useful side effect this makes sure that bulk builds cannot
2138: break anything in your system. There have been numerous cases where
1.6 rillig 2139: certain packages tried to install files outside the
2140: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2141: <code class="filename">/etc</code>.
2142: </p>
1.6 rillig 2143: </div>
1.41 asau 2144: <div class="sect1">
1.6 rillig 2145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 rillig 2146: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
2147: <p>Running a bulk build works roughly as follows:</p>
1.41 asau 2148: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2149: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2150: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2151: </ul></div>
1.41 asau 2152: <div class="sect2">
1.15 rillig 2153: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2154: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112 rillig 2155: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2156: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2157: Configure network access to fetch distribution files.
1.112 rillig 2158: Create a user with name "pbulk".</p>
1.68 asau 2159: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2160: <pre class="screen">
1.151 sevan 2161: <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>
2162: <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 2163: <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 2164: </pre>
2165: <p>Or any other way that fits (e.g., curl, wget).</p>
2166: <p>Deploy and configure pbulk tools, e.g.:</p>
2167: <pre class="screen">
1.118 sevan 2168: <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 2169: <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>
2170: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2171: </pre>
2172: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2173: <h3 class="title">Note</h3>
2174: <p><code class="filename">mk.conf.frag</code> is a fragment of
2175: <code class="filename">mk.conf</code> that contains settings you want to
2176: apply to packages you build. For instance,</p>
2177: <pre class="programlisting">
1.112 rillig 2178: PKG_DEVELOPER= yes # perform more checks
2179: X11_TYPE= modular # use pkgsrc X11
2180: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2181: # when building all packages)
1.68 asau 2182: </pre>
2183: </div>
2184: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2185: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2186: <pre class="programlisting">
2187: www/firefox
2188: mail/thunderbird
2189: misc/libreoffice4
2190: </pre>
1.69 asau 2191: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2192: and make final amendments, if wanted.</p>
1.68 asau 2193: <p>Start it:</p>
2194: <pre class="screen">
2195: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2196: </pre>
2197: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2198: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2199: </p>
2200: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2201: <h3 class="title">Note</h3>
2202: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2203: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2204: The script is kept small enough for better understanding.</p>
2205: </div>
2206: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2207: <h3 class="title">Note</h3>
2208: <p>The <code class="filename">pbulk.sh</code> script supports running
2209: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2210: </div>
1.6 rillig 2211: </div>
2212: </div>
1.41 asau 2213: <div class="sect1">
1.6 rillig 2214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2215: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71 wiz 2216: <p>A complete bulk build requires lots of disk space. Some of the
2217: disk space can be read-only, some other must be writable. Some can be on
2218: remote filesystems (such as NFS) and some should be local. Some can be
2219: temporary filesystems, others must survive a sudden reboot.</p>
2220: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2221: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2222: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2223: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2224: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2225: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2226: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2227: </ul></div>
2228: </div>
2229: <div class="sect1">
2230: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.178 rillig 2231: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2232: <p>To ensure that pkgsrc packages work in different configurations, it
2233: makes sense to run non-default bulk builds from time to time. This
2234: section lists some ideas for bulk builds that intentionally let packages
2235: fail if they don't follow the pkgsrc style.</p>
2236: <div class="sect2">
2237: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2238: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.178 rillig 2239: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2240: <pre class="programlisting">
2241: GNU_CONFIGURE_STRICT= yes
2242: </pre>
2243: <p>When a package fails this additional check, the most common cause
2244: is that the configure option was valid for an older version of the
2245: package but does not apply anymore. In that case, just remove it.</p>
2246: </div>
2247: <div class="sect2">
2248: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2249: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.178 rillig 2250: <p>The job of a compiler is not restricted to producing executable
1.179 rillig 2251: code, most compilers also detect typical programming mistakes. The pkgsrc
2252: compiler wrappers make it easy to force compiler options when the package
2253: is built. This can be used to find typical bugs across all packages that
2254: are in pkgsrc. By reporting these bugs upstream, the packages will be
2255: more reliable with the next updates.</p>
2256: <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 2257: <pre class="programlisting">
2258: CFLAGS+= -Werror=char-subscripts
1.179 rillig 2259: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 2260: </pre>
1.179 rillig 2261: <p>When a package fails to build using these stricter compiler
2262: options, document the circumstances in which the compiler produced the
2263: error message. This includes:</p>
1.178 rillig 2264: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2265: <li class="listitem"><p>The platform
2266: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2267: <li class="listitem"><p>The source file</p></li>
2268: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2269: part of the diagnostic.</p></li>
1.179 rillig 2270: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.178 rillig 2271: </ul></div>
2272: <p>If a package produces these error messages, but the package is
1.179 rillig 2273: 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
2274: in the next builds:</p>
1.178 rillig 2275: <pre class="programlisting">
1.179 rillig 2276: .if ${PKGPATH} == category/package
1.178 rillig 2277: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2278: # error message
2279: # code
1.179 rillig 2280: # Reason why the code does not need to be fixed.
1.178 rillig 2281: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 2282: .endif
1.178 rillig 2283: </pre>
2284: <p>If the error messages from the compiler are valid and the code
1.179 rillig 2285: needs to be fixed, prepare a local patch (see
2286: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2287: authors of the package, providing them with the information you collected
2288: above.</p>
2289: <p>Patches that are not essential for the package to work should only
2290: be reported upstream but not committed to pkgsrc, to make future updates
2291: easier.</p>
1.178 rillig 2292: </div>
2293: <div class="sect2">
2294: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2295: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
2296: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2297: these apply to all phases of the package build process. Especially in the
2298: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2299: decisions. The GNU configure scripts feed many small test programs to the
2300: C compiler to see whether certain headers are available, functions are
2301: defined in a library and programs can be run. In many cases these
2302: programs would not survive a strict compiler run with <code class="literal">-Wall
2303: -Wextra -Werror</code>.</p>
2304: <p>The pkgsrc infrastructure is flexible enough to support compiler
2305: options being added between the <code class="literal">configure</code> and
2306: <code class="literal">build</code> phases. It's a little more complicated than the
2307: other examples in this section but still easy enough.</p>
2308: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2309: desired compiler options. The compiler wrapper's original task is to hide
2310: unwanted directories of include files and to normalize compiler options.
2311: It does this by wrapping the compiler command and rewriting the command
2312: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2313: package directory and examine the
2314: <code class="filename">work/.cwrappers/config</code> directory. It contains
2315: individual configurations for the C compiler and the related tools. The
2316: plan is to find a hook between the configure and build phases, and to
2317: modify these configuration files at that point.</p>
2318: <p>To find this hook, have a look at
2319: <code class="filename">mk/build/build.mk</code>, which contains among others the
2320: <code class="literal">pre-build-checks-hook</code>. The word
2321: <code class="literal">checks</code> doesn't quite fit, but the
2322: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2323: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2324: <pre class="programlisting">
2325: # Just a few example options.
2326: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2327:
2328: .if ${BUILD_ONLY_CFLAGS:U:M*}
2329: pre-build-checks-hook: add-build-only-cflags
2330:
2331: add-build-only-cflags: .PHONY
2332: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2333: ${TEST} ! -f ${.TARGET} || exit 0; \
2334: for flag in ${BUILD_ONLY_CFLAGS}; do \
2335: ${ECHO} "append=$$flag" >> cc; \
2336: done; \
2337: > ${.TARGET}
2338: .endif
2339: </pre>
2340: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2341: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2342: not with spaces.)</p>
2343: <p>The condition in the <code class="literal">.if</code> statement contains the
2344: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2345: should be undefined, possibly because it is only defined for a subset of
2346: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2347: at least one compiler option, to prevent a syntax error in the shell
2348: parser.</p>
2349: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2350: that the additional compiler options are only appended once, even if
2351: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2352: creates a marker file.</p>
2353: <p>To verify that this setup works, run <span class="command"><strong>bmake
2354: configure</strong></span> in a package directory. Up to now, everything works
2355: as usual. Examine the directory
2356: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2357: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2358: the file <code class="filename">cc</code>. Examine the tail of the
2359: <code class="filename">work/.work.log</code> file to see that the normal compiler
2360: options are used.</p>
2361: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2362: options to the file <code class="filename">cc</code> and will create the marker
2363: file in the same directory. After that, the build starts as usual, but
2364: with the added compiler options. Examine the tail of the file
2365: <code class="filename">work/.work.log</code> to see that the lines starting with
2366: <code class="literal">[*]</code> don't contain the compiler options, but the
2367: corresponding lines starting with <code class="literal"><.></code> do end
2368: with these options.</p>
2369: <p>Building packages using this setup variant and fixing the resulting
2370: 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>
2371: </div>
2372: <div class="sect2">
2373: <div class="titlepage"><div><div><h3 class="title">
2374: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.178 rillig 2375: <p>Some directories like <code class="varname">PREFIX</code>,
2376: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2377: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2378: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2379: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2380: <pre class="programlisting">
2381: PREFIX= /a-random-uuid
2382: PKG_SYSCONFDIR= /a-random-uuid
2383: VARBASE= /a-random-uuid
2384: PKGMANDIR= a-random-uuid
2385: PKG_INFODIR= a-random-uuid
2386: </pre>
2387: </div>
2388: <div class="sect2">
2389: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2390: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.178 rillig 2391: <p>When building a package, warnings are typically ignored since they
2392: just flow by and do not cause the build to fail immediately. To find
2393: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2394: <pre class="programlisting">
2395: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2396: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2397: </pre>
2398: <p>(There are many more classes of warnings in pkgsrc, and most of
2399: them can be redefined with a simple definition like above.</p>
1.179 rillig 2400: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.178 rillig 2401: the package Makefile, research whether the package actually needs Perl.
2402: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2403: Makefile, and if it doesn't, add
2404: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2405: </div>
2406: <div class="sect2">
2407: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2408: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.178 rillig 2409: <p>Using pkglint as part of the regular build process is mostly a
2410: waste of time. If you want to fix some of the warnings, just run pkglint
2411: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2412: 10), which is much faster than a complete bulk build.</p>
2413: </div>
2414: <div class="sect2">
2415: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2416: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.178 rillig 2417: <p>To ensure that the binary packages don't contain references to the
2418: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2419: that variable includes the item <code class="literal">extra</code>, it is
2420: possible to define additional patterns that must not appear in any
2421: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2422: <pre class="programlisting">
2423: CHECK_WRKREF= extra
2424: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2425: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2426: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2427: </pre>
2428: <p>The above patterns will probably generate many false positives,
2429: therefore the results need to be taken with a grain of salt.</p>
2430: </div>
2431: <div class="sect2">
2432: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2433: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.178 rillig 2434: <p>To run the test suites that come with each package, add this line
2435: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2436: <pre class="programlisting">
2437: PKGSRC_RUN_TEST= yes
2438: </pre>
2439: <p>Be prepared that even the most basic packages fail this test. When
2440: doing a bulk build with this, it will often abort in the early phase
2441: where the packages are scanned for their dependencies since there are
2442: cyclic dependencies. There is still a lot to do in this area.</p>
2443: </div>
2444: <div class="sect2">
2445: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2446: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.178 rillig 2447: <p>To catch typos in the shell snippets from the Makefile fragments,
2448: add the <code class="literal">-u</code> flag to most of the commands by adding this
2449: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2450: <pre class="programlisting">
2451: RUN= @set -eu;
2452: </pre>
1.181 rillig 2453: <p>After that, ensure that none of the bulk build log files (even
2454: those for successfully built packages) contains the string
2455: <code class="literal">parameter not set</code> or whatever error message the
2456: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.178 rillig 2457: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2458: definition.</p>
2459: </div>
2460: <div class="sect2">
2461: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2462: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.178 rillig 2463: <p>The build logs of a package are often quite long. This allows error
2464: messages or other interesting details to hide between the noise. To make
2465: the actual error message stand out more, add these lines to
2466: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2467: <pre class="programlisting">
2468: GNU_CONFIGURE_QUIET= yes
2469: MAKE_FLAGS+= -s
2470: </pre>
2471: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2472: Make. On exotic platforms with their own make, it may be a little
2473: different.</p>
2474: </div>
2475: </div>
2476: <div class="sect1">
2477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2478: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2479: <p>After your pkgsrc bulk-build has completed, you may wish to
2480: create a CD-ROM set of the resulting binary packages to assist
2481: in installing packages on other machines. The
1.137 leot 2482: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.1 dsieger 2483: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2484: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2485: way that keeps all the dependencies for a given package on the same
2486: CD as that package.</p>
1.41 asau 2487: <div class="sect2">
1.1 dsieger 2488: <div class="titlepage"><div><div><h3 class="title">
1.178 rillig 2489: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2490: <p>Complete documentation for cdpack is found in the cdpack(1)
2491: man page. The following short example assumes that the binary
2492: packages are left in
2493: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2494: sufficient disk space exists in <code class="filename">/u2</code> to
2495: hold the ISO 9660 images.</p>
2496: <pre class="screen">
2497: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2498: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2499: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2500: </pre>
2501: <p>If you wish to include a common set of files
2502: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2503: etc.) on each CD in the collection, then you need to create a
1.175 gutterid 2504: directory which contains these files, e.g.:</p>
1.1 dsieger 2505: <pre class="screen">
2506: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2507: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2508: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2509: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2510: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2511: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2512: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2513: </pre>
2514: <p>Now create the images:</p>
2515: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2516: <p>Each image will contain <code class="filename">README</code>,
2517: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2518: in their root directories.</p>
2519: </div>
2520: </div>
2521: </div>
1.41 asau 2522: <div class="chapter">
1.1 dsieger 2523: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2524: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2525: <div class="toc">
2526: <p><b>Table of Contents</b></p>
1.100 leot 2527: <dl class="toc">
1.154 rillig 2528: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2529: <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 2530: </dl>
2531: </div>
2532: <p>The files that are installed by pkgsrc are organized in a way that
2533: is similar to what you find in the <code class="filename">/usr</code> directory
2534: of the base system. But some details are different. This is because
2535: pkgsrc initially came from FreeBSD and had adopted its file system
2536: hierarchy. Later it was largely influenced by NetBSD. But no matter
2537: which operating system you are using pkgsrc with, you can expect the
2538: same layout for pkgsrc.</p>
2539: <p>There are mainly four root directories for pkgsrc, which are all
2540: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2541: When pkgsrc has been installed as root, the default locations
2542: are:</p>
2543: <pre class="programlisting">
2544: LOCALBASE= /usr/pkg
2545: PKG_SYSCONFBASE= /usr/pkg/etc
2546: VARBASE= /var
1.119 sevan 2547: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2548: </pre>
2549: <p>In unprivileged mode (when pkgsrc has been installed as any other
2550: user), the default locations are:</p>
2551: <pre class="programlisting">
2552: LOCALBASE= ${HOME}/pkg
2553: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2554: VARBASE= ${HOME}/pkg/var
1.119 sevan 2555: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2556: </pre>
2557: <p>What these four directories are for, and what they look like is
2558: explained below.</p>
1.41 asau 2559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2560: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2561: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2562: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2563: the well-known subdirectories like <code class="filename">bin</code>,
2564: <code class="filename">include</code>, <code class="filename">lib</code>,
2565: <code class="filename">share</code> and
2566: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2567: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2568: <code class="filename">/var</code> in the base system. Some programs (especially
2569: games, network daemons) need write access to it during normal
2570: operation.</p></li>
1.23 wiz 2571: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2572: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2573: 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 2574: itself.</p></li>
2575: </ul></div>
1.41 asau 2576: <div class="sect1">
1.1 dsieger 2577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2578: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2579: </h2></div></div></div>
2580: <p>The following directories exist in a typical pkgsrc installation
2581: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2582: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2583: <dt><span class="term"><code class="filename">bin</code></span></dt>
2584: <dd><p>Contains executable programs that are intended to be
2585: directly used by the end user.</p></dd>
2586: <dt><span class="term"><code class="filename">emul</code></span></dt>
2587: <dd><p>Contains files for the emulation layers of various other
2588: operating systems, especially for
2589: NetBSD.</p></dd>
2590: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2591: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2592: <dd><p>Contains
2593: the configuration files.</p></dd>
2594: <dt><span class="term"><code class="filename">include</code></span></dt>
2595: <dd><p>Contains headers for the C and C++ programming
2596: languages.</p></dd>
2597: <dt><span class="term"><code class="filename">info</code></span></dt>
2598: <dd><p>Contains GNU info files of various
2599: packages.</p></dd>
2600: <dt><span class="term"><code class="filename">lib</code></span></dt>
2601: <dd><p>Contains shared and static
2602: libraries.</p></dd>
2603: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2604: <dd><p>Contains data files that don't change after
2605: installation. Other data files belong into
2606: <code class="filename">${VARBASE}</code>.</p></dd>
2607: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2608: <dd><p>Contains programs that are not intended to be used by
2609: end users, such as helper programs or network
2610: daemons.</p></dd>
2611: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2612: <dd><p>Contains programs that are intended to be executed as
2613: CGI scripts by a web server.</p></dd>
2614: <dt><span class="term"><code class="filename">man</code> (the usual value of
2615: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2616: <dd><p>Contains brief
2617: documentation in form of manual pages.</p></dd>
2618: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2619: <dd><p>Contains programs that are intended to be used only by
2620: the super-user.</p></dd>
2621: <dt><span class="term"><code class="filename">share</code></span></dt>
2622: <dd><p>Contains platform-independent data files that don't
2623: change after installation.</p></dd>
2624: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2625: <dd><p>Contains documentation files provided by the
2626: packages.</p></dd>
2627: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2628: <dd><p>Contains example files provided by the packages. Among
2629: others, the original configuration files are saved here and copied to
2630: <code class="filename">${PKG_SYSCONFDIR}</code> during
2631: installation.</p></dd>
2632: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2633: <dd><p>Contains the original files for rc.d
2634: scripts.</p></dd>
2635: <dt><span class="term"><code class="filename">var</code> (the usual location of
2636: <code class="filename">${VARBASE}</code>)</span></dt>
2637: <dd><p>Contains files
2638: that may be modified after
2639: installation.</p></dd>
2640: </dl></div>
2641: </div>
1.41 asau 2642: <div class="sect1">
1.1 dsieger 2643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2644: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2645: </h2></div></div></div>
1.41 asau 2646: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2647: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2648: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2649: <dd><p>Contains
2650: information about the currently installed
2651: packages.</p></dd>
2652: <dt><span class="term"><code class="filename">games</code></span></dt>
2653: <dd><p>Contains highscore
2654: files.</p></dd>
2655: <dt><span class="term"><code class="filename">log</code></span></dt>
2656: <dd><p>Contains log files.</p></dd>
2657: <dt><span class="term"><code class="filename">run</code></span></dt>
2658: <dd><p>Contains informational files about daemons that are
2659: currently running.</p></dd>
2660: </dl></div>
2661: </div>
2662: </div>
1.41 asau 2663: <div class="chapter">
1.1 dsieger 2664: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2665: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2666: <div class="toc">
2667: <p><b>Table of Contents</b></p>
1.100 leot 2668: <dl class="toc">
1.154 rillig 2669: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2670: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2671: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2672: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2673: <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>
2674: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2675: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2676: <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>
2677: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2678: <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 2679: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 2680: <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>
2681: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
2682: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2683: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2684: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2685: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2686: <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 2687: </dl>
2688: </div>
2689: <p>This section contains hints, tips & tricks on special things in
2690: pkgsrc that we didn't find a better place for in the previous chapters, and
2691: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2692: <div class="sect1">
1.1 dsieger 2693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2694: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2695: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2696: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2697: <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 2698: This is a general purpose list for most issues regarding
2699: pkgsrc, regardless of platform, e.g. soliciting user help
2700: for pkgsrc configuration, unexpected build failures, using
2701: particular packages, upgrading pkgsrc installations,
2702: questions regarding the pkgsrc release branches, etc. General announcements or
2703: proposals for changes that impact the pkgsrc user community,
2704: e.g. major infrastructure changes, new features, package
2705: removals, etc., may also be posted.</p></li>
1.174 leot 2706: <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 2707: A list where the results of pkgsrc bulk builds are sent and
2708: discussed.</p></li>
1.174 leot 2709: <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 2710: This list is for those who are interested in getting a
2711: commit message for every change committed to pkgsrc. It is
2712: also available in digest form, meaning one daily message
2713: containing all commit messages for changes to the package
2714: source tree in that 24 hour period.</p></li>
2715: </ul></div>
2716: <p>To subscribe, do:</p>
2717: <pre class="programlisting">
2718: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2719: </pre>
2720: <p>Archives for all these mailing lists are available from
1.174 leot 2721: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2722: </div>
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="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2726: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2727: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2728: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2729: they might be useful, and not to duplicate the documentation that comes
2730: with each package.</p>
2731: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.137 leot 2732: <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/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1 dsieger 2733: Symlinks for use by buildlink.</p></li></ul></div>
2734: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2735: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2736: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.121 sevan 2737: Calculates various kinds of checksums (including SHA3).</p></li>
1.137 leot 2738: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.1 dsieger 2739: Compatibility library for pkgsrc tools.</p></li>
1.137 leot 2740: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.1 dsieger 2741: non-BSD systems due to lack of native mtree.</p></li>
1.137 leot 2742: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.1 dsieger 2743: Up-to-date replacement for
2744: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2745: systems where pkg_install is not present.</p></li>
2746: </ul></div>
2747: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2748: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2749: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1 dsieger 2750: Create a binary package from an
1.10 hubertf 2751: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2752: save the old package.</p></li>
1.137 leot 2753: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.1 dsieger 2754: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2755: from multiple locations. It currently supports the following
2756: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.137 leot 2757: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.16 jnemeth 2758: the best compiler flags to optimise code for your current
1.23 wiz 2759: CPU and compiler. </p></li>
1.1 dsieger 2760: </ul></div>
2761: <p>Utilities for keeping track of installed packages, being up to date,
2762: etc:</p>
1.41 asau 2763: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2764: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.65 wiz 2765: update tool similar to apt(1). Download, install, and upgrade
2766: binary packages easily.</p></li>
1.137 leot 2767: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.1 dsieger 2768: packages whose installed versions do not match the latest pkgsrc
2769: entries.</p></li>
1.137 leot 2770: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.1 dsieger 2771: dependency graphs of packages, to aid in choosing a strategy for
2772: updating.</p></li>
1.137 leot 2773: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
2774: graphs from the output of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
2775: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12 weinem 2776: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.137 leot 2777: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1 dsieger 2778: does various checks on the complete pkgsrc system.</p></li>
1.137 leot 2779: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.1 dsieger 2780: packages you have installed.</p></li>
2781: </ul></div>
2782: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2783: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2784: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.1 dsieger 2785: making and maintaining patches for a package (includes pkgdiff,
2786: pkgvi, mkpatches, etc.).</p></li>
1.137 leot 2787: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.1 dsieger 2788: converting to pkgsrc.</p></li>
2789: </ul></div>
2790: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2791: utilities)</p>
1.41 asau 2792: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2793: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.1 dsieger 2794: packages in a chrooted area.</p></li>
1.137 leot 2795: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.1 dsieger 2796: kernel version for chrooted cross builds.</p></li>
2797: </ul></div>
2798: </div>
1.41 asau 2799: <div class="sect1">
1.1 dsieger 2800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2801: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2802: <p>To install packages from source as a non-root user, download
1.154 rillig 2803: 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 2804: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2805: --unprivileged</strong></span>.</p>
2806: <p>This will install the binary part of pkgsrc to
2807: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2808: into <code class="filename">~/pkg/etc</code>.</p>
2809: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2810: </div>
1.41 asau 2811: <div class="sect1">
1.1 dsieger 2812: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2813: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2814: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2815: enable this feature by adding the option
2816: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2817: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2818: distfile is found, pkgsrc will try to resume it.</p>
2819: <p>You can also
1.61 wiz 2820: use a different program than the platform default program by changing the
1.16 jnemeth 2821: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2822: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2823: by using the value manual. A value of custom disables the system defaults
2824: and dependency tracking for the fetch program. In that case you have to
2825: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2826: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2827: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2828: <p>For example, if you want to use
1.16 jnemeth 2829: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2830: like:</p>
2831: <pre class="programlisting">
1.112 rillig 2832: FETCH_USING= wget
1.1 dsieger 2833: </pre>
2834: </div>
1.41 asau 2835: <div class="sect1">
1.1 dsieger 2836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2837: <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 2838: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2839: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2840: you will have to add the following line into
1.10 hubertf 2841: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2842: <pre class="programlisting">
1.4 rillig 2843: X11_TYPE=modular
1.1 dsieger 2844: </pre>
2845: </div>
1.41 asau 2846: <div class="sect1">
1.1 dsieger 2847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2848: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2849: <p>If you are sitting behind a firewall which does not allow direct
2850: connections to Internet hosts (i.e. non-NAT), you may specify the
2851: relevant proxy hosts. This is done using an environment variable in the
2852: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2853: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2854: port 80 as the proxy port number. So the proxy environment variables
2855: are:</p>
2856: <pre class="programlisting">
2857: ftp_proxy=ftp://orpheus.amdahl.com:80/
2858: http_proxy=http://orpheus.amdahl.com:80/
2859: </pre>
2860: </div>
1.41 asau 2861: <div class="sect1">
1.1 dsieger 2862: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2863: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2864: <p>Some fetch tools are not prepared to support HTTPS by default
2865: (for example, the one in NetBSD 6.0), or the one installed by the
2866: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2867: dependency graph).</p>
2868: <p>Usually you won't notice, because distribution files are
2869: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2870: be often enough if you are following pkgsrc-current. In that case, set
2871: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2872: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2873: with HTTPS support by default. Of course, these tools need to be
2874: installed before you can use them this way.</p>
2875: </div>
2876: <div class="sect1">
2877: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2878: <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 2879: <p>This depends on which utility is used to retrieve distfiles. From
2880: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2881: the first available command from the following list:</p>
1.41 asau 2882: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2883: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2884: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2885: </ul></div>
2886: <p>On a default NetBSD installation, this will be
2887: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2888: connections first, and falls back to active connections if the server
2889: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2890: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2891: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2892: <p>Having that option present will prevent
2893: <code class="filename">/usr/bin/ftp</code> from falling back to active
2894: transfers.</p>
2895: </div>
1.41 asau 2896: <div class="sect1">
1.1 dsieger 2897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2898: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2899: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2900: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2901: 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 2902: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2903: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2904: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2905: resulting list to your machine at work/school and use it there. If you
1.197 leot 2906: don't have a NetBSD-compatible <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1 dsieger 2907: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2908: URL:</p>
2909: <p>At home:</p>
2910: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2911: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2912: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2913: <p>At work:</p>
2914: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2915: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2916: home.</p>
2917: <p>If you have a machine running NetBSD, and you want to get
2918: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2919: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2920: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2921: directly by running:</p>
2922: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2923: <p>If you even decide to ignore
2924: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2925: by running:</p>
2926: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2927: </div>
1.41 asau 2928: <div class="sect1">
1.1 dsieger 2929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2930: <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 2931: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.137 leot 2932: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.1 dsieger 2933: package, you get the error from make that it doesn't know how to make
2934: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2935: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2936: the NetBSD base distribution on your machine. It is recommended to do
2937: that to format man pages.</p>
1.137 leot 2938: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.1 dsieger 2939: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2940: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2941: </div>
1.41 asau 2942: <div class="sect1">
1.1 dsieger 2943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2944: <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 2945: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2946: when you installed your NetBSD machine. Please get and install it, by
2947: extracting it in <code class="filename">/</code>:</p>
2948: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2949: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2950: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2951: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2952: -r</strong></span>).</p>
2953: </div>
1.41 asau 2954: <div class="sect1">
1.1 dsieger 2955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2956: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 2957: <p>When installing packages as non-root user and using the just-in-time
1.197 leot 2958: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 2959: password for each required package installed. To avoid this, the sudo
2960: package can be used, which does password caching over a limited time. To
2961: use it, install sudo (either as binary package or from
1.137 leot 2962: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.10 hubertf 2963: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2964: <span class="emphasis"><em>after</em></span> the definition of the
2965: <code class="varname">LOCALBASE</code> variable:</p>
2966: <pre class="programlisting">
2967: .if exists(${LOCALBASE}/bin/sudo)
2968: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2969: .endif
2970: </pre>
2971: </div>
1.41 asau 2972: <div class="sect1">
1.1 dsieger 2973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2974: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 2975: <p>As the system administrator, you can choose where configuration files
2976: are installed. The default settings make all these files go into
2977: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
2978: be suboptimal depending on your expectations (e.g., a read-only,
2979: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2980: configuration of the provided packages).</p>
2981: <p>In order to change the defaults, you can modify the
2982: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 2983: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 2984: directory; some common examples include <code class="filename">/etc</code> or
2985: <code class="filename">/etc/pkg</code>.</p>
2986: <p>Furthermore, you can change this value on a per-package basis by
2987: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2988: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2989: package you would like to modify, that is, the contents of
2990: <code class="varname">PKGBASE</code>.</p>
2991: <p>Note that after changing these settings, you must rebuild and
2992: reinstall any affected packages.</p>
2993: </div>
1.41 asau 2994: <div class="sect1">
1.1 dsieger 2995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2996: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1 dsieger 2997: <p>Please be aware that there can often be bugs in third-party software,
2998: and some of these bugs can leave a machine vulnerable to exploitation by
2999: attackers. In an effort to lessen the exposure, the NetBSD packages team
3000: maintains a database of known-exploits to packages which have at one time
3001: been included in pkgsrc. The database can be downloaded automatically, and
3002: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3003: do this, refer to the following two tools (installed as part of the
1.137 leot 3004: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.23 wiz 3005: <div class="orderedlist"><ol class="orderedlist" type="1">
3006: <li class="listitem">
1.20 snj 3007: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3008: download a list of the security vulnerabilities information. This list
1.25 spz 3009: is kept up to date by the pkgsrc security team, and is distributed
3010: from the NetBSD ftp server:</p>
1.177 leot 3011: <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 3012: </li>
1.23 wiz 3013: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3014: current machine, checking each known vulnerability. If a
1.1 dsieger 3015: vulnerable package is installed, it will be shown by output to stdout,
3016: including a description of the type of vulnerability, and a URL
3017: containing more information.</p></li>
3018: </ol></div>
1.121 sevan 3019: <p>Use of these tools is strongly recommended!
1.202 nia 3020: 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 3021: reporting.</p>
3022: <p>If this database is installed, pkgsrc builds will use it to
3023: perform a security check before building any package.</p>
1.1 dsieger 3024: </div>
1.41 asau 3025: <div class="sect1">
1.1 dsieger 3026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3027: <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 3028: <p>When you add your own preferences to the
3029: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3030: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3031: environment variables to the <code class="filename">./configure</code>
1.197 leot 3032: scripts and to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1 dsieger 3033: <code class="varname">CFLAGS</code> from the environment variable by
3034: overriding them in the <code class="filename">Makefile</code>s of their
3035: package.</p>
3036: <p>Currently there is no solution to this problem. If you
3037: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3038: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3039: directory and then inspect any <code class="filename">Makefile</code> and
3040: <code class="filename">Makefile.in</code> for whether they define
3041: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3042: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3043: programmers write so bad code that it only works for the
3044: specific combination of <code class="varname">CFLAGS</code> they have
3045: chosen.</p>
1.172 rillig 3046: <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>
3047: <pre class="programlisting">
3048: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3049: CFLAGS+= -Dpkgsrc___CFLAGS
3050: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3051: </pre>
3052: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3053: to see whether the above flags are passed to the actual build
3054: commands in general.</p>
3055: <p>To find out whether the flags are passed to individual compiler
3056: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3057: most cases, the flags from the original command lines (the lines starting
3058: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3059: (the lines starting with <code class="literal"><.></code>). If the flag is
3060: missing from the actual compiler command, it must have been removed by
1.184 rillig 3061: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.1 dsieger 3062: </div>
1.41 asau 3063: <div class="sect1">
1.1 dsieger 3064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3065: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3066: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3067: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3068: case that occurs often is that people only update pkgsrc in
3069: parts, because of performance reasons. Since pkgsrc is one large
3070: system, not a collection of many small systems, there are
3071: sometimes changes that only work when the whole pkgsrc tree is
3072: updated.</p></li>
1.41 asau 3073: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3074: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3075: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3076: files.</p></li>
1.41 asau 3077: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3078: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3079: verify this.</p></li>
1.108 rillig 3080: <li class="step"><p>If you are a package developer who wants to invest
1.154 rillig 3081: 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 3082: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3083: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3084: </ol></div>
3085: </div>
1.41 asau 3086: <div class="sect1">
1.1 dsieger 3087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3088: <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 3089: <p>You have modified a file from pkgsrc, and someone else has
3090: modified that same file afterwards in the CVS repository. Both changes
3091: are in the same region of the file, so when you updated pkgsrc, the
3092: <code class="literal">cvs</code> command marked the conflicting changes in the
3093: file. Because of these markers, the file is no longer a valid
3094: <code class="filename">Makefile</code>.</p>
3095: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3096: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3097: -dP</strong></span> in that directory to download the current version.</p>
3098: </div>
3099: </div>
3100: </div>
1.41 asau 3101: <div class="part">
1.1 dsieger 3102: <div class="titlepage"><div><div><h1 class="title">
3103: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3104: <div class="partintro">
1.1 dsieger 3105: <div></div>
3106: <p>This part of the book deals with creating and
1.23 wiz 3107: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3108: guide on creating a new package. The remaining chapters are more
3109: like a reference manual for pkgsrc.</p>
3110: <div class="toc">
3111: <p><b>Table of Contents</b></p>
1.100 leot 3112: <dl class="toc">
1.154 rillig 3113: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 3114: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 3115: <dd><dl>
1.184 rillig 3116: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3117: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3118: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 3119: <dd><dl>
1.184 rillig 3120: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3121: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3122: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3123: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3124: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 3125: </dl></dd>
1.184 rillig 3126: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3127: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3128: <dd><dl>
3129: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3130: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3131: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3132: </dl></dd>
3133: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3134: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3135: </dl></dd>
1.184 rillig 3136: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 3137: <dd><dl>
1.184 rillig 3138: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3139: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3140: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3141: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3142: <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 3143: <dd><dl>
1.184 rillig 3144: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3145: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 3146: </dl></dd>
1.184 rillig 3147: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3148: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3149: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3150: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3151: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3152: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3153: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3154: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3155: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3156: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3157: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3158: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3159: </dl></dd>
3160: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3161: <dd><dl>
3162: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 3163: <dd><dl>
1.184 rillig 3164: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
3165: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
3166: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
3167: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
1.6 rillig 3168: </dl></dd>
1.184 rillig 3169: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3170: <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 3171: </dl></dd>
1.184 rillig 3172: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3173: <dd><dl>
1.184 rillig 3174: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3175: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3176: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3177: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 3178: <dd><dl>
1.184 rillig 3179: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3180: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3181: <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>
3182: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 3183: </dl></dd>
3184: </dl></dd>
1.184 rillig 3185: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 3186: <dd><dl>
1.184 rillig 3187: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3188: <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>
3189: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3190: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3191: </dl></dd>
1.184 rillig 3192: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 3193: <dd><dl>
1.184 rillig 3194: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3195: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3196: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3197: </dl></dd>
3198: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3199: <dd><dl>
3200: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3201: <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 3202: <dd><dl>
1.184 rillig 3203: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3204: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 3205: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3206: and
3207: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3208: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3209: </dl></dd>
1.184 rillig 3210: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3211: <dd><dl>
3212: <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>
3213: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3214: </dl></dd>
3215: </dl></dd>
3216: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 3217: <dd><dl>
1.184 rillig 3218: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3219: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3220: <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>
3221: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3222: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3223: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3224: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3225: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3226: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 3227: </dl></dd>
1.184 rillig 3228: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3229: <dd><dl>
3230: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3231: <dd><dl>
3232: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3233: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 3234: </dl></dd>
1.184 rillig 3235: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 3236: <dd><dl>
1.184 rillig 3237: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3238: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
3239: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
3240: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
3241: </dl></dd>
3242: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3243: <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>
3244: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3245: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3246: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3247: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3248: <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 3249: </dl></dd>
3250: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3251: <dd><dl>
3252: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3253: <dd><dl>
3254: <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>
3255: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3256: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3257: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3258: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3259: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3260: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3261: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3262: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3263: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3264: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3265: </dl></dd>
3266: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3267: <dd><dl>
3268: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3269: <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>
3270: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3271: </dl></dd>
3272: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3273: <dd><dl>
3274: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3275: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3276: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
3277: </dl></dd>
3278: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3279: <dd><dl>
3280: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3281: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.203 nia 3282: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing Perl scripts</a></span></dt>
1.154 rillig 3283: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
3284: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
3285: </dl></dd>
3286: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3287: <dd><dl>
3288: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3289: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 3290: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3291: <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>
3292: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 3293: </dl></dd>
3294: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3295: <dd><dl>
3296: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3297: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3298: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3299: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3300: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 3301: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154 rillig 3302: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
3303: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203 nia 3304: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
3305: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
3306: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
3307: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
3308: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
3309: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
3310: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1 dsieger 3311: emulation</a></span></dt>
1.203 nia 3312: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
3313: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1 dsieger 3314: </dl></dd>
1.154 rillig 3315: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3316: </dl></dd>
1.184 rillig 3317: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3318: <dd><dl>
3319: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3320: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3321: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3322: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3323: </dl></dd>
1.154 rillig 3324: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3325: <dd><dl>
1.154 rillig 3326: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3327: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3328: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3329: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3330: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3331: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3332: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3333: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3334: </dl></dd>
3335: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 3336: </dl>
3337: </div>
3338: </div>
1.41 asau 3339: <div class="chapter">
1.1 dsieger 3340: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3341: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3342: <p>
3343: To get help when developing pkgsrc, the definitive source is this
3344: document, the pkgsrc guide. If you don't find anything here,
3345: there are alternatives:
3346: </p>
3347: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3348: <li class="listitem">
3349: <p>
3350: The built-in pkgsrc help, which is available after bootstrapping
3351: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3352: help for any topic, such as a variable name like
3353: <code class="varname">BUILD_DEFS</code>, a make target like
3354: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3355: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
3356: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix D. Help topics">Appendix D, <i>Help topics</i></a>.</p>
3357: </li>
3358: <li class="listitem"><p>
1.163 rillig 3359: To see the value of a single variable, run <span class="command"><strong>bmake
3360: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3361: </p></li>
3362: <li class="listitem"><p>
3363: To see the values of the most common variables, run
3364: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3365: topic. To see the variables for a single topic, run
3366: <span class="command"><strong>bmake
3367: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3368: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3369: </p></li>
3370: <li class="listitem"><p>
1.154 rillig 3371: The tech-pkg mailing list, to which
3372: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3373: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3374: questions</a>.</p></li>
3375: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3376: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3377: or by using a specialized chat program such as
3378: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3379: Pick any user name and join the channel #pkgsrc.</p></li>
3380: </ul></div>
3381: </div>
3382: <div class="chapter">
3383: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 3384: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3385: <div class="toc">
3386: <p><b>Table of Contents</b></p>
1.100 leot 3387: <dl class="toc">
1.184 rillig 3388: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3389: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3390: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3391: <dd><dl>
3392: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3393: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3394: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3395: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3396: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3397: </dl></dd>
3398: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3399: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3400: <dd><dl>
3401: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3402: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3403: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3404: </dl></dd>
1.184 rillig 3405: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3406: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3407: </dl>
3408: </div>
1.184 rillig 3409: <p>Whenever you're preparing a package, there are a number of
3410: files involved which are described in the following
3411: sections.</p>
3412: <div class="sect1">
3413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3414: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3415: </h2></div></div></div>
3416: <p>Building, installation and creation of a binary package are all
3417: controlled by the package's <code class="filename">Makefile</code>.
3418: The <code class="filename">Makefile</code> describes various things about
3419: a package, for example from where to get it, how to configure,
3420: build, and install it.</p>
3421: <p>A package <code class="filename">Makefile</code> contains several
3422: sections that describe the package.</p>
3423: <p>In the first section there are the following variables, which
3424: should appear exactly in the order given here. The order and
3425: grouping of the variables is mostly historical and has no further
3426: meaning.</p>
3427: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3428: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3429: distribution file to be downloaded from the package's
3430: website.</p></li>
3431: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3432: package, as used by pkgsrc. You need to provide it if
3433: <code class="varname">DISTNAME</code> (which is the default) is not a good
3434: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3435: provided (no distribution file is required). Usually it is the pkgsrc
3436: directory name together with the version number. It must match the
3437: regular expression
3438: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3439: starts with a letter or digit, and contains only letters, digits,
1.204 ! nia 3440: dashes, underscores, dots and plus signs.
! 3441: New packages should have entirely lower-case names, with the exception
! 3442: of some that must follow pre-existing conventions
! 3443: (e.g. R packages begin with <code class="varname">R-</code>).
! 3444: You can use the <code class="code">:tl</code> variable modifier to lower-case
! 3445: the package name.</p></li>
1.184 rillig 3446: <li class="listitem">
3447: <p><code class="varname">CATEGORIES</code> is a list of categories
3448: which the package fits in. You can choose any of the top-level
3449: directories of pkgsrc for it.</p>
3450: <p>Currently the following values are available for
3451: <code class="varname">CATEGORIES</code>. If more than
3452: one is used, they need to be separated by spaces:</p>
1.1 dsieger 3453: <pre class="programlisting">
1.184 rillig 3454: archivers cross geography meta-pkgs security
3455: audio databases graphics misc shells
3456: benchmarks devel ham multimedia sysutils
3457: biology editors inputmethod net textproc
3458: cad emulators lang news time
3459: chat finance mail parallel wm
3460: comms fonts math pkgtools www
3461: converters games mbone print x11
1.1 dsieger 3462: </pre>
3463: </li>
1.184 rillig 3464: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3465: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3466: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3467: and <code class="varname">DISTFILES</code> are discussed in detail in
3468: <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>
3469: </ul></div>
3470: <p>The second section contains information about separately
3471: downloaded patches, if any.
3472: </p>
3473: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3474: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3475: Name(s) of additional files that contain distribution patches.
3476: There is no default. pkgsrc will look for them at
3477: <code class="varname">PATCH_SITES</code>.
3478: They will automatically be uncompressed before patching if
3479: the names end with <code class="filename">.gz</code> or
3480: <code class="filename">.Z</code>.</p></li>
3481: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3482: Primary location(s) for distribution patch files (see
3483: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3484: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.197 leot 3485: an argument to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.184 rillig 3486: help find the correct files to patch. It defaults to
3487: <span class="command"><strong>-p0</strong></span>.</p></li>
3488: </ul></div>
3489: <p>The third section contains the following variables.
3490: </p>
3491: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3492: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
3493: address of the person who feels responsible for this package,
3494: and who is most likely to look at problems or questions regarding
1.197 leot 3495: this package which have been reported with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.184 rillig 3496: Other developers may contact the <code class="varname">MAINTAINER</code>
3497: before making changes to the package, but are not required to
3498: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3499: to yourself. If you really can't maintain the package for future
3500: updates, set it to
3501: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
3502: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
3503: of <code class="varname">MAINTAINER</code> when you do not want other
3504: developers to update or change the package without contacting
3505: you first. A package Makefile should contain one of
3506: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3507: not both. </p></li>
3508: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3509: find more information about the package.</p></li>
3510: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3511: description of the package (should not include the package
3512: name).</p></li>
3513: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3514: 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>
3515: </ul></div>
3516: <p>Other variables that affect the build:
3517: </p>
3518: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3519: <p><code class="varname">WRKSRC</code>: The directory where the
3520: interesting distribution files of the package are found. The
3521: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3522: works for most packages.</p>
3523: <p>If a package doesn't create a subdirectory for itself
3524: (most GNU software does, for instance), but extracts itself in
3525: the current directory, you should set
3526: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3527: <p>If a package doesn't create a subdirectory with the
3528: name of <code class="varname">DISTNAME</code> but some different name,
3529: set <code class="varname">WRKSRC</code> to point to the proper name in
3530: <code class="filename">${WRKDIR}</code>, for example
3531: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
3532: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
3533: <p>The name of the working directory created by pkgsrc is
3534: taken from the <code class="varname">WRKDIR_BASENAME</code>
3535: variable. By default, its value is
3536: <code class="filename">work</code>. If you want to use the same
3537: pkgsrc tree for building different kinds of binary packages,
3538: you can change the variable according to your needs. Two
3539: other variables handle common cases of setting
3540: <code class="varname">WRKDIR_BASENAME</code> individually. If
3541: <code class="varname">OBJHOSTNAME</code> is defined in
3542: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3543: the host's name is attached to the directory name. If
3544: <code class="varname">OBJMACHINE</code> is defined, the platform name
3545: is attached, which might look like
3546: <code class="filename">work.i386</code> or
3547: <code class="filename">work.sparc</code>.</p>
3548: </li></ul></div>
3549: <p>Please pay attention to the following gotchas:</p>
3550: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3551: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3552: installed in compressed form by the package. For packages using
3553: BSD-style makefiles which honor MANZ, there is
3554: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3555: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3556: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3557: below).</p></li>
3558: <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>
3559: </ul></div>
3560: </div>
1.41 asau 3561: <div class="sect1">
1.1 dsieger 3562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 3563: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3564: </h2></div></div></div>
3565: <p>The <code class="filename">distinfo</code> file contains the message
3566: digest, or checksum, of each distfile needed for the package. This
3567: ensures that the distfiles retrieved from the Internet have not been
3568: corrupted during transfer or altered by a malign force to introduce
3569: a security hole. To provide maximum security, all distfiles are
3570: protected using three different message digest algorithms (SHA1,
3571: RMD160, SHA512), as well as the file size.</p>
3572: <p>The <code class="filename">distinfo</code> file also contains the
3573: checksums for all the patches found in the
3574: <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
3575: are only applied intentionally and that they don't accidentally change,
3576: e.g. when merging different changes together. They also make sure that
3577: new patches are actually added to CVS and old ones are removed.
3578: Too see whether the patches and the <code class="filename">distinfo</code> file
3579: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3580: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3581: <span class="command"><strong>make distinfo</strong></span> command.</p>
3582: <p>Some packages have different sets of distfiles depending on
3583: the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk8/README.html" target="_top"><code class="filename">lang/openjdk8</code></a>. These are kept in the same
3584: <code class="filename">distinfo</code> file and care should be taken when
3585: upgrading such a package to ensure distfile information is not
3586: lost.</p>
3587: </div>
3588: <div class="sect1">
3589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3590: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3591: </h2></div></div></div>
3592: <p>Some packages don't work out-of-the box on the various
3593: platforms that are supported by pkgsrc. These packages need
3594: to be patched to make them work. The patch files can be
3595: found in the <code class="filename">patches/</code> directory.</p>
3596: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3597: applied to the files in <code class="varname">WRKSRC</code> directory after
3598: extracting them, in alphabetic order.</p>
1.41 asau 3599: <div class="sect2">
1.1 dsieger 3600: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3601: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3602: <p>The <code class="filename">patch-*</code> files should be in
3603: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3604: problems. (To force patches to apply with fuzz you can set
3605: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3606: should contain only changes for a single file, and no file should be
3607: patched by more than one patch file. This helps to keep future
3608: modifications simple.</p>
3609: <p>Each patch file is structured as follows: In the first line,
3610: there is the RCS Id of the patch itself. The second line should be
3611: empty for aesthetic reasons. After that, there should be a comment for
3612: each change that the patch does. There are a number of standard
3613: cases:</p>
3614: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3615: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3616: mention the vulnerability ID (CAN, CVE).</p></li>
3617: <li class="listitem"><p>Patches that change source code should mention the
3618: platform and other environment (for example, the compiler) that the
3619: patch is needed for.</p></li>
3620: </ul></div>
3621: <p>The patch should be commented so that any
3622: developer who knows the code of the application can make some use of
3623: the patch. Special care should be taken for the upstream developers,
3624: since we generally want that they accept our patches, so we have less
3625: work in the future.</p>
1.1 dsieger 3626: </div>
1.41 asau 3627: <div class="sect2">
1.1 dsieger 3628: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3629: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3630: <p>One important thing to mention is to pay attention that no RCS
3631: IDs get stored in the patch files, as these will cause problems when
3632: later checked into the NetBSD CVS tree. Use the
3633: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
3634: problems.</p>
3635: <p>For even more automation, we recommend using
3636: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
3637: whole set of patches. You just have to backup files before you
3638: edit them to <code class="filename">filename.orig</code>, e.g. with
3639: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3640: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3641: you upgrade a package this way, you can easily compare the new
3642: set of patches with the previously existing one with
3643: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3644: are replaced by new files, so carefully check if you want to take all
3645: the changes.</p>
3646: <p>When you have finished a package, remember to generate
3647: the checksums for the patch files by using the <span class="command"><strong>make
3648: 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>
3649: <p>When adding a patch that corrects a problem in the
3650: distfile (rather than e.g. enforcing pkgsrc's view of where
3651: man pages should go), send the patch as a bug report to the
3652: maintainer. This benefits non-pkgsrc users of the package,
3653: and usually makes it possible to remove the patch in future
3654: version.</p>
3655: <p>The file names of the patch files are usually of the form
3656: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3657: Many packages still use the previous convention
3658: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3659: but new patches should be of the form containing the filename.
3660: <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
3661: automatically.</p>
1.17 imil 3662: </div>
1.160 brook 3663: <div class="sect2">
3664: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3665: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3666: <p>If you want to share patches between multiple packages
3667: in pkgsrc, e.g. because they use the same distfiles, set
3668: <code class="varname">PATCHDIR</code> to the path where the patch files
3669: can be found, e.g.:</p>
3670: <pre class="programlisting">
3671: PATCHDIR= ../../editors/xemacs/patches
3672: </pre>
3673: <p>Patch files that are distributed by the author or other
3674: maintainers can be listed in
3675: <code class="varname">PATCHFILES</code>.</p>
3676: <p>If it is desired to store any patches that should not be
3677: committed into pkgsrc, they can be kept outside the pkgsrc
3678: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3679: directory tree there is expected to have the same
3680: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3681: patches are expected to be stored inside these dirs (also
3682: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3683: example, if you want to keep a private patch for
3684: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3685: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3686: files in the named directory are expected to be patch files,
3687: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3688: applied</em></span>.</p>
1.160 brook 3689: </div>
3690: <div class="sect2">
3691: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3692: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3693: <p>When fixing a portability issue in the code do not use
3694: preprocessor magic to check for the current operating system nor
3695: platform. Doing so hurts portability to other platforms because
3696: the OS-specific details are not abstracted appropriately.</p>
3697: <p>The general rule to follow is: instead of checking for the
3698: operating system the application is being built on, check for the
3699: specific <span class="emphasis"><em>features</em></span> you need. For example,
3700: instead of assuming that kqueue is available under NetBSD and
3701: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3702: kqueue support, add a check that detects kqueue itself —
3703: yes, this generally involves patching the
3704: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3705: that prevents some OSes from adopting interfaces from other OSes
3706: (e.g. Linux implementing kqueue), something that the above checks
3707: cannot take into account.</p>
3708: <p>Of course, checking for features generally involves more
3709: work on the developer's side, but the resulting changes are
3710: cleaner and there are chances they will work on many other
3711: platforms. Not to mention that there are higher chances of being
3712: later integrated into the mainstream sources. Remember:
3713: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3714: <p>Some typical examples:</p>
3715: <div class="table">
3716: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3717: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3718: <colgroup>
3719: <col>
3720: <col>
3721: <col>
3722: </colgroup>
3723: <thead><tr>
3724: <th>Where</th>
3725: <th>Incorrect</th>
3726: <th>Correct</th>
3727: </tr></thead>
3728: <tbody>
3729: <tr>
3730: <td>configure script</td>
3731: <td>
1.160 brook 3732: <pre class="programlisting">
1.184 rillig 3733: case ${target_os} in
3734: netbsd*) have_kvm=yes ;;
3735: *) have_kvm=no ;;
3736: esac
1.160 brook 3737: </pre>
1.184 rillig 3738: </td>
3739: <td>
1.160 brook 3740: <pre class="programlisting">
1.184 rillig 3741: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.160 brook 3742: </pre>
1.184 rillig 3743: </td>
3744: </tr>
3745: <tr>
3746: <td>C source file</td>
3747: <td>
1.1 dsieger 3748: <pre class="programlisting">
1.184 rillig 3749: #if defined(__NetBSD__)
3750: # include <sys/event.h>
3751: #endif
1.1 dsieger 3752: </pre>
1.184 rillig 3753: </td>
3754: <td>
1.1 dsieger 3755: <pre class="programlisting">
1.184 rillig 3756: #if defined(HAVE_SYS_EVENT_H)
3757: # include <sys/event.h>
3758: #endif
1.1 dsieger 3759: </pre>
1.184 rillig 3760: </td>
3761: </tr>
3762: <tr>
3763: <td>C source file</td>
3764: <td>
1.1 dsieger 3765: <pre class="programlisting">
1.184 rillig 3766: int
3767: monitor_file(...)
3768: {
3769: #if defined(__NetBSD__)
3770: int fd = kqueue();
3771: ...
3772: #else
3773: ...
3774: #endif
3775: }
1.1 dsieger 3776: </pre>
1.184 rillig 3777: </td>
3778: <td>
1.1 dsieger 3779: <pre class="programlisting">
1.184 rillig 3780: int
3781: monitor_file(...)
3782: {
3783: #if defined(HAVE_KQUEUE)
3784: int fd = kqueue();
3785: ...
3786: #else
3787: ...
3788: #endif
3789: }
1.1 dsieger 3790: </pre>
1.184 rillig 3791: </td>
3792: </tr>
3793: </tbody>
3794: </table></div>
3795: </div>
3796: <br class="table-break">
3797: </div>
3798: <div class="sect2">
3799: <div class="titlepage"><div><div><h3 class="title">
3800: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3801: <p>Always, always, <span class="strong"><strong>always</strong></span>
3802: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3803: improvements you do to a package to the mainstream developers.
3804: This is the only way to get their attention on portability issues
3805: and to ensure that future versions can be built out-of-the box on
3806: NetBSD. Furthermore, any user that gets newer distfiles will get
3807: the fixes straight from the packaged code.</p>
3808: <p>This generally involves cleaning up the patches
3809: (because sometimes the patches that are
3810: added to pkgsrc are quick hacks), filing bug reports in the
3811: appropriate trackers for the projects and working with the
3812: mainstream authors to accept your changes. It is
3813: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3814: the packages in pkgsrc are kept simple and thus further changes
3815: can be done without much hassle.</p>
3816: <p>When you have done this, please add a URL to the upstream
3817: bug report to the patch comment.</p>
3818: <p>Support the idea of free software!</p>
3819: </div>
1.1 dsieger 3820: </div>
1.184 rillig 3821: <div class="sect1">
3822: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3823: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3824: <div class="variablelist"><dl class="variablelist">
3825: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3826: <dd><p>A multi-line description of the piece of software. This should include
3827: any credits where they are due. Please bear in mind that others do not
3828: share your sense of humour (or spelling idiosyncrasies), and that others
3829: will read everything that you write here.</p></dd>
3830: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3831: <dd><p>This file governs the files that are installed on your
3832: system: all the binaries, manual pages, etc. There are other
3833: directives which may be entered in this file, to control the
3834: creation and deletion of directories, and the location of
3835: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3836: information.</p></dd>
3837: </dl></div>
3838: </div>
3839: <div class="sect1">
3840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3841: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3842: <div class="sect2">
3843: <div class="titlepage"><div><div><h3 class="title">
3844: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3845: <div class="variablelist"><dl class="variablelist">
3846: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3847: <dd>
1.197 leot 3848: <p>This shell script is invoked twice by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.184 rillig 3849: First time after package extraction and before files are
3850: moved in place, the second time after the files to install
3851: are moved in place. This can be used to do any custom
3852: procedures not possible with @exec commands in
1.197 leot 3853: <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
3854: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 3855: Please note that you can modify variables in it easily by using
3856: <code class="varname">FILES_SUBST</code> in the package's
3857: <code class="filename">Makefile</code>:</p>
1.1 dsieger 3858: <pre class="programlisting">
1.184 rillig 3859: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3860: </pre>
1.184 rillig 3861: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3862: <code class="filename">INSTALL</code>. By default, substitution is
3863: performed for <code class="varname">PREFIX</code>,
3864: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3865: <code class="varname">VARBASE</code>, and a few others, type
3866: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3867: complete list.</p>
3868: </dd>
3869: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3870: <dd><p>This script is executed before and after any files are removed. It is
3871: this script's responsibility to clean up any additional messy details
3872: around the package's installation, since all pkg_delete knows is how to
3873: delete the files created in the original distribution.
1.197 leot 3874: See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
3875: and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.184 rillig 3876: The same methods to replace variables can be used as for
3877: the <code class="filename">INSTALL</code> file.</p></dd>
3878: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3879: <dd>
3880: <p>This file is displayed after installation of the package.
1.198 leot 3881: While this was used often in the past, it has two
3882: problems: the display will be missed if many packages are
3883: intalled at once, and the person installing the package
3884: and the one using or configuring it may be different. It
3885: should therefore be used only in exceptional circumstances
3886: where lasting negative consequences would result from
3887: someone not reading it.</p>
3888: <p>MESSAGE should not be used for:</p>
3889: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3890: <li class="listitem"><p>exhortations to read the documentation</p></li>
3891: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
3892: <li class="listitem"><p>anything that should be explained in the
3893: installation/configuration documentation that should
3894: come with the package</p></li>
3895: </ul></div>
3896: <p>If the documentation provided by upstream needs
3897: enhancing, create e.g. files/README.pkgsrc and install it
3898: in the package's documentation directory.
3899: </p>
3900: <p>Note that MESSAGE is shown for all operating
3901: systems and all init systems. If a MESSAGE is necessary,
3902: it should be narrowed to only those operating systems and
3903: init systems to which it applies.</p>
3904: <p>Note that you can modify variables in it easily by using
1.184 rillig 3905: <code class="varname">MESSAGE_SUBST</code> in the package's
3906: <code class="filename">Makefile</code>:</p>
1.1 dsieger 3907: <pre class="programlisting">
1.184 rillig 3908: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3909: </pre>
1.184 rillig 3910: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
3911: <code class="filename">MESSAGE</code>. By default, substitution is
3912: performed for <code class="varname">PKGNAME</code>,
3913: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
3914: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3915: <code class="varname">PKG_SYSCONFDIR</code>,
3916: <code class="varname">ROOT_GROUP</code>, and
3917: <code class="varname">ROOT_USER</code>.</p>
3918: <p>You can display a different or additional files by
3919: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3920: default is <code class="filename">MESSAGE</code>, if the file
3921: exists.</p>
3922: </dd>
3923: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
3924: <dd>
3925: <p>This file is used by the alternatives framework.
3926: It creates, configures, and destroys generic wrappers used to
3927: run programs with similar interfaces.
3928: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3929: for more information.</p>
3930: <p>Each line of the file contains two filenames, first
3931: the wrapper and then the alternative provided by the package.
3932: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3933: </dd>
3934: </dl></div>
3935: </div>
3936: <div class="sect2">
3937: <div class="titlepage"><div><div><h3 class="title">
3938: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
3939: <div class="variablelist"><dl class="variablelist">
3940: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3941: <dd><p>This file contains arbitrary things that could
3942: also go into a <code class="filename">Makefile</code>, but its purpose is
3943: to be used by more than one package. This file should only be
3944: used when the packages that will use the file are known in
3945: advance. For other purposes it is often better to write a
3946: <code class="filename">*.mk</code> file and give it a good name that
3947: describes what it does.</p></dd>
3948: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3949: <dd><p>This file contains the dependency information
3950: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
3951: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3952: <dd><p>This file contains workarounds for compiler bugs
3953: and similar things. It is included automatically by the pkgsrc
3954: infrastructure, so you don't need an extra
3955: <code class="literal">.include</code> line for
3956: it.</p></dd>
3957: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3958: <dd><p>This file contains the code for the
3959: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
3960: selected by the user. If a package has only one or two options,
3961: it is equally acceptable to put the code directly into the
3962: <code class="filename">Makefile</code>.</p></dd>
3963: </dl></div>
3964: </div>
3965: <div class="sect2">
3966: <div class="titlepage"><div><div><h3 class="title">
3967: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
3968: <div class="variablelist"><dl class="variablelist">
3969: <dt><span class="term"><code class="filename">README*</code></span></dt>
3970: <dd><p>These files do not take place in the creation of
3971: a package and thus are purely informative to the package
3972: developer.</p></dd>
3973: <dt><span class="term"><code class="filename">TODO</code></span></dt>
3974: <dd><p>This file contains things that need to be done
3975: to make the package even
3976: better.</p></dd>
3977: </dl></div>
3978: </div>
3979: </div>
3980: <div class="sect1">
3981: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3982: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
3983: </h2></div></div></div>
3984: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
3985: unpacked into the directory denoted by
3986: <code class="varname">WRKDIR</code>. It can be removed by running
3987: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
3988: directory is also used to keep various timestamp files.
3989: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
3990: The default is <code class="filename">${.CURDIR}/work</code>
3991: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
3992: if <code class="varname">OBJMACHINE</code> is set.</p>
1.1 dsieger 3993: </div>
1.184 rillig 3994: <div class="sect1">
3995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3996: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
3997: </h2></div></div></div>
3998: <p>If you have any files that you wish to be placed in the package
3999: prior to configuration or building, you can place these files here
4000: and use a <span class="command"><strong>${CP}</strong></span> command in the
4001: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4002: <p>If you want to share files in this way with other
4003: packages, set the <code class="varname">FILESDIR</code> variable to point
4004: to the other package's <code class="filename">files</code> directory,
4005: e.g.:</p>
1.1 dsieger 4006: <pre class="programlisting">
1.184 rillig 4007: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 4008: </pre>
4009: </div>
4010: </div>
1.41 asau 4011: <div class="chapter">
1.1 dsieger 4012: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 4013: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.1 dsieger 4014: <div class="toc">
4015: <p><b>Table of Contents</b></p>
1.100 leot 4016: <dl class="toc">
1.184 rillig 4017: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4018: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4019: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4020: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4021: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4022: <dd><dl>
4023: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4024: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4025: </dl></dd>
4026: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4027: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4028: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4029: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4030: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4031: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4032: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4033: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4034: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4035: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4036: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4037: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.1 dsieger 4038: </dl>
4039: </div>
1.41 asau 4040: <div class="sect1">
1.1 dsieger 4041: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4042: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4043: <p>This chapter gives a detailed description on how a package is
4044: built. Building a package is separated into different
4045: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4046: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4047: described in the following sections. Each phase is split into
4048: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4049: containing phase, prefixed by one of <code class="varname">pre-</code>,
4050: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4051: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4052: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4053: <p>Never override the regular targets (like
4054: <code class="varname">fetch</code>), if you have to, override the
4055: <code class="varname">do-*</code> ones instead.</p>
4056: <p>The basic steps for building a program are always the same. First
4057: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4058: the local system and then extracted. After any pkgsrc-specific patches
4059: to compile properly are applied, the software can be configured, then
4060: built (usually by compiling), and finally the generated binaries, etc.
4061: can be put into place on the system.</p>
4062: <p>To get more details about what is happening at each step,
4063: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4064: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4065: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4066: </div>
4067: <div class="sect1">
4068: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4069: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4070: <p>Before outlining the process performed by the NetBSD package system in
4071: the next section, here's a brief discussion on where programs are
4072: installed, and which variables influence this.</p>
4073: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4074: where all files of the final program shall be installed. It is
4075: usually set to <code class="varname">LOCALBASE</code>
4076: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4077: for pkgs in the <code class="filename">cross</code> category. The value of
4078: <code class="varname">PREFIX</code> needs to be put
4079: into the various places in the program's source where paths to
4080: 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>
4081: <p>When choosing which of these variables to use,
4082: follow the following rules:</p>
1.41 asau 4083: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 4084: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4085: where the current pkg will be installed. When referring to a
4086: pkg's own installation path, use
4087: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
4088: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
4089: are installed. If you need to construct a -I or -L argument
4090: to the compiler to find includes and libraries installed by
4091: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
4092: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4093: installed all packages in <code class="filename">/usr/local</code>. As
4094: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4095: administrator, this variable is a misnomer.</p></li>
4096: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4097: distribution (from xsrc, etc.) is installed. When looking for
4098: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4099: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4100: <li class="listitem"><p>X11-based packages using imake must set
4101: <code class="varname">USE_IMAKE</code> to be installed correctly under
4102: <code class="varname">LOCALBASE</code>.</p></li>
4103: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.197 leot 4104: install files according to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.184 rillig 4105: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4106: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4107: </ul></div>
4108: </div>
4109: <div class="sect1">
4110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4111: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4112: <p>When building a package, various directories are used to store
4113: source files, temporary files, pkgsrc-internal files, and so on. These
4114: directories are explained here.</p>
4115: <p>Some of the directory variables contain relative pathnames. There
4116: are two common base directories for these relative directories:
4117: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4118: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4119: inside the package itself.</p>
4120: <div class="variablelist"><dl class="variablelist">
4121: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4122: <dd><p>This is an absolute pathname that points to the pkgsrc
4123: root directory. Generally, you don't need
4124: it.</p></dd>
4125: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4126: <dd><p>This is an absolute pathname that points to the
4127: current package.</p></dd>
4128: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
4129: <dd><p>This is a pathname relative to
4130: <code class="varname">PKGSRCDIR</code> that points to the current
4131: package.</p></dd>
4132: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4133: <dd><p>This is an absolute pathname pointing to the directory
4134: where all work takes place. The distfiles are extracted to this
4135: directory. It also contains temporary directories and log files used by
4136: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4137: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4138: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4139: <dd><p>This is an absolute pathname pointing to the directory
4140: where the distfiles are extracted. It is usually a direct subdirectory
4141: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4142: that isn't hidden. This variable may be changed by a package
4143: <code class="filename">Makefile</code>.</p></dd>
4144: </dl></div>
4145: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4146: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4147: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4148: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4149: If users would like to have their pkgsrc trees behave in a
4150: read-only manner, then the value of
4151: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4152: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 4153: </div>
1.41 asau 4154: <div class="sect1">
1.1 dsieger 4155: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4156: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4157: <p>You can run a particular phase by typing <span class="command"><strong>make
4158: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
4159: phase. This will automatically run all phases that are required for this
4160: phase. The default phase is <code class="varname">build</code>, that is, when you
4161: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
4162: the package will be built, but not installed.</p>
1.1 dsieger 4163: </div>
1.41 asau 4164: <div class="sect1">
1.1 dsieger 4165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4166: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4167: <p>The first step in building a package is to fetch the
4168: distribution files (distfiles) from the sites that are providing
4169: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4170: phase.</p>
1.41 asau 4171: <div class="sect2">
1.1 dsieger 4172: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 4173: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4174: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4175: defines all URLs from where the distfile, whose name is
4176: derived from the <code class="varname">DISTNAME</code> variable, is
4177: fetched. The more complicated cases are described
4178: below.</p>
4179: <p>The variable <code class="varname">DISTFILES</code> specifies
4180: the list of distfiles that have to be fetched. Its value
4181: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4182: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4183: so that most packages don't need to define it at all.
4184: <code class="varname">EXTRACT_SUFX</code> is
4185: <code class="literal">.tar.gz</code> by default, but can be changed
4186: freely. Note that if your package requires additional
4187: distfiles to the default one, you cannot just append the
4188: additional filenames using the <code class="literal">+=</code>
4189: operator, but you have write for example:</p>
4190: <pre class="programlisting">
4191: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4192: </pre>
4193: <p>Each distfile is fetched from a list of sites, usually
4194: <code class="varname">MASTER_SITES</code>. If the package has multiple
4195: <code class="varname">DISTFILES</code> or multiple
4196: <code class="varname">PATCHFILES</code> from different sites, you can
4197: set
4198: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4199: to the list of URLs where the file
4200: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4201: (including the suffix) can be found.</p>
4202: <pre class="programlisting">
4203: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4204: DISTFILES+= foo-file.tar.gz
4205: SITES.foo-file.tar.gz= \
4206: https://www.somewhere.com/somehow/ \
4207: https://www.somewhereelse.com/mirror/somehow/
4208: </pre>
4209: <p>When actually fetching the distfiles, each item from
4210: <code class="varname">MASTER_SITES</code> or
4211: <code class="varname">SITES.*</code> gets the name of each distfile
4212: appended to it, without an intermediate slash. Therefore,
4213: all site values have to end with a slash or other separator
4214: character. This allows for example to set
4215: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4216: that gets the name of the distfile as a parameter. In this
4217: case, the definition would look like:</p>
4218: <pre class="programlisting">
4219: MASTER_SITES= https://www.example.com/download.cgi?file=
4220: </pre>
4221: <p> The exception to this rule are URLs starting with a dash.
4222: In that case the URL is taken as is, fetched and the result
4223: stored under the name of the distfile. You can use this style
4224: for the case when the download URL style does not match the
4225: above common case. For example, if permanent download URL is a
4226: redirector to the real download URL, or the download file name
4227: is offered by an HTTP Content-Disposition header. In the
4228: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4229: created instead of the default
4230: <code class="filename">v1.0.0.tar.gz</code>.</p>
4231: <pre class="programlisting">
4232: DISTNAME= foo-1.0.0
4233: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4234: </pre>
4235: <p>There are some predefined values for
4236: <code class="varname">MASTER_SITES</code>, which can be used in
4237: packages. The names of the variables should speak for
4238: themselves.</p>
4239: <table border="0" summary="Simple list" class="simplelist">
4240: <tr>
4241: <td>MASTER_SITE_APACHE</td>
4242: <td>MASTER_SITE_BACKUP</td>
4243: </tr>
4244: <tr>
4245: <td>MASTER_SITE_CRATESIO</td>
4246: <td>MASTER_SITE_CYGWIN</td>
4247: </tr>
4248: <tr>
4249: <td>MASTER_SITE_DEBIAN</td>
4250: <td>MASTER_SITE_FREEBSD</td>
4251: </tr>
4252: <tr>
4253: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4254: <td>MASTER_SITE_GENTOO</td>
4255: </tr>
4256: <tr>
4257: <td>MASTER_SITE_GITHUB</td>
4258: <td>MASTER_SITE_GNOME</td>
4259: </tr>
4260: <tr>
4261: <td>MASTER_SITE_GNU</td>
4262: <td>MASTER_SITE_GNUSTEP</td>
4263: </tr>
4264: <tr>
4265: <td>MASTER_SITE_HASKELL_HACKAGE</td>
4266: <td>MASTER_SITE_IFARCHIVE</td>
4267: </tr>
4268: <tr>
4269: <td>MASTER_SITE_KDE</td>
4270: <td>MASTER_SITE_MOZILLA</td>
4271: </tr>
4272: <tr>
4273: <td>MASTER_SITE_MOZILLA_ALL</td>
4274: <td>MASTER_SITE_MYSQL</td>
4275: </tr>
4276: <tr>
4277: <td>MASTER_SITE_NETLIB</td>
4278: <td>MASTER_SITE_OPENBSD</td>
4279: </tr>
4280: <tr>
4281: <td>MASTER_SITE_OPENOFFICE</td>
4282: <td>MASTER_SITE_OSDN</td>
4283: </tr>
4284: <tr>
4285: <td>MASTER_SITE_PERL_CPAN</td>
4286: <td>MASTER_SITE_PGSQL</td>
4287: </tr>
4288: <tr>
4289: <td>MASTER_SITE_PYPI</td>
4290: <td>MASTER_SITE_RUBYGEMS</td>
4291: </tr>
4292: <tr>
4293: <td>MASTER_SITE_R_CRAN</td>
4294: <td>MASTER_SITE_SOURCEFORGE</td>
4295: </tr>
1.1 dsieger 4296: <tr>
1.184 rillig 4297: <td>MASTER_SITE_SUNSITE</td>
4298: <td>MASTER_SITE_SUSE</td>
1.1 dsieger 4299: </tr>
4300: <tr>
1.184 rillig 4301: <td>MASTER_SITE_TEX_CTAN</td>
4302: <td>MASTER_SITE_XCONTRIB</td>
1.1 dsieger 4303: </tr>
4304: <tr>
1.184 rillig 4305: <td>MASTER_SITE_XEMACS</td>
4306: <td>MASTER_SITE_XORG</td>
4307: </tr>
4308: </table>
4309: <p>Some explanations for the less self-explaining ones:
4310: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
4311: 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
4312: 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>
4313: <p>If you choose one of these predefined sites, you may
4314: want to specify a subdirectory of that site. Since these
4315: macros may expand to more than one actual site, you
4316: <span class="emphasis"><em>must</em></span> use the following construct to
4317: specify a subdirectory:</p>
1.1 dsieger 4318: <pre class="programlisting">
1.184 rillig 4319: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4320: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 4321: </pre>
1.184 rillig 4322: <p>Note the trailing slash after the subdirectory
4323: name.</p>
4324: </div>
4325: <div class="sect2">
4326: <div class="titlepage"><div><div><h3 class="title">
4327: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4328: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4329: all the distfiles exist in a local directory
4330: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4331: user). If the files do not exist, they are fetched using
4332: commands of the form</p>
1.1 dsieger 4333: <pre class="programlisting">
1.184 rillig 4334: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4335: </pre>
4336: <p>where <code class="literal">${site}</code> varies through
4337: several possibilities in turn: first,
4338: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4339: sites specified in either <code class="varname">SITES.file</code> if
4340: defined, else <code class="varname">MASTER_SITES</code> or
4341: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4342: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4343: all except the first and the last can be optionally sorted
4344: by the user, via setting either
4345: <code class="varname">MASTER_SORT_RANDOM</code>, and
4346: <code class="varname">MASTER_SORT_AWK</code> or
4347: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4348: <p> The specific command and arguments used depend on the
4349: <code class="varname">FETCH_USING</code> parameter. The example above is
4350: for <code class="literal">FETCH_USING=custom</code>.</p>
4351: <p>The distfiles mirror run by the NetBSD Foundation uses the
4352: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4353: distfiles, if they are freely distributable. Packages setting
4354: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4355: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4356: mirrored.</p>
1.1 dsieger 4357: </div>
4358: </div>
1.184 rillig 4359: <div class="sect1">
4360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4361: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4362: <p>After the distfile(s) are fetched, their checksum is
4363: generated and compared with the checksums stored in the
4364: distinfo file. If the checksums don't match, the build is
4365: aborted. This is to ensure the same distfile is used for
4366: building, and that the distfile wasn't changed, e.g. by some
4367: malign force, deliberately changed distfiles on the master
4368: distribution site or network lossage.</p>
1.1 dsieger 4369: </div>
1.41 asau 4370: <div class="sect1">
1.1 dsieger 4371: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4372: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4373: <p>When the distfiles are present on the local system, they
4374: need to be extracted, as they usually come in the form of some
4375: compressed archive format.</p>
4376: <p>By default, all <code class="varname">DISTFILES</code> are
4377: extracted. If you only need some of them, you can set the
4378: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4379: files.</p>
4380: <p>Extracting the files is usually done by a little
4381: program, <code class="filename">mk/extract/extract</code>, which
4382: already knows how to extract various archive formats, so most
4383: likely you will not need to change anything here. But if you
4384: need, the following variables may help you:</p>
1.41 asau 4385: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4386: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4387: <dd><p>Use these variables to override the default
4388: options for an extract command, which are defined in
4389: <code class="filename">mk/extract/extract</code>.</p></dd>
4390: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4391: <dd><p>This variable can be set to
4392: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4393: (which is the default value), <code class="literal">pax</code>, or an
4394: absolute pathname pointing to the command with which tar
4395: archives should be extracted. It is preferred to choose bsdtar over gtar
4396: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 4397: </dl></div>
1.184 rillig 4398: <p>If the <code class="filename">extract</code> program doesn't
4399: serve your needs, you can also override the
4400: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4401: command used for extracting the files. This command is
4402: executed in the <code class="filename">${WRKSRC}</code>
4403: directory. During execution of this command, the shell
4404: variable <code class="varname">extract_file</code> holds the absolute
4405: pathname of the file that is going to be extracted.</p>
4406: <p>And if that still does not suffice, you can override the
4407: <code class="varname">do-extract</code> target in the package
4408: Makefile.</p>
1.1 dsieger 4409: </div>
1.41 asau 4410: <div class="sect1">
1.1 dsieger 4411: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4412: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4413: <p>After extraction, all the patches named by the
4414: <code class="varname">PATCHFILES</code>, those present in the patches
4415: subdirectory of the package as well as in
4416: $LOCALPATCHES/$PKGPATH (e.g.
4417: <code class="filename">/usr/local/patches/graphics/png</code>) are
4418: applied. Patchfiles ending in <code class="filename">.Z</code> or
4419: <code class="filename">.gz</code> are uncompressed before they are
4420: applied, files ending in <code class="filename">.orig</code> or
4421: <code class="filename">.rej</code> are ignored. Any special options to
1.197 leot 4422: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.184 rillig 4423: <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.197 leot 4424: <p>By default <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.184 rillig 4425: fail if the expected text from the patch context is not found in the
4426: patched file. If that happens, fix the patch file by comparing it
4427: with the actual text in the file to be patched.</p>
1.1 dsieger 4428: </div>
1.41 asau 4429: <div class="sect1">
1.1 dsieger 4430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4431: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4432: <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>.
4433: </p>
1.1 dsieger 4434: </div>
1.41 asau 4435: <div class="sect1">
1.1 dsieger 4436: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4437: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4438: <p>This phase creates wrapper programs for the compilers and
4439: linkers. The following variables can be used to tweak the
4440: wrappers.</p>
4441: <div class="variablelist"><dl class="variablelist">
4442: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4443: <dd><p>The command used to print progress
4444: messages. Does nothing by default. Set to
4445: <code class="literal">${ECHO}</code> to see the progress
4446: messages.</p></dd>
4447: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4448: <dd><p>This variable can be set to
4449: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4450: depending on whether you want additional information in the
4451: wrapper log file.</p></dd>
4452: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4453: <dd><p>This variable can be set to
4454: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4455: on whether the wrapper should use its cache, which will
4456: improve the speed. The default value is
4457: <code class="literal">yes</code>, but is forced to
4458: <code class="literal">no</code> if the platform does not support
4459: it.</p></dd>
4460: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4461: <dd><p>A list of reordering commands. A reordering
4462: command has the form
4463: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4464: It ensures that that
4465: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4466: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4467: </p></dd>
4468: </dl></div>
4469: </div>
4470: <div class="sect1">
4471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4472: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4473: <p>Most pieces of software need information on the header
4474: files, system calls, and library routines which are available
4475: on the platform they run on. The process of determining this
4476: information is known as configuration, and is usually
4477: automated. In most cases, a script is supplied with the
4478: distfiles, and its invocation results in generation of header
4479: files, Makefiles, etc.</p>
4480: <p>If the package contains a configure script, this can be
4481: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4482: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4483: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.187 rillig 4484: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4485: <p>In the <code class="literal">do-configure</code> stage, a rough
4486: equivalent of the following command is run. See
4487: <code class="filename">mk/configure/configure.mk</code>, target
4488: <code class="literal">do-configure-script</code> for the exact
4489: definition.</p>
4490: <pre class="programlisting">
4491: .for dir in ${CONFIGURE_DIRS}
4492: cd ${WRKSRC} && cd ${dir} \
4493: && env ${CONFIGURE_ENV} \
4494: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 4495: .endfor
1.1 dsieger 4496: </pre>
1.184 rillig 4497: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4498: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4499: <code class="varname">WRKSRC</code>. In each of these directories, the
4500: configure script is run with the environment
4501: <code class="varname">CONFIGURE_ENV</code> and arguments
4502: <code class="varname">CONFIGURE_ARGS</code>. The variables
4503: <code class="varname">CONFIGURE_ENV</code>,
4504: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4505: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4506: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4507: package.</p>
4508: <p>If the program uses the Perl way of configuration (mainly Perl
4509: modules, but not only), i.e. a file called
4510: <code class="filename">Makefile.PL</code>, it should include
4511: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4512: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4513: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4514: <p>If the program uses an <code class="filename">Imakefile</code>
4515: for configuration, the appropriate steps can be invoked by
4516: setting <code class="varname">USE_IMAKE</code> to
4517: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4518: You can add variables to xmkmf's environment by adding them to the
4519: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4520: <p>If the program uses <code class="filename">cmake</code>
4521: for configuration, the appropriate steps can be invoked by
4522: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
4523: You can add variables to cmake's environment by adding them to the
4524: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
4525: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
4526: The top directory argument is given by the
4527: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
4528: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
4529: <p>If there is no configure step at all, set
4530: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4531: </div>
1.41 asau 4532: <div class="sect1">
1.1 dsieger 4533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4534: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.187 rillig 4535: <p>For building a package, a rough equivalent of the following
4536: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4537: <code class="literal">do-build</code> for the exact definition.</p>
1.1 dsieger 4538: <pre class="programlisting">
1.187 rillig 4539: .for dir in ${BUILD_DIRS}
4540: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 4541: && env ${MAKE_ENV} \
1.187 rillig 4542: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 4543: -f ${MAKE_FILE} \
4544: ${BUILD_TARGET}
4545: .endfor
1.1 dsieger 4546: </pre>
1.184 rillig 4547: <p><code class="varname">BUILD_DIRS</code> (default:
4548: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4549: <code class="varname">WRKSRC</code>. In each of these directories,
4550: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4551: <code class="varname">MAKE_ENV</code> and arguments
4552: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4553: <code class="varname">MAKE_ENV</code>,
4554: <code class="varname">BUILD_MAKE_FLAGS</code>,
4555: <code class="varname">MAKE_FILE</code> and
4556: <code class="varname">BUILD_TARGET</code> may all be changed by the
4557: package.</p>
4558: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4559: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4560: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4561: default value of <code class="varname">MAKE_FILE</code> is
4562: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4563: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4564: <p>If there is no build step at all, set
4565: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4566: </div>
1.41 asau 4567: <div class="sect1">
1.1 dsieger 4568: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4569: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4570: <p>[TODO]</p>
1.1 dsieger 4571: </div>
1.41 asau 4572: <div class="sect1">
1.1 dsieger 4573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4574: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4575: <p>Once the build stage has completed, the final step is to
4576: install the software in public directories, so users can
4577: access the programs and files.</p>
1.187 rillig 4578: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4579: of the following code is executed; see
4580: <code class="filename">mk/install/install.mk</code>, target
4581: <code class="literal">do-install</code> for the exact definition. Additionally,
4582: before and after this code, several consistency checks are run
4583: against the files-to-be-installed, see
4584: <code class="filename">mk/check/*.mk</code> for details.</p>
4585: <pre class="programlisting">
4586: .for dir in ${INSTALL_DIRS}
4587: cd ${WRKSRC} && cd ${dir} \
4588: && env ${INSTALL_ENV} ${MAKE_ENV} \
4589: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4590: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 4591: .endfor
1.1 dsieger 4592: </pre>
1.184 rillig 4593: <p>The variable's meanings are analogous to the ones in the
4594: <span class="emphasis"><em>build</em></span> phase.
4595: <code class="varname">INSTALL_DIRS</code> defaults to
4596: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4597: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4598: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4599: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4600: defined.</p>
4601: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4602: variables are useful. They are all variations of the
1.197 leot 4603: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.184 rillig 4604: permissions preset. <code class="varname">INSTALL</code> is the plain
4605: install command. The specialized variants, together with their
4606: intended use, are:</p>
4607: <div class="variablelist"><dl class="variablelist">
4608: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4609: <dd><p>directories that contain
4610: binaries</p></dd>
4611: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4612: <dd><p>directories that contain
4613: scripts</p></dd>
4614: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4615: <dd><p>directories that contain shared and static
4616: libraries</p></dd>
4617: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4618: <dd><p>directories that contain data
4619: files</p></dd>
4620: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4621: <dd><p>directories that contain man
4622: pages</p></dd>
4623: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4624: <dd><p>directories that contain data files for games
4625: </p></dd>
4626: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4627: <dd><p>binaries that can be stripped from debugging
4628: symbols</p></dd>
4629: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4630: <dd><p>binaries that cannot be
4631: stripped</p></dd>
4632: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4633: <dd><p>game
4634: binaries</p></dd>
4635: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4636: <dd><p>shared and static
4637: libraries</p></dd>
4638: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4639: <dd><p>data files</p></dd>
4640: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4641: <dd><p>data files for
4642: games</p></dd>
4643: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4644: <dd><p>man pages</p></dd>
4645: </dl></div>
4646: <p>Some other variables are:</p>
4647: <div class="variablelist"><dl class="variablelist">
4648: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.197 leot 4649: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.184 rillig 4650: when installing binaries. Any debugging sections and symbols present in
4651: binaries will be preserved.
4652: </p></dd>
4653: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4654: <dd><p>A list of directories relative to
4655: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4656: beginning of the <span class="emphasis"><em>install</em></span> phase.
4657: The package is supposed to create all needed directories itself
4658: before installing files to it and list all other directories here.
4659: </p></dd>
4660: </dl></div>
4661: <p>In the rare cases that a package shouldn't install anything,
4662: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4663: mostly relevant for packages in the <code class="filename">regress</code>
4664: category.</p>
1.1 dsieger 4665: </div>
1.41 asau 4666: <div class="sect1">
1.1 dsieger 4667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4668: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4669: <p>Once the install stage has completed, a binary package of
4670: the installed files can be built. These binary packages can be
4671: used for quick installation without previous compilation, e.g. by
4672: the <span class="command"><strong>make bin-install</strong></span> or by using
4673: <span class="command"><strong>pkg_add</strong></span>.</p>
4674: <p>By default, the binary packages are created in
4675: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4676: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4677: one for each category in the <code class="varname">CATEGORIES</code>
4678: variable. <code class="varname">PACKAGES</code> defaults to
4679: <code class="filename">pkgsrc/packages</code>.</p>
1.1 dsieger 4680: </div>
1.41 asau 4681: <div class="sect1">
1.1 dsieger 4682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4683: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4684: <p>Once you're finished with a package, you can clean the work
4685: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4686: to clean the work directories of all dependencies too, use
4687: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 4688: </div>
1.41 asau 4689: <div class="sect1">
1.1 dsieger 4690: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4691: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.41 asau 4692: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4693: <dt><span class="term">pre/post-*</span></dt>
4694: <dd>
4695: <p>For any of the main targets described in the previous
4696: section (configure, build, install, etc.), two auxiliary
4697: targets exist with
4698: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4699: prefix for the main target's name. These targets are
4700: invoked before and after the main target is called,
4701: allowing extra configuration or installation steps be
4702: performed from a package's Makefile, for example, which
4703: a program's configure script or install target
4704: omitted.</p>
4705: <p>About 5% of the pkgsrc packages define their custom
4706: post-extract target, another 5% define pre-configure, and 10%
4707: define post-install. The other pre/post-* targets are defined
4708: even less often.</p>
4709: </dd>
4710: <dt><span class="term">do-*</span></dt>
1.1 dsieger 4711: <dd>
1.184 rillig 4712: <p>Should one of the main targets do the wrong thing,
4713: and should there be no variable to fix this, you can
4714: redefine it with the do-* target. (Note that redefining
4715: the target itself instead of the do-* target is a bad
4716: idea, as the pre-* and post-* targets won't be called
4717: anymore, etc.)</p>
4718: <p>About 15% of the pkgsrc packages override the default
4719: do-install, the other do-* targets are overridden even less
4720: often.</p>
1.1 dsieger 4721: </dd>
1.184 rillig 4722: <dt><span class="term">reinstall</span></dt>
1.1 dsieger 4723: <dd>
1.184 rillig 4724: <p>If you did a <span class="command"><strong>make install</strong></span> and
4725: you noticed some file was not installed properly, you
4726: can repeat the installation with this target, which will
4727: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4728: <p>This is the default value of
4729: <code class="varname">DEPENDS_TARGET</code> except in the case of
4730: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4731: package</strong></span>, where the defaults are
4732: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4733: respectively.</p>
1.1 dsieger 4734: </dd>
1.184 rillig 4735: <dt><span class="term">deinstall</span></dt>
4736: <dd>
1.197 leot 4737: <p>This target does a <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.184 rillig 4738: current directory, effectively de-installing the
4739: package. The following variables can be used to tune the
4740: behaviour:</p>
4741: <div class="variablelist"><dl class="variablelist">
4742: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.197 leot 4743: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.184 rillig 4744: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4745: <dd><p>Remove all packages that require (depend on)
4746: the given package. This can be used to remove any
4747: packages that may have been pulled in by a given
4748: package, e.g. if <span class="command"><strong>make deinstall
4749: DEINSTALLDEPENDS=1</strong></span> is done in
4750: <code class="filename">pkgsrc/x11/kde</code>, this is
4751: likely to remove whole KDE. Works by adding
1.197 leot 4752: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.184 rillig 4753: command line.</p></dd>
4754: </dl></div>
4755: </dd>
4756: <dt><span class="term">bin-install</span></dt>
4757: <dd><p>Install a binary package from local disk and via FTP
4758: from a list of sites (see the
4759: <code class="varname">BINPKG_SITES</code> variable), and do a
4760: <span class="command"><strong>make package</strong></span> if no binary package is
4761: available anywhere. The arguments given to
4762: <span class="command"><strong>pkg_add</strong></span> can be set via
4763: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4764: operation, etc.</p></dd>
4765: <dt><span class="term">install-clean</span></dt>
4766: <dd><p>This target removes the state files for the "install" and later
4767: phases so that the "install" target may be re-invoked. This can be
4768: used after editing the PLIST to install the package without
4769: rebuilding it.</p></dd>
4770: <dt><span class="term">build-clean</span></dt>
4771: <dd><p>This target removes the state files for the "build" and later
4772: phases so that the "build" target may be re-invoked.</p></dd>
4773: <dt><span class="term">update</span></dt>
4774: <dd>
4775: <p>This target causes the current package to be
4776: updated to the latest version. The package and all
4777: depending packages first get de-installed, then current
4778: versions of the corresponding packages get compiled and
4779: installed. This is similar to manually noting which
4780: packages are currently installed, then performing a
4781: series of <span class="command"><strong>make deinstall</strong></span> and
4782: <span class="command"><strong>make install</strong></span> (or whatever
4783: <code class="varname">UPDATE_TARGET</code> is set to) for these
4784: packages.</p>
4785: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4786: resume package updating in case a previous <span class="command"><strong>make
4787: update</strong></span> was interrupted for some reason.
4788: However, in this case, make sure you don't call
4789: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4790: list of dependent packages in <code class="varname">WRKDIR</code>.
4791: Otherwise, you lose the ability to automatically update
4792: the current package along with the dependent packages
4793: you have installed.</p>
4794: <p>Resuming an interrupted <span class="command"><strong>make
4795: update</strong></span> will only work as long as the package
4796: tree remains unchanged. If the source code for one of
4797: the packages to be updated has been changed, resuming
4798: <span class="command"><strong>make update</strong></span> will most certainly
4799: fail!</p>
4800: <p>The following variables can be used either on the
4801: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4802: alter the behaviour of <span class="command"><strong>make
4803: update</strong></span>:</p>
4804: <div class="variablelist"><dl class="variablelist">
4805: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4806: <dd><p>Install target to recursively use for the
4807: updated package and the dependent packages.
4808: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4809: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4810: <span class="command"><strong>make update</strong></span>. Other good
4811: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4812: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4813: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4814: endless loop!</p></dd>
4815: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4816: <dd><p>Don't clean up after updating. Useful if
4817: you want to leave the work sources of the updated
4818: packages around for inspection or other purposes.
4819: Be sure you eventually clean up the source tree
4820: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4821: or you may run into troubles with old source code
4822: still lying around on your next
4823: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4824: update</strong></span>.</p></dd>
4825: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4826: <dd><p>Deinstall each package before installing
4827: (making <code class="varname">DEPENDS_TARGET</code>). This
4828: may be necessary if the
4829: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4830: called after interrupting a running <span class="command"><strong>make
4831: update</strong></span>.</p></dd>
4832: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4833: <dd><p>Allows you to disable recursion and hardcode
4834: the target for packages. The default is
4835: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4836: facilitating a recursive update of prerequisite
4837: packages. Only set
4838: <code class="varname">DEPENDS_TARGET</code> if you want to
4839: disable recursive updates. Use
4840: <code class="varname">UPDATE_TARGET</code> instead to just
4841: set a specific target for each package to be
4842: installed during <span class="command"><strong>make update</strong></span>
4843: (see above).</p></dd>
4844: </dl></div>
4845: </dd>
4846: <dt><span class="term">clean-update</span></dt>
4847: <dd>
4848: <p>Clean the source tree for all packages that would
4849: get updated if <span class="command"><strong>make update</strong></span> was called
4850: from the current directory. This target should not be
4851: used if the current package (or any of its depending
4852: packages) have already been de-installed (e.g., after
4853: calling <span class="command"><strong>make update</strong></span>) or you may lose
4854: some packages you intended to update. As a rule of
4855: thumb: only use this target <span class="emphasis"><em>before</em></span>
4856: the first time you run <span class="command"><strong>make update</strong></span>
4857: and only if you have a dirty package tree (e.g., if you
4858: used <code class="varname">NOCLEAN</code>).</p>
4859: <p>If you are unsure about whether your tree is
4860: clean, you can either perform a <span class="command"><strong>make
4861: clean</strong></span> at the top of the tree, or use the
4862: following sequence of commands from the directory of the
4863: package you want to update (<span class="emphasis"><em>before</em></span>
4864: running <span class="command"><strong>make update</strong></span> for the first
4865: time, otherwise you lose all the packages you wanted to
4866: update!):</p>
4867: <pre class="screen">
4868: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
4869: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
4870: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
4871: </pre>
4872: <p>The following variables can be used either on the
4873: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
4874: <span class="command"><strong>make clean-update</strong></span>:</p>
4875: <div class="variablelist"><dl class="variablelist">
4876: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
4877: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
4878: reconstruct the list of directories to update for
4879: this package. Only use this if <span class="command"><strong>make
4880: update</strong></span> successfully installed all
4881: packages you wanted to update. Normally, this is
4882: done automatically on <span class="command"><strong>make
4883: update</strong></span>, but may have been suppressed by
4884: the <code class="varname">NOCLEAN</code> variable (see
4885: above).</p></dd>
4886: </dl></div>
4887: </dd>
4888: <dt><span class="term">replace</span></dt>
4889: <dd>
4890: <p>Update the installation of the current package. This
4891: differs from update in that it does not replace dependent
4892: packages. You will need to install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
4893: target to work.</p>
4894: <p><span class="emphasis"><em>Be careful when using this
4895: target!</em></span> There are no guarantees that dependent
4896: packages will still work, in particular they will most
4897: certainly break if you <span class="command"><strong>make replace</strong></span> a
4898: library package whose shared library major version changed
4899: between your installed version and the new one. For this
4900: reason, this target is not officially supported and only
4901: recommended for advanced users.</p>
4902: </dd>
4903: <dt><span class="term">info</span></dt>
1.197 leot 4904: <dd><p>This target invokes <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.184 rillig 4905: package. You can use this to check which version of a
4906: package is installed.</p></dd>
4907: <dt><span class="term">index</span></dt>
4908: <dd>
4909: <p>This is a top-level command, i.e. it should be used in
4910: the <code class="filename">pkgsrc</code> directory. It creates a
4911: database of all packages in the local pkgsrc tree, including
4912: dependencies, comment, maintainer, and some other useful
4913: information. Individual entries are created by running
4914: <span class="command"><strong>make describe</strong></span> in the packages'
4915: directories. This index file is saved as
4916: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
4917: verbose format by running <span class="command"><strong>make
4918: print-index</strong></span>. You can search in it with
4919: <span class="command"><strong>make search
4920: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
4921: extract a list of all packages that depend on a particular
4922: one by running <span class="command"><strong>make show-deps
4923: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
4924: <p>Running this command takes a very long time, some
4925: hours even on fast machines!</p>
4926: </dd>
4927: <dt><span class="term">readme</span></dt>
4928: <dd>
4929: <p>This target generates a
1.199 nia 4930: <code class="filename">index.html</code> file, which can be
1.184 rillig 4931: viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>. The generated files
4932: contain references to any packages which are in the
4933: <code class="varname">PACKAGES</code> directory on the local
4934: host. The generated files can be made to refer to URLs
4935: based on <code class="varname">FTP_PKG_URL_HOST</code> and
4936: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.199 nia 4937: wanted to generate <code class="filename">index.html</code>
1.184 rillig 4938: files which pointed to binary packages on the local
4939: machine, in the directory
4940: <code class="filename">/usr/packages</code>, set
4941: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
4942: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
4943: <code class="varname">${PACKAGES}</code> directory and its
4944: subdirectories will be searched for all the binary
4945: packages.</p>
4946: <p>The target can be run at the toplevel or in category
4947: directories, in which case it descends recursively.</p>
4948: </dd>
4949: <dt><span class="term">readme-all</span></dt>
4950: <dd><p>This is a top-level command, run it in
4951: <code class="filename">pkgsrc</code>. Use this target to create a
4952: file <code class="filename">README-all.html</code> which contains a
4953: list of all packages currently available in the NetBSD
4954: Packages Collection, together with the category they belong
4955: to and a short description. This file is compiled from the
1.199 nia 4956: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.184 rillig 4957: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
4958: readme</strong></span>.</p></dd>
4959: <dt><span class="term">cdrom-readme</span></dt>
4960: <dd><p>This is very much the same as the
4961: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
4962: used when generating a pkgsrc tree to be written to a
4963: CD-ROM. This target also produces
1.199 nia 4964: <code class="filename">index.html</code> files, and can be made
1.184 rillig 4965: to refer to URLs based on
4966: <code class="varname">CDROM_PKG_URL_HOST</code> and
4967: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
4968: <dt><span class="term">show-distfiles</span></dt>
4969: <dd><p>This target shows which distfiles and patchfiles
4970: are needed to build the package
4971: (<code class="varname">ALLFILES</code>, which contains all
4972: <code class="varname">DISTFILES</code> and
4973: <code class="varname">PATCHFILES</code>, but not
4974: <code class="filename">patches/*</code>).</p></dd>
4975: <dt><span class="term">show-downlevel</span></dt>
4976: <dd><p>This target shows nothing if the package is not
4977: installed. If a version of this package is installed,
4978: but is not the version provided in this version of
4979: pkgsrc, then a warning message is displayed. This target
4980: can be used to show which of your installed packages are
4981: downlevel, and so the old versions can be deleted, and
4982: the current ones added.</p></dd>
4983: <dt><span class="term">show-pkgsrc-dir</span></dt>
4984: <dd><p>This target shows the directory in the pkgsrc
4985: hierarchy from which the package can be built and
4986: installed. This may not be the same directory as the one
4987: from which the package was installed. This target is
4988: intended to be used by people who may wish to upgrade
4989: many packages on a single host, and can be invoked from
4990: the top-level pkgsrc Makefile by using the
4991: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
4992: <dt><span class="term">show-installed-depends</span></dt>
4993: <dd><p>This target shows which installed packages match
4994: the current package's <code class="varname">DEPENDS</code>. Useful
4995: if out of date dependencies are causing build
4996: problems.</p></dd>
4997: <dt><span class="term">print-build-depends-list</span></dt>
4998: <dd><p>This target shows the list of packages that the current package
4999: depends on for building.</p></dd>
5000: <dt><span class="term">print-run-depends-list</span></dt>
5001: <dd><p>This target shows the list of packages that the current package
5002: depends on for running.</p></dd>
5003: <dt><span class="term">check-shlibs</span></dt>
5004: <dd><p>After a package is installed, check all its
5005: binaries and (on ELF platforms) shared libraries to see
5006: if they find the shared libs they need. Run by default
5007: 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>
5008: <dt><span class="term">print-PLIST</span></dt>
5009: <dd>
5010: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5011: upgraded pkg, this prints out an attempt to generate a
5012: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5013: -newer work/.extract_done</strong></span>. An attempt is made
5014: to care for shared libs etc., but it is
5015: <span class="emphasis"><em>strongly</em></span> recommended to review the
5016: result before putting it into
5017: <code class="filename">PLIST</code>. On upgrades, it's useful to
5018: diff the output of this command against an already
5019: existing <code class="filename">PLIST</code> file.</p>
1.197 leot 5020: <p>If the package installs files via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.184 rillig 5021: other methods that don't update file access times, be
5022: sure to add these files manually to your
5023: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5024: -newer</span>”</span> command used by this target won't catch
5025: them!</p>
5026: <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
5027: information on this target.</p>
5028: </dd>
5029: </dl></div>
5030: </div>
5031: </div>
5032: <div class="chapter">
5033: <div class="titlepage"><div><div><h2 class="title">
5034: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5035: <div class="toc">
5036: <p><b>Table of Contents</b></p>
5037: <dl class="toc">
5038: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5039: <dd><dl>
5040: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
5041: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
5042: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
5043: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
5044: </dl></dd>
5045: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5046: <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>
5047: </dl>
5048: </div>
5049: <p>When you find a package that is not yet in pkgsrc, you
5050: most likely have a URL from where you can download the source
5051: code. Starting with this URL, creating a package involves only a
5052: few steps.</p>
5053: <div class="procedure"><ol class="procedure" type="1">
5054: <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
5055: enable the basic quality checks.</p></li>
5056: <li class="step">
5057: <p>Install the package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkg_developer/README.html" target="_top"><code class="filename">meta-pkgs/pkg_developer</code></a>, which among others will
5058: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5059: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5060: <span class="command"><strong>mkpatches</strong></span>:</p>
5061: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5062: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5063: </li>
5064: <li class="step">
5065: <p>Choose one of the top-level directories as the category in
5066: which you want to place your package. You can also create a directory of
5067: your own (maybe called <code class="filename">local</code>). In that category
5068: directory, create another directory for your package and change into
5069: it:</p>
5070: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>mkdir <em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em></code></strong>
5071: <code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em></code></strong></pre>
5072: </li>
5073: <li class="step">
5074: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
5075: you for a URL. Enter the URL of the distribution file (in most cases a
5076: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
5077: of your package are created automatically. The distribution file is
5078: extracted automatically to fill in some details in the
5079: <code class="filename">Makefile</code> that would otherwise have to be done
5080: manually:</p>
5081: <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>
5082: </li>
5083: <li class="step">
5084: <p>Examine the extracted files to determine the dependencies of
5085: your package. Ideally, this is mentioned in some
5086: <code class="filename">README</code> file, but things may differ. For each of
5087: these dependencies, look where it exists in pkgsrc, and if there is a
5088: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5089: line to your package <code class="filename">Makefile</code> which includes that
5090: file just before the last line. If the
5091: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5092: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5093: that the package's include files and libraries are provided.</p>
5094: <p>If you just need binaries from a package, add a
5095: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5096: version of the dependency and where it can be found in pkgsrc. This line
5097: should be placed in the third paragraph. If the dependency is only
5098: needed for building the package, but not when using it, use
5099: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5100: instead of <code class="varname">DEPENDS</code>.
5101: The difference between <code class="varname">TOOL_DEPENDS</code> and
5102: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5103: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
5104: packages, i.e. packages for the architecture where the package
5105: is built;
5106: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
5107: packages, i.e. packages for the architecture for which the package
5108: is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
5109: to specify a dependency used only for testing the resulting package
5110: built, using the upstream project's included test suite.
5111: Your package may then look like this:</p>
5112: <pre class="programlisting">
5113: [...]
5114:
5115: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5116: DEPENDS+= screen-[0-9]*:../../misc/screen
5117: DEPENDS+= screen>=4.0:../../misc/screen
5118:
5119: [...]
5120:
5121: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5122: .include "../../devel/glib2/buildlink3.mk"
5123: .include "../../mk/bsd.pkg.mk"
5124: </pre>
5125: </li>
5126: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5127: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5128: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5129: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5130: additional explanations.</p></li>
5131: <li class="step"><p>In many cases the package is not yet ready to build. You can
5132: 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
5133: over there, you can hopefully continue here.</p></li>
5134: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5135: directory from the extracted files. Besides these files, a lot of cache
5136: files and other system information has been saved in the working
5137: directory, which may become wrong after you edited the
5138: <code class="filename">Makefile</code>.</p></li>
5139: <li class="step">
5140: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5141: 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>
5142: <p>If the extracted files from the package need to be fixed, run multiple rounds of these commands:</p>
5143: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>make</code></strong>
5144: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5145: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
5146: <code class="prompt">$</code> <strong class="userinput"><code>make mps</code></strong>
5147: <code class="prompt">$</code> <strong class="userinput"><code>make clean</code></strong></pre>
5148: </li>
5149: <li class="step"><p>When the package builds fine, the next step is to install
5150: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5151: everything works.</p></li>
5152: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5153: contains a list of the files that are installed by the package, is
5154: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5155: >PLIST</strong></span> to generate a probably correct list. Check
5156: the file using your preferred text editor to see if the list of
5157: files looks plausible.</p></li>
5158: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5159: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5160: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5161: had been registered in the database of installed files, but with an
5162: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5163: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5164: registered with the list of files from
5165: <code class="filename">PLIST</code>.</p></li>
5166: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
5167: package from the set of installed files.</p></li>
5168: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5169: from above again in a single step, making sure that the PLIST is correct
5170: and the whole package is created as intended.</p></li>
5171: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything left to do.</p></li>
5172: <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>
5173: </ol></div>
5174: <div class="sect1">
5175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5176: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5177: <div class="sect2">
5178: <div class="titlepage"><div><div><h3 class="title">
5179: <a name="creating.perl-module"></a>14.1.1. Perl modules</h3></div></div></div>
5180: <p>Simple Perl modules are handled automatically by
5181: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
5182: </div>
5183: <div class="sect2">
5184: <div class="titlepage"><div><div><h3 class="title">
5185: <a name="creating.python-module"></a>14.1.2. Python modules and programs</h3></div></div></div>
5186: <p>Python modules and programs packages are easily created using a
5187: set of predefined variables.</p>
5188: <p>
5189: If some Python versions are not supported by the software, set the
5190: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5191: that are not supported, e.g.
5192: </p>
5193: <pre class="programlisting">
5194: PYTHON_VERSIONS_INCOMPATIBLE= 27
5195: </pre>
5196: <p>
5197: If the packaged software is a Python module, include one of
5198: <code class="filename">../../lang/python/egg.mk</code>,
5199: <code class="filename">../../lang/python/distutils.mk</code>, or
5200: <code class="filename">../../lang/python/extension.mk</code>.</p>
5201: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
5202: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
5203: If the packaged software is using setuptools, you only need
5204: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
5205: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
5206: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>,
5207: so pkgsrc will use this framework.
5208: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>;
5209: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
5210: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
5211: to the name of the script.</p>
5212: <p>Either way, the package directory should be called
5213: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5214: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5215: </p>
5216: <pre class="programlisting">
5217: DISTNAME= foopymodule-1.2.10
5218: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5219: </pre>
5220: <p>If it is an application, include
5221: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5222: In order to correctly set the path to the Python interpreter, use the
5223: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5224: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5225: For example:
5226: </p>
5227: <pre class="programlisting">
5228: REPLACE_PYTHON= *.py
5229: </pre>
5230: <p>Some Python modules have separate distributions for Python-2.x
5231: and Python-3.x support. In pkgsrc this is handled by the
5232: <code class="filename">versioned_dependencies.mk</code> file. Set
5233: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
5234: packages that should be depended upon and include
5235: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
5236: then the pkgsrc infrastructure will depend on the appropriate package
5237: version. For example:
5238: </p>
5239: <pre class="programlisting">
5240: PYTHON_VERSIONED_DEPENDENCIES=dialog
5241: </pre>
5242: <p>
5243: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
5244: of supported packages.</p>
5245: </div>
5246: <div class="sect2">
5247: <div class="titlepage"><div><div><h3 class="title">
5248: <a name="creating.R-package"></a>14.1.3. R packages</h3></div></div></div>
5249: <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>
5250: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
5251: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/README.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
5252: Individual packages (and optionally their dependencies) may be created
5253: and updated. R packages generally follow the same form, and most of
5254: the relevant information needed is contained in a
5255: <code class="filename">DESCRIPTION</code> file as part of each R package on
5256: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5257: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5258: creates or updates a package in the canonical form. The resulting
5259: package should be reviewed for correctness.</p>
5260: </div>
5261: <div class="sect2">
5262: <div class="titlepage"><div><div><h3 class="title">
5263: <a name="creating.TeX-package"></a>14.1.4. TeXlive packages</h3></div></div></div>
5264: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
5265: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/README.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
5266: <p>If the TeXlive package name is not known, it may be useful to
5267: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5268: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5269: 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
5270: archive</a>.</p>
5271: <p>If the TeXlive package name is known, download the files from
5272: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5273: archive</a>. For package <code class="filename">foo</code>, you will need
5274: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5275: also have associated documentation packages, so download
5276: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5277: should be placed in the appropriate category directory, which is often
5278: but not always <code class="filename">print</code>. Then run the following
5279: command in the category directory.</p>
5280: <pre class="programlisting">
5281: texlive2pkg foo.tar.xz foo.doc.tar.xz
5282: </pre>
5283: <p>This will create two packages, <code class="filename">tex-foo</code> and
5284: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5285: are correct.</p>
5286: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5287: currently does not include version information in package filenames
5288: and changes their contents periodically when updates occur.
5289: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5290: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5291: main one and the corresponding documentation, upload the distfiles
5292: with the following command in each package directory.</p>
5293: <pre class="programlisting">
5294: make upload-distfiles
5295: </pre>
5296: </div>
5297: </div>
5298: <div class="sect1">
5299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5300: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5301: <div class="sect2">
5302: <div class="titlepage"><div><div><h3 class="title">
5303: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5304: <div class="sect3">
5305: <div class="titlepage"><div><div><h4 class="title">
5306: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5307: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5308: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5309: pkgsrc. As the description says it has to do with the web, the obvious
5310: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5311: <pre class="programlisting">
5312: <code class="prompt">$</code> mkdir www/nvu
5313: <code class="prompt">$</code> cd www/nvu
5314: </pre>
5315: <p>The web site says that the sources are available as a tar file, so
5316: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5317: <pre class="programlisting">
5318: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5319: </pre>
5320: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5321: below the <code class="varname">DISTNAME</code> line, as the package name should
5322: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5323: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5324: <code class="varname">COMMENT</code> fields. Then the package
5325: <code class="filename">Makefile</code> looked like that:</p>
5326: <pre class="programlisting">
5327: # $NetBSD $
5328: #
5329:
5330: DISTNAME= nvu-1.0-sources
5331: PKGNAME= nvu-1.0
5332: CATEGORIES= www
5333: MASTER_SITES= http://cvs.nvu.com/download/
5334: EXTRACT_SUFX= .tar.bz2
5335:
5336: MAINTAINER= rillig@NetBSD.org
5337: HOMEPAGE= http://cvs.nvu.com/
5338: COMMENT= Web Authoring System
5339:
5340: # url2pkg-marker (please do not remove this line.)
5341: .include "../../mk/bsd.pkg.mk"
5342: </pre>
5343: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5344: this is a workaround to prevent CVS expanding to the filename of the
5345: guide.</p>
5346: <p>Then, I quit the editor and watched pkgsrc downloading a large
5347: source archive:</p>
5348: <pre class="programlisting">
5349: url2pkg> Running "make makesum" ...
5350: => Required installed package digest>=20010302: digest-20060826 found
5351: => Fetching nvu-1.0-sources.tar.bz2
5352: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5353: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5354: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5355: url2pkg> Running "make extract" ...
5356: => Required installed package digest>=20010302: digest-20060826 found
5357: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5358: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5359: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5360: ===> Installing dependencies for nvu-1.0
5361: ===> Overriding tools for nvu-1.0
5362: ===> Extracting for nvu-1.0
5363: url2pkg> Adjusting the Makefile.
5364:
5365: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5366:
5367: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5368: </pre>
5369: </div>
5370: <div class="sect3">
5371: <div class="titlepage"><div><div><h4 class="title">
5372: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5373: <p>Now that the package has been extracted, let's see what's inside
5374: it. The package has a <code class="filename">README.txt</code>, but that only
5375: says something about mozilla, so it's probably useless for seeing what
5376: dependencies this package has. But since there is a GNU configure script
5377: in the package, let's hope that it will complain about everything it
5378: needs.</p>
5379: <pre class="programlisting">
5380: <code class="prompt">$</code> bmake
5381: => Required installed package digest>=20010302: digest-20060826 found
5382: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5383: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5384: ===> Patching for nvu-1.0
5385: ===> Creating toolchain wrappers for nvu-1.0
5386: ===> Configuring for nvu-1.0
5387: [...]
5388: configure: error: Perl 5.004 or higher is required.
5389: [...]
5390: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5391: [...]
5392: </pre>
5393: <p>That worked quite well. So I opened the package Makefile in my
5394: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5395: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5396: package have changed now, and since a perl wrapper is automatically
5397: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5398: from scratch.</p>
5399: <pre class="programlisting">
5400: <code class="prompt">$</code> bmake clean
5401: ===> Cleaning for nvu-1.0
5402: <code class="prompt">$</code> bmake
5403: [...]
5404: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5405: GNU Make. You will not be able to build Mozilla without GNU Make.
5406: [...]
5407: </pre>
5408: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5409: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5410: <pre class="programlisting">
5411: [...]
5412: checking for GTK - version >= 1.2.0... no
5413: *** Could not run GTK test program, checking why...
5414: [...]
5415: </pre>
5416: <p>Now to the other dependencies. The first question is: Where is the
5417: GTK package hidden in pkgsrc?</p>
5418: <pre class="programlisting">
5419: <code class="prompt">$</code> echo ../../*/gtk*
5420: [many packages ...]
5421: <code class="prompt">$</code> echo ../../*/gtk
5422: ../../x11/gtk
5423: <code class="prompt">$</code> echo ../../*/gtk2
5424: ../../x11/gtk2
5425: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5426: ../../x11/gtk2/buildlink3.mk
5427: </pre>
5428: <p>The first try was definitely too broad. The second one had exactly
5429: one result, which is very good. But there is one pitfall with GNOME
5430: packages. Before GNOME 2 had been released, there were already many
5431: GNOME 1 packages in pkgsrc. To be able to continue to use these
5432: packages, the GNOME 2 packages were imported as separate packages, and
5433: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5434: whether this was the case here, and indeed it was.</p>
5435: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5436: file, adding the dependency is very easy. I just inserted an
5437: <code class="literal">.include</code> line before the last line of the package
5438: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5439: <pre class="programlisting">
5440: [...]
5441: .include "../../x11/gtk2/buildlink3.mk"
5442: .include "../../mk/bsd.pkg.mk
5443: </pre>
5444: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5445: was:</p>
1.1 dsieger 5446: <pre class="programlisting">
1.184 rillig 5447: [...]
5448: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5449: checking for GTK - version >= 1.2.0... no
5450: *** Could not run GTK test program, checking why...
5451: *** The test program failed to compile or link. See the file config.log for the
5452: *** exact error that occured. This usually means GTK was incorrectly installed
5453: *** or that you have moved GTK since it was installed. In the latter case, you
5454: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5455: configure: error: Test for GTK failed.
5456: [...]
1.111 sevan 5457: </pre>
1.184 rillig 5458: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5459: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5460: told me that this package really wanted to have the GNOME 1 version of
5461: GTK. If the package had looked for GTK2, it would have looked for
5462: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5463: So I changed the <code class="literal">x11/gtk2</code> to
5464: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5465: and tried again.</p>
1.18 snj 5466: <pre class="programlisting">
1.184 rillig 5467: [...]
5468: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5469: In file included from xpidl.c:42:
5470: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5471: In file included from xpidl.c:42:
5472: xpidl.h:132: error: parse error before "IDL_ns"
5473: [...]
1.111 sevan 5474: </pre>
1.184 rillig 5475: <p>The package still does not find all of its dependencies. Now the
5476: question is: Which package provides the
5477: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.18 snj 5478: <pre class="programlisting">
1.184 rillig 5479: <code class="prompt">$</code> echo ../../*/*idl*
5480: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5481: <code class="prompt">$</code> echo ../../*/*IDL*
5482: ../../net/libIDL
1.111 sevan 5483: </pre>
1.184 rillig 5484: <p>Let's take the one from the second try. So I included the
5485: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5486: again. But the error didn't change. After digging through some of the
5487: code, I concluded that the build process of the package was broken and
5488: couldn't have ever worked, but since the Mozilla source tree is quite
5489: large, I didn't want to fix it. So I added the following to the package
5490: <code class="filename">Makefile</code> and tried again:</p>
1.86 wiz 5491: <pre class="programlisting">
1.184 rillig 5492: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5493: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.111 sevan 5494: </pre>
1.184 rillig 5495: <p>The latter line is needed because the package expects the library
5496: <code class="filename">libIDL.so</code>, but only
5497: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5498: wrapper to rewrite that on the fly.</p>
5499: <p>The next problem was related to a recent change of the FreeType
5500: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
5501: which patch files were relevant for this issue and copied them to the
5502: <code class="filename">patches</code> directory. Then I retried, fixed the
5503: patches so that they applied cleanly and retried again. This time,
5504: everything worked.</p>
1.86 wiz 5505: </div>
1.184 rillig 5506: <div class="sect3">
5507: <div class="titlepage"><div><div><h4 class="title">
5508: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 5509: <pre class="programlisting">
1.184 rillig 5510: <code class="prompt">$</code> bmake CHECK_FILES=no install
5511: [...]
5512: <code class="prompt">$</code> bmake print-PLIST >PLIST
5513: <code class="prompt">$</code> bmake deinstall
5514: <code class="prompt">$</code> bmake install
1.111 sevan 5515: </pre>
1.184 rillig 5516: </div>
5517: </div>
1.1 dsieger 5518: </div>
5519: </div>
1.41 asau 5520: <div class="chapter">
1.1 dsieger 5521: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 5522: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 5523: <div class="toc">
5524: <p><b>Table of Contents</b></p>
1.100 leot 5525: <dl class="toc">
1.184 rillig 5526: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5527: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5528: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5529: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5530: <dd><dl>
5531: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5532: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5533: <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>
5534: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 5535: </dl></dd>
5536: </dl>
5537: </div>
1.184 rillig 5538: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5539: each of which forms a well-defined part of the pkgsrc system. Using
1.197 leot 5540: the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 5541: like pkgsrc requires some discipline to keep the code correct and
5542: understandable.</p>
5543: <p>The basic ingredients for <code class="filename">Makefile</code>
5544: programming are variables and shell
5545: commands. Among these shell commands may even be more complex ones
1.197 leot 5546: like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 5547: as intended it is necessary to quote all variables correctly when they
5548: are used.</p>
5549: <p>This chapter describes some patterns that appear quite often in
5550: <code class="filename">Makefile</code>s, including the pitfalls that come along
5551: with them.</p>
1.41 asau 5552: <div class="sect1">
1.1 dsieger 5553: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5554: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5555: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5556: <p>When you are creating a file as a
5557: target of a rule, always write the data to a temporary file first
5558: and finally rename that file. Otherwise there might occur an error
5559: in the middle of generating the file, and when the user runs
1.197 leot 5560: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 5561: regenerated properly. Example:</p>
1.1 dsieger 5562: <pre class="programlisting">
1.184 rillig 5563: wrong:
5564: @echo "line 1" > ${.TARGET}
5565: @echo "line 2" >> ${.TARGET}
5566: @false
5567:
5568: correct:
5569: @echo "line 1" > ${.TARGET}.tmp
5570: @echo "line 2" >> ${.TARGET}.tmp
5571: @false
5572: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 5573: </pre>
1.184 rillig 5574: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5575: <code class="filename">wrong</code> will exist, although there was an error
5576: message in the first run. On the other hand, running <span class="command"><strong>make
5577: correct</strong></span> gives an error message twice, as expected.</p>
1.197 leot 5578: <p>You might remember that <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.184 rillig 5579: <code class="literal">${.TARGET}</code> in case of error, but this only
5580: happens when it is interrupted, for example by pressing
5581: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.197 leot 5582: when one of the commands fails (like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.184 rillig 5583: </li></ul></div>
5584: </div>
5585: <div class="sect1">
5586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5587: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5588: <p><code class="filename">Makefile</code> variables contain strings that
5589: can be processed using the five operators <code class="code">=</code>,
5590: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.197 leot 5591: <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.184 rillig 5592: page.</p>
5593: <p>When a variable's value is parsed from a
5594: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5595: the backslash character <code class="code">\</code> are handled specially. If a
5596: backslash is the last character in a line, that backslash is removed
5597: from the line and the line continues with the next line of the file.</p>
5598: <p>The <code class="code">#</code> character starts a comment that reaches
5599: until the end of the line. To get an actual <code class="code">#</code> character,
5600: such as in a URL, write <code class="code">\#</code> instead.</p>
5601: <p>The evaluation of variables either happens immediately or lazy.
5602: It happens immediately when the variable occurs on the right-hand
5603: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5604: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5605: In the other cases, it is evaluated lazily.</p>
5606: <p>Some of the modifiers split the string into words and then
5607: operate on the words, others operate on the string as a whole. When a
5608: string is split into words, double quotes and single quotes are
1.197 leot 5609: interpreted as delimiters, just like in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.184 rillig 5610: <div class="sect2">
5611: <div class="titlepage"><div><div><h3 class="title">
5612: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5613: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5614: <li class="listitem"><p>All variable names starting with an underscore
5615: are reserved for use by the pkgsrc infrastructure. They shall
5616: not be used by packages.</p></li>
5617: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5618: lowercase variable names for the iteration
5619: variables.</p></li>
5620: <li class="listitem"><p>All list variables should have a plural name,
5621: such as <code class="varname">PKG_OPTIONS</code> or
5622: <code class="varname">DISTFILES</code>.</p></li>
5623: </ul></div>
5624: </div>
5625: </div>
5626: <div class="sect1">
5627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5628: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5629: <div class="sect2">
5630: <div class="titlepage"><div><div><h3 class="title">
5631: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5632: <p>When adding a string that possibly contains whitespace or quotes to
5633: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5634: modifier.</p>
5635: <p>When adding another list to a list (example 2), it must not be
5636: quoted, since its elements are already quoted.</p>
1.1 dsieger 5637: <pre class="programlisting">
1.184 rillig 5638: STRING= foo * bar `date`
5639: LIST= # empty
5640: ANOTHER_LIST= a=b c=d
5641:
5642: LIST+= ${STRING:Q} # 1
5643: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 5644: </pre>
1.184 rillig 5645: </div>
5646: <div class="sect2">
5647: <div class="titlepage"><div><div><h3 class="title">
5648: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5649: <p>Echoing a string containing special characters needs special
5650: work.</p>
1.1 dsieger 5651: <pre class="programlisting">
1.184 rillig 5652: STRING= foo bar < > * `date` $$HOME ' "
5653: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5654:
5655: all:
5656: echo ${STRING} # 1
5657: echo ${STRING:Q} # 2
5658: printf '%s\n' ${STRING:Q}'' # 3
5659: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 5660: </pre>
1.184 rillig 5661: <p>Example 1 leads to a syntax error in the shell, as the characters
5662: are just copied.</p>
5663: <p>Example 2 quotes the string so that the shell interprets it
5664: correctly. But the echo command may additionally interpret strings with a
5665: leading dash or those containing backslashes.</p>
1.197 leot 5666: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.184 rillig 5667: interprets the format string, but not the next argument. The trailing
5668: single quotes handle the case when the string is empty. In that case, the
5669: :Q modifier would result in an empty string too, which would then be
1.197 leot 5670: skipped by the shell. For <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.184 rillig 5671: but other programs may care.</p>
5672: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5673: need to be quoted because the quoting has already been done
5674: when adding elements to the list.</p>
1.1 dsieger 5675: </div>
1.41 asau 5676: <div class="sect2">
1.1 dsieger 5677: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 5678: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5679: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5680: GNU-style configure script (especially those that call other configure
5681: scripts), it must not have leading or trailing whitespace, since
5682: otherwise the configure script gets confused. To trim leading and
5683: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5684: following example:</p>
1.1 dsieger 5685: <pre class="programlisting">
1.184 rillig 5686: CPPFLAGS= # empty
5687: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5688: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 5689:
1.184 rillig 5690: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 5691:
1.184 rillig 5692: all:
5693: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5694: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5695: </pre>
5696: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5697: trailing whitespace because the <code class="code">+=</code> operator always adds a
5698: space.</p>
5699: </div>
5700: <div class="sect2">
5701: <div class="titlepage"><div><div><h3 class="title">
5702: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5703: <p>When a possibly empty variable is used in a shell program, it may
5704: lead to a syntax error.</p>
5705: <pre class="programlisting">
5706: EGFILES= # empty
1.1 dsieger 5707:
1.184 rillig 5708: install-examples: # produces a syntax error in the shell
5709: for egfile in ${EGFILES}; do \
5710: echo "Installing $$egfile"; \
5711: done
5712: </pre>
5713: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.197 leot 5714: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.184 rillig 5715: To fix this syntax error, use one of the snippets below.</p>
5716: <pre class="programlisting">
5717: EMPTY= # empty
1.1 dsieger 5718:
1.184 rillig 5719: install-examples:
5720: for egfile in ${EGFILES} ""; do \
5721: [ -n "$$egfile" ] || continue; \
5722: echo "Installing $$egfile"; \
5723: done
5724: </pre>
5725: <p>In this case, an empty string is appended to the iteration list (to
5726: prevent the syntax error) and filtered out later.</p>
5727: <pre class="programlisting">
5728: EGFILES= # empty
1.1 dsieger 5729:
1.184 rillig 5730: install-examples:
5731: .for egfile in ${EGFILES}
5732: echo "Installing ${egfile}"
5733: .endfor
1.1 dsieger 5734: </pre>
1.184 rillig 5735: <p>If one of the filenames contains special characters, it should be
5736: enclosed in single or double quotes.</p>
5737: <p>To have a shell command test whether a make variable is empty, use
5738: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5739: </div>
5740: </div>
5741: </div>
5742: <div class="chapter">
5743: <div class="titlepage"><div><div><h2 class="title">
5744: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5745: <div class="toc">
5746: <p><b>Table of Contents</b></p>
5747: <dl class="toc">
5748: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5749: <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>
5750: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5751: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5752: </dl>
1.1 dsieger 5753: </div>
1.184 rillig 5754: <p>Many packages have the ability to be built to support different
5755: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5756: in pkgsrc that provides generic handling of those options that
5757: determine different ways in which the packages can be built. It's
5758: possible for the user to specify exactly which sets of options will be
5759: built into a package or to allow a set of global default options
5760: apply.</p>
5761: <p>There are two broad classes of behaviors that one might want to
5762: control via options. One is whether some particular feature is
5763: enabled in a program that will be built anyway, often by including or
5764: not including a dependency on some other package. The other is
5765: whether or not an additional program will be built as part of the
5766: package. Generally, it is better to make a split package for such
5767: additional programs instead of using options, because it enables
5768: binary packages to be built which can then be added separately. For
5769: example, the foo package might have minimal dependencies (those
5770: packages without which foo doesn't make sense), and then the foo-gfoo
5771: package might include the GTK frontend program gfoo. This is better
5772: than including a gtk option to foo that adds gfoo, because either that
5773: option is default, in which case binary users can't get foo without
5774: gfoo, or not default, in which case they can't get gfoo. With split
5775: packages, they can install foo without having GTK, and later decide to
5776: install gfoo (pulling in GTK at that time). This is an advantage to
5777: source users too, avoiding the need for rebuilds.</p>
5778: <p>Plugins with widely varying dependencies should usually be split
5779: instead of options.</p>
5780: <p>It is often more work to maintain split packages, especially if
5781: the upstream package does not support this. The decision of split
5782: vs. option should be made based on the likelihood that users will want
5783: or object to the various pieces, the size of the dependencies that are
5784: included, and the amount of work.</p>
5785: <p>A further consideration is licensing. Non-free parts, or parts
5786: that depend on non-free dependencies (especially plugins) should
5787: almost always be split if feasible.</p>
5788: <div class="sect1">
5789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5790: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5791: <p>Global default options are listed in
5792: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5793: that should be built into every package if that option is supported.
5794: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5795: </div>
1.41 asau 5796: <div class="sect1">
1.1 dsieger 5797: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5798: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5799: </h2></div></div></div>
5800: <p>The following example shows how
5801: <code class="filename">bsd.options.mk</code> should be used
5802: by the hypothetical ``wibble'' package, either in the package
5803: <code class="filename">Makefile</code>, or in a file,
5804: e.g. <code class="filename">options.mk</code>, that is included by the
5805: main package <code class="filename">Makefile</code>.</p>
1.1 dsieger 5806: <pre class="programlisting">
1.184 rillig 5807: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5808: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5809: PKG_OPTIONS_OPTIONAL_GROUPS= database
5810: PKG_OPTIONS_GROUP.database= mysql pgsql
5811: PKG_SUGGESTED_OPTIONS= wibble-foo
5812: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5813: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5814:
5815: .include "../../mk/bsd.prefs.mk"
5816:
5817: # this package was previously named wibble2
5818: .if defined(PKG_OPTIONS.wibble2)
5819: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5820: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5821: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5822: .endif
5823:
5824: .include "../../mk/bsd.options.mk"
5825:
5826: # Package-specific option-handling
1.1 dsieger 5827:
1.184 rillig 5828: ###
5829: ### FOO support
5830: ###
5831: .if !empty(PKG_OPTIONS:Mwibble-foo)
5832: CONFIGURE_ARGS+= --enable-foo
5833: .endif
1.1 dsieger 5834:
1.184 rillig 5835: ###
5836: ### LDAP support
5837: ###
5838: .if !empty(PKG_OPTIONS:Mldap)
5839: . include "../../databases/openldap-client/buildlink3.mk"
5840: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5841: .endif
1.1 dsieger 5842:
1.184 rillig 5843: ###
5844: ### database support
5845: ###
5846: .if !empty(PKG_OPTIONS:Mmysql)
5847: . include "../../mk/mysql.buildlink3.mk"
5848: .endif
5849: .if !empty(PKG_OPTIONS:Mpgsql)
5850: . include "../../mk/pgsql.buildlink3.mk"
5851: .endif
5852: </pre>
5853: <p>The first section contains the information about which build
5854: options are supported by the package, and any default options settings
5855: if needed.</p>
5856: <div class="orderedlist"><ol class="orderedlist" type="1">
5857: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.197 leot 5858: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 5859: options. It should be set to
5860: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5861: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5862: at the point where the options are processed.</p></li>
5863: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
5864: build options supported by the package.</p></li>
5865: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
5866: list of names of groups of mutually exclusive options. The options in
5867: each group are listed in
5868: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5869: The most specific setting of any option from the group takes
5870: precedence over all other options in the group. Options from the
5871: groups will be automatically added to
5872: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
5873: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
5874: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5875: packages will fail if no option from the group is
5876: selected.</p></li>
5877: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
5878: of names of sets of options. At least one option from each set must
5879: be selected. The options in each set are listed in
5880: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5881: Options from the sets will be automatically added to
5882: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5883: fail if no option from the set is selected.</p></li>
5884: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
5885: build options which are enabled by default.</p></li>
5886: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
5887: of
5888: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
5889: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
5890: their option counterparts. Pairs should be added with
5891: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
5892: warning will be issued if the user uses a legacy
5893: variable.</p></li>
5894: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
5895: of
5896: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
5897: pairs that map options that have been renamed to their new
5898: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
5899: the listing of global legacy options. A warning will be issued if
5900: the user uses a legacy option.</p></li>
5901: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
5902: options implied by deprecated variables used. This can be used for
5903: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5904: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5905: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
5906: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
5907: a list of warnings about deprecated variables or options used, and
5908: what to use instead.</p></li>
5909: </ol></div>
5910: <p>A package should never modify
5911: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5912: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5913: To suggest a default set of options, use
5914: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5915: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5916: including <code class="filename">bsd.options.mk</code>. If none of
5917: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5918: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5919: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5920: happen with platform-specific options if none of them is supported on
5921: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5922: empty list and the package is otherwise treated as not using the
5923: options framework.</p>
5924: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5925: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5926: build options, properly filtered to remove unsupported and duplicate
5927: options.</p>
5928: <p>The remaining sections contain the logic that is specific to
5929: each option. The correct way to check for an option is to check
5930: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5931: <pre class="programlisting">
5932: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.1 dsieger 5933: </pre>
5934: </div>
1.184 rillig 5935: <div class="sect1">
5936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5937: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
5938: <p>Options that enable similar features in different packages (like
5939: optional support for a library) should use a common name in all
5940: packages that support it (like the name of the library). If another
5941: package already has an option with the same meaning, use the same
5942: name.</p>
5943: <p>Options that enable features specific to one package, where it's
5944: unlikely that another (unrelated) package has the same (or a similar)
5945: optional feature, should use a name prefixed with
5946: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5947: <p>If a group of related packages share an optional feature
5948: specific to that group, prefix it with the name of the
5949: <span class="quote">“<span class="quote">main</span>”</span> package
5950: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5951: <p>For new options, add a line to
5952: <code class="filename">mk/defaults/options.description</code>. Lines have two
5953: fields, separated by tab. The first field is the option name, the
5954: second its description. The description should be a whole sentence
5955: (starting with an uppercase letter and ending with a period) that
5956: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5957: support.</span>”</span> The file is sorted by option names.</p>
5958: </div>
5959: <div class="sect1">
5960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5961: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
5962: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
5963: different dependencies based on the options with which the package was
5964: built. For querying these options, the file
5965: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5966: typical example looks like this:</p>
1.1 dsieger 5967: <pre class="programlisting">
1.184 rillig 5968: pkgbase := libpurple
5969: .include "../../mk/pkg-build-options.mk"
5970:
5971: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5972: ...
5973: .endif
1.117 sevan 5974: </pre>
1.184 rillig 5975: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5976: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5977: options of the libpurple package, which can then be queried like
5978: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5979: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5980: details.</p>
1.1 dsieger 5981: </div>
5982: </div>
1.41 asau 5983: <div class="chapter">
1.1 dsieger 5984: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 5985: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 5986: <div class="toc">
5987: <p><b>Table of Contents</b></p>
1.100 leot 5988: <dl class="toc">
1.184 rillig 5989: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
5990: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
5991: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 5992: </dl>
5993: </div>
1.184 rillig 5994: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
5995: by pkgsrc and also for individual packages to define what commands
5996: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
5997: or for later run-time of an installed packaged (such as
5998: <code class="varname">DEPENDS</code>).
5999: If the native system provides an adequate tool, then in many cases, a pkgsrc
6000: package will not be used.</p>
6001: <p>When building a package, the replacement tools are
6002: made available in a directory (as symlinks or wrapper scripts)
6003: that is early in the executable search path. Just like the buildlink
6004: system, this helps with consistent builds.</p>
6005: <p>A tool may be needed to help build a specific package. For example,
6006: perl, GNU make (gmake) or yacc may be needed.</p>
6007: <p>Also a tool may be needed, for example, because the native system's supplied
6008: tool may be inefficient for building a package with pkgsrc.
6009: For example, a package may need GNU awk, bison (instead of
6010: yacc) or a better sed.</p>
6011: <p>The tools used by a package can be listed by running
6012: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6013: <div class="sect1">
1.1 dsieger 6014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6015: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6016: <p>The default set of tools used by pkgsrc is defined in
6017: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6018: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6019: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6020: These can be seen by running:
6021: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6022: <p>If a package needs a specific program to build
6023: then the <code class="varname">USE_TOOLS</code> variable can be used
6024: to define the tools needed.</p>
1.1 dsieger 6025: </div>
1.184 rillig 6026: <div class="sect1">
6027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6028: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6029: <p>In the following examples, the :run means that it is needed at
6030: run-time (and becomes a DEPENDS).
6031: The default is a build dependency which can be set with
6032: :build. (So in this example, it is the same as gmake:build
6033: and pkg-config:build.)</p>
1.1 dsieger 6034: <pre class="programlisting">
1.184 rillig 6035: USE_TOOLS+= gmake perl:run pkg-config
1.1 dsieger 6036: </pre>
1.184 rillig 6037: <p>When using the tools framework, a
6038: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6039: which contains the full path to the appropriate tool. For example,
6040: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6041: on Linux systems.</p>
6042: <p>If you always need a pkgsrc version of the
6043: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6044: </p>
1.1 dsieger 6045: </div>
1.184 rillig 6046: <div class="sect1">
6047: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6048: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6049: <p>When improving or porting pkgsrc to a new platform, have a look
6050: at (or create) the corresponding platform specific make file fragment under
6051: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6052: the name of the common tools. For example:</p>
1.1 dsieger 6053: <pre class="programlisting">
1.184 rillig 6054: .if exists(/usr/bin/bzcat)
6055: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6056: .elif exists(/usr/bin/bzip2)
6057: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6058: .endif
6059:
6060: TOOLS_PLATFORM.true?= true # shell builtin
1.1 dsieger 6061: </pre>
6062: </div>
6063: </div>
1.184 rillig 6064: <div class="chapter">
6065: <div class="titlepage"><div><div><h2 class="title">
6066: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6067: <div class="toc">
6068: <p><b>Table of Contents</b></p>
6069: <dl class="toc">
6070: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6071: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6072: <dd><dl>
6073: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6074: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6075: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6076: and
6077: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6078: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6079: </dl></dd>
6080: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
6081: <dd><dl>
6082: <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>
6083: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
6084: </dl></dd>
6085: </dl>
1.1 dsieger 6086: </div>
1.184 rillig 6087: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6088: are seen by a package's configure and build processes. This is implemented
6089: in a two step process:</p>
6090: <div class="orderedlist"><ol class="orderedlist" type="1">
6091: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6092: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6093: of <code class="varname">WRKDIR</code>.</p></li>
6094: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6095: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6096: <code class="option">-L${LOCALBASE}/lib</code> into references to
6097: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6098: native compiler on some operating systems look like GCC, so that
6099: packages that expect GCC won't require modifications to build with
6100: those native compilers.</p></li>
6101: </ol></div>
6102: <p>This normalizes the environment in which a package is built so that the
6103: package may be built consistently despite what other software may be
6104: installed. Please note that the normal system header and library paths,
6105: e.g. <code class="filename">/usr/include</code>,
6106: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6107: designed to insulate the package build from non-system-supplied
6108: software.</p>
1.41 asau 6109: <div class="sect1">
1.1 dsieger 6110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6111: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6112: <p>The process of converting packages to use the buildlink3
6113: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6114: The things to keep in mind are:</p>
1.23 wiz 6115: <div class="orderedlist"><ol class="orderedlist" type="1">
1.184 rillig 6116: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6117: instead of the actual toolchain. Some packages are tricky,
6118: and the only way to know for sure is the check
6119: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6120: wrappers are being invoked.</p></li>
6121: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6122: the package Makefile, e.g. Java VMs, standalone shells,
6123: etc., because the code to symlink files into
6124: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6125: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6126: </p></li>
6127: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6128: <code class="filename">buildlink3.mk</code> files that you list in a
6129: package's Makefile are added as dependencies for that package.
6130: </p></li>
6131: </ol></div>
6132: <p>If a dependency on a particular package is required for its libraries and
6133: headers, then we replace:</p>
6134: <pre class="programlisting">
6135: DEPENDS+= foo>=1.1.0:../../category/foo
6136: </pre>
6137: <p>with</p>
6138: <pre class="programlisting">
6139: .include "../../category/foo/buildlink3.mk"
6140: </pre>
6141: <p>The buildlink3.mk files usually define the required dependencies.
6142: If you need a newer version of the dependency when using buildlink3.mk
6143: files, then you can define it in your Makefile; for example:</p>
1.1 dsieger 6144: <pre class="programlisting">
1.184 rillig 6145: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6146: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 6147: </pre>
1.184 rillig 6148: <p>There are several <code class="filename">buildlink3.mk</code>
6149: files in <code class="filename">pkgsrc/mk</code>
6150: that handle special package issues:</p>
6151: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6152: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6153: the native or a pkgsrc Berkeley DB implementation based on
6154: the values of <code class="varname">BDB_ACCEPTED</code> and
6155: <code class="varname">BDB_DEFAULT</code>.</p></li>
6156: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6157: comes with neither Curses nor NCurses, this will take care
6158: to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
6159: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6160: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6161: adding a dependency on Heimdal or MIT-krb5 for packages that
6162: require a Kerberos 5 implementation.</p></li>
6163: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6164: system-provided Motif installation or adds a dependency on
6165: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
6166: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6167: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6168: to choose which Motif version will be used.</p></li>
6169: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6170: system-provided GNU readline or editline (libedit) installation,
6171: or adds a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
6172: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
6173: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6174: If your package really needs GNU readline library, its Makefile
6175: should include <code class="filename">devel/readline/buildlink3.mk</code>
6176: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6177: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6178: variables that may be used by packages that use the
6179: Open Sound System (OSS) API.</p></li>
6180: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6181: any of the Postgres versions in the variable
6182: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6183: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6184: the file for more information.</p></li>
6185: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6186: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
6187: a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
6188: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6189: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6190: library.</p></li>
6191: </ul></div>
6192: <p>The comments in those <code class="filename">buildlink3.mk</code>
6193: files provide a more complete
6194: description of how to use them properly.</p>
1.1 dsieger 6195: </div>
1.41 asau 6196: <div class="sect1">
1.1 dsieger 6197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6198: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6199: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6200: included by Makefiles to indicate the need to compile and link
6201: against header files and libraries provided by the package. A
6202: <code class="filename">buildlink3.mk</code> file should always provide
6203: enough information to add the correct type of dependency
6204: relationship and include any other
6205: <code class="filename">buildlink3.mk</code> files that it needs to find
6206: headers and libraries that it needs in turn.</p>
6207: <p>To generate an initial <code class="filename">buildlink3.mk</code>
6208: file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
6209: package is highly recommended. For most packages, the following
6210: command will generate a good starting point for
6211: <code class="filename">buildlink3.mk</code> files:</p>
6212: <pre class="screen">
6213: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6214: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6215: </pre>
1.41 asau 6216: <div class="sect2">
1.1 dsieger 6217: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6218: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6219: <p>The following real-life example
6220: <code class="filename">buildlink3.mk</code> is taken
6221: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.1 dsieger 6222: <pre class="programlisting">
1.184 rillig 6223: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
6224:
6225: BUILDLINK_TREE+= tiff
6226:
6227: .if !defined(TIFF_BUILDLINK3_MK)
6228: TIFF_BUILDLINK3_MK:=
6229:
6230: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6231: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6232: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6233:
6234: .include "../../devel/zlib/buildlink3.mk"
6235: .include "../../graphics/jpeg/buildlink3.mk"
6236: .endif # TIFF_BUILDLINK3_MK
6237:
6238: BUILDLINK_TREE+= -tiff
1.1 dsieger 6239: </pre>
1.184 rillig 6240: <p>The header and footer manipulate
6241: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6242: <code class="filename">buildlink3.mk</code> files and is used to track
6243: the dependency tree.</p>
6244: <p>The main section is protected from multiple inclusion
6245: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6246: added. Several important variables are set in the section:</p>
6247: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6248: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6249: is the dependency version recorded in the installed
1.184 rillig 6250: package; this should always be set using
6251: <span class="command"><strong>+=</strong></span> to ensure that
6252: we're appending to any pre-existing list of values. This
1.185 wiz 6253: variable should be set to the last version of the
1.184 rillig 6254: package that had an backwards-incompatible API change.
6255: </p></li>
6256: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6257: is the location of the <em class="replaceable"><code>pkg</code></em>
6258: pkgsrc directory.</p></li>
6259: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6260: (not shown above) controls whether we use
6261: <code class="varname">BUILD_DEPENDS</code> or
6262: <code class="varname">DEPENDS</code> to add the dependency on
6263: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6264: selected by setting
6265: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6266: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
6267: used.</p></li>
6268: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6269: and
6270: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6271: (not shown above) are lists of subdirectories of
6272: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6273: to add to the header and library search paths. These
6274: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6275: respectively.</p></li>
6276: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6277: (not shown above) is the list of preprocessor flags to add
6278: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6279: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6280: should be avoided and instead be handled using
6281: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6282: above.</p></li>
6283: </ul></div>
6284: <p>The following variables are all optionally defined within
6285: this second section (protected against multiple inclusion) and
6286: control which package files are symlinked into
6287: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6288: transformed during the symlinking:</p>
6289: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6290: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6291: (not shown above) is a shell glob pattern relative to
6292: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6293: to be symlinked into
6294: <code class="filename">${BUILDLINK_DIR}</code>,
6295: e.g. <code class="filename">include/*.h</code>.</p></li>
6296: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6297: (not shown above) is a shell pipeline that
6298: outputs to stdout a list of files relative to
6299: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6300: The resulting files are to be symlinked
6301: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6302: this takes the <code class="filename">+CONTENTS</code> of a
6303: <em class="replaceable"><code>pkg</code></em> and filters it through
6304: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6305: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6306: (not shown above) is a filter command that filters
6307: <code class="filename">+CONTENTS</code> input into a list of files
6308: relative to
6309: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6310: on stdout. By default,
6311: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6312: outputs the contents of the <code class="filename">include</code>
6313: and <code class="filename">lib</code> directories in the package
6314: <code class="filename">+CONTENTS</code>.</p></li>
6315: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6316: (not shown above) is a list of sed arguments used to
6317: transform the name of the source filename into a
6318: destination filename, e.g. <span class="command"><strong>-e
6319: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6320: </ul></div>
6321: <p>This section can additionally include any
6322: <code class="filename">buildlink3.mk</code> needed for
6323: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6324: Including these <code class="filename">buildlink3.mk</code> files
6325: means that the headers and libraries for these
6326: dependencies are also symlinked into
6327: <code class="filename">${BUILDLINK_DIR}</code>
6328: whenever the <em class="replaceable"><code>pkg</code></em>
6329: <code class="filename">buildlink3.mk</code>
6330: file is included. Dependencies are only added for directly
6331: include <code class="filename">buildlink3.mk</code> files.</p>
6332: <p>When providing a <code class="filename">buildlink3.mk</code> and
6333: including other <code class="filename">buildlink3.mk</code> files in it,
6334: please only add necessary ones, i.e., those whose libraries or
6335: header files are automatically exposed when the package is
6336: use.</p>
6337: <p>In particular, if only an executable
6338: (<code class="filename">bin/foo</code>) is linked against a library, that
6339: library does not need to be propagated in the
6340: <code class="filename">buildlink3.mk</code> file.</p>
6341: <p>The following steps should help you decide if a
6342: <code class="filename">buildlink3.mk</code> file needs to be included:
6343: </p>
6344: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6345: <li class="listitem"><p>Look at the installed header files: What
6346: headers do they include? The packages providing these files
6347: must be buildlinked.</p></li>
6348: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6349: libraries and look against what other libraries they link.
6350: Some of the packages providing these probably need to be
6351: buildlinked; however, it's not automatic, since e.g. GTK on
6352: some systems pulls in the X libraries, so they will show up in
6353: the <code class="filename">ldd</code> output, while on others (like OS
6354: X) it won't. <code class="filename">ldd</code> output can thus only be
6355: used as a hint.</p></li>
6356: </ul></div>
6357: <p>
6358: </p>
6359: </div>
1.41 asau 6360: <div class="sect2">
1.1 dsieger 6361: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6362: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6363: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6364: and
6365: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6366: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.185 wiz 6367: <p>Both variables set lower bounds for a version of this package.
6368: The two variables differ in that one describes source
1.184 rillig 6369: compatibility (API) and the other binary compatibility (ABI).
6370: The difference is that a change in the API breaks compilation of
6371: programs while changes in the ABI stop compiled programs from
6372: running.</p>
1.185 wiz 6373: <p>The
6374: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6375: variable in a <code class="filename">buildlink3.mk</code> should be
6376: changed very rarely. (One possible scenario: If all packages
6377: using this package need a higher version than defined in the
6378: <code class="filename">buildlink3.mk</code>,
1.184 rillig 6379: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6380: could be updated to that higher version.)</p>
6381: <p>On the other hand, changes to
1.184 rillig 6382: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6383: are more common. The variable will need to be updated every
6384: time the major version of one of its shared libraries is changed,
6385: or any other change where a binary built against the previous
6386: version of the package will not run against the new version any
6387: longer.</p>
6388: <p>In such a case, the package's
1.184 rillig 6389: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6390: must be increased to require the new package version. Then the
6391: <code class="varname">PKGREVISION</code> of all packages
6392: <em class="replaceable"><code>foo</code></em> that depend on this package need
6393: to be increased, and if they have
6394: <code class="filename">buildlink3.mk</code> files,
6395: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6396: in their <code class="filename">buildlink3.mk</code> files must be
6397: increased to the new version as well. This is required so that a
6398: package will pull in the versions of the packages that use the
6399: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6400: uniquely identify the packages built against the new ABI. The
6401: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/revbump/README.html" target="_top"><code class="filename">pkgtools/revbump</code></a> package can
6402: help with these updates.</p>
6403: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6404: about dependencies on other packages, including the
6405: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.184 rillig 6406: <p>Please take careful consideration before adjusting
6407: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6408: or
6409: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6410: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6411: cause unneeded package deletions and rebuilds. In many cases,
6412: new versions of packages work just fine with older
6413: dependencies.</p>
1.184 rillig 6414: <p>Also it is not needed to set
6415: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6416: when it is identical to
6417: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.1 dsieger 6418: </div>
6419: </div>
1.41 asau 6420: <div class="sect1">
1.1 dsieger 6421: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6422: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6423: <p>Some packages in pkgsrc install headers and libraries that
6424: coincide with headers and libraries present in the base system.
6425: Aside from a <code class="filename">buildlink3.mk</code> file, these
6426: packages should also include a <code class="filename">builtin.mk</code>
6427: file that includes the necessary checks to decide whether using
6428: the built-in software or the pkgsrc software is
6429: appropriate.</p>
6430: <p>The only requirements of a builtin.mk file for
6431: <em class="replaceable"><code>pkg</code></em> are:</p>
6432: <div class="orderedlist"><ol class="orderedlist" type="1">
6433: <li class="listitem"><p>It should set
6434: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6435: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6436: after it is included.</p></li>
6437: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6438: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6439: which is already set before the
6440: <code class="filename">builtin.mk</code> file is included.</p></li>
6441: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6442: is <span class="emphasis"><em>very</em></span> important and takes careful
6443: attention to <code class="filename">Makefile</code> coding.</p></li>
6444: </ol></div>
6445: <div class="sect2">
6446: <div class="titlepage"><div><div><h3 class="title">
6447: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6448: <p>The following is the recommended template for builtin.mk
6449: files:</p>
1.1 dsieger 6450: <pre class="programlisting">
1.184 rillig 6451: .if !defined(IS_BUILTIN.foo)
6452: #
6453: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6454: # genuinely exists in the system or not.
6455: #
6456: IS_BUILTIN.foo?= no
1.1 dsieger 6457:
1.184 rillig 6458: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6459: # version can be determined.
6460: #
6461: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6462: BUILTIN_PKG.foo?= foo-1.0
6463: . endif
6464: .endif # IS_BUILTIN.foo
1.1 dsieger 6465:
1.184 rillig 6466: .if !defined(USE_BUILTIN.foo)
6467: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6468: . if defined(BUILTIN_PKG.foo)
6469: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6470: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6471: USE_BUILTIN.foo!= \
6472: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6473: && ${ECHO} "yes" || ${ECHO} "no"
6474: . endif
6475: . endfor
6476: . endif
6477: .endif # USE_BUILTIN.foo
1.1 dsieger 6478:
1.184 rillig 6479: CHECK_BUILTIN.foo?= no
6480: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6481: #
6482: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6483: # "yes" or "no".
6484: #
6485: .endif # CHECK_BUILTIN.foo
1.1 dsieger 6486: </pre>
1.184 rillig 6487: <p>The first section sets
6488: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6489: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6490: in the base system. This should not be a base system software
6491: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6492: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6493: included as part of the base system. This variable is only
6494: used internally within the <code class="filename">builtin.mk</code>
6495: file.</p>
6496: <p>The second section sets
6497: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6498: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6499: system if it exists (if
6500: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6501: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6502: within the <code class="filename">builtin.mk</code> file.</p>
6503: <p>The third section sets
6504: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6505: and is <span class="emphasis"><em>required</em></span> in all
6506: <code class="filename">builtin.mk</code> files. The code in this
6507: section must make the determination whether the built-in
6508: software is adequate to satisfy the dependencies listed in
6509: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6510: This is typically done by comparing
6511: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6512: against each of the dependencies in
6513: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6514: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6515: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6516: end of the <code class="filename">builtin.mk</code> file. Note that
6517: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6518: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6519: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6520: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6521: that the built-in version of the software is similar enough to
6522: be used as a replacement.</p>
6523: <p>The last section is guarded by
6524: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6525: and includes code that uses the value of
6526: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6527: set in the previous section. This typically includes, e.g.,
6528: adding additional dependency restrictions and listing additional
6529: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6530: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6531: </div>
6532: <div class="sect2">
6533: <div class="titlepage"><div><div><h3 class="title">
6534: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
6535: <p>When building packages, it's possible to choose whether to set
6536: a global preference for using either the built-in (native)
6537: version or the pkgsrc version of software to satisfy a
6538: dependency. This is controlled by setting
6539: <code class="varname">PREFER_PKGSRC</code> and
6540: <code class="varname">PREFER_NATIVE</code>. These variables take values
6541: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
6542: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
6543: use the pkgsrc versions of software, while
6544: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
6545: built-in versions. Preferences are determined by the most
6546: specific instance of the package in either
6547: <code class="varname">PREFER_PKGSRC</code> or
6548: <code class="varname">PREFER_NATIVE</code>. If a package is specified
6549: in neither or in both variables, then
6550: <code class="varname">PREFER_PKGSRC</code> has precedence over
6551: <code class="varname">PREFER_NATIVE</code>. For example, to require
6552: using pkgsrc versions of software for all but the most basic
6553: bits on a NetBSD system, you can set:</p>
1.1 dsieger 6554: <pre class="programlisting">
1.184 rillig 6555: PREFER_PKGSRC= yes
6556: PREFER_NATIVE= getopt skey tcp_wrappers
6557: </pre>
6558: <p>A package <span class="emphasis"><em>must</em></span> have a
6559: <code class="filename">builtin.mk</code>
6560: file to be listed in <code class="varname">PREFER_NATIVE</code>,
6561: otherwise it is simply ignored in that list.</p>
1.191 bacon 6562: <p><code class="varname">PREFER_PKGSRC</code> and
6563: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
6564: to ensure that the bootstrap process does not use inapropriate
6565: native tools as dependencies for core packages.
6566:
6567: </p>
6568: <pre class="screen">
6569: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
6570: </pre>
6571: <p>
6572:
1.184 rillig 6573: Switching between settings globally at a later date can introduce
6574: complications with dependency resolution. This is caused by packages
1.191 bacon 6575: built with the opposite preference being installed alongside each
6576: other. Hence, any changes to these variables after bootstrap will
6577: necessitate rebuilding all packages depending on one whose preference
6578: has been changed. This is not trivial and should be avoided.</p>
6579: <p>When using pkgsrc on Linux systems, there is high risk of
6580: "leakage", where programs installed by pkgsrc may inadvertently use a
6581: command or library not installed by pkgsrc, e.g. those installed by
6582: yum or apt. Such foreign dependencies may be installed, removed, or
6583: upgraded to a version incompatible with the pkgsrc package at any
6584: time, causing pkgsrc packages to subsequently malfunction. Pkgsrc
6585: cannot prevent this, as it has no control over other package managers.
6586: Another potential problem is that under Redhat Enterprise and related
6587: Linux systems, yum packages are only patched and never upgraded, so
6588: eventually they may become too outdated for use by pkgsrc. Even
6589: intentionally using foreign dependencies, not considered leakage, can
6590: lead to these problems, so it is generally discouraged. In order to
6591: minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
6592: This ensures that pkgsrc is aware of any changes to dependency packages
6593: and can rebuild or upgrade the entire dependency tree as needed. This
6594: default can be overridden by setting --prefer-pkgsrc to "no" or a list of
6595: packages, or by setting --prefer-native to "yes".</p>
1.1 dsieger 6596: </div>
1.7 rillig 6597: </div>
1.1 dsieger 6598: </div>
1.41 asau 6599: <div class="chapter">
1.1 dsieger 6600: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 6601: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.1 dsieger 6602: <div class="toc">
6603: <p><b>Table of Contents</b></p>
1.100 leot 6604: <dl class="toc">
1.184 rillig 6605: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6606: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6607: <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>
6608: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6609: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6610: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6611: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6612: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6613: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 6614: </dl>
6615: </div>
1.184 rillig 6616: <p>The <code class="filename">PLIST</code> file contains a package's
6617: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6618: the package (relative to the <code class="filename">${PREFIX}</code>
6619: directory it's been installed in) plus some additional statements
1.197 leot 6620: - see the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 6621: This chapter addresses some issues that need attention when
6622: dealing with the <code class="filename">PLIST</code> file (or files, see
6623: below!).</p>
1.41 asau 6624: <div class="sect1">
1.1 dsieger 6625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6626: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6627: <p>Be sure to add a RCS ID line as the first thing in any
6628: <code class="filename">PLIST</code> file you write:</p>
6629: <pre class="programlisting">
6630: @comment $NetBSD $
6631: </pre>
6632: <p>An artificial space has been added between NetBSD and $, this is a
6633: workaround here to prevent CVS expanding to the filename of the guide. When
6634: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6635: </div>
1.41 asau 6636: <div class="sect1">
1.1 dsieger 6637: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6638: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6639: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6640: to output a PLIST that matches any new files since the package
6641: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6642: more information on this target.</p>
1.1 dsieger 6643: </div>
1.41 asau 6644: <div class="sect1">
1.1 dsieger 6645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6646: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6647: </h2></div></div></div>
6648: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6649: of AWK patterns and actions that are used to filter the output of
6650: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6651: scripting you like to it, but be careful with quoting.</p>
6652: <p>For example, to get all files inside the
6653: <code class="filename">libdata/foo</code> directory removed from the
6654: resulting PLIST:</p>
1.1 dsieger 6655: <pre class="programlisting">
1.184 rillig 6656: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 6657: </pre>
1.185 wiz 6658: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6659: evaluated after the file list and directory list are sorted.
6660: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6661: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6662: list and directory list are sorted.</p>
1.184 rillig 6663: </div>
6664: <div class="sect1">
6665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6666: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6667: <p>A number of variables are substituted automatically in
6668: PLISTs when a package is installed on a system. This includes the
6669: following variables:</p>
6670: <div class="variablelist"><dl class="variablelist">
6671: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6672: <dd>
6673: <p>Some packages like emacs and perl embed information
6674: about which architecture they were built on into the
6675: pathnames where they install their files. To handle this
6676: case, PLIST will be preprocessed before actually used, and
6677: the symbol
6678: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6679: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6680: same is done if the string
6681: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6682: PLIST somewhere - use this on packages that have GNU
6683: autoconf-created configure scripts.</p>
6684: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6685: <h3 class="title">Legacy note</h3>
6686: <p>There used to be a symbol
6687: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6688: was replaced by the output of <span class="command"><strong>uname
6689: -m</strong></span>, but that's no longer supported and has
6690: been removed.</p>
6691: </div>
6692: </dd>
6693: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6694: <dd>
6695: <p>Some packages want to embed the OS name and version
6696: into some paths. To do this, use these variables in the
6697: <code class="filename">PLIST</code>:
6698: </p>
6699: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6700: <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>
6701: <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>
6702: <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>
6703: </ul></div>
6704: </dd>
6705: </dl></div>
6706: <p>For a list of values which are replaced by
6707: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6708: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6709: <code class="varname">PLIST_SUBST</code> should help.</p>
6710: <p>If you want to change other variables not listed above, you
6711: can add variables and their expansions to this variable in the
6712: 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 6713: <pre class="programlisting">
1.184 rillig 6714: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 6715: </pre>
1.184 rillig 6716: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6717: in the <code class="filename">PLIST</code> with
6718: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6719: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6720: the common case of conditionally including some
6721: <code class="filename">PLIST</code> entries. It can be done by adding
6722: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6723: setting the corresponding <code class="varname">PLIST.foo</code> variable
6724: to <code class="literal">yes</code> if the entry should be included.
6725: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6726: in the <code class="filename">PLIST</code> with either
6727: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6728: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6729: For example, in <code class="filename">Makefile</code>:</p>
1.66 asau 6730: <pre class="programlisting">
1.184 rillig 6731: PLIST_VARS+= foo
6732: .if <em class="replaceable"><code>condition</code></em>
6733: PLIST.foo= yes
6734: .else
1.66 asau 6735: </pre>
1.184 rillig 6736: <p>And then in <code class="filename">PLIST</code>:</p>
1.1 dsieger 6737: <pre class="programlisting">
1.184 rillig 6738: @comment $NetBSD $
6739: bin/bar
6740: man/man1/bar.1
6741: ${PLIST.foo}bin/foo
6742: ${PLIST.foo}man/man1/foo.1
6743: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 6744: </pre>
1.184 rillig 6745: <p>An artificial space has been added between NetBSD and $, this is a
6746: workaround here to prevent CVS expanding to the filename of the guide. When
1.195 gutterid 6747: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6748: </div>
1.184 rillig 6749: <div class="sect1">
6750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6751: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6752: <p>Man pages should be installed in compressed form if
6753: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6754: and uncompressed otherwise. To handle this in the
6755: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6756: appended/removed automatically for man pages according to
6757: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6758: or not, see above for details. This modification of the
6759: <code class="filename">PLIST</code> file is done on a copy of it, not
6760: <code class="filename">PLIST</code> itself.</p>
1.1 dsieger 6761: </div>
1.41 asau 6762: <div class="sect1">
1.1 dsieger 6763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6764: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6765: </h2></div></div></div>
6766: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6767: in generating the binary package, set the variable
6768: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.197 leot 6769: The files are later concatenated using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.184 rillig 6770: important. The default for <code class="varname">PLIST_SRC</code> is
6771: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.1 dsieger 6772: </div>
1.41 asau 6773: <div class="sect1">
1.1 dsieger 6774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6775: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6776: <p>Some packages decide to install a different set of files based on
6777: the operating system being used. These differences can be
6778: automatically handled by using the following files:</p>
6779: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6780: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6781: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6782: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6783: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6784: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6785: </ul></div>
1.1 dsieger 6786: </div>
1.41 asau 6787: <div class="sect1">
1.1 dsieger 6788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6789: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6790: <p>Some packages decide to generate hard-to-guess file names
6791: during installation that are hard to wire down.</p>
6792: <p>In such cases, you can set the
6793: <code class="varname">GENERATE_PLIST</code> variable to shell code
6794: terminated (with a semicolon) that will output PLIST entries which
6795: will be appended to the PLIST</p>
6796: <p>You can find one example in editors/xemacs:</p>
6797: <pre class="programlisting">
6798: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6799: </pre>
6800: <p>which will append something like
6801: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6802: <code class="filename">PLIST</code>.
6803: </p>
1.1 dsieger 6804: </div>
1.41 asau 6805: <div class="sect1">
1.1 dsieger 6806: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6807: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6808: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6809: multiple (and unrelated) packages install files. These
6810: directories were problematic because you had to add special
6811: tricks in the PLIST to conditionally remove them, or have some
6812: centralized package handle them.</p>
6813: <p>In pkgsrc, it is now easy: Each package should create
6814: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6815: will remove any directories left empty after uninstalling a
6816: package.</p>
6817: <p>If a package needs an empty directory to work, create
6818: the directory during installation as usual, and also add an
6819: entry to the PLIST:
6820:
6821: </p>
6822: <pre class="programlisting">
6823: @pkgdir path/to/empty/directory
6824: </pre>
6825: <p>
6826:
6827: or take a look at <code class="varname">MAKE_DIRS</code> and
6828: <code class="varname">OWN_DIRS</code>.
1.1 dsieger 6829: </p>
6830: </div>
1.184 rillig 6831: </div>
6832: <div class="chapter">
6833: <div class="titlepage"><div><div><h2 class="title">
6834: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6835: <div class="toc">
6836: <p><b>Table of Contents</b></p>
6837: <dl class="toc">
6838: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6839: <dd><dl>
6840: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6841: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6842: </dl></dd>
6843: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6844: <dd><dl>
6845: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6846: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
6847: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
6848: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
6849: </dl></dd>
6850: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6851: <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>
6852: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6853: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6854: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6855: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6856: <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>
6857: </dl>
6858: </div>
6859: <p>This chapter describes the framework known as
6860: <code class="literal">pkginstall</code>, whose key features are:</p>
6861: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6862: <li class="listitem"><p>Generic installation and manipulation of directories and files
6863: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6864: <li class="listitem"><p>Automatic handling of configuration files during installation,
6865: provided that packages are correctly designed.</p></li>
6866: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6867: <li class="listitem"><p>Registration of system users and groups.</p></li>
6868: <li class="listitem"><p>Registration of system shells.</p></li>
6869: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6870: </ul></div>
6871: <p>The following sections inspect each of the above points in detail.</p>
6872: <p>You may be thinking that many of the things described here could be
6873: easily done with simple code in the package's post-installation target
6874: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6875: as the code in them is only executed when building from source. Machines
6876: using binary packages could not benefit from it at all (as the code itself
6877: could be unavailable). Therefore, the only way to achieve any of the items
6878: described above is by means of the installation scripts, which are
6879: automatically generated by pkginstall.</p>
1.41 asau 6880: <div class="sect1">
1.1 dsieger 6881: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6882: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6883: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6884: of files and directories that belong to a package. The names used in it
6885: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6886: which means that it cannot register files outside this directory (absolute
6887: path names are not allowed). Despite this restriction, some packages need
6888: to install files outside this location; e.g., under
6889: <code class="filename">${VARBASE}</code> or
6890: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6891: is to create such files during installation time by using
6892: installation scripts.</p>
6893: <p>The generic installation scripts are shell scripts that can
6894: contain arbitrary code. The list of scripts to execute is taken from
6895: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6896: <code class="filename">INSTALL</code>. A similar variable exists for package
6897: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6898: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6899: commands, so they have the potential to create and manage files
6900: anywhere in the file system.</p>
6901: <p>Using these general installation files is not recommended, but
6902: may be needed in some special cases. One reason for avoiding them is
6903: that the user has to trust the packager that there is no unwanted or
6904: simply erroneous code included in the installation script. Also,
6905: previously there were many similar scripts for the same functionality,
6906: and fixing a common error involved finding and changing all of
6907: them.</p>
6908: <p>The pkginstall framework offers another, standardized way. It
6909: provides generic scripts to abstract the manipulation of such files
6910: and directories based on variables set in the package's
6911: <code class="filename">Makefile</code>. The rest of this section describes
6912: these variables.</p>
6913: <div class="sect2">
6914: <div class="titlepage"><div><div><h3 class="title">
6915: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
6916: <p>The following variables can be set to request the creation of
6917: directories anywhere in the file system:</p>
6918: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6919: <li class="listitem">
6920: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
6921: contain a list of directories that should be created and should attempt
6922: to be destroyed by the installation scripts. The difference between
6923: the two is that the latter prompts the administrator to remove any
6924: directories that may be left after deinstallation (because they were
6925: not empty), while the former does not. Example:</p>
6926: <pre class="programlisting">
6927: MAKE_DIRS+= ${VARBASE}/foo/private
6928: </pre>
6929: </li>
6930: <li class="listitem">
6931: <p><code class="varname">MAKE_DIRS_PERMS</code> and
6932: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
6933: which directories should be created and should attempt to be destroyed
6934: by the installation scripts. Each tuple holds the following values,
6935: separated by spaces: the directory name, its owner, its group and its
6936: numerical mode. For example:</p>
6937: <pre class="programlisting">
6938: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
6939: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
6940: </pre>
6941: <p>The difference between the two is exactly the same as their
6942: non-<code class="varname">PERMS</code> counterparts.</p>
6943: </li>
6944: </ul></div>
1.1 dsieger 6945: </div>
1.184 rillig 6946: <div class="sect2">
6947: <div class="titlepage"><div><div><h3 class="title">
6948: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
6949: <p>Creating non-empty files outside the installation prefix is tricky
6950: because the <code class="filename">PLIST</code> forces all files to be inside it.
6951: To overcome this problem, the only solution is to extract the file in the
6952: known place (i.e., inside the installation prefix) and copy it to the
6953: appropriate location during installation (done by the installation scripts
6954: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
6955: file</em></span> in the following paragraphs, which describe the variables
6956: that can be used to automatically and consistently handle files outside the
6957: installation prefix:</p>
6958: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6959: <li class="listitem">
6960: <p><code class="varname">CONF_FILES</code> and
6961: <code class="varname">REQD_FILES</code> are pairs of master and target files.
6962: During installation time, the master file is copied to the target one
6963: if and only if the latter does not exist. Upon deinstallation, the
6964: target file is removed provided that it was not modified by the
6965: installation.</p>
6966: <p>The difference between the two is that the latter prompts the
6967: administrator to remove any files that may be left after
6968: deinstallation (because they were not empty), while the former does
6969: not.</p>
6970: </li>
6971: <li class="listitem">
6972: <p><code class="varname">CONF_FILES_PERMS</code> and
6973: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
6974: files as well as their target locations. For each of them, it also
6975: specifies their owner, their group and their numeric permissions, in
6976: this order. For example:</p>
1.1 dsieger 6977: <pre class="programlisting">
1.184 rillig 6978: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
6979: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 6980: </pre>
1.184 rillig 6981: <p>The difference between the two is exactly the same as their
6982: non-<code class="varname">PERMS</code> counterparts.</p>
6983: </li>
6984: </ul></div>
6985: </div>
1.1 dsieger 6986: </div>
1.41 asau 6987: <div class="sect1">
1.1 dsieger 6988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6989: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
6990: <p>Configuration files are special in the sense that they are installed
6991: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
6992: need special treatment during installation (most of which is automated by
6993: pkginstall). The main concept you must bear in mind is that files marked
6994: as configuration files are automatically copied to the right place (somewhere
6995: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
6996: and only if</em></span> they didn't exist before. Similarly, they will not
6997: be removed if they have local modifications. This ensures that
6998: administrators never lose any custom changes they may have made.</p>
6999: <div class="sect2">
7000: <div class="titlepage"><div><div><h3 class="title">
7001: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7002: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7003: specifies where configuration files shall be installed. Its contents are
7004: set based upon the following variables:</p>
7005: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7006: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7007: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
7008: be overridden by the user to point to his preferred location (e.g.,
7009: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7010: Packages must not use it directly.</p></li>
7011: <li class="listitem">
7012: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7013: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7014: for the package being built shall be installed. The definition of this
7015: variable only makes sense in the package's
7016: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7017: <p>As an example, consider the Apache package,
7018: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
7019: configuration files under the
7020: <code class="filename">httpd/</code> subdirectory of
7021: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7022: Makefile.</p>
7023: </li>
7024: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7025: variable that holds this package's configuration directory (if
7026: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7027: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7028: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7029: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7030: directory where the configuration files for the package identified by
7031: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7032: </ul></div>
7033: <p>Based on the above variables, pkginstall determines the value of
7034: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
7035: variable that can be used within a package to refer to its configuration
7036: directory. The algorithm used to set its value is basically the
7037: following:</p>
7038: <div class="orderedlist"><ol class="orderedlist" type="1">
7039: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7040: its value is used.</p></li>
7041: <li class="listitem"><p>If the previous variable is not defined but
7042: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7043: <code class="filename">Makefile</code>, the resulting value is
7044: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7045: <li class="listitem"><p>Otherwise, it is set to
7046: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7047: </ol></div>
7048: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
7049: automatically added to <code class="filename">OWN_DIRS</code>. See <a class="xref" href="#dirs-outside-prefix" title="20.1.1. Directory manipulation">Section 20.1.1, “Directory manipulation”</a> what this means. This does not apply to
7050: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
7051: be created with OWN_DIRS or MAKE_DIRS.</p>
7052: </div>
7053: <div class="sect2">
7054: <div class="titlepage"><div><div><h3 class="title">
7055: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7056: <p>Given that pkgsrc (and users!) expect configuration files to be in a
7057: known place, you need to teach each package where it shall install its
7058: files. In some cases you will have to patch the package Makefiles to
7059: achieve it. If you are lucky, though, it may be as easy as passing an
7060: extra flag to the configuration script; this is the case of GNU Autoconf-
7061: generated files:</p>
1.1 dsieger 7062: <pre class="programlisting">
1.184 rillig 7063: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 7064: </pre>
1.184 rillig 7065: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
7066: for</em></span> its configuration files, not where they will be originally
7067: installed (although the difference is never explicit,
7068: unfortunately).</p>
1.1 dsieger 7069: </div>
1.184 rillig 7070: <div class="sect2">
7071: <div class="titlepage"><div><div><h3 class="title">
7072: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
7073: <p>As said before, pkginstall automatically handles configuration files.
7074: This means that <span class="strong"><strong>the packages themselves must not
7075: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7076: directly</strong></span>. Bad news is that many software installation scripts
7077: will, out of the box, mess with the contents of that directory. So what is
7078: the correct procedure to fix this issue?</p>
7079: <p>You must teach the package (usually by manually patching it) to
7080: install any configuration files under the examples hierarchy,
7081: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7082: <code class="filename">PLIST</code> registers them and the administrator always
7083: has the original copies available.</p>
7084: <p>Once the required configuration files are in place (i.e., under the
7085: examples hierarchy), the pkginstall framework can use them as master copies
7086: during the package installation to update what is in
7087: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7088: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
7089: used. Check out <a class="xref" href="#files-outside-prefix" title="20.1.2. File manipulation">Section 20.1.2, “File manipulation”</a> for information
7090: about their syntax and their purpose. Here is an example, taken from the
7091: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.1 dsieger 7092: <pre class="programlisting">
1.184 rillig 7093: EGDIR= ${PREFIX}/share/doc/mutt/samples
7094: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 dsieger 7095: </pre>
1.184 rillig 7096: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
7097: package and has no meaning outside it.</p>
1.1 dsieger 7098: </div>
1.184 rillig 7099: <div class="sect2">
7100: <div class="titlepage"><div><div><h3 class="title">
7101: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
7102: <p>The automatic copying of config files can be toggled by setting the
7103: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7104: installation.</p>
1.1 dsieger 7105: </div>
7106: </div>
1.41 asau 7107: <div class="sect1">
1.1 dsieger 7108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7109: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7110: <p>System startup scripts are special files because they must be
7111: installed in a place known by the underlying OS, usually outside the
7112: 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
7113: can be used. However, pkginstall provides a special mechanism to handle
7114: these files.</p>
7115: <p>In order to provide system startup scripts, the package has
7116: to:</p>
7117: <div class="orderedlist"><ol class="orderedlist" type="1">
7118: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7119: the <code class="literal">.sh</code> suffix appended. Considering the
7120: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
7121: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
7122: <li class="listitem">
7123: <p>Tell pkginstall to handle it, appending the name of the script,
7124: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7125: Continuing the previous example:</p>
7126: <pre class="programlisting">
7127: RCD_SCRIPTS+= cupsd
7128: </pre>
7129: </li>
7130: </ol></div>
7131: <p>Once this is done, pkginstall will do the following steps for each
7132: script in an automated fashion:</p>
7133: <div class="orderedlist"><ol class="orderedlist" type="1">
7134: <li class="listitem"><p>Process the file found in the files directory applying all the
7135: substitutions described in the <code class="filename">FILES_SUBST</code>
7136: variable.</p></li>
7137: <li class="listitem"><p>Copy the script from the files directory to the examples
7138: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
7139: that this master file must be explicitly registered in the
7140: <code class="filename">PLIST</code>.</p></li>
7141: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7142: from the examples hierarchy into the system-wide startup scripts
7143: directory.</p></li>
7144: </ol></div>
7145: <div class="sect2">
7146: <div class="titlepage"><div><div><h3 class="title">
7147: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7148: <p>The automatic copying of config files can be toggled by setting the
7149: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7150: installation. Note that the scripts will be always copied inside the
7151: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7152: matter what the value of this variable is.</p>
1.1 dsieger 7153: </div>
7154: </div>
1.184 rillig 7155: <div class="sect1">
7156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7157: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7158: <p>If a package needs to create special users and/or groups during
7159: installation, it can do so by using the pkginstall framework.</p>
7160: <p>Users can be created by adding entries to the
7161: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7162: syntax:</p>
7163: <pre class="programlisting">
7164: user:group
7165: </pre>
7166: <p>Further specification of user details may be done by setting
7167: per-user variables.
7168: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7169: numeric UID for the user.
7170: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7171: user's description or comment.
7172: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7173: user's home directory, and defaults to
7174: <code class="filename">/nonexistent</code> if not specified.
7175: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7176: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7177: not specified.</p>
7178: <p>Similarly, groups can be created by adding entries to the
7179: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7180: <pre class="programlisting">
7181: group
7182: </pre>
7183: <p>The numeric GID of the group may be set by defining
7184: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7185: <p>If a package needs to create the users and groups at an earlier
7186: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7187: <code class="literal">configure</code>,<code class="literal">build</code>, or
7188: <code class="literal">pre-install</code> to indicate the phase before which the
7189: users and groups are created. In this case, the numeric UIDs and GIDs
7190: of the created users and groups are automatically hardcoded into the
7191: final installation scripts.</p>
1.1 dsieger 7192: </div>
1.41 asau 7193: <div class="sect1">
1.1 dsieger 7194: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7195: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7196: <p>Packages that install system shells should register them in the shell
7197: database, <code class="filename">/etc/shells</code>, to make things easier to the
7198: administrator. This must be done from the installation scripts to keep
7199: binary packages working on any system. pkginstall provides an easy way to
7200: accomplish this task.</p>
7201: <p>When a package provides a shell interpreter, it has to set the
7202: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7203: add some hooks to the installation scripts to handle it. Consider the
7204: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
7205: <pre class="programlisting">
7206: PKG_SHELL= ${PREFIX}/bin/zsh
7207: </pre>
7208: <div class="sect2">
7209: <div class="titlepage"><div><div><h3 class="title">
7210: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7211: <p>The automatic registration of shell interpreters can be disabled by
7212: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7213: environment variable to <code class="literal">NO</code>.</p>
7214: </div>
1.1 dsieger 7215: </div>
1.41 asau 7216: <div class="sect1">
1.1 dsieger 7217: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7218: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7219: <p>Packages that install X11 fonts should update the database files
7220: that index the fonts within each fonts directory. This can easily be
7221: accomplished within the pkginstall framework.</p>
7222: <p>When a package installs X11 fonts, it must list the directories in
7223: which fonts are installed in the
7224: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7225: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7226: <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
7227: installation scripts to run the appropriate commands to update the fonts
7228: database files within each of those directories. For convenience, if the
7229: directory path is relative, it is taken to be relative to the package's
7230: installation prefix. Consider the following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.1 dsieger 7231: <pre class="programlisting">
1.184 rillig 7232: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 7233: </pre>
1.184 rillig 7234: <div class="sect2">
7235: <div class="titlepage"><div><div><h3 class="title">
7236: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7237: <p>The automatic update of fonts databases can be disabled by
7238: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7239: environment variable to <code class="literal">NO</code>.</p>
1.1 dsieger 7240: </div>
7241: </div>
7242: </div>
1.41 asau 7243: <div class="chapter">
1.1 dsieger 7244: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 7245: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 7246: <div class="toc">
7247: <p><b>Table of Contents</b></p>
1.100 leot 7248: <dl class="toc">
1.154 rillig 7249: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 7250: <dd><dl>
1.154 rillig 7251: <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>
7252: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7253: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7254: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7255: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7256: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7257: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7258: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7259: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7260: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7261: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7262: </dl></dd>
7263: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7264: <dd><dl>
7265: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7266: <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>
7267: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7268: </dl></dd>
7269: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7270: <dd><dl>
7271: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7272: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7273: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
7274: </dl></dd>
7275: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7276: <dd><dl>
7277: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7278: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.203 nia 7279: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing Perl scripts</a></span></dt>
1.154 rillig 7280: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
7281: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
7282: </dl></dd>
7283: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7284: <dd><dl>
7285: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7286: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 7287: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7288: <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>
7289: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 7290: </dl></dd>
7291: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7292: <dd><dl>
7293: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7294: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7295: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7296: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7297: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 7298: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154 rillig 7299: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
7300: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203 nia 7301: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
7302: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
7303: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
7304: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
7305: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
7306: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
7307: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1 dsieger 7308: emulation</a></span></dt>
1.203 nia 7309: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
7310: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1 dsieger 7311: </dl></dd>
1.154 rillig 7312: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7313: </dl>
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.154 rillig 7317: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 7318: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 7319: different platforms. As a result, it is important to ensure,
7320: where possible, that packages in pkgsrc are portable. This
7321: chapter mentions some particular details you should pay
7322: attention to while working on pkgsrc.</p>
1.41 asau 7323: <div class="sect2">
1.1 dsieger 7324: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7325: <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 7326: </h3></div></div></div>
7327: <p>The pkgsrc user can configure pkgsrc by overriding several
7328: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7329: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7330: want to use those variables in the preprocessor directives of
1.197 leot 7331: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 7332: <code class="literal">.for</code>), you need to include the file
7333: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7334: loads the user preferences.</p>
7335: <p>But note that some variables may not be completely defined
7336: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7337: included, as they may contain references to variables that are
1.108 rillig 7338: not yet defined. In shell commands (the lines in
7339: <code class="filename">Makefile</code> that are indented with a tab) this
7340: is no problem, since variables are only expanded when they are
7341: used. But in the preprocessor directives mentioned above and in
7342: dependency lines (of the form <code class="literal">target:
1.1 dsieger 7343: dependencies</code>) the variables are expanded at load
7344: time.</p>
1.41 asau 7345: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7346: <h3 class="title">Note</h3>
1.108 rillig 7347: <p>To check whether a variable can be used at load time,
7348: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 7349: </div>
7350: </div>
1.41 asau 7351: <div class="sect2">
1.1 dsieger 7352: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7353: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 7354: <p>Occasionally, packages require interaction from the user,
7355: and this can be in a number of ways:</p>
1.41 asau 7356: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7357: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7358: interaction such as entering username/password or accepting a
7359: license on a web page.</p></li>
1.23 wiz 7360: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7361: passwords.</p></li>
1.23 wiz 7362: <li class="listitem"><p>help to configure the package before it is built</p></li>
7363: <li class="listitem"><p>help during the build process</p></li>
7364: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7365: </ul></div>
1.108 rillig 7366: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7367: variable to define which stages need interaction. This should be
7368: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 7369: <pre class="programlisting">
7370: INTERACTIVE_STAGE= configure install
1.111 sevan 7371: </pre>
1.1 dsieger 7372: <p>The user can then decide to skip this package by setting the
1.108 rillig 7373: <code class="varname">BATCH</code> variable. Packages that require interaction
7374: are also excluded from bulk builds.</p>
1.1 dsieger 7375: </div>
1.41 asau 7376: <div class="sect2">
1.1 dsieger 7377: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7378: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 7379: <p>Authors of software can choose the licence under which software
7380: can be copied. The Free Software Foundation has declared some
7381: licenses "Free", and the Open Source Initiative has a definition of
7382: "Open Source".</p>
7383: <p>By default, pkgsrc allows packages with Free or Open Source
7384: licenses to be built. To allow packages with other licenses to be
7385: built as well, the pkgsrc user needs to add these licenses to the
7386: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7387: that this variable only affects which packages may be
7388: <span class="emphasis"><em>built</em></span>, while the license terms often also
7389: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 7390: <p>One might want to only install packages with a BSD license,
1.108 rillig 7391: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 7392: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 7393: user can override the default by setting the
7394: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 7395: of "+=". The licenses accepted by default are defined in the
7396: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7397: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7398: <p>The license tag mechanism is intended to address
7399: copyright-related issues surrounding building, installing and
7400: using a package, and not to address redistribution issues (see
7401: <code class="varname">RESTRICTED</code> and
1.111 sevan 7402: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7403: Packages with redistribution restrictions should set these
7404: tags.</p>
1.1 dsieger 7405: <p>Denoting that a package may be copied according to a
7406: particular license is done by placing the license in
7407: <code class="filename">pkgsrc/licenses</code> and setting the
7408: <code class="varname">LICENSE</code> variable to a string identifying the
1.137 leot 7409: license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.1 dsieger 7410: <pre class="programlisting">
7411: LICENSE= xv-license
1.111 sevan 7412: </pre>
1.1 dsieger 7413: <p>When trying to build, the user will get a notice that the
7414: package is covered by a license which has not been placed in the
7415: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7416: <pre class="programlisting">
7417: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7418: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7419: ===> To view the license, enter "/usr/bin/make show-license".
7420: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7421: ===> ACCEPTABLE_LICENSES+=xv-license
7422: *** Error code 1
1.111 sevan 7423: </pre>
1.10 hubertf 7424: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7425: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7426: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7427: convey to pkgsrc that it should not in the future fail because of
7428: that license:</p>
7429: <pre class="programlisting">
7430: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7431: </pre>
7432: <p>The use of <code class="varname">LICENSE=shareware</code>,
7433: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7434: is deprecated because it does not crisply refer to a particular
7435: license text. Another problem with such usage is that it does not
7436: enable a user to tell pkgsrc to proceed for a single package
7437: without also telling pkgsrc to proceed for all packages with that
7438: tag.</p>
7439: <div class="sect3">
7440: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7441: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7442: <p>When adding a package with a new license, the following steps
7443: are required:</p>
7444: <div class="orderedlist"><ol class="orderedlist" type="1">
7445: <li class="listitem">
1.169 rillig 7446: <p>Check whether the license qualifies as Free or Open Source by
7447: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7448: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111 sevan 7449: Open Source Initiative</a>. If this is the case, the filename in
7450: <code class="filename">pkgsrc/licenses/</code> does not need the
7451: <code class="filename">-license</code> suffix, and the license name should be
7452: added to:</p>
1.48 rodent 7453: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7454: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7455: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7456: <li class="listitem"><p>default_acceptable_licenses in
7457: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48 rodent 7458: </ul></div>
7459: </li>
1.169 rillig 7460: <li class="listitem"><p>The license text should be added to
7461: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7462: licenses can be seen in this directory.</p></li>
1.48 rodent 7463: </ol></div>
1.111 sevan 7464: </div>
7465: <div class="sect3">
7466: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7467: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7468: <p>When the license changes (in a way other than formatting),
1.111 sevan 7469: make sure that the new license has a different name (e.g.,
1.1 dsieger 7470: append the version number if it exists, or the date). Just
7471: because a user told pkgsrc to build programs under a previous
7472: version of a license does not mean that pkgsrc should build
7473: programs under the new licenses. The higher-level point is that
7474: pkgsrc does not evaluate licenses for reasonableness; the only
7475: test is a mechanistic test of whether a particular text has been
1.111 sevan 7476: approved by either of two bodies (FSF or OSI).</p>
7477: </div>
1.1 dsieger 7478: </div>
1.41 asau 7479: <div class="sect2">
1.1 dsieger 7480: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7481: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7482: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7483: By declaring the restrictions, package tools can
1.1 dsieger 7484: automatically refrain from e.g. placing binary packages on FTP
7485: sites.</p>
1.111 sevan 7486: <p>There are four possible restrictions, which are
1.1 dsieger 7487: the cross product of sources (distfiles) and binaries not being
7488: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7489: language in any license, and because non-Free licenses tend to be
7490: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7491: CD-ROM.
7492:
7493: "FTP" means making the source or binary file available over the
7494: Internet at no charge.
7495:
7496: "CD-ROM" means making the source or binary available on some kind of
7497: media, together with other source and binary packages, which is sold
7498: for a distribution charge.
1.1 dsieger 7499: </p>
7500: <p>In order to encode these restrictions, the package system
7501: defines five make variables that can be set to note these
7502: restrictions:</p>
1.41 asau 7503: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7504: <li class="listitem">
1.1 dsieger 7505: <p><code class="varname">RESTRICTED</code></p>
7506: <p>This variable should be set whenever a restriction
7507: exists (regardless of its kind). Set this variable to a
7508: string containing the reason for the restriction. It should
7509: be understood that those wanting to understand the restriction
7510: will have to read the license, and perhaps seek advice of
7511: counsel.</p>
7512: </li>
1.23 wiz 7513: <li class="listitem">
1.1 dsieger 7514: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7515: <p>Binaries may not be placed on CD-ROM containing other
7516: binary packages, for which a distribution charge may be made.
7517: In this case, set this variable to
7518: <code class="varname">${RESTRICTED}</code>.</p>
7519: </li>
1.23 wiz 7520: <li class="listitem">
1.1 dsieger 7521: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7522: <p>Binaries may not made available on the Internet without
7523: charge. In this case, set this variable to
7524: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7525: binary packages will not be included on ftp.NetBSD.org.</p>
7526: </li>
1.23 wiz 7527: <li class="listitem">
1.1 dsieger 7528: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7529: <p>Distfiles may not be placed on CD-ROM, together with
7530: other distfiles, for which a fee may be charged. In this
7531: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7532: </p>
7533: </li>
1.23 wiz 7534: <li class="listitem">
1.1 dsieger 7535: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7536: <p>Distfiles may not made available via FTP at no charge.
7537: In this case, set this variable to
7538: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7539: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7540: </li>
7541: </ul></div>
1.111 sevan 7542: <p>Please note that packages will be removed from pkgsrc when the
7543: distfiles are not distributable and cannot be obtained for a period
7544: of one full quarter branch. Packages with manual/interactive fetch
7545: must have a maintainer and it is his/her responsibility to ensure
7546: this.</p>
1.1 dsieger 7547: </div>
1.41 asau 7548: <div class="sect2">
1.1 dsieger 7549: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7550: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.175 gutterid 7551: <p>Your package may depend on some other package being present,
7552: and there are various ways of expressing this dependency.
7553: pkgsrc supports the <code class="varname">DEPENDS</code>,
7554: <code class="varname">BUILD_DEPENDS</code>,
7555: <code class="varname">TOOL_DEPENDS</code>, and
7556: <code class="varname">TEST_DEPENDS</code> definitions, the
1.1 dsieger 7557: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7558: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7559: to handle dependencies, and which uses the variables named above.
1.184 rillig 7560: 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 7561: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7562: definition registers that pre-requisite in the binary package so it
7563: will be pulled in when the binary package is later installed, whilst
7564: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7565: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7566: dependency that is only needed for building or testing the resulting
1.184 rillig 7567: 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 7568: <p>This means that if you only need a package present whilst
1.175 gutterid 7569: you are building or testing, it should be noted as a
7570: <code class="varname">TOOL_DEPENDS</code>,
7571: <code class="varname">BUILD_DEPENDS</code>, or
7572: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.156 leot 7573: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7574: packages, i.e. packages for the architecture where the package
7575: is built;
7576: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.175 gutterid 7577: packages, i.e., packages for the architecture for which the package
1.156 leot 7578: is built.</p>
1.175 gutterid 7579: <p>The format for a <code class="varname">DEPENDS</code>,
7580: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7581: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.1 dsieger 7582: <pre class="programlisting">
7583: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7584: </pre>
1.23 wiz 7585: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7586: may include any of the wildcard version numbers recognized by
1.197 leot 7587: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23 wiz 7588: <div class="orderedlist"><ol class="orderedlist" type="1">
7589: <li class="listitem">
1.1 dsieger 7590: <p>If your package needs another package's binaries or
1.54 wiz 7591: libraries to build and run, and if that package has a
1.1 dsieger 7592: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7593: <pre class="programlisting">
7594: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7595: </pre>
1.1 dsieger 7596: </li>
1.23 wiz 7597: <li class="listitem">
1.54 wiz 7598: <p>If your package needs another package's binaries or
7599: libraries only for building, and if that package has a
7600: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7601: <pre class="programlisting">
7602: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7603: </pre>
1.54 wiz 7604: <p>but set
7605: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7606: to make it a build dependency only. This case is rather
7607: rare.</p>
7608: </li>
7609: <li class="listitem">
1.25 spz 7610: <p>If your package needs binaries from another package to build,
1.156 leot 7611: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7612: <pre class="programlisting">
1.156 leot 7613: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7614: </pre>
1.1 dsieger 7615: </li>
1.156 leot 7616: <li class="listitem"><p>If your package needs static libraries to link against, header
7617: files to include, etc. from another package to build,
7618: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7619: <li class="listitem"><p>If your package needs a library with which to link and
7620: there is no <code class="filename">buildlink3.mk</code> file
7621: available, create one. Using
7622: <code class="varname">DEPENDS</code> won't be sufficient because the
7623: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7624: <li class="listitem">
1.25 spz 7625: <p>If your package needs some executable to be able to run
7626: correctly and if there's no
7627: <code class="filename">buildlink3.mk</code> file, this is specified
7628: using the <code class="varname">DEPENDS</code> variable. The
1.137 leot 7629: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.129 wiz 7630: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7631: when it runs, and that is specified:</p>
1.1 dsieger 7632: <pre class="programlisting">
1.129 wiz 7633: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7634: </pre>
1.25 spz 7635: </li>
1.175 gutterid 7636: <li class="listitem"><p>If your package includes a test suite that has extra
7637: dependencies only required for this purpose (frequently this
7638: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7639: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.25 spz 7640: <li class="listitem">
7641: <p>You can use wildcards in package dependencies. Note that
7642: such wildcard dependencies are retained when creating binary
7643: packages. The dependency is checked when installing the binary
7644: package and any package which matches the pattern will be
7645: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7646: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7647: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7648: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7649: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7650: <p>Wildcards can also be used to specify that a package
7651: will only build against a certain minimum version of a
7652: pre-requisite:</p>
7653: <pre class="programlisting">
1.25 spz 7654: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7655: </pre>
1.25 spz 7656: <p>This means that the package will build using version 6.0
7657: of ImageMagick or newer. Such a dependency may be warranted
7658: if, for example, the command line options of an executable
7659: have changed.</p>
7660: <p>If you need to depend on minimum versions of libraries,
1.183 wiz 7661: set
7662: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7663: to the appropriate pattern before including its
7664: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7665: <pre class="programlisting">
7666: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7667: .include "../../graphics/jpeg/buildlink3.mk"
7668: </pre>
1.1 dsieger 7669: <p>For security fixes, please update the package
1.154 rillig 7670: 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 7671: information.</p>
7672: </li>
7673: </ol></div>
7674: <p>If your package needs files from another package to build,
7675: add the relevant distribution files to
7676: <code class="varname">DISTFILES</code>, so they will be extracted
1.137 leot 7677: automatically. See the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.1 dsieger 7678: (It relies on the jpeg sources being present in source form
7679: during the build.)</p>
7680: </div>
1.41 asau 7681: <div class="sect2">
1.1 dsieger 7682: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7683: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7684: <p>Your package may conflict with other packages a user might
7685: already have installed on his system, e.g. if your package
7686: installs the same set of files as another package in the pkgsrc
1.80 wiz 7687: tree or has the same <code class="varname">PKGNAME</code>.</p>
1.142 leot 7688: <p>For example, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/libXaw3d/README.html" target="_top"><code class="filename">x11/libXaw3d</code></a>
7689: and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
7690: install the same shared library, thus you set in
7691: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7692: <pre class="programlisting">
7693: CONFLICTS= Xaw-Xpm-[0-9]*
7694: </pre>
7695: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7696: <pre class="programlisting">
7697: CONFLICTS= libXaw3d-[0-9]*
7698: </pre>
1.197 leot 7699: <p><a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 7700: that conflict with existing packages and abort. However, in many
7701: situations this is too late in the process. Binary package managers
7702: will not know about the conflict until they attempt to install the
7703: package after already downloading it and all its dependencies.
7704: Users may also waste time building a package and its dependencies
7705: only to find out at the end that it conflicts with another package
7706: they have installed.</p>
7707: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7708: should be added in all cases where it is known that packages conflict
7709: with each other. These <code class="varname">CONFLICTS</code> entries are
1.197 leot 7710: exported in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 7711: managers to inform users that packages cannot be installed onto
7712: the target system.</p>
1.1 dsieger 7713: </div>
1.41 asau 7714: <div class="sect2">
1.1 dsieger 7715: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7716: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7717: <p>There are several reasons why a package might be
7718: instructed to not build under certain circumstances. If the
7719: package builds and runs on most platforms, the exceptions
1.83 dholland 7720: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7721: the package builds and runs on a small handful of platforms,
7722: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7723: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7724: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7725: (OS-version-platform) that can use glob-style
7726: wildcards.</p>
7727: <p>If a package is not appropriate for some platforms (as
1.114 maya 7728: opposed to merely broken), a different set of variables should be
1.83 dholland 7729: used as this affects failure reporting and statistics.
7730: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7731: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7732: the package is appropriate for only a small handful of platforms
7733: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7734: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7735: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7736: (OS-version-platform) that can use glob-style
7737: wildcards.</p>
7738: <p>Some packages are tightly bound to a specific version of an
1.137 leot 7739: operating system, e.g. LKMs or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
1.1 dsieger 7740: backwards compatible with other versions of the OS, and should be
7741: uploaded to a version specific directory on the FTP server. Mark
7742: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7743: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7744: the package system internals, but may be used in the
7745: future.</p>
7746: <p>If the package should be skipped (for example, because it
7747: provides functionality already provided by the system), set
7748: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7749: the package should fail because some preconditions are not met,
7750: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7751: message.</p>
7752: </div>
1.41 asau 7753: <div class="sect2">
1.1 dsieger 7754: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7755: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7756: <p>To ensure that a package may not be deleted, once it has been
7757: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7758: be set in the package Makefile. This will be carried into any
7759: binary package that is made from this pkgsrc entry. A
1.23 wiz 7760: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.197 leot 7761: not be deleted using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23 wiz 7762: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7763: </div>
1.41 asau 7764: <div class="sect2">
1.1 dsieger 7765: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7766: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7767: <p>When a vulnerability is found, this should be noted in
7768: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7769: and after committing that file, ask pkgsrc-security@NetBSD.org to
7770: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7771: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7772: <code class="varname">PKGREVISION</code> should be increased (this is of
7773: course not necessary if the problem is fixed by using a newer
7774: release of the software), and the pattern in the
7775: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7776: <p>Also, if the fix should be applied to the stable pkgsrc
7777: branch, be sure to submit a pullup request!</p>
7778: <p>Binary packages already on ftp.NetBSD.org will be handled
7779: semi-automatically by a weekly cron job.</p>
7780: </div>
1.41 asau 7781: <div class="sect2">
1.1 dsieger 7782: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7783: <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 7784: <p>When making fixes to an existing package it can be useful
7785: to change the version number in <code class="varname">PKGNAME</code>. To
7786: avoid conflicting with future versions by the original author, a
1.23 wiz 7787: <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 7788: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7789: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7790: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7791: <pre class="programlisting">
7792: DISTNAME= foo-17.42
7793: PKGREVISION= 9
1.111 sevan 7794: </pre>
1.1 dsieger 7795: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7796: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7797: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7798: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7799: <code class="varname">PKGNAME_NOREV</code>.</p>
7800: <p>When a new release of the package is released, the
7801: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7802: minor release of the above package, things should be like:</p>
7803: <pre class="programlisting">
7804: DISTNAME= foo-17.43
1.111 sevan 7805: </pre>
1.1 dsieger 7806: <p><code class="varname">PKGREVISION</code> should be incremented for any
7807: non-trivial change in the resulting binary package. Without a
7808: <code class="varname">PKGREVISION</code> bump, someone with the previous
7809: version installed has no way of knowing that their package is out
7810: of date. Thus, changes without increasing
7811: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7812: trivial that no reasonable person would want to upgrade", and this
7813: is the rough test for when increasing
7814: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7815: changes that do not merit increasing
7816: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7817: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7818: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169 rillig 7819: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7820: comments in Makefile.</p></li>
7821: <li class="listitem"><p>Changing build variables if the resulting binary
7822: package is the same.</p></li>
7823: <li class="listitem"><p>Changing
7824: <code class="filename">DESCR</code>.</p></li>
7825: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7826: default options don't change.</p></li>
1.1 dsieger 7827: </ul></div>
7828: <p>Examples of changes that do merit an increase to
7829: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7830: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7831: <li class="listitem"><p>Security fixes</p></li>
7832: <li class="listitem"><p>Changes or additions to a patch
7833: file</p></li>
7834: <li class="listitem"><p>Changes to the
7835: <code class="filename">PLIST</code></p></li>
7836: <li class="listitem"><p>A dependency is changed or
7837: renamed.</p></li>
1.1 dsieger 7838: </ul></div>
7839: <p>PKGREVISION must also be incremented when dependencies have ABI
7840: changes.</p>
7841: </div>
1.41 asau 7842: <div class="sect2">
1.1 dsieger 7843: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7844: <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 7845: <p>When you want to replace the same text in multiple files, or
7846: multiple times in the same file, it is cumbersome to maintain a patch
7847: file for this. This is where the SUBST framework steps in. It provides an
7848: easy-to-use interface for replacing text in files. It just needs the
7849: following information:</p>
7850: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7851: <li class="listitem"><p>In which phase of the package build cycle should the
7852: replacement happen?</p></li>
7853: <li class="listitem"><p>In which files should the replacement
1.172 rillig 7854: happen?</p></li>
1.180 rillig 7855: <li class="listitem"><p>Which text should be replaced with
7856: what?</p></li>
1.172 rillig 7857: </ul></div>
7858: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.180 rillig 7859: variables. A minimal example is:</p>
7860: <pre class="programlisting">
7861: SUBST_CLASSES+= paths
7862: SUBST_STAGE.paths= pre-configure
7863: SUBST_FILES.paths= src/*.c
7864: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
7865: </pre>
7866: <p>Translated into English, it means: In the pre-configure stage (that
7867: is, after applying the patches from the patches/ directory and before
7868: running the configure script and the portability check), replace the text
7869: <code class="literal">/usr/local</code> with the content of the variable
7870: <code class="varname">PREFIX</code>.</p>
7871: <p>Each SUBST block starts by appending an identifier to
7872: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
7873: identifier can be chosen freely by the package. If there should ever be
7874: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
7875: early, so don't worry about name collisions.</p>
7876: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
7877: SUBST block are parameterized using this identifier. In the remainder of
7878: this section, these parameterized variables are written as
7879: <code class="varname">SUBST_STAGE.*</code>.</p>
7880: <pre class="programlisting">
7881: SUBST_CLASSES+= paths
7882: SUBST_STAGE.paths= pre-configure
7883: SUBST_MESSAGE.paths= Fixing absolute paths.
7884: SUBST_FILES.paths= src/*.c
7885: SUBST_FILES.paths+= scripts/*.sh
7886: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
7887: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
7888: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
7889: </pre>
7890: <p>To get a complete picture about the SUBST substitutions, run
7891: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
7892: expected, run pkglint on the package, which detects several typical
7893: mistakes surrounding the SUBST blocks. For any questions that might
7894: remain after this, have a look at
7895: <code class="filename">mk/subst.mk</code>.</p>
7896: <div class="sect3">
7897: <div class="titlepage"><div><div><h4 class="title">
7898: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
7899: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
7900: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
7901: <code class="literal">pre-configure</code> is used most often, by far. The most
7902: popular stages are, in chronological order:</p>
7903: <div class="variablelist"><dl class="variablelist">
7904: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
7905: <dd>
7906: <p>The substitutions are applied immediately after the
7907: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
7908: package will leave no traces of the original files.</p>
7909: <p>When the substitution applies to files for which there is also a
7910: patch in the <code class="filename">patches/</code> directory, this means that the
7911: patches will be computed based on the result of the substitution. When
7912: these patches are sent to the upstream maintainer later, to be fixed in
7913: the upstream package, these patches may no longer match what the upstream
7914: author is used to. Because of this, <code class="literal">pre-configure</code> is
7915: often a better choice.</p>
7916: </dd>
7917: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
7918: <dd>
7919: <p>The substitutions are applied after the patches from the
7920: <code class="filename">patches/</code> directory. This makes it possible to run
7921: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
7922: can be edited using the tools pkgvi and mkpatches from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package.</p>
7923: <p>When updating the patches, it is helpful to explicitly separate the
7924: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
7925: configure</strong></span>, and to only edit the patches between these commands.
7926: Otherwise the substitutions from the SUBST block will end up in the patch
7927: file. When this happens in really obvious ways, pkglint will complain
7928: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
7929: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
7930: can only detect these really obvious
7931: cases.</p>
7932: </dd>
7933: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
7934: <dd><p>This stage should only be used if the package defines a
7935: <code class="literal">pre-configure</code> action itself, and the substitution must
7936: happen after that. Typical examples are packages that use the
7937: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
7938: script from
7939: <code class="filename">configure.ac</code>.</p></dd>
7940: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
7941: <dd><p>This stage is used to fix up any mistakes by the
7942: configure stage.</p></dd>
7943: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
7944: <dd><p>This stage should only be used for substitutions that are
7945: clearly related to building the package, not for fixing the
7946: configuration. Substitutions for pathnames (such as replacing
7947: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
7948: user names (such as replacing <code class="literal">@MY_USER@</code> with the
7949: actual username) belong in pre-configure or post-configure
7950: instead.</p></dd>
7951: <dt><span class="term"><code class="literal">post-build</code></span></dt>
7952: <dd>
7953: <p>Just as with pre-build, this stage should only be used
7954: for substitutions that are clearly related to building the package, not
7955: for fixing the configuration. Substitutions for pathnames (such as
7956: replacing <code class="filename">/usr/local</code> with
7957: <code class="literal">${PREFIX}</code>) or user names (such as replacing
7958: <code class="literal">@MY_USER@</code> with the actual username) belong in
7959: pre-configure or post-configure instead.</p>
7960: <p>A typical use is to update pkg-config files to include the rpath
7961: compiler options.</p>
7962: </dd>
7963: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
7964: <dd><p>In general, the install phase should be as simple as
7965: possible. As with the pre-build and post-build stages, it should not be
7966: used to fix pathnames or user names, these belong in pre-configure
7967: instead. There are only few legitimate use cases for applying
7968: substitutions in this stage.</p></dd>
7969: </dl></div>
7970: </div>
7971: <div class="sect3">
7972: <div class="titlepage"><div><div><h4 class="title">
1.181 rillig 7973: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.180 rillig 7974: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
7975: filename patterns. These patterns are relative to
7976: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
7977: A typical example is:</p>
7978: <pre class="programlisting">
7979: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
7980: </pre>
7981: <p>The above patterns, especially the last, are quite broad. The SUBST
7982: implementation checks that each filename pattern that is mentioned here
7983: has an effect. For example, if none of the
7984: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
7985: and substituted, that filename pattern is redundant and should be left
1.181 rillig 7986: out. By default, the SUBST framework will complain with an error message.
7987: If the text to be substituted occurs in some of the files from a single
7988: pattern, but not in all of them, that is totally ok, and the SUBST
1.180 rillig 7989: framework will only print an INFO message for those files.</p>
7990: <p>If there is a good reason for having redundant filename patterns,
1.181 rillig 7991: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.180 rillig 7992: <p>Another popular way of choosing the files for the substitutions is
7993: via a shell command, like this:</p>
7994: <pre class="programlisting">
1.181 rillig 7995: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 7996: SUBST_FILES.path= ${C_FILES_CMD:sh}
7997: </pre>
7998: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
7999: freely chosen and independent of the SUBST framework.</p>
8000: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8001: lists each file individually. Thereby chances are higher that there are
8002: filename patterns in which no substitution happens. Since the SUBST
8003: framework cannot know whether the filename patterns in
8004: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8005: Makefile (where any redundant filename pattern would be suspicious) or
8006: been generated by a shell command (in which redundant filename patterns
8007: are more likely and to be expected), it will complain about these
8008: redundant filename patterns. Therefore, SUBST blocks that use a shell
8009: command to generate the list of filename patterns often need to set
8010: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8011: </div>
8012: <div class="sect3">
8013: <div class="titlepage"><div><div><h4 class="title">
8014: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8015: <p>In most cases, the substitutions are given using one or more
1.197 leot 8016: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.180 rillig 8017: <pre class="programlisting">
8018: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8019: </pre>
8020: <p>Each of the sed commands needs to be preceded by the
8021: <code class="literal">-e</code> option and should be specified on a line of its
8022: own, to avoid hiding short sed commands at the end of a line.</p>
8023: <p>Since the sed commands often contain shell metacharacters as the
8024: separator (the <code class="literal">|</code> in the above example), it is common
8025: to enclose them in single quotes.</p>
8026: <p>A common substitution is to replace placeholders of the form
8027: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8028: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8029: <pre class="programlisting">
8030: SUBST_VARS.path= PREFIX
8031: </pre>
8032: <p>This type of substitutions is typically done by the GNU configure
1.181 rillig 8033: scripts during the do-configure stage, but in some cases these need to be
8034: overridden. The same pattern is also used when a package defines patches
8035: that replace previously hard-coded paths like
8036: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8037: placeholder first, which then gets substituted by the actual
8038: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8039: cases, it works equally well to just use the SUBST framework to directly
8040: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8041: thereby omitting the intermediate patch file.</p>
1.180 rillig 8042: <p>If the above is not flexible enough, it is possible to not use sed
8043: at all for the substitution but to specify an entirely different command,
8044: like this:</p>
1.1 dsieger 8045: <pre class="programlisting">
1.180 rillig 8046: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8047: </pre>
8048: <p>This is used for the few remaining packages in which the
8049: distributed files use Windows-style line endings that need to be
8050: converted to UNIX-style line endings.</p>
8051: </div>
8052: <div class="sect3">
8053: <div class="titlepage"><div><div><h4 class="title">
8054: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8055: <p>When a SUBST block is applied during a package build, a message is
8056: logged. The default message is fine for most purposes but can be
8057: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8058: message.</p>
8059: </div>
1.1 dsieger 8060: </div>
8061: </div>
1.41 asau 8062: <div class="sect1">
1.1 dsieger 8063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8064: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 8065: <div class="sect2">
1.1 dsieger 8066: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8067: <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 8068: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8069: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8070: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8071: with the name of each file to download as an argument, expecting
8072: it to output the URL of the directory from which to download
1.137 leot 8073: it. <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.1 dsieger 8074: example of this usage.</p>
8075: <p>If the download can't be automated, because the user must
8076: submit personal information to apply for a password, or must pay
8077: for the source, or whatever, you can set
8078: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8079: displayed to the user before aborting the build. Example:</p>
8080: <pre class="programlisting">
8081: FETCH_MESSAGE= "Please download the files"
8082: FETCH_MESSAGE+= " "${DISTFILES:Q}
8083: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 8084: </pre>
1.1 dsieger 8085: </div>
1.41 asau 8086: <div class="sect2">
1.1 dsieger 8087: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8088: <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 8089: <p>Sometimes authors of a software package make some
8090: modifications after the software was released, and they put up a
8091: new distfile without changing the package's version number. If a
8092: package is already in pkgsrc at that time, the checksum will
8093: no longer match. The contents of the new distfile should be
8094: compared against the old one before changing anything, to make
8095: sure the distfile was really updated on purpose, and that
8096: no trojan horse or so crept in.
8097: Please mention that the distfiles were compared and what was found
1.53 rodent 8098: in your commit message.</p>
1.109 wiz 8099: <p>Then, the correct way to work around this is to set
8100: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8101: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8102: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8103: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 8104: <code class="varname">PATCHFILES</code> for this package will be put in that
1.154 rillig 8105: 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 8106: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 8107: including the <code class="filename">nbX</code> suffix) or a date stamp can
8108: be appended, like
8109: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169 rillig 8110: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8111: name does not contain a version and the distfile is apt to change. In
8112: cases where the likelihood of this is very small,
8113: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8114: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8115: distfile name changes, even if a package is being moved or
8116: renamed.</p>
1.53 rodent 8117: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8118: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8119: path in the filenames.
1.53 rodent 8120: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8121: Furthermore, a mail to the package's authors seems appropriate
8122: telling them that changing distfiles after releases without
8123: changing the file names is not good practice.</p>
8124: </div>
1.88 tnn 8125: <div class="sect2">
8126: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8127: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169 rillig 8128: <p>Helper methods exist for packages hosted on github.com which
8129: will often have distfile names that clash with other packages, for
8130: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8131: from below:</p>
1.88 tnn 8132: <div class="sect3">
8133: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8134: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169 rillig 8135: <p>If your distfile URL looks similar to
1.189 bacon 8136: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.169 rillig 8137: then you are packaging a tagged release.</p>
1.88 tnn 8138: <pre class="programlisting">
1.189 bacon 8139: DISTNAME= example-1.0
1.90 tnn 8140: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8141: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8142: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 8143: EXTRACT_SUFX= .zip
8144: </pre>
8145: </div>
8146: <div class="sect3">
8147: <div class="titlepage"><div><div><h4 class="title">
1.189 bacon 8148: <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>
8149: <p>If your distfile looks similar to
8150: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8151: release, then set the package version to 0.0.0.N, where N is the number
8152: of commits to the repository, and set GITHUB_TAG to the commit hash.
8153: This will (almost) ensure that the first tagged release will have a
8154: version greater than this one so that package upgrades will function
8155: properly.</p>
8156: <pre class="programlisting">
8157: DISTNAME= example-0.0.0.347
8158: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8159: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8160: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8161: </pre>
8162: </div>
8163: <div class="sect3">
8164: <div class="titlepage"><div><div><h4 class="title">
8165: <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>
8166: <p>If your distfile looks similar to
8167: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8168: then include the last release version and the commit count since that
8169: release in the package version and set GITHUB_TAG to the commit hash.
8170: The latest release and commit count are shown in the output of
8171: "git describe --tags":
8172: </p>
8173: <pre class="screen">
8174: # git clone https://github.com/username/example
8175: # cd example
8176: # git describe --tags
8177: 1.2.3-5-g988881a
8178: </pre>
1.88 tnn 8179: <pre class="programlisting">
1.189 bacon 8180: DISTNAME= example-1.2.3.5
8181: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8182: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8183: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 8184: </pre>
1.88 tnn 8185: </div>
8186: <div class="sect3">
8187: <div class="titlepage"><div><div><h4 class="title">
1.189 bacon 8188: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.169 rillig 8189: <p>If your distfile URL looks similar to
1.189 bacon 8190: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.169 rillig 8191: then you are packaging a release.</p>
1.88 tnn 8192: <pre class="programlisting">
8193: DISTNAME= offensive-1.6
1.90 tnn 8194: PKGNAME= ${DISTNAME:S/offensive/proper/}
8195: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8196: GITHUB_PROJECT= example
1.90 tnn 8197: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8198: EXTRACT_SUFX= .zip
1.111 sevan 8199: </pre>
1.88 tnn 8200: </div>
8201: </div>
1.1 dsieger 8202: </div>
1.41 asau 8203: <div class="sect1">
1.1 dsieger 8204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8205: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8206: <div class="sect2">
1.1 dsieger 8207: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8208: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8209: <p>pkgsrc supports many different machines, with different
8210: object formats like a.out and ELF, and varying abilities to do
8211: shared library and dynamic loading at all. To accompany this,
8212: varying commands and options have to be passed to the
8213: compiler, linker, etc. to get the Right Thing, which can be
8214: pretty annoying especially if you don't have all the machines
8215: at your hand to test things. The
1.137 leot 8216: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.23 wiz 8217: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8218: both static and dynamic libraries from a set of source files,
8219: thus being platform-independent.</p>
8220: <p>Here's how to use libtool in a package in seven simple
8221: steps:</p>
1.23 wiz 8222: <div class="orderedlist"><ol class="orderedlist" type="1">
8223: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8224: Makefile.</p></li>
1.23 wiz 8225: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8226: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8227: add it to the definition of <code class="varname">CC</code>, if only
8228: libraries are being built in a given Makefile. This one command
8229: will build both PIC and non-PIC library objects, so you need not
8230: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8231: <li class="listitem">
1.1 dsieger 8232: <p>For the linking of the library, remove any
1.23 wiz 8233: <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
8234: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8235: <pre class="programlisting">
8236: ${LIBTOOL} --mode=link \
8237: ${CC} -o ${.TARGET:.a=.la} \
8238: ${OBJS:.o=.lo} \
8239: -rpath ${PREFIX}/lib \
8240: -version-info major:minor
1.111 sevan 8241: </pre>
1.1 dsieger 8242: <p>Note that the library is changed to have a
8243: <code class="filename">.la</code> extension, and the objects are
8244: changed to have a <code class="filename">.lo</code>
8245: extension. Change <code class="varname">OBJS</code> as
8246: necessary. This automatically creates all of the
8247: <code class="filename">.a</code>,
8248: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8249: necessary) in the build directory. Be sure to include
1.23 wiz 8250: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8251: minor are zero, as libtool will otherwise strip off the
8252: shared library version.</p>
8253: <p>From the libtool manual:</p>
8254: <pre class="programlisting">
8255: So, libtool library versions are described by three integers:
8256:
8257: CURRENT
8258: The most recent interface number that this library implements.
8259:
8260: REVISION
8261: The implementation number of the CURRENT interface.
8262:
8263: AGE
8264: The difference between the newest and oldest interfaces that
8265: this library implements. In other words, the library implements
8266: all the interface numbers in the range from number `CURRENT -
8267: AGE' to `CURRENT'.
8268:
8269: If two libraries have identical CURRENT and AGE numbers, then the
8270: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 8271: </pre>
1.23 wiz 8272: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8273: different results for a.out and ELF (excluding symlinks)
8274: in only one case. An ELF library of the form
1.23 wiz 8275: <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 8276: will have a symlink of
1.23 wiz 8277: <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 8278: on an a.out platform. This is handled
8279: automatically.</p>
1.23 wiz 8280: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8281: directory of the library being built.</p>
8282: <p>In the <code class="filename">PLIST</code>, include only the
8283: <code class="filename">.la</code> file, the other files will be
8284: added automatically.</p>
8285: </li>
1.23 wiz 8286: <li class="listitem">
1.1 dsieger 8287: <p>When linking shared object (<code class="filename">.so</code>)
1.197 leot 8288: files, i.e. files that are loaded via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23 wiz 8289: shared libraries, use <span class="quote">“<span class="quote">-module
8290: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8291: tacked on.</p>
8292: <p>The <code class="filename">PLIST</code> file gets the
8293: <code class="filename">foo.so</code> entry.</p>
8294: </li>
1.23 wiz 8295: <li class="listitem">
1.1 dsieger 8296: <p>When linking programs that depend on these libraries
8297: <span class="emphasis"><em>before</em></span> they are installed, preface
1.197 leot 8298: the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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.1/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 8299: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8300: libraries (static or shared), but please be aware that
8301: libtool will not allow you to specify a relative path in
1.23 wiz 8302: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8303: expects you to change that argument to be the
8304: <code class="filename">.la</code> file. e.g.</p>
8305: <pre class="programlisting">
8306: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 8307: </pre>
1.1 dsieger 8308: <p>should be changed to:</p>
8309: <pre class="programlisting">
8310: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 8311: </pre>
1.1 dsieger 8312: <p>and it will do the right thing with the libraries.</p>
8313: </li>
1.23 wiz 8314: <li class="listitem">
1.197 leot 8315: <p>When installing libraries, preface the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8316: or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 8317: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8318: <code class="filename">.la</code>. e.g.</p>
8319: <pre class="programlisting">
1.22 jakllsch 8320: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 8321: </pre>
1.1 dsieger 8322: <p>This will install the static <code class="filename">.a</code>,
8323: shared library, any needed symlinks, and run
1.197 leot 8324: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 8325: </li>
1.23 wiz 8326: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8327: the <code class="filename">.la</code>
8328: file (this is a change from previous behaviour).</p></li>
8329: </ol></div>
8330: </div>
1.41 asau 8331: <div class="sect2">
1.1 dsieger 8332: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8333: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8334: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8335: package Makefile. This will override the package's own libtool
8336: in most cases. For older libtool using packages, libtool is
8337: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8338: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8339: configure; find work*/ -name libtool</strong></span>.</p>
8340: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8341: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8342: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8343: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8344: package's libtool script(s), set it as appropriate.</p>
8345: <p>If you do not need <code class="filename">*.a</code> static
8346: libraries built and installed, then use
8347: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8348: <p>If your package makes use of the platform-independent library
8349: for loading dynamic shared objects, that comes with libtool
8350: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8351: <p>Some packages use libtool incorrectly so that the package
8352: may not work or build in some circumstances. Some of the more
8353: common errors are:</p>
1.41 asau 8354: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8355: <li class="listitem">
1.1 dsieger 8356: <p>The inclusion of a shared object (-module) as a dependent library in an
8357: executable or library. This in itself isn't a problem if one of two things
8358: has been done:</p>
1.23 wiz 8359: <div class="orderedlist"><ol class="orderedlist" type="1">
8360: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8361: <code class="filename">libfoo.la</code>, not
8362: <code class="filename">foo.la</code></p></li>
1.23 wiz 8363: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8364: </ol></div>
8365: </li>
1.23 wiz 8366: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8367: The function lt_dlinit() should be called and the macro
8368: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8369: executables.</p></li>
8370: </ul></div>
8371: </div>
1.41 asau 8372: <div class="sect2">
1.1 dsieger 8373: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8374: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8375: <p>If a package needs GNU autoconf or automake to be executed
8376: to regenerate the configure script and Makefile.in makefile
8377: templates, then they should be executed in a pre-configure
8378: target.</p>
8379: <p>For packages that need only autoconf:</p>
8380: <pre class="programlisting">
8381: AUTOCONF_REQD= 2.50 # if default version is not good enough
8382: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8383: ...
8384:
8385: pre-configure:
8386: cd ${WRKSRC} && autoconf
8387:
8388: ...
1.111 sevan 8389: </pre>
1.1 dsieger 8390: <p>and for packages that need automake and autoconf:</p>
8391: <pre class="programlisting">
8392: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8393: USE_TOOLS+= automake # use "automake14" for automake-1.4
8394: ...
8395:
8396: pre-configure:
8397: set -e; cd ${WRKSRC}; \
8398: aclocal; autoheader; automake -a --foreign -i; autoconf
8399:
8400: ...
1.111 sevan 8401: </pre>
1.1 dsieger 8402: <p>Packages which use GNU Automake will almost certainly
8403: require GNU Make.</p>
8404: <p>There are times when the configure process makes
8405: additional changes to the generated files, which then causes
8406: the build process to try to re-execute the automake sequence.
8407: This is prevented by touching various files in the configure
8408: stage. If this causes problems with your package you can set
8409: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8410: Makefile.</p>
8411: </div>
8412: </div>
1.41 asau 8413: <div class="sect1">
1.1 dsieger 8414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8415: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41 asau 8416: <div class="sect2">
1.1 dsieger 8417: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8418: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8419: <p>Compilers for the C, C++, and Fortran languages comes with
8420: the NetBSD base system. By default, pkgsrc assumes that a package
8421: is written in C and will hide all other compilers (via the wrapper
1.184 rillig 8422: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8423: <p>To declare which language's compiler a package needs, set
8424: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 8425: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8426: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8427: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8428: written in C++, usually need a C compiler for the configure
8429: phase.</p>
8430: </div>
1.41 asau 8431: <div class="sect2">
1.1 dsieger 8432: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8433: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 8434: <p>If a program is written in Java, use the Java framework in
8435: pkgsrc. The package must include
8436: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8437: provides the following variables:</p>
1.41 asau 8438: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8439: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8440: dependency on the JDK is added. If
1.23 wiz 8441: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8442: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8443: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8444: JDK.</p></li>
1.23 wiz 8445: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8446: a package needs a Java2 implementation. The supported values
1.23 wiz 8447: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8448: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8449: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8450: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8451: above. This variable is not set by default.</p></li>
1.24 wiz 8452: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8453: automatically set to the runtime location of the used Java
8454: implementation dependency. It may be used to set
8455: <code class="varname">JAVA_HOME</code> to a good value if the program
8456: needs this variable to be defined.
8457: </p></li>
1.1 dsieger 8458: </ul></div>
8459: </div>
1.41 asau 8460: <div class="sect2">
1.1 dsieger 8461: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 8462: <a name="perl-scripts"></a>21.4.3. Packages containing Perl scripts</h3></div></div></div>
8463: <p>If your package contains interpreted Perl scripts, add
1.23 wiz 8464: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8465: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8466: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8467: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8468: that you want adjusted. Every occurrence of
8469: <code class="filename">*/bin/perl</code> in a she-bang line will be
8470: replaced with the full path to the perl executable.</p>
1.1 dsieger 8471: <p>If a particular version of perl is needed, set the
8472: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8473: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.203 nia 8474: <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.1 dsieger 8475: about handling perl modules.</p>
8476: </div>
1.41 asau 8477: <div class="sect2">
1.1 dsieger 8478: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8479: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 8480: <p><code class="varname">REPLACE_SH</code>,
8481: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8482: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.195 gutterid 8483: hash bangs in files. Please use the appropriate one, preferring
1.40 wiz 8484: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 8485: Each should contain a list of scripts, relative to
8486: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8487: occurrence of the matching shell in a she-bang line will be
8488: replaced with the full path to the shell executable.
1.40 wiz 8489: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8490: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8491: </div>
1.41 asau 8492: <div class="sect2">
1.40 wiz 8493: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8494: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 8495: <p>Currently, there is no special handling for other languages
8496: in pkgsrc. If a compiler package provides a
8497: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8498: just add a (build) dependency on the appropriate compiler
8499: package.</p>
8500: </div>
8501: </div>
1.41 asau 8502: <div class="sect1">
1.1 dsieger 8503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8504: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8505: <p>The most common failures when building a package are that
8506: some platforms do not provide certain header files, functions or
8507: libraries, or they provide the functions in a library that the
8508: original package author didn't know. To work around this, you
8509: can rewrite the source code in most cases so that it does not
8510: use the missing functions or provides a replacement function.</p>
1.41 asau 8511: <div class="sect2">
1.1 dsieger 8512: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8513: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8514: <p>If a package already comes with a GNU configure script, the
8515: preferred way to fix the build failure is to change the
8516: configure script, not the code. In the other cases, you can
8517: utilize the C preprocessor, which defines certain macros
8518: depending on the operating system and hardware architecture it
8519: compiles for. These macros can be queried using for example
8520: <code class="varname">#if defined(__i386)</code>. Almost every operating
8521: system, hardware architecture and compiler has its own macro.
8522: For example, if the macros <code class="varname">__GNUC__</code>,
8523: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8524: are all defined, you know that you are using NetBSD on an i386
8525: compatible CPU, and your compiler is GCC.</p>
8526: <p>The list of the following macros for hardware and
8527: operating system depends on the compiler that is used. For
8528: example, if you want to conditionally compile code on Solaris,
8529: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8530: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8531: <div class="sect3">
1.1 dsieger 8532: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8533: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1 dsieger 8534: <p>To distinguish between 4.4 BSD-derived systems and the
8535: rest of the world, you should use the following code.</p>
8536: <pre class="programlisting">
8537: #include <sys/param.h>
8538: #if (defined(BSD) && BSD >= 199306)
8539: /* BSD-specific code goes here */
8540: #else
8541: /* non-BSD-specific code goes here */
8542: #endif
8543: </pre>
8544: <p>If this distinction is not fine enough, you can also test
8545: for the following macros.</p>
8546: <pre class="programlisting">
1.45 obache 8547: Cygwin __CYGWIN__
8548: DragonFly __DragonFly__
1.1 dsieger 8549: FreeBSD __FreeBSD__
1.45 obache 8550: Haiku __HAIKU__
1.1 dsieger 8551: Interix __INTERIX
8552: IRIX __sgi (TODO: get a definite source for this)
8553: Linux linux, __linux, __linux__
1.83 dholland 8554: Mac OS X __APPLE__
1.45 obache 8555: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8556: Minix3 __minix
1.1 dsieger 8557: NetBSD __NetBSD__
8558: OpenBSD __OpenBSD__
8559: Solaris sun, __sun
8560: </pre>
8561: </div>
1.41 asau 8562: <div class="sect3">
1.1 dsieger 8563: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8564: <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 8565: <pre class="programlisting">
8566: i386 i386, __i386, __i386__
8567: MIPS __mips
8568: SPARC sparc, __sparc
8569: </pre>
8570: </div>
1.41 asau 8571: <div class="sect3">
1.1 dsieger 8572: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8573: <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 8574: <pre class="programlisting">
8575: GCC __GNUC__ (major version), __GNUC_MINOR__
8576: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8577: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8578: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8579: </pre>
8580: </div>
8581: </div>
1.41 asau 8582: <div class="sect2">
1.1 dsieger 8583: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8584: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8585: <p>Some source files trigger bugs in the compiler, based on
8586: combinations of compiler version and architecture and almost
8587: always relation to optimisation being enabled. Common symptoms
8588: are gcc internal errors or never finishing compiling a
8589: file.</p>
8590: <p>Typically, a workaround involves testing the
8591: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8592: optimisation for that combination of file,
1.87 tnn 8593: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8594: <p>This used to be a big problem in the past, but is rarely
8595: needed now as compiler technology has matured. If you still need
8596: to add a compiler specific workaround, please do so in the file
8597: <code class="filename">hacks.mk</code> and describe the symptom and
8598: compiler version as detailed as possible.</p>
1.1 dsieger 8599: </div>
1.41 asau 8600: <div class="sect2">
1.1 dsieger 8601: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8602: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8603: <p>Compilation sometimes fails with an error message like this:</p>
8604: <pre class="programlisting">
8605: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8606: fatal error: pango/pango.h: No such file or directory
8607: </pre>
8608: <p>The proper way to fix this problem depends on the type of the
8609: header, which is described in the following sections.</p>
8610: <div class="sect3">
8611: <div class="titlepage"><div><div><h4 class="title">
8612: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8613: <p>If the header name looks like it comes from a different package,
8614: that other package should be included via the buildlink3
8615: framework.</p>
8616: <p>First, look whether the header is somewhere in the buildlink3
8617: directory below <code class="varname">WRKDIR</code>. In the above case of
8618: the missing Pango header:</p>
8619: <pre class="programlisting">
8620: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8621: </pre>
8622: <p>In the case of Pango, the output is:</p>
8623: <pre class="programlisting">
8624: work/.buildlink/include/pango-1.0/pango/pango.h
8625: </pre>
8626: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8627: in the <code class="filename">.buildlink</code> directory, it would have been
8628: found automatically. There is an extra <code class="filename">pango-1.0</code>
8629: path component though, which means that the compiler command line must
8630: contain an option of the form
8631: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8632: most cases this option is generated by the configure script, which can be examined using:</p>
8633: <pre class="programlisting">
8634: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8635: -I/usr/pkg/include/pango-1.0
8636: -I/usr/pkg/include/pango-1.0
8637: -I/usr/pkg/include/pango-1.0
8638: -I/usr/pkg/include/pango-1.0
8639: -I/usr/pkg/include/pango-1.0
8640: </pre>
8641: <p>This looks good. These options are transformed by the buildlink
8642: wrapper to refer to the correct path inside
8643: <code class="filename">work/.buildlink</code>.</p>
8644: <p>Since the compilation fails though, examine the compiler command
8645: lines in <code class="filename">work/.work.log</code> to see whether the
8646: <code class="literal">-I</code> option is included in the particular command
8647: line.</p>
8648: <p>To further analyze the situation, run <span class="command"><strong>bmake
8649: build-env</strong></span>, which sets up an interactive, realistic environment
8650: including all the pkgsrc wrapper commands and environment variables. From
8651: there, try to compile some simple example programs that use the
8652: header.</p>
8653: </div>
8654: <div class="sect3">
8655: <div class="titlepage"><div><div><h4 class="title">
8656: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8657: <p>If the name of the header seems to come from the package itself,
8658: and if the build is run with parallel jobs, the package may have some
8659: undeclared dependencies between the <code class="filename">.c</code> and the
8660: <code class="filename">.h</code> files, and a C file is compiled before its
8661: required header is generated.</p>
8662: <p>To see whether the build runs with parallel jobs, run
8663: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8664: like this:</p>
8665: <pre class="programlisting">
8666: usr MAKE_JOBS= 7
8667: pkg MAKE_JOBS_SAFE # undefined
8668: def _MAKE_JOBS_N= 7
8669: </pre>
8670: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8671: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8672: package could have disabled parallel builds by setting
8673: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8674: in this case it hasn't.</p>
8675: <p>To see whether the build failure is caused by parallel builds,
8676: first save the exact error message and a bit of context, maybe you need
8677: it later for reporting a bug. Next, run:</p>
8678: <pre class="programlisting">
8679: MAKE_JOBS_SAFE=no bmake clean build
8680: </pre>
8681: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8682: report</a> against the pkgsrc package, including the exact error
8683: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8684: </div>
1.173 rillig 8685: <div class="sect3">
8686: <div class="titlepage"><div><div><h4 class="title">
8687: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
8688: <p>Pkgsrc does not work reliably if any of
8689: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
8690: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
8691: bootstrap program prevents installing pkgsrc in symlink-based
8692: directories. Existing pkgsrc installations are not checked for symlinks
8693: though.</p>
8694: <p>The "No such file or directory" error messages are a typical
8695: symptom of symlinks, and it's quite difficult to find out that this is
8696: the actual cause.</p>
8697: </div>
8698: <div class="sect3">
8699: <div class="titlepage"><div><div><h4 class="title">
8700: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
8701: <p>When building a hierarchy of packages, it may happen that one
8702: package is built and then pkgsrc is updated. This situation can provoke
8703: various hard to diagnose build errors. To clean up the situation:</p>
8704: <pre class="programlisting">
8705: <code class="prompt">$</code> (cd ../../ && test -f mk/bsd.pkg.mk && rm -rf */*/work)
8706: </pre>
8707: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
8708: this command in the wrong directory.)</p>
8709: <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
8710: that directory as well.</p>
8711: </div>
8712: <div class="sect3">
8713: <div class="titlepage"><div><div><h4 class="title">
8714: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
8715: <p>On platforms other than BSD, third-party packages are installed in
8716: <code class="filename">/usr/include</code>, together with the base system. This
8717: means that pkgsrc cannot distinguish between headers provided by the base
8718: system (which it needs) and headers from third-party packages (which are
8719: often included in pkgsrc as well). This can lead to subtle version
8720: mismatches.</p>
8721: <p>In pkgsrc installations that have been active for several years, it
8722: may happen that some files are manually deleted. To exclude this unlikely
8723: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
8724: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
8725: check/fix dependencies.</p>
8726: <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>
8727: for contact information. Be prepared to describe what you have tried so
8728: far and what any error messages were.</p>
8729: </div>
1.172 rillig 8730: </div>
8731: <div class="sect2">
8732: <div class="titlepage"><div><div><h3 class="title">
8733: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 8734: </h3></div></div></div>
1.1 dsieger 8735: <p>This error message often means that a package did not
8736: link to a shared library it needs. The following functions are
8737: known to cause this error message over and over.</p>
8738: <div class="informaltable">
1.106 tnn 8739: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 8740: <colgroup>
8741: <col>
8742: <col>
8743: <col>
8744: </colgroup>
8745: <thead><tr>
8746: <th>Function</th>
8747: <th>Library</th>
8748: <th>Affected platforms</th>
8749: </tr></thead>
8750: <tbody>
8751: <tr>
8752: <td>accept, bind, connect</td>
8753: <td>-lsocket</td>
8754: <td>Solaris</td>
8755: </tr>
8756: <tr>
8757: <td>crypt</td>
8758: <td>-lcrypt</td>
8759: <td>DragonFly, NetBSD</td>
8760: </tr>
8761: <tr>
8762: <td>dlopen, dlsym</td>
8763: <td>-ldl</td>
8764: <td>Linux</td>
8765: </tr>
8766: <tr>
8767: <td>gethost*</td>
8768: <td>-lnsl</td>
8769: <td>Solaris</td>
8770: </tr>
8771: <tr>
8772: <td>inet_aton</td>
8773: <td>-lresolv</td>
8774: <td>Solaris</td>
8775: </tr>
8776: <tr>
8777: <td>nanosleep, sem_*, timer_*</td>
8778: <td>-lrt</td>
8779: <td>Solaris</td>
8780: </tr>
8781: <tr>
8782: <td>openpty</td>
8783: <td>-lutil</td>
8784: <td>Linux</td>
8785: </tr>
8786: </tbody>
8787: </table>
8788: </div>
8789: <p>To fix these linker errors, it is often sufficient to say
8790: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8791: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8792: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8793: bmake</strong></span>.</p>
1.41 asau 8794: <div class="sect3">
1.1 dsieger 8795: <div class="titlepage"><div><div><h4 class="title">
1.172 rillig 8796: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8797: <p>When you are using the SunPro compiler, there is another
8798: possibility. That compiler cannot handle the following code:</p>
8799: <pre class="programlisting">
8800: extern int extern_func(int);
8801:
8802: static inline int
8803: inline_func(int x)
8804: {
8805: return extern_func(x);
8806: }
8807:
8808: int main(void)
8809: {
8810: return 0;
8811: }
8812: </pre>
8813: <p>It generates the code for <code class="function">inline_func</code> even if
8814: that function is never used. This code then refers to
8815: <code class="function">extern_func</code>, which can usually not be resolved. To
8816: solve this problem you can try to tell the package to disable inlining
8817: of functions.</p>
8818: </div>
8819: </div>
1.41 asau 8820: <div class="sect2">
1.1 dsieger 8821: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8822: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1 dsieger 8823: <p>Sometimes packages fail to build because the compiler runs
8824: into an operating system specific soft limit. With the
8825: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 8826: to unlimit the resources. Currently, the allowed values are any combination of
8827: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8828: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 8829: Setting this variable is similar to running the shell builtin
1.10 hubertf 8830: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8831: segment size or maximum stack size of a process, respectively, to
8832: their hard limits.</p>
8833: </div>
8834: </div>
1.41 asau 8835: <div class="sect1">
1.1 dsieger 8836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8837: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 8838: <div class="sect2">
1.1 dsieger 8839: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8840: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8841: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8842: with some operating systems cannot create more than one
8843: directory at a time. As such, you should call
8844: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8845: <pre class="programlisting">
8846: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8847: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 8848: </pre>
1.23 wiz 8849: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8850: dir2</code></span>”</span> to the
1.1 dsieger 8851: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8852: automatically do the right thing.</p>
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="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8857: <p>In general, documentation should be installed into
8858: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8859: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8860: includes the version number of the package).</p>
8861: <p>Many modern packages using GNU autoconf allow to set the
8862: directory where HTML documentation is installed with the
1.23 wiz 8863: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8864: is needed because otherwise the documentation ends up in
8865: <code class="filename">${PREFIX}/share/doc/html</code> or other
8866: places.</p>
8867: <p>An exception to the above is that library API documentation
1.137 leot 8868: generated with the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.1 dsieger 8869: browsers (devhelp) should be left at their default location, which
8870: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8871: documentation can be recognized from files ending in
8872: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8873: (It is also acceptable to install such files in
8874: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8875: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8876: <code class="filename">.devhelp*</code> file must be directly in that
8877: directory then, no additional subdirectory level is allowed in
8878: this case. This is usually achieved by using
1.23 wiz 8879: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8880: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8881: though.)</p>
8882: </div>
1.41 asau 8883: <div class="sect2">
1.1 dsieger 8884: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8885: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8886: <p>Certain packages, most of them in the games category, install
8887: a score file that allows all users on the system to record their
8888: highscores. In order for this to work, the binaries need to be
8889: installed setgid and the score files owned by the appropriate
1.35 wiz 8890: group and/or owner (traditionally the "games" user/group). Set
8891: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8892: following variables, documented in more detail in
8893: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8894: behaviour: <code class="varname">GAMEDATAMODE</code>,
8895: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8896: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8897: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8898: <code class="varname">GAMEDATA_PERMS</code> and
8899: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8900: <p>An example that illustrates some of the variables described above is
8901: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8902: used to properly set directory permissions of the directory where the
8903: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8904: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8905: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8906: binary:</p>
8907: <pre class="programlisting">
1.112 rillig 8908: USE_GAMESGROUP= yes
1.100 leot 8909:
1.112 rillig 8910: BUILD_DEFS+= VARBASE
1.100 leot 8911:
1.112 rillig 8912: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8913: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8914: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 8915: </pre>
1.100 leot 8916: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8917: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8918: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8919: needed to be accessed by setgid games and
8920: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8921: <p>A package should therefore never hard code file ownership or
1.100 leot 8922: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8923: or alternatively on <code class="varname">INSTALL_GAME</code>,
8924: <code class="varname">INSTALL_GAME_DATA</code> and
8925: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8926: </div>
1.41 asau 8927: <div class="sect2">
1.1 dsieger 8928: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8929: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8930: <p><code class="varname">DESTDIR</code> support means that a package
8931: installs into a staging directory, not the final location of the
8932: files. Then a binary package is created which can be used for
8933: installation as usual. There are two ways: Either the package must
1.23 wiz 8934: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8935: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8936: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8937: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 8938: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8939: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 8940: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8941: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8942: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8943: the inclusion.</p></li>
1.23 wiz 8944: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8945: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8946: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8947: automatically. Many manual rules and pre/post-install often are
8948: incorrect; fix them.</p></li>
1.23 wiz 8949: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8950: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8951: <li class="listitem"><p>In general, packages should support
1.4 rillig 8952: <code class="varname">UNPRIVILEGED</code> to be able to use
8953: DESTDIR.</p></li>
8954: </ul></div>
8955: </div>
1.41 asau 8956: <div class="sect2">
1.4 rillig 8957: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8958: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8959: <p>Your package may also contain scripts with hardcoded paths to
1.203 nia 8960: other interpreters besides (or as well as) Perl. To correct the
1.1 dsieger 8961: full pathname to the script interpreter, you need to set the
8962: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8963: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8964: <pre class="programlisting">
8965: REPLACE_INTERPRETER+= tcl
8966: REPLACE.tcl.old= .*/bin/tclsh
8967: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8968: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8969: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 8970: </pre>
1.41 asau 8971: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8972: <h3 class="title">Note</h3>
8973: <p>Before March 2006, these variables were called
8974: <code class="varname">_REPLACE.*</code> and
8975: <code class="varname">_REPLACE_FILES.*</code>.</p>
8976: </div>
8977: </div>
1.41 asau 8978: <div class="sect2">
1.1 dsieger 8979: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 8980: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.1 dsieger 8981: <p>Makefiles of packages providing perl5 modules should include
8982: the Makefile fragment
8983: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8984: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8985: configuration for such modules as well as various hooks to tune
8986: this configuration. See comments in this file for
8987: details.</p>
8988: <p>Perl5 modules will install into different places depending
8989: on the version of perl used during the build process. To
8990: address this, pkgsrc will append lines to the
8991: <code class="filename">PLIST</code> corresponding to the files listed in
8992: the installed <code class="filename">.packlist</code> file generated by
8993: most perl5 modules. This is invoked by defining
8994: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8995: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8996: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8997: e.g.:</p>
1.1 dsieger 8998: <pre class="programlisting">
1.47 wiz 8999: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 9000: </pre>
1.47 wiz 9001: <p>The perl5 config variables
9002: <code class="varname">installarchlib</code>,
9003: <code class="varname">installscript</code>,
9004: <code class="varname">installvendorbin</code>,
9005: <code class="varname">installvendorscript</code>,
9006: <code class="varname">installvendorarch</code>,
9007: <code class="varname">installvendorlib</code>,
9008: <code class="varname">installvendorman1dir</code>, and
9009: <code class="varname">installvendorman3dir</code> represent those
9010: locations in which components of perl5 modules may be installed,
9011: provided as variable with uppercase and prefixed with
9012: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9013: and may be used by perl5 packages that don't have a packlist.
9014: These variables are also substituted for in the
9015: <code class="filename">PLIST</code> as uppercase prefixed with
9016: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 9017: </div>
1.41 asau 9018: <div class="sect2">
1.1 dsieger 9019: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9020: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 9021: <p>Some packages install info files or use the
1.23 wiz 9022: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 9023: commands. <code class="varname">INFO_FILES</code> should be defined in
9024: the package Makefile so that <code class="filename">INSTALL</code> and
9025: <code class="filename">DEINSTALL</code> scripts will be generated to
9026: handle registration of the info files in the Info directory
1.23 wiz 9027: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 9028: files registration is either provided by the system, or by a
9029: special purpose package automatically added as dependency if
9030: needed.</p>
9031: <p><code class="varname">PKGINFODIR</code> is the directory under
9032: <code class="filename">${PREFIX}</code> where info files are primarily
9033: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 9034: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 9035: <p>The info files for the package should be listed in the
9036: package <code class="filename">PLIST</code>; however any split info files
9037: need not be listed.</p>
1.23 wiz 9038: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9039: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 9040: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 9041: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 9042: should be noted with the <code class="varname">TEXINFO_REQD</code>
9043: variable in the package <code class="filename">Makefile</code>. By
9044: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 9045: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 9046: does not match the required minimum, a build dependency on the
1.137 leot 9047: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.1 dsieger 9048: be added automatically.</p>
9049: <p>The build and installation process of the software provided
9050: by the package should not use the
1.10 hubertf 9051: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 9052: info files is the task of the package
9053: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 9054: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 9055: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 9056: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9057: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 9058: in <code class="varname">PATH</code>.</p>
1.10 hubertf 9059: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 9060: no effect except the logging of a message. The script overriding
1.10 hubertf 9061: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 9062: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 9063: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 9064: </div>
1.41 asau 9065: <div class="sect2">
1.1 dsieger 9066: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9067: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9068: <p>All packages that install manual pages should install them
9069: into the same directory, so that there is one common place to look
9070: for them. In pkgsrc, this place is
9071: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9072: should be used in packages. The default for
9073: <code class="varname">PKGMANDIR</code> is
1.23 wiz 9074: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9075: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 9076: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9077: <h3 class="title">Note</h3>
9078: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9079: is far from complete.</p>
9080: </div>
9081: <p>The <code class="filename">PLIST</code> files can just use
9082: <code class="filename">man/</code> as the top level directory for the man
9083: page file entries, and the pkgsrc framework will convert as
9084: needed. In all other places, the correct
9085: <code class="varname">PKGMANDIR</code> must be used.</p>
9086: <p>Packages that are
9087: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 9088: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 9089: <code class="filename">./configure</code>
9090: --mandir switch to set where the man pages should be installed.
9091: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9092: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9093: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9094: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 9095: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 9096: Or if the <code class="filename">./configure</code> script uses
9097: a non-standard use of --mandir, you can set
9098: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.184 rillig 9099: <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 9100: information on installation of compressed manual pages.</p>
9101: </div>
1.41 asau 9102: <div class="sect2">
1.1 dsieger 9103: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9104: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9105: <p>If a package installs font files, you will need to rebuild
9106: the fonts database in the directory where they get installed at
9107: installation and deinstallation time. This can be automatically
9108: done by using the pkginstall framework.</p>
9109: <p>You can list the directories where fonts are installed in the
9110: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9111: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 9112: <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 9113: Also make sure that the database file
9114: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9115: <p>Note that you should not create new directories for fonts;
9116: instead use the standard ones to avoid that the user needs to
9117: manually configure his X server to find them.</p>
9118: </div>
1.41 asau 9119: <div class="sect2">
1.1 dsieger 9120: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9121: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9122: <p>If a package installs SGML or XML data files that need to be
9123: registered in system-wide catalogs (like DTDs, sub-catalogs,
9124: etc.), you need to take some extra steps:</p>
1.23 wiz 9125: <div class="orderedlist"><ol class="orderedlist" type="1">
9126: <li class="listitem"><p>Include
1.1 dsieger 9127: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9128: your <code class="filename">Makefile</code>, which takes care of
9129: registering those files in system-wide catalogs at
9130: installation and deinstallation time.</p></li>
1.23 wiz 9131: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9132: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9133: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9134: any XML catalogs installed by the package.</p></li>
1.23 wiz 9135: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9136: to be added to the SGML catalog. These come in groups of
9137: three strings; see xmlcatmgr(1) for more information
9138: (specifically, arguments recognized by the 'add' action).
9139: Note that you will normally not use this variable.</p></li>
1.23 wiz 9140: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9141: to be added to the XML catalog. These come in groups of three
9142: strings; see xmlcatmgr(1) for more information (specifically,
9143: arguments recognized by the 'add' action). Note that you will
9144: normally not use this variable.</p></li>
9145: </ol></div>
9146: </div>
1.41 asau 9147: <div class="sect2">
1.1 dsieger 9148: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9149: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9150: <p>If a package provides extensions to the MIME database by
9151: installing <code class="filename">.xml</code> files inside
9152: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9153: need to take some extra steps to ensure that the database is kept
9154: consistent with respect to these new files:</p>
1.23 wiz 9155: <div class="orderedlist"><ol class="orderedlist" type="1">
9156: <li class="listitem"><p>Include
1.1 dsieger 9157: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9158: (avoid using the <code class="filename">buildlink3.mk</code> file from
9159: this same directory, which is reserved for inclusion from
9160: other <code class="filename">buildlink3.mk</code> files). It takes
9161: care of rebuilding the MIME database at installation and
9162: deinstallation time, and disallows any access to it directly
9163: from the package.</p></li>
1.23 wiz 9164: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9165: <code class="filename">share/mime</code> directory,
9166: <span class="emphasis"><em>except</em></span> for files saved under
9167: <code class="filename">share/mime/packages</code>. The former are
9168: handled automatically by
9169: the update-mime-database program, but the latter are
9170: package-dependent and must be removed by the package that
9171: installed them in the first place.</p></li>
1.23 wiz 9172: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9173: from the PLIST. They will be handled by the shared-mime-info
9174: package.</p></li>
9175: </ol></div>
9176: </div>
1.41 asau 9177: <div class="sect2">
1.1 dsieger 9178: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9179: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.1 dsieger 9180: <p>If a package uses intltool during its build, add
9181: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9182: which forces it to use the intltool package provided by pkgsrc,
9183: instead of the one bundled with the distribution file.</p>
9184: <p>This tracks intltool's build-time dependencies and uses the
9185: latest available version; this way, the package benefits of any
9186: bug fixes that may have appeared since it was released.</p>
9187: </div>
1.41 asau 9188: <div class="sect2">
1.1 dsieger 9189: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9190: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9191: <p>If a package contains a rc.d script, it won't be copied into
9192: the startup directory by default, but you can enable it, by adding
9193: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9194: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9195: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9196: it will automatically remove the scripts when the package is
9197: deinstalled.</p>
9198: </div>
1.41 asau 9199: <div class="sect2">
1.1 dsieger 9200: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9201: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9202: <p>If a package installs TeX packages into the texmf tree,
9203: the <code class="filename">ls-R</code> database of the tree needs to be
9204: updated.</p>
1.41 asau 9205: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9206: <h3 class="title">Note</h3>
1.22 jakllsch 9207: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9208: packages should install files
1.22 jakllsch 9209: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9210: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9211: </div>
1.23 wiz 9212: <div class="orderedlist"><ol class="orderedlist" type="1">
9213: <li class="listitem"><p>Include
1.22 jakllsch 9214: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9215: takes care of rebuilding the <code class="filename">ls-R</code>
9216: database at installation and deinstallation time.</p></li>
1.23 wiz 9217: <li class="listitem">
1.1 dsieger 9218: <p>If your package installs files into a texmf
9219: tree other than the one
1.22 jakllsch 9220: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9221: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9222: trees that need database update.</p>
9223: <p>If your package also installs font map files that need
1.10 hubertf 9224: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9225: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9226: set <code class="varname">TEX_MAP_FILES</code> and/or
9227: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9228: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9229: be run automatically at installation/deinstallation to
9230: enable/disable font map files for TeX output
9231: drivers.</p>
9232: </li>
1.23 wiz 9233: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9234: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9235: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9236: </ol></div>
9237: </div>
1.41 asau 9238: <div class="sect2">
1.1 dsieger 9239: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9240: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.1 dsieger 9241: emulation</h3></div></div></div>
9242: <p>There are some packages that provide libraries and
9243: executables for running binaries from a one operating system
9244: on a different one (if the latter supports it). One example
9245: is running Linux binaries on NetBSD.</p>
1.137 leot 9246: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.1 dsieger 9247: helps in extracting and packaging Linux rpm packages.</p>
9248: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9249: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9250: if all libraries for each installed executable can be found by
9251: the dynamic linker. Since the standard dynamic linker is run,
9252: this fails for emulation packages, because the libraries used
9253: by the emulation are not in the standard directories.</p>
9254: </div>
1.184 rillig 9255: <div class="sect2">
9256: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9257: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.184 rillig 9258: <p>If a package installs images under the
9259: <code class="filename">share/icons/hicolor</code> and/or updates the
9260: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9261: database, you need to take some extra steps to make sure that the
9262: shared theme directory is handled appropriately and that the cache
9263: database is rebuilt:</p>
9264: <div class="orderedlist"><ol class="orderedlist" type="1">
9265: <li class="listitem"><p>Include
9266: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9267: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9268: entry that refers to the theme cache.</p></li>
9269: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9270: directories from the <code class="filename">share/icons/hicolor</code>
9271: hierarchy because they will be handled automatically.</p></li>
9272: </ol></div>
9273: <p>The best way to verify that the PLIST is correct with
9274: respect to the last two points is to regenerate it using
9275: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9276: </div>
9277: <div class="sect2">
9278: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9279: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.184 rillig 9280: <p>If a package installs <code class="filename">.desktop</code> files
9281: under <code class="filename">share/applications</code> and these include
9282: MIME information (MimeType key), you need to take extra steps to
9283: ensure that they are registered into the MIME database:</p>
9284: <div class="orderedlist"><ol class="orderedlist" type="1">
9285: <li class="listitem"><p>Include
9286: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9287: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9288: <code class="filename">share/applications/mimeinfo.cache</code> file.
9289: It will be handled automatically.</p></li>
9290: </ol></div>
9291: <p>The best way to verify that the PLIST is correct with
9292: respect to the last point is to regenerate it using <span class="command"><strong>make
9293: print-PLIST</strong></span>.</p>
9294: </div>
9295: </div>
9296: <div class="sect1">
9297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9298: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9299: <p>In some cases one does not have the time to solve a problem
9300: immediately. In this case, one can plainly mark a package as broken. For
9301: this, one just sets the variable <code class="varname">BROKEN</code> to the
9302: reason why the package is broken (similar to the
9303: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9304: the package will immediately be shown this message, and the build
9305: will not be even tried.</p>
9306: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9307: intervals.</p>
9308: </div>
9309: </div>
9310: <div class="chapter">
9311: <div class="titlepage"><div><div><h2 class="title">
9312: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9313: <div class="toc">
9314: <p><b>Table of Contents</b></p>
9315: <dl class="toc">
9316: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9317: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9318: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9319: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9320: </dl>
9321: </div>
9322: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9323: site</a>:</p>
9324: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9325: environment, an intuitive and attractive desktop for users, and the
9326: GNOME development platform, an extensive framework for building
9327: applications that integrate into the rest of the desktop.</p></blockquote></div>
9328: <p>pkgsrc provides a seamless way to automatically build and install
9329: a complete GNOME environment <span class="emphasis"><em>under many different
9330: platforms</em></span>. We can say with confidence that pkgsrc is one of
9331: the most advanced build and packaging systems for GNOME due to its
9332: included technologies buildlink3, the wrappers and tools framework and
9333: automatic configuration file management. Lots of efforts are put into
9334: achieving a completely clean deinstallation of installed software
9335: components.</p>
9336: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9337: the above also means that great efforts are put into making GNOME work
1.201 cirnatda 9338: under this operating system.</p>
1.184 rillig 9339: <p>This chapter is aimed at pkgsrc developers and other people
9340: interested in helping our GNOME porting and packaging efforts. It
9341: provides instructions on how to manage the existing packages and some
9342: important information regarding their internals.</p>
9343: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9344: <h3 class="title">We need your help!</h3>
9345: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9346: and GNOME and are willing to learn new exciting stuff, please jump
9347: straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9348: work</a> list! There is still a long way to go to get a
9349: fully-functional GNOME desktop under NetBSD and we need your help to
9350: achieve it!</p>
9351: </div>
9352: <div class="sect1">
9353: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9354: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9355: <p>pkgsrc includes three GNOME-related meta packages:</p>
9356: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9357: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
9358: the core GNOME desktop environment. It only includes the necessary
9359: bits to get it to boot correctly, although it may lack important
9360: functionality for daily operation. The idea behind this package is
9361: to let end users build their own configurations on top of this one,
9362: first installing this meta package to achieve a functional setup and
9363: then adding individual applications.</p></li>
9364: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
9365: complete installation of the GNOME platform and desktop as defined
9366: by the GNOME project; this is based on the components distributed in
9367: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9368: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9369: official FTP server. Developer-only tools found in those
9370: directories are not installed unless required by some other
9371: component to work properly. Similarly, packages from the bindings
9372: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9373: in unless required as a dependency for an end-user component. This
9374: package "extends" <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
9375: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
9376: Installs all the tools required to build a GNOME component when
9377: fetched from the CVS repository. These are required to let the
9378: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9379: </ul></div>
9380: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9381: sorted in a way that eases updates: a package may depend on other
9382: packages listed before it but not on any listed after it. It is very
9383: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9384: change it to alphabetical sorting!</em></span></p>
9385: </div>
9386: <div class="sect1">
9387: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9388: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9389: <p>Almost all GNOME applications are written in C and use a common
9390: set of tools as their build system. Things get different with the new
9391: bindings to other languages (such as Python), but the following will
9392: give you a general idea on the minimum required tools:</p>
9393: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9394: <li class="listitem">
9395: <p>Almost all GNOME applications use the GNU Autotools as their
9396: build system. As a general rule you will need to tell this to your
9397: package:</p>
9398: <pre class="programlisting">
9399: GNU_CONFIGURE=yes
9400: USE_LIBTOOL=yes
9401: USE_TOOLS+=gmake
9402: </pre>
9403: </li>
9404: <li class="listitem">
9405: <p>If the package uses pkg-config to detect dependencies, add this
9406: tool to the list of required utilities:</p>
9407: <pre class="programlisting">
9408: USE_TOOLS+=pkg-config
9409: </pre>
9410: <p>Also use <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
9411: the end of the build process to ensure that you did not miss to
9412: specify any dependency in your package and that the version
9413: requirements are all correct.</p>
9414: </li>
9415: <li class="listitem"><p>If the package uses intltool, be sure to add
9416: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9417: to handle dependencies and to force the package to use the latest
9418: available version.</p></li>
9419: <li class="listitem">
9420: <p>If the package uses gtk-doc (a documentation generation
9421: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9422: tool is rather big and the distfile should come with pregenerated
9423: documentation anyway; if it does not, it is a bug that you ought to
9424: report. For such packages you should disable gtk-doc (unless it is
9425: the default):</p>
9426: <pre class="programlisting">
9427: CONFIGURE_ARGS+=--disable-gtk-doc
9428: </pre>
9429: <p>The default location of installed HTML files
9430: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9431: and should not be changed unless the package insists on installing
9432: them somewhere else. Otherwise programs as
9433: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9434: do that with an entry similar to:</p>
9435: <pre class="programlisting">
9436: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9437: </pre>
9438: </li>
9439: </ul></div>
9440: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9441: files under the installation prefix to maintain databases. In this
9442: context, shared means that those exact same directories and files are
9443: used among several different packages, leading to conflicts in the
9444: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9445: handle the most common cases, so you have to forget about using
9446: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9447: omitting shared files from them. If you find yourself doing those,
9448: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9449: <p>The following table lists the common situations that result in
9450: using shared directories or files. For each of them, the appropriate
9451: solution is given. After applying the solution be sure to
9452: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9453: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9454: <div class="table">
9455: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9456: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9457: <colgroup>
9458: <col>
9459: <col>
9460: </colgroup>
9461: <thead><tr>
9462: <th>If the package...</th>
9463: <th>Then...</th>
9464: </tr></thead>
9465: <tbody>
9466: <tr>
9467: <td>Installs icons under the
9468: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9469: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.203 nia 9470: <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 9471: </tr>
9472: <tr>
9473: <td>Installs files under
9474: <code class="filename">share/mime/packages</code>.</td>
1.203 nia 9475: <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 9476: </tr>
9477: <tr>
9478: <td>Installs <code class="filename">.desktop</code> files under
9479: <code class="filename">share/applications</code> and these include MIME
9480: information.</td>
1.203 nia 9481: <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 9482: </tr>
9483: </tbody>
9484: </table></div>
1.1 dsieger 9485: </div>
1.184 rillig 9486: <br class="table-break">
1.1 dsieger 9487: </div>
1.41 asau 9488: <div class="sect1">
1.1 dsieger 9489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 9490: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9491: <p>When seeing GNOME as a whole, there are two kinds of
9492: updates:</p>
9493: <div class="variablelist"><dl class="variablelist">
9494: <dt><span class="term">Major update</span></dt>
9495: <dd>
9496: <p>Given that there is still a very long way for GNOME 3 (if it
9497: ever appears), we consider a major update one that goes from a
9498: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9499: where <code class="literal">Y</code> is even and greater than
9500: <code class="literal">X</code>. These are hard to achieve because they
9501: introduce lots of changes in the components' code and almost all
9502: GNOME distfiles are updated to newer versions. Some of them can
9503: even break API and ABI compatibility with the previous major
9504: version series. As a result, the update needs to be done all at
9505: once to minimize breakage.</p>
9506: <p>A major update typically consists of around 80 package
9507: updates and the addition of some new ones.</p>
9508: </dd>
9509: <dt><span class="term">Minor update</span></dt>
9510: <dd>
9511: <p>We consider a minor update one that goes from a
9512: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9513: one where <code class="literal">Y</code> is greater than
9514: <code class="literal">X</code>. These are easy to achieve because they do
9515: not update all GNOME components, can be done in an incremental way
9516: and do not break API nor ABI compatibility.</p>
9517: <p>A minor update typically consists of around 50 package
9518: updates, although the numbers here may vary a lot.</p>
9519: </dd>
9520: </dl></div>
9521: <p>In order to update the GNOME components in pkgsrc to a new stable
9522: release (either major or minor), the following steps should be
9523: followed:</p>
9524: <div class="orderedlist"><ol class="orderedlist" type="1">
1.23 wiz 9525: <li class="listitem">
1.184 rillig 9526: <p>Get a list of all the tarballs that form the new release by
9527: using the following commands. These will leave the full list of the
9528: components' distfiles into the <code class="filename">list.txt</code>
9529: file:</p>
9530: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9531: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9532: awk '{ print $9 }' >list.txt</code></strong>
9533: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9534: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9535: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.1 dsieger 9536: </li>
1.184 rillig 9537: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9538: bump their version to the release you are updating them to. The
9539: three meta packages should be always consistent with versioning.
9540: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9541: in them.</p></li>
1.23 wiz 9542: <li class="listitem">
1.184 rillig 9543: <p>For each meta package, update all its
9544: <code class="varname">DEPENDS</code> lines to match the latest versions as
9545: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9546: newer version (even if found in the FTP) because the meta packages
9547: are supposed to list the exact versions that form a specific GNOME
9548: release. Exceptions are permitted here if a newer version solves a
9549: serious issue in the overall desktop experience; these typically
9550: come in the form of a revision bump in pkgsrc, not in newer versions
9551: from the developers.</p>
9552: <p>Packages not listed in the <code class="filename">list.txt</code> file
9553: should be updated to the latest version available (if found in
9554: pkgsrc). This is the case, for example, of the dependencies on the
9555: GNU Autotools in the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.1 dsieger 9556: </li>
1.23 wiz 9557: <li class="listitem">
1.184 rillig 9558: <p>Generate a patch from the modified meta packages and extract the
9559: list of "new" lines. This will provide you an outline on what
9560: packages need to be updated in pkgsrc and in what order:</p>
9561: <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 9562: </li>
1.184 rillig 9563: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9564: installed packages and start over from scratch at this point.</p></li>
9565: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9566: of <code class="filename">todo.txt</code> and update the packages listed in
9567: it in order. For major desktop updates none of these should be
9568: committed until the entire set is completed because there are chances
9569: of breaking not-yet-updated packages.</p></li>
9570: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9571: the tree one by one with appropriate log messages. At the end,
9572: commit the three meta package updates and all the corresponding
9573: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9574: <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>
9575: </ol></div>
9576: </div>
9577: <div class="sect1">
9578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9579: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9580: <p>GNOME is a very big component in pkgsrc which approaches 100
9581: packages. Please, it is very important that you always, always,
9582: <span class="strong"><strong>always</strong></span> feed back any portability
9583: 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
9584: their attention on portability issues and to ensure that future versions
9585: can be built out-of-the box on NetBSD. The less custom patches in
9586: pkgsrc, the easier further updates are. Those developers in charge of
9587: issuing major GNOME updates will be grateful if you do that.</p>
1.200 cirnatda 9588: <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
9589: GitLab</a>. Not all components use these to track bugs, but most
1.184 rillig 9590: of them do. Do not be short on your reports: always provide detailed
9591: explanations of the current failure, how it can be improved to achieve
1.200 cirnatda 9592: maximum portability and, if at all possible, provide a patch against the
9593: main Git branch. The more verbose you are, the higher chances of your
9594: patch being accepted.</p>
1.184 rillig 9595: <p>Also, please avoid using preprocessor magic to fix portability
9596: issues. While the FreeBSD GNOME people are doing a great job in porting
9597: GNOME to their operating system, the official GNOME sources are now
9598: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9599: and similar macros. This hurts portability. Please see our patching
9600: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9601: details.</p>
9602: </div>
1.1 dsieger 9603: </div>
1.41 asau 9604: <div class="chapter">
1.1 dsieger 9605: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9606: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9607: <div class="toc">
9608: <p><b>Table of Contents</b></p>
1.100 leot 9609: <dl class="toc">
1.154 rillig 9610: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9611: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9612: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9613: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9614: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9615: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9616: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9617: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9618: </dl>
9619: </div>
1.41 asau 9620: <div class="sect1">
1.1 dsieger 9621: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9622: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9623: <p>Our policy is that we accept binaries only from pkgsrc
9624: developers to guarantee that the packages don't contain any
9625: trojan horses etc. This is not to annoy anyone but rather to
9626: protect our users! You're still free to put up your home-made
9627: binary packages and tell the world where to get them. NetBSD
9628: developers doing bulk builds and wanting to upload them please
1.154 rillig 9629: 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 9630: builds)</i></a>.</p>
1.1 dsieger 9631: </div>
1.41 asau 9632: <div class="sect1">
1.1 dsieger 9633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9634: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9635: <p>First, check that your package is complete, compiles and
1.184 rillig 9636: 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.197 leot 9637: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1 dsieger 9638: archive that contains all files that make up the package.
9639: Finally, send this package to the pkgsrc bug tracking system,
1.197 leot 9640: either with the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 9641: that, go to the web page
1.174 leot 9642: <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 9643: which contains some instructions and a link to a form where you
9644: can submit packages. The
1.137 leot 9645: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.21 snj 9646: also available as a substitute for either of the above two tools.
9647: </p>
1.1 dsieger 9648: <p>In the form of the problem report, the category should be
1.23 wiz 9649: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9650: and version number, and the description field should contain a
9651: short description of your package (contents of the COMMENT
9652: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 9653: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 9654: <p>If you want to submit several packages, please send a
9655: separate PR for each one, it's easier for us to track things
9656: that way.</p>
9657: <p>Alternatively, you can also import new packages into
1.23 wiz 9658: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.174 leot 9659: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
1.1 dsieger 9660: for details.</p>
9661: </div>
1.41 asau 9662: <div class="sect1">
1.1 dsieger 9663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9664: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9665: <p>Please note all package additions, updates, moves, and
9666: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9667: important to keep this file up to date and conforming to the
9668: existing format, because it will be used by scripts to
1.174 leot 9669: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9670: sites. Additionally, check the
9671: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9672: for the package you updated or removed, in case it was mentioned
9673: there.</p>
9674: <p>When the <code class="varname">PKGREVISION</code> of a package is
9675: bumped, the change should appear in
9676: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9677: related or otherwise relevant. Mass bumps that result from a
9678: dependency being updated should not be mentioned. In all other
9679: cases it's the developer's decision.</p>
9680: <p>There is a make target that helps in creating proper
1.10 hubertf 9681: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9682: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9683: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9684: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9685: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9686: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9687: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9688: For new packages, or package moves or removals, set the
9689: <code class="varname">CTYPE</code> variable on the command line to "Added",
9690: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9691: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9692: not the same as your NetBSD login name. The target also automatically
9693: removes possibly existing entries for the package in the
9694: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 9695: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 9696: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9697: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9698: makes the cvs commands use the main repository.
9699: </p>
1.1 dsieger 9700: </div>
1.41 asau 9701: <div class="sect1">
1.1 dsieger 9702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9703: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 9704: <p>For several years, there have been mirrors of pkgsrc in
9705: fossil, git, and hg. Standard practise when using these tools is to
9706: make the first line of a commit message function as a summary that
9707: can be read without the rest, such as is commonly done with "git log
9708: --oneline". For this reason, we have the following guidelines for
9709: pkgsrc commit messages:</p>
9710: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9711: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 9712: big picture in 65 characters or less. When a commit is for one
1.130 wiz 9713: package, include the name of the package. For updates, include the
9714: version to which it is updated.</p></li>
9715: <li class="listitem"><p>Leave the next line empty.</p></li>
9716: <li class="listitem"><p>Then come the details for the commit (changes in that
9717: package, reason for a change) and any relevant PRs. Wrap this
9718: section.</p></li>
9719: </ul></div>
9720: <p>Here is an example:
9721: </p>
9722: <pre class="programlisting">
9723: libxslt: update to 1.0.30
9724:
9725: Changes since 1.0.29:
9726: ...
9727: </pre>
9728: <p>
9729: </p>
9730: <p>Here is another example:
9731: </p>
9732: <pre class="programlisting">
9733: mk/bsd.pkg.mk: enable SSP by default on NetBSD
9734:
9735: (rationale)
9736: </pre>
9737: <p>
9738: </p>
9739: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
9740: allowed on the pkgsrc repository to change commit messages.</p>
9741: </div>
9742: <div class="sect1">
9743: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9744: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 9745: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 9746: access to the pkgsrc repository.</p>
9747: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9748: Start by adding the directory and then files in the directory. Don't
9749: forget to add the new package to the category's
9750: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9751: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9752: <pre class="programlisting">
9753: <code class="prompt">$</code> cd .../pkgsrc/category
9754: <code class="prompt">$</code> cvs add pkgname
9755: <code class="prompt">$</code> cd pkgname
9756: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9757: <code class="prompt">$</code> cvs add patches/p*
9758: <code class="prompt">$</code> cvs status | less
1.34 wiz 9759: <code class="prompt">$</code> cvs commit
1.33 wiz 9760: <code class="prompt">$</code> cd ..
9761: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 9762: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 9763: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 9764: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 9765: </pre>
1.1 dsieger 9766: <p>The commit message of the initial import should include part of the
9767: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9768: what the package is/does.</p>
1.33 wiz 9769: <p>Also mention the new package in
9770: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9771: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9772: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 9773: </div>
1.41 asau 9774: <div class="sect1">
1.1 dsieger 9775: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9776: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9777: <p>Please always put a concise, appropriate and relevant summary of the
9778: changes between old and new versions into the commit log when updating
9779: a package. There are various reasons for this:</p>
1.41 asau 9780: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9781: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 9782: or its information may be overwritten by newer information.</p></li>
1.23 wiz 9783: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9784: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 9785: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9786: repository is very useful for people who read the pkgsrc-changes mailing
9787: list, so that they can make tactical decisions about when to upgrade
9788: the package.</p></li>
9789: </ul></div>
9790: <p>Please also recognize that, just because a new version of a package
9791: has been released, it should not automatically be upgraded in the CVS
9792: repository. We prefer to be conservative in the packages that are
9793: included in pkgsrc - development or beta packages are not really the
9794: best thing for most places in which pkgsrc is used. Please use your
9795: judgement about what should go into pkgsrc, and bear in mind that
9796: stability is to be preferred above new and possibly untested features.</p>
9797: </div>
1.41 asau 9798: <div class="sect1">
1.1 dsieger 9799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9800: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 9801: <p>Renaming packages is not recommended.</p>
1.175 gutterid 9802: <p>When renaming packages, be sure to fix any references to the old name
1.20 snj 9803: in other Makefiles, options, buildlink files, etc.</p>
1.167 leot 9804: <p>
1.175 gutterid 9805: Also, when renaming a package, please add
1.167 leot 9806: the package name and version pattern(s) of the previous package
9807: to <code class="varname">SUPERSEDES</code>.
1.20 snj 9808: This may be repeated for multiple renames.
9809: The new package would be an exact replacement.
1.167 leot 9810: Example:
1.20 snj 9811: </p>
1.167 leot 9812: <pre class="programlisting">
9813: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
9814: SUPERSEDES+= optcomp-[0-9]*
9815: </pre>
1.23 wiz 9816: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 9817: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9818: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9819: not be an exact replacement but is a suggestion for the replaced
9820: functionality.</p>
9821: </div>
1.41 asau 9822: <div class="sect1">
1.20 snj 9823: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9824: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 9825: <p>It is preferred that packages are not renamed or moved, but if needed
9826: please follow these steps.
9827: </p>
1.23 wiz 9828: <div class="orderedlist"><ol class="orderedlist" type="1">
9829: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9830: <li class="listitem">
1.1 dsieger 9831: <p>Remove all CVS dirs.</p>
9832: <p>Alternatively to the first two steps you can also do:</p>
9833: <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>
9834: <p>and use that for further work.</p>
9835: </li>
1.23 wiz 9836: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9837: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9838: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9839: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 9840: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9841: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9842: for doing an update using pkgsrc building; for example, it can
1.197 leot 9843: search the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 9844: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9845: new <code class="varname">PKGPATH</code> for that moved package. Note that
9846: it may have multiple matches, so the tool should also check on the
9847: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9848: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9849: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 9850: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9851: place.</p></li>
1.23 wiz 9852: <li class="listitem">
1.1 dsieger 9853: <p>Check if any package depends on it:
9854: </p>
9855: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9856: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9857: </li>
1.23 wiz 9858: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9859: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9860: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9861: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9862: <li class="listitem">
1.1 dsieger 9863: <p>Commit the changed and removed files:</p>
9864: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9865: <p>(and any packages from step 5, of course).</p>
9866: </li>
9867: </ol></div>
9868: </div>
9869: </div>
1.41 asau 9870: <div class="chapter">
1.1 dsieger 9871: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9872: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9873: <p>This section contains the answers to questions that may
9874: arise when you are writing a package. If you don't find your
9875: question answered here, first have a look in the other chapters,
9876: and if you still don't have the answer, ask on the
9877: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9878: <div class="qandaset">
1.174 leot 9879: <a name="devfaq.qandaset"></a><dl>
1.154 rillig 9880: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9881: MAKEFLAGS, .MAKEFLAGS and
9882: MAKE_FLAGS?</a>
9883: </dt>
1.154 rillig 9884: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9885: MAKE, GMAKE and
9886: MAKE_PROGRAM?</a>
9887: </dt>
1.154 rillig 9888: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9889: CC, PKG_CC and
9890: PKGSRC_COMPILER?</a>
9891: </dt>
1.154 rillig 9892: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9893: BUILDLINK_LDFLAGS,
9894: BUILDLINK_LDADD and
9895: BUILDLINK_LIBS?</a>
9896: </dt>
1.154 rillig 9897: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9898: VARNAME=BUILDLINK_PREFIX.foo
9899: say it's empty?</a>
9900: </dt>
1.154 rillig 9901: <dt>24.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9902: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9903: don't understand the := inside
9904: it.</a>
9905: </dt>
1.154 rillig 9906: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9907: developers?</a>
9908: </dt>
1.154 rillig 9909: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9910: documentation?</a>
9911: </dt>
1.174 leot 9912: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill.
9913: What shall I do?</a>
1.1 dsieger 9914: </dt>
9915: </dl>
1.41 asau 9916: <table border="0" style="width: 100%;">
9917: <colgroup>
1.1 dsieger 9918: <col align="left" width="1%">
1.23 wiz 9919: <col>
1.41 asau 9920: </colgroup>
1.1 dsieger 9921: <tbody>
1.41 asau 9922: <tr class="question">
1.1 dsieger 9923: <td align="left" valign="top">
1.174 leot 9924: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.1 dsieger 9925: </td>
9926: <td align="left" valign="top"><p>What is the difference between
9927: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9928: <code class="varname">MAKE_FLAGS</code>?</p></td>
9929: </tr>
9930: <tr class="answer">
9931: <td align="left" valign="top"></td>
9932: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.197 leot 9933: to the pkgsrc-internal invocations of <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1 dsieger 9934: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9935: the <code class="varname">MAKE_PROGRAM</code> when building the
9936: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9937: </tr>
1.41 asau 9938: <tr class="question">
1.1 dsieger 9939: <td align="left" valign="top">
1.174 leot 9940: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.1 dsieger 9941: </td>
9942: <td align="left" valign="top"><p>What is the difference between
9943: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9944: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9945: </tr>
9946: <tr class="answer">
9947: <td align="left" valign="top"></td>
9948: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.197 leot 9949: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1 dsieger 9950: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9951: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9952: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9953: Make program that is used for building the
9954: package.</p></td>
9955: </tr>
1.41 asau 9956: <tr class="question">
1.1 dsieger 9957: <td align="left" valign="top">
1.174 leot 9958: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.1 dsieger 9959: </td>
9960: <td align="left" valign="top"><p>What is the difference between
9961: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9962: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9963: </tr>
9964: <tr class="answer">
9965: <td align="left" valign="top"></td>
9966: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9967: compiler, which can be configured by the pkgsrc user.
9968: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9969: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9970: path to a compiler, but the type of compiler that should be
9971: used. See <code class="filename">mk/compiler.mk</code> for more
9972: information about the latter variable.</p></td>
9973: </tr>
1.41 asau 9974: <tr class="question">
1.1 dsieger 9975: <td align="left" valign="top">
1.174 leot 9976: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.1 dsieger 9977: </td>
9978: <td align="left" valign="top"><p>What is the difference between
9979: <code class="varname">BUILDLINK_LDFLAGS</code>,
9980: <code class="varname">BUILDLINK_LDADD</code> and
9981: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9982: </tr>
9983: <tr class="answer">
9984: <td align="left" valign="top"></td>
9985: <td align="left" valign="top"><p>[FIXME]</p></td>
9986: </tr>
1.41 asau 9987: <tr class="question">
1.1 dsieger 9988: <td align="left" valign="top">
1.174 leot 9989: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.1 dsieger 9990: </td>
1.10 hubertf 9991: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9992: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9993: say it's empty?</p></td>
9994: </tr>
9995: <tr class="answer">
9996: <td align="left" valign="top"></td>
9997: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 9998: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9999: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 10000: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 10001: command.</p></td>
10002: </tr>
1.41 asau 10003: <tr class="question">
1.1 dsieger 10004: <td align="left" valign="top">
1.174 leot 10005: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.1 dsieger 10006: </td>
10007: <td align="left" valign="top"><p>What does
1.108 rillig 10008: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10009: don't understand the <code class="code">:=</code> inside
1.1 dsieger 10010: it.</p></td>
10011: </tr>
10012: <tr class="answer">
10013: <td align="left" valign="top"></td>
1.108 rillig 10014: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
10015: assignment operator, although it looks like it.
1.1 dsieger 10016: Instead, it is a degenerate form of
1.108 rillig 10017: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.197 leot 10018: which is documented in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.108 rillig 10019: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 10020: case of <code class="varname">MASTER_SITE_*</code>,
10021: <em class="replaceable"><code>old_string</code></em> is the empty string and
10022: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 10023: <code class="code">package/</code>. That's where the
10024: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 10025: together.</p></td>
10026: </tr>
1.41 asau 10027: <tr class="question">
1.1 dsieger 10028: <td align="left" valign="top">
1.174 leot 10029: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.1 dsieger 10030: </td>
10031: <td align="left" valign="top"><p>Which mailing lists are there for package
10032: developers?</p></td>
10033: </tr>
10034: <tr class="answer">
10035: <td align="left" valign="top"></td>
1.41 asau 10036: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.174 leot 10037: <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 10038: <dd><p>This is a list for technical discussions related
10039: to pkgsrc development, e.g. soliciting feedback for changes to
10040: pkgsrc infrastructure, proposed new features, questions related
10041: to porting pkgsrc to a new platform, advice for maintaining a
10042: package, patches that affect many packages, help requests moved
10043: from pkgsrc-users when an infrastructure bug is found,
10044: etc.</p></dd>
1.174 leot 10045: <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 10046: <dd><p>All bug reports in category "pkg" sent with
1.197 leot 10047: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/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 10048: directly; use one of the other mailing
10049: lists.</p></dd>
10050: </dl></div></td>
10051: </tr>
1.41 asau 10052: <tr class="question">
1.1 dsieger 10053: <td align="left" valign="top">
1.174 leot 10054: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.1 dsieger 10055: </td>
10056: <td align="left" valign="top"><p>Where is the pkgsrc
10057: documentation?</p></td>
10058: </tr>
10059: <tr class="answer">
10060: <td align="left" valign="top"></td>
10061: <td align="left" valign="top">
10062: <p>There are many places where you can find
10063: documentation about pkgsrc:</p>
1.41 asau 10064: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10065: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 10066: of chapters that explain large parts of pkgsrc, but some
10067: chapters tend to be outdated. Which ones they are is hard to
10068: say.</p></li>
1.174 leot 10069: <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 10070: about certain features, announcements of new parts of the pkgsrc
10071: infrastructure and sometimes even announcements that a certain
10072: feature has been marked as obsolete. The benefit here is that
10073: each message has a date appended to it.</p></li>
1.23 wiz 10074: <li class="listitem"><p>Many of the files in the
1.1 dsieger 10075: <code class="filename">mk/</code> directory start with a comment that
10076: describes the purpose of the file and how it can be used by the
10077: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 10078: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 10079: help</strong></span>.</p></li>
1.23 wiz 10080: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 10081: information, but they tend to be highly abbreviated, especially
10082: for actions that occur often. Some contain a detailed
10083: description of what has changed, but they are geared towards the
10084: other pkgsrc developers, not towards an average pkgsrc user.
10085: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10086: don't know what has been before, these messages may not be worth
10087: too much to you.</p></li>
1.23 wiz 10088: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10089: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 10090: mind of the developer who wrote the code. To get this
1.10 hubertf 10091: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 10092: to see who has written it and ask on the
10093: <code class="literal">tech-pkg</code> mailing list, so that others can
10094: find your questions later (see above). To be sure that the
10095: developer in charge reads the mail, you may CC him or
10096: her.</p></li>
10097: </ul></div>
1.184 rillig 10098: </td>
10099: </tr>
10100: <tr class="question">
10101: <td align="left" valign="top">
10102: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
10103: </td>
10104: <td align="left" valign="top"><p>I have a little time to kill.
10105: What shall I do?</p></td>
10106: </tr>
10107: <tr class="answer">
10108: <td align="left" valign="top"></td>
10109: <td align="left" valign="top">
10110: <p>This is not really an FAQ yet, but here's the answer
10111: anyway.</p>
1.41 asau 10112: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 10113: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
10114: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
10115: will tell you about newer versions of installed packages that are
10116: available, but not yet updated in pkgsrc.</p></li>
10117: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10118: — it contains a list of suggested new packages and a list of
10119: cleanups and enhancements for pkgsrc that would be nice to
10120: have.</p></li>
10121: <li class="listitem"><p>Review packages for which review was requested on
10122: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10123: mailing list.</p></li>
1.1 dsieger 10124: </ul></div>
1.184 rillig 10125: </td>
1.1 dsieger 10126: </tr>
10127: </tbody>
1.184 rillig 10128: </table>
1.1 dsieger 10129: </div>
10130: </div>
10131: </div>
1.41 asau 10132: <div class="part">
1.1 dsieger 10133: <div class="titlepage"><div><div><h1 class="title">
10134: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10135: <div class="partintro">
1.1 dsieger 10136: <div></div>
10137: <p>This part of the guide deals with everything
10138: from the infrastructure that is behind the interfaces described
10139: in the developer's guide. A casual package maintainer should not
10140: need anything from this part.</p>
10141: <div class="toc">
10142: <p><b>Table of Contents</b></p>
1.100 leot 10143: <dl class="toc">
1.184 rillig 10144: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10145: <dd><dl>
1.184 rillig 10146: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10147: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10148: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10149: <dd><dl>
1.184 rillig 10150: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10151: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10152: </dl></dd>
1.184 rillig 10153: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10154: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10155: <dd><dl>
1.184 rillig 10156: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10157: <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 10158: </dl></dd>
1.184 rillig 10159: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10160: <dd><dl>
1.184 rillig 10161: <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>
10162: <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 10163: </dl></dd>
10164: </dl></dd>
1.184 rillig 10165: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 10166: <dd><dl>
1.184 rillig 10167: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10168: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10169: <dd><dl>
1.184 rillig 10170: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10171: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10172: </dl></dd>
10173: </dl></dd>
1.184 rillig 10174: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10175: <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 10176: </dl>
10177: </div>
10178: </div>
1.41 asau 10179: <div class="chapter">
1.1 dsieger 10180: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10181: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10182: <div class="toc">
10183: <p><b>Table of Contents</b></p>
1.100 leot 10184: <dl class="toc">
1.184 rillig 10185: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10186: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10187: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10188: <dd><dl>
1.184 rillig 10189: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10190: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10191: </dl></dd>
1.184 rillig 10192: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10193: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10194: <dd><dl>
1.184 rillig 10195: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10196: <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 10197: </dl></dd>
1.184 rillig 10198: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10199: <dd><dl>
1.184 rillig 10200: <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>
10201: <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 10202: </dl></dd>
10203: </dl>
10204: </div>
10205: <p>The pkgsrc infrastructure consists of many small Makefile
10206: fragments. Each such fragment needs a properly specified
10207: interface. This chapter explains how such an interface looks
10208: like.</p>
1.41 asau 10209: <div class="sect1">
1.1 dsieger 10210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10211: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10212: <p>Whenever a variable is defined in the pkgsrc
10213: infrastructure, the location and the way of definition provide
10214: much information about the intended use of that variable.
10215: Additionally, more documentation may be found in a header
10216: comment or in this pkgsrc guide.</p>
10217: <p>A special file is
10218: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10219: variables that are intended to be user-defined. They are either
10220: defined using the <code class="literal">?=</code> operator or they are
10221: left undefined because defining them to anything would
1.23 wiz 10222: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10223: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10224: file.</p>
10225: <p>Outside this file, the following conventions apply:
10226: Variables that are defined using the <code class="literal">?=</code>
10227: operator may be overridden by a package.</p>
10228: <p>Variables that are defined using the <code class="literal">=</code>
10229: operator may be used read-only at run-time.</p>
10230: <p>Variables whose name starts with an underscore must not be
10231: accessed outside the pkgsrc infrastructure at all. They may
10232: change without further notice.</p>
1.41 asau 10233: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10234: <h3 class="title">Note</h3>
10235: <p>These conventions are currently not applied
10236: consistently to the complete pkgsrc
10237: infrastructure.</p>
10238: </div>
10239: </div>
1.41 asau 10240: <div class="sect1">
1.1 dsieger 10241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10242: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10243: <p>All variables that contain lists of things should default
10244: to being empty. Two examples that do not follow this rule are
10245: <code class="varname">USE_LANGUAGES</code> and
10246: <code class="varname">DISTFILES</code>. These variables cannot simply be
10247: modified using the <code class="literal">+=</code> operator in package
10248: <code class="filename">Makefile</code>s (or other files included by
10249: them), since there is no guarantee whether the variable is
10250: already set or not, and what its value is. In the case of
1.23 wiz 10251: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10252: the default value and just define it as in the following
10253: example.</p>
10254: <pre class="programlisting">
10255: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10256: </pre>
10257: <p>Because of the selection of this default value, the same
10258: value appears in many package Makefiles. Similarly for
10259: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10260: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10261: doesn't stand out. Nevertheless it is mentioned in many
10262: files.</p>
10263: </div>
1.41 asau 10264: <div class="sect1">
1.1 dsieger 10265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10266: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.41 asau 10267: <div class="sect2">
1.1 dsieger 10268: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10269: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.1 dsieger 10270: <p>Variable evaluation takes place either at load time or at
10271: runtime, depending on the context in which they occur. The
10272: contexts where variables are evaluated at load time are:</p>
1.41 asau 10273: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10274: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10275: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10276: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10277: <code class="literal">.for</code>,</p></li>
1.23 wiz 10278: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10279: </ul></div>
10280: <p>A special exception are references to the iteration
10281: variables of <code class="literal">.for</code> loops, which are expanded
10282: inline, no matter in which context they appear.</p>
10283: <p>As the values of variables may change during load time,
10284: care must be taken not to evaluate them by accident. Typical
10285: examples for variables that should not be evaluated at load time
10286: are <code class="varname">DEPENDS</code> and
10287: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10288: clear, here is an example:</p>
10289: <pre class="programlisting">
10290: CONFIGURE_ARGS= # none
10291: CFLAGS= -O
10292: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10293:
10294: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10295:
10296: CFLAGS+= -Wall
1.111 sevan 10297: </pre>
1.1 dsieger 10298: <p>This code shows how the use of the <code class="literal">:=</code>
10299: operator can quickly lead to unexpected results. The first
10300: paragraph is fairly common code. The second paragraph evaluates
10301: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10302: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10303: <code class="literal">-Wall</code> is appended to the
10304: <code class="varname">CFLAGS</code>, but this addition will not appear in
10305: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10306: paragraphs from above typically occur in completely unrelated
10307: files.</p>
10308: </div>
1.41 asau 10309: <div class="sect2">
1.1 dsieger 10310: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10311: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10312: <p>After all the files have been loaded, the values of the
10313: variables cannot be changed anymore. Variables that are used in
10314: the shell commands are expanded at this point.</p>
10315: </div>
10316: </div>
1.41 asau 10317: <div class="sect1">
1.1 dsieger 10318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10319: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10320: <p>There are many ways in which the definition and use of a
1.108 rillig 10321: variable can be restricted in order to detect bugs and violations
10322: of the (mostly unwritten) policies. A package can be checked with
10323: <code class="literal">pkglint -Wall</code> to see whether it meets these
10324: rules.</p>
1.1 dsieger 10325: </div>
1.41 asau 10326: <div class="sect1">
1.1 dsieger 10327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10328: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10329: <p>Most of the <code class="filename">.mk</code> files fall into one
10330: of the following classes. Cases where a file falls into more
10331: than one class should be avoided as it often leads to subtle
10332: bugs.</p>
1.41 asau 10333: <div class="sect2">
1.1 dsieger 10334: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10335: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10336: <p>In a traditional imperative programming language some of
10337: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10338: procedures. They take some input parameters and—after
10339: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10340: variables in <code class="filename">Makefile</code>s have global scope
10341: care must be taken not to use parameter names that have already
10342: another meaning. For example, <code class="varname">PKGNAME</code> is a
10343: bad choice for a parameter name.</p>
10344: <p>Procedures are completely evaluated at preprocessing time.
10345: That is, when calling a procedure all input parameters must be
10346: completely resolvable. For example,
10347: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10348: parameter since it is very likely that further text will be
10349: added after calling the procedure, which would effectively apply
10350: the procedure to only a part of the variable. Also, references
1.108 rillig 10351: to other variables will be modified after calling the
1.1 dsieger 10352: procedure.</p>
10353: <p>A procedure can declare its output parameters either as
10354: suitable for use in preprocessing directives or as only
10355: available at runtime. The latter alternative is for variables
10356: that contain references to other runtime variables.</p>
10357: <p>Procedures shall be written such that it is possible to
10358: call the procedure more than once. That is, the file must not
10359: contain multiple-inclusion guards.</p>
10360: <p>Examples for procedures are
10361: <code class="filename">mk/bsd.options.mk</code> and
10362: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10363: that the parameters are evaluated at load time, they should be
10364: assigned using the <code class="literal">:=</code> operator, which should
10365: be used only for this purpose.</p>
10366: </div>
1.41 asau 10367: <div class="sect2">
1.1 dsieger 10368: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10369: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10370: <p>Action files take some input parameters and may define
10371: runtime variables. They shall not define loadtime variables.
10372: There are action files that are included implicitly by the
10373: pkgsrc infrastructure, while other must be included
10374: explicitly.</p>
10375: <p>An example for action files is
10376: <code class="filename">mk/subst.mk</code>.</p>
10377: </div>
10378: </div>
1.41 asau 10379: <div class="sect1">
1.1 dsieger 10380: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10381: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10382: <p>Package <code class="filename">Makefile</code>s usually consist of
10383: a set of variable definitions, and include the file
10384: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10385: Before that, they may also include various other
10386: <code class="filename">*.mk</code> files if they need to query the
10387: availability of certain features like the type of compiler or
10388: the X11 implementation. Due to the heavy use of preprocessor
10389: directives like <code class="literal">.if</code> and
10390: <code class="literal">.for</code>, the order in which the files are loaded
10391: matters.</p>
10392: <p>This section describes at which point the various files
10393: are loaded and gives reasons for that order.</p>
1.41 asau 10394: <div class="sect2">
1.1 dsieger 10395: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10396: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10397: </h3></div></div></div>
10398: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10399: is to define some essential variables like
10400: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10401: <code class="varname">MACHINE_ARCH</code>.</p>
10402: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10403: 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 10404: After that, those variables
1.1 dsieger 10405: that have not been overridden by the user are loaded from
10406: <code class="filename">mk/defaults/mk.conf</code>.</p>
10407: <p>After the user settings, the system settings and platform
10408: settings are loaded, which may override the user
10409: settings.</p>
10410: <p>Then, the tool definitions are loaded. The tool wrappers
10411: are not yet in effect. This only happens when building a
10412: package, so the proper variables must be used instead of the
10413: direct tool names.</p>
10414: <p>As the last steps, some essential variables from the
10415: wrapper and the package system flavor are loaded, as well as the
10416: variables that have been cached in earlier phases of a package
10417: build.</p>
10418: </div>
1.41 asau 10419: <div class="sect2">
1.1 dsieger 10420: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10421: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10422: </h3></div></div></div>
10423: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10424: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10425: loaded, which fill default values for those variables that have
10426: not been defined by the package. These variables may later
10427: be used even in unrelated files.</p>
10428: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10429: provides the target <code class="literal">error-check</code> that is added
10430: as a special dependency to all other targets that use
10431: <code class="varname">DELAYED_ERROR_MSG</code> or
10432: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10433: <p>Then, the package-specific hacks from
10434: <code class="filename">hacks.mk</code> are included.</p>
10435: <p>Then, various other files follow. Most of them don't have
10436: any dependencies on what they need to have included before or
10437: after them, though some do.</p>
10438: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10439: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10440: restricts the use of these variables to all the files that have
10441: been included before. Appearances in later files will be
10442: silently ignored.</p>
10443: <p>Then, the files for the main targets are included, in the
10444: order of later execution, though the actual order should not
10445: matter.</p>
10446: <p>At last, some more files are included that don't set any
10447: interesting variables but rather just define make targets to be
10448: executed.</p>
10449: </div>
10450: </div>
10451: </div>
1.41 asau 10452: <div class="chapter">
1.1 dsieger 10453: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10454: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.1 dsieger 10455: <div class="toc">
10456: <p><b>Table of Contents</b></p>
1.100 leot 10457: <dl class="toc">
1.184 rillig 10458: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10459: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10460: <dd><dl>
1.184 rillig 10461: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10462: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10463: </dl></dd>
10464: </dl>
10465: </div>
10466: <p>The pkgsrc infrastructure consists of a large codebase,
10467: and there are many corners where every little bit of a file is
10468: well thought out, making pkgsrc likely to fail as soon as
10469: anything is changed near those parts. To prevent most changes
10470: from breaking anything, a suite of regression tests should go
10471: along with every important part of the pkgsrc infrastructure.
10472: This chapter describes how regression tests work in pkgsrc and
10473: how you can add new tests.</p>
1.41 asau 10474: <div class="sect1">
1.1 dsieger 10475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10476: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.137 leot 10477: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.10 hubertf 10478: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10479: can simply run that command, which will run all tests in the
1.168 rillig 10480: <code class="filename">regress/</code> directory.</p>
1.1 dsieger 10481: </div>
1.41 asau 10482: <div class="sect1">
1.1 dsieger 10483: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10484: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.168 rillig 10485: <p>Every directory in the <code class="filename">regress/</code>
10486: directory that contains a file called <code class="filename">spec</code>
1.1 dsieger 10487: is considered a regression test. This file is a shell program
1.10 hubertf 10488: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10489: The following functions can be overridden to suit your
10490: needs.</p>
1.41 asau 10491: <div class="sect2">
1.1 dsieger 10492: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10493: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 10494: <p>These functions do not take any parameters. Although they
10495: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.174 leot 10496: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108 rillig 10497: question</a> for details.</p>
1.41 asau 10498: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10499: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 10500: <dd><p>This function prepares the environment for the
10501: test. By default it does nothing.</p></dd>
1.108 rillig 10502: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10503: <dd>
10504: <p>This function runs the actual test. By default,
1.1 dsieger 10505: it calls <code class="varname">TEST_MAKE</code> with the arguments
10506: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10507: error messages into the file
1.108 rillig 10508: <code class="varname">TEST_OUTFILE</code>.</p>
10509: <p>When defining this function, make sure that all output that
10510: needs to be checked is written to the correct output file.
10511: Example:</p>
10512: <pre class="programlisting">
10513: do_test() {
1.112 rillig 10514: echo "Example output"
1.108 rillig 10515: } 1>$TEST_OUTFILE 2>&1
10516: </pre>
10517: </dd>
10518: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10519: <dd>
10520: <p>This function is run after the test and is
1.1 dsieger 10521: typically used to compare the actual output from the one that is
10522: expected. It can make use of the various helper functions from
1.108 rillig 10523: the next section. Example:</p>
10524: <pre class="programlisting">
10525: check_result() {
1.112 rillig 10526: exit_status 0
10527: output_require "Example"
10528: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10529: output_prohibit "no such file or directory"
1.168 rillig 10530: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 10531: }
10532: </pre>
10533: </dd>
10534: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 10535: <dd><p>This function cleans everything up after the
10536: test has been run. By default it does nothing.</p></dd>
10537: </dl></div>
10538: </div>
1.41 asau 10539: <div class="sect2">
1.1 dsieger 10540: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10541: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.41 asau 10542: <div class="variablelist"><dl class="variablelist">
1.168 rillig 10543: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10544: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108 rillig 10545: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 10546: <dd><p>This function compares the exitcode of the
1.108 rillig 10547: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 10548: If they differ, the test will fail.</p></dd>
1.108 rillig 10549: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10550: <dd>
10551: <p>This function checks for each of its parameters
10552: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 10553: extended regular expression. If it does not, the test will
1.108 rillig 10554: fail. Example:</p>
10555: <pre class="programlisting">
10556: output_require "looks fine"
10557: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10558: </pre>
10559: </dd>
1.177 leot 10560: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.1 dsieger 10561: <dd><p>This function checks for each of its parameters
1.10 hubertf 10562: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10563: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10564: If any of the regular expressions matches, the test will
10565: fail.</p></dd>
10566: </dl></div>
10567: </div>
10568: </div>
10569: </div>
1.41 asau 10570: <div class="chapter">
1.1 dsieger 10571: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10572: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10573: <div class="toc">
10574: <p><b>Table of Contents</b></p>
1.184 rillig 10575: <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 10576: </div>
10577: <p>The pkgsrc system has already been ported to many
10578: operating systems, hardware architectures and compilers. This
10579: chapter explains the necessary steps to make pkgsrc even more
10580: portable.</p>
1.41 asau 10581: <div class="sect1">
1.1 dsieger 10582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10583: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10584: <p>To port pkgsrc to a new operating system (called
10585: <code class="literal">MyOS</code> in this example), you need to touch the
10586: following files:</p>
1.41 asau 10587: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10588: <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>
10589: <dd><p>This file contains some basic definitions, for
10590: example the name of the C
10591: compiler.</p></dd>
10592: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10593: <dd><p>Insert code that defines the variables
10594: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10595: <code class="varname">LOWER_OS_VERSION</code>,
10596: <code class="varname">LOWER_VENDOR</code>,
10597: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10598: <code class="varname">APPEND_ELF</code>, and the other variables that
10599: appear in this file.</p></dd>
10600: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10601: <dd><p>This file contains the platform-specific
10602: definitions that are used by pkgsrc. Start by copying one of the
10603: other files and edit it to your
10604: needs.</p></dd>
10605: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10606: <dd><p>This file defines the paths to all the tools
10607: that are needed by one or the other package in pkgsrc, as well
10608: as by pkgsrc itself. Find out where these tools are on your
10609: platform and add them.</p></dd>
10610: </dl></div>
10611: <p>Now, you should be able to build some basic packages, like
1.137 leot 10612: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.1 dsieger 10613: </div>
10614: </div>
10615: </div>
1.41 asau 10616: <div class="appendix">
10617: <div class="titlepage"><div><div><h1 class="title">
10618: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10619: <div class="toc">
10620: <p><b>Table of Contents</b></p>
1.100 leot 10621: <dl class="toc">
1.1 dsieger 10622: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10623: <dd><dl>
10624: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10625: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10626: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 10627: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 10628: </dl></dd>
10629: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10630: </dl>
10631: </div>
10632: <p>We checked to find a piece of software that wasn't in the packages
10633: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10634: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10635: present in the tree is beyond us, but it's useful for the purposes of
10636: this exercise.</p>
1.41 asau 10637: <div class="sect1">
1.1 dsieger 10638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10639: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10640: <div class="sect2">
1.1 dsieger 10641: <div class="titlepage"><div><div><h3 class="title">
10642: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10643: <pre class="programlisting">
10644: # $NetBSD$
10645: #
10646:
10647: DISTNAME= bison-1.25
10648: CATEGORIES= devel
1.171 rillig 10649: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 10650:
1.29 dholland 10651: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 10652: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 10653: COMMENT= GNU yacc clone
10654:
10655: GNU_CONFIGURE= yes
1.46 wiz 10656: INFO_FILES= yes
1.1 dsieger 10657:
10658: .include "../../mk/bsd.pkg.mk"
10659: </pre>
10660: </div>
1.41 asau 10661: <div class="sect2">
1.1 dsieger 10662: <div class="titlepage"><div><div><h3 class="title">
10663: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10664: <pre class="programlisting">
10665: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.197 leot 10666: improvements. Why you would want this when Berkeley <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 10667: of the NetBSD source tree is beyond me.
10668: </pre>
10669: </div>
1.41 asau 10670: <div class="sect2">
1.1 dsieger 10671: <div class="titlepage"><div><div><h3 class="title">
10672: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10673: <pre class="programlisting">
10674: @comment $NetBSD$
10675: bin/bison
10676: man/man1/bison.1.gz
10677: share/bison.simple
10678: share/bison.hairy
10679: </pre>
10680: </div>
1.41 asau 10681: <div class="sect2">
1.1 dsieger 10682: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 10683: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1 dsieger 10684: <p>The NetBSD package system comes with
1.137 leot 10685: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1 dsieger 10686: which helps to check the contents of these
10687: files. After installation it is quite easy to use, just change to the
1.171 rillig 10688: directory of the package you wish to examine and run
1.10 hubertf 10689: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10690: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171 rillig 10691: ERROR: Makefile: Each package must define its LICENSE.
10692: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10693: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10694: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10695: 1 error, 2 warnings and 1 note found.
10696: (Run "pkglint -e" to show explanations.)
10697: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 10698: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1 dsieger 10699: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170 rillig 10700: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1 dsieger 10701: -Wall</strong></span> for a very thorough check.</p>
10702: </div>
10703: </div>
1.41 asau 10704: <div class="sect1">
1.1 dsieger 10705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10706: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10707: <p>Create the directory where the package lives,
10708: plus any auxiliary directories:</p>
10709: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10710: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10711: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10712: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10713: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.184 rillig 10714: <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 10715: then continue with fetching the distfile:</p>
10716: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10717: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10718: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10719: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10720: ftp: Error retrieving file: 500 Internal error
10721:
10722: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10723: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10724: ftp: Error retrieving file: 500 Internal error
10725:
10726: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10727: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10728: Successfully retrieved file.</pre>
10729: <p>Generate the checksum of the distfile into
10730: <code class="filename">distinfo</code>:</p>
10731: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10732: <p>Now compile:</p>
10733: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10734: >> Checksum OK for bison-1.25.tar.gz.
10735: ===> Extracting for bison-1.25
10736: ===> Patching for bison-1.25
10737: ===> Ignoring empty patch directory
10738: ===> Configuring for bison-1.25
10739: creating cache ./config.cache
10740: checking for gcc... cc
10741: checking whether we are using GNU C... yes
10742: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10743: checking how to run the C preprocessor... cc -E
10744: checking for minix/config.h... no
10745: checking for POSIXized ISC... no
10746: checking whether cross-compiling... no
10747: checking for ANSI C header files... yes
10748: checking for string.h... yes
10749: checking for stdlib.h... yes
10750: checking for memory.h... yes
10751: checking for working const... yes
10752: checking for working alloca.h... no
10753: checking for alloca... yes
10754: checking for strerror... yes
10755: updating cache ./config.cache
10756: creating ./config.status
10757: creating Makefile
10758: ===> Building for bison-1.25
10759: 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
10760: 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
10761: 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
10762: 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
10763: 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
10764: 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
10765: 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
10766: 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
10767: 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
10768: 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
10769: 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
10770: 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
10771: 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
10772: 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
10773: 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
10774: 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
10775: 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
10776: 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
10777: 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
10778: 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
10779: 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
10780: 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
10781: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10782: rm -f bison.s1
10783: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10784: <p>Everything seems OK, so install the files:</p>
10785: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10786: >> Checksum OK for bison-1.25.tar.gz.
10787: ===> Installing for bison-1.25
10788: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10789: rm -f /usr/pkg/bin/bison
10790: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10791: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10792: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10793: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10794: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10795: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10796: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10797: ===> Registering installation for bison-1.25</pre>
10798: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10799: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10800: binary package, do this now:</p>
10801: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10802: >> Checksum OK for bison-1.25.tar.gz.
10803: ===> Building package for bison-1.25
10804: Creating package bison-1.25.tgz
10805: Registering depends:.
10806: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10807: <p>Now that you don't need the source and object files
10808: any more, clean up:</p>
10809: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10810: ===> Cleaning for bison-1.25</pre>
10811: </div>
10812: </div>
1.41 asau 10813: <div class="appendix">
10814: <div class="titlepage"><div><div><h1 class="title">
10815: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10816: <div class="toc">
10817: <p><b>Table of Contents</b></p>
1.100 leot 10818: <dl class="toc">
1.1 dsieger 10819: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10820: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10821: </dl>
10822: </div>
1.41 asau 10823: <div class="sect1">
1.1 dsieger 10824: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10825: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10826: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10827: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10828: => figlet221.tar.gz doesn't seem to exist on this system.
10829: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10830: => [172219 bytes]
10831: Connected to ftp.plig.net.
10832: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10833: 331 Guest login ok, send your complete e-mail address as password.
10834: 230-You are user #5 of 500 simultaneous users allowed.
10835: 230-
10836: 230- ___ _ _ _
10837: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10838: 230- | _| _| . |_| . | | | . |_| . | _| . |
10839: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10840: 230- |_| |_| |___| |___|
10841: 230-
10842: 230-** Welcome to ftp.plig.org **
10843: 230-
10844: 230-Please note that all transfers from this FTP site are logged. If you
10845: 230-do not like this, please disconnect now.
10846: 230-
1.18 snj 10847: 230-This archive is available via
1.1 dsieger 10848: 230-
10849: 230-HTTP: http://ftp.plig.org/
10850: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10851: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10852: 230-
10853: 230-Please email comments, bug reports and requests for packages to be
10854: 230-mirrored to ftp-admin@plig.org.
10855: 230-
10856: 230-
10857: 230 Logged in anonymously.
10858: Remote system type is UNIX.
10859: Using binary mode to transfer files.
10860: 200 Type okay.
10861: 250 "/pub" is new cwd.
10862: 250-"/pub/figlet" is new cwd.
10863: 250-
10864: 250-Welcome to the figlet archive at ftp.figlet.org
10865: 250-
10866: 250- ftp://ftp.figlet.org/pub/figlet/
10867: 250-
10868: 250-The official FIGlet web page is:
10869: 250- http://www.figlet.org/
10870: 250-
10871: 250-If you have questions, please mailto:info@figlet.org. If you want to
10872: 250-contribute a font or something else, you can email us.
10873: 250
10874: 250 "/pub/figlet/program" is new cwd.
10875: 250 "/pub/figlet/program/unix" is new cwd.
10876: local: figlet221.tar.gz remote: figlet221.tar.gz
10877: 502 Unimplemented command.
10878: 227 Entering Passive Mode (195,40,6,41,246,104)
10879: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10880: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10881: 226 Transfer completed.
10882: 172219 bytes received in 00:02 (75.99 KB/s)
10883: 221 Goodbye.
10884: => Checksum OK for figlet221.tar.gz.
10885: ===> Extracting for figlet-2.2.1nb2
10886: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10887: ===> Patching for figlet-2.2.1nb2
10888: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10889: ===> Overriding tools for figlet-2.2.1nb2
10890: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10891: ===> Configuring for figlet-2.2.1nb2
10892: ===> Building for figlet-2.2.1nb2
10893: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10894: chmod a+x figlet
10895: gcc -O2 -o chkfont chkfont.c
10896: => Unwrapping files-to-be-installed.
10897: <code class="prompt">#</code>
10898: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10899: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10900: ===> Installing for figlet-2.2.1nb2
10901: install -d -o root -g wheel -m 755 /usr/pkg/bin
10902: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10903: mkdir -p /usr/pkg/share/figlet
10904: cp figlet /usr/pkg/bin
10905: cp chkfont /usr/pkg/bin
10906: chmod 555 figlist showfigfonts
10907: cp figlist /usr/pkg/bin
10908: cp showfigfonts /usr/pkg/bin
10909: cp fonts/*.flf /usr/pkg/share/figlet
10910: cp fonts/*.flc /usr/pkg/share/figlet
10911: cp figlet.6 /usr/pkg/man/man6
10912: ===> Registering installation for figlet-2.2.1nb2
10913: <code class="prompt">#</code></pre>
10914: </div>
1.41 asau 10915: <div class="sect1">
1.1 dsieger 10916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10917: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10918: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10919: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10920: ===> Packaging figlet-2.2.1nb2
10921: ===> Building binary package for figlet-2.2.1nb2
10922: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10923: Using SrcDir value of /usr/pkg
10924: Registering depends:.
10925: <code class="prompt">#</code></pre>
10926: </div>
10927: </div>
1.41 asau 10928: <div class="appendix">
10929: <div class="titlepage"><div><div><h1 class="title">
10930: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10931: <div class="toc">
10932: <p><b>Table of Contents</b></p>
1.100 leot 10933: <dl class="toc">
1.23 wiz 10934: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10935: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10936: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10937: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10938: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148 leot 10939: <code class="filename">stable</code>,
1.23 wiz 10940: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10941: source packages</a></span></dt>
10942: </dl>
10943: </div>
10944: <p>As in other big projects, the directory layout of pkgsrc
10945: is quite complex for newbies. This chapter explains where you
10946: find things on the FTP server. The base directory on
1.10 hubertf 10947: <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>.
1.1 dsieger 10948: On other servers it may be different, but inside this directory,
10949: everything should look the same, no matter on which server you
10950: are. This directory contains some subdirectories, which are
10951: explained below.</p>
1.41 asau 10952: <div class="sect1">
1.1 dsieger 10953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10954: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10955: <p>The directory <code class="filename">distfiles</code> contains lots
10956: of archive files from all pkgsrc packages, which are mirrored
10957: here. The subdirectories are called after their package names
10958: and are used when the distributed files have names that don't
10959: explicitly contain a version number or are otherwise too generic
10960: (for example <code class="filename">release.tar.gz</code>).</p>
10961: </div>
1.41 asau 10962: <div class="sect1">
1.1 dsieger 10963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10964: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10965: <p>This directory contains things that individual pkgsrc
10966: developers find worth publishing.</p>
10967: </div>
1.41 asau 10968: <div class="sect1">
1.1 dsieger 10969: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10970: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10971: <p>This directory contains binary packages for the various
10972: platforms that are supported by pkgsrc.
10973: 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>
1.41 asau 10974: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10975: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10976: operating system for which the packages have been built. The
1.10 hubertf 10977: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10978: command, so it may differ from the one you are used to
10979: hear.</p></li>
1.23 wiz 10980: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10981: architecture of the platform for which the packages have been
1.10 hubertf 10982: built. It also includes the <code class="varname">ABI</code> (Application
10983: Binary Interface) for platforms that have several of
10984: them.</p></li>
1.23 wiz 10985: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10986: the operating system. For version numbers that change often (for
10987: example NetBSD-current), the often-changing part should be
10988: replaced with an <code class="literal">x</code>, for example
10989: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10990: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10991: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10992: for a stable branch, or <code class="literal">head</code> for packages
10993: built from the HEAD branch. The latter should only be used when
10994: the packages are updated on a regular basis. Otherwise the date
10995: from checking out pkgsrc should be appended, for example
10996: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10997: </ul></div>
10998: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10999: can quickly click through the directories on the
11000: server and find the best binary packages for their machines. Since they
11001: usually know the operating system and the hardware architecture, OPSYS
11002: and ARCH are placed first. After these choices, they can select the
11003: best combination of OSVERSION and TAG together, since it is usually the
11004: case that packages stay compatible between different version of the
11005: operating system.</p>
11006: <p>In each of these directories, there is a
11007: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 11008: <code class="filename">All</code> which contains all binary packages.
11009: Besides that, there are various category directories that
11010: contain symbolic links to the real binary packages.</p>
11011: </div>
1.41 asau 11012: <div class="sect1">
1.1 dsieger 11013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11014: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 11015: <p>Here are the reports from bulk builds, for those who want
11016: to fix packages that didn't build on some of the platforms. The
1.23 wiz 11017: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.8 rillig 11018: </div>
1.41 asau 11019: <div class="sect1">
1.8 rillig 11020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11021: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.148 leot 11022: <code class="filename">stable</code>,
1.22 jakllsch 11023: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 11024: source packages</h2></div></div></div>
1.23 wiz 11025: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 11026: that is the files that define how to create binary packages from
11027: source archives.</p>
1.149 leot 11028: <p>Each of the <code class="filename">current</code>,
11029: <code class="filename">stable</code> and
11030: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11031: directories share the same structure. They each contain a
11032: <code class="filename">pkgsrc</code> directory and
11033: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 11034: <p>The directory <code class="filename">pkgsrc</code> contains a
11035: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 11036: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11037: as the directory, ready to be downloaded as a whole.</p>
11038: <p>The <code class="filename">current</code> directory contains files
11039: related to the HEAD branch of the CVS repository.
11040: In this directory there is an additional file called
11041: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11042: all pkgsrc <code class="filename">README</code>s with information about
11043: categories and packages.
11044: </p>
11045: <p>The <code class="filename">stable</code> directory is a symlink to
11046: the latest
11047: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11048: </p>
11049: <p>The
11050: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11051: directories contain files related to the
11052: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11053: stable branch of the CVS repository. In these directories there is
11054: an additional file called
11055: <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 11056: which contains the state of pkgsrc when it was branched.</p>
11057: </div>
11058: </div>
1.41 asau 11059: <div class="appendix">
11060: <div class="titlepage"><div><div><h1 class="title">
1.154 rillig 11061: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
11062: <p>
11063: The following list contains all help topics that are available
11064: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11065: </p>
1.156 leot 11066: <table border="0" summary="Simple list" class="simplelist">
11067: <tr>
11068: <td>#!</td>
11069: <td>-lintl</td>
11070: </tr>
11071: <tr>
11072: <td>64bit</td>
11073: <td>ABI</td>
11074: </tr>
11075: <tr>
11076: <td>ACCEPTABLE_LICENSES</td>
11077: <td>ACROREAD_FONTPATH</td>
11078: </tr>
11079: <tr>
11080: <td>ADDITIONAL</td>
11081: <td>AFAIK</td>
11082: </tr>
11083: <tr>
11084: <td>AIX</td>
11085: <td>ALLOW_VULNERABLE_PACKAGES</td>
11086: </tr>
11087: <tr>
11088: <td>ALL_ENV</td>
1.200 cirnatda 11089: <td>ALTERNATIVES_SRC</td>
1.197 leot 11090: </tr>
11091: <tr>
11092: <td>AMANDA_TMP</td>
1.200 cirnatda 11093: <td>AMANDA_USER</td>
1.177 leot 11094: </tr>
11095: <tr>
1.197 leot 11096: <td>AMANDA_VAR</td>
1.200 cirnatda 11097: <td>APACHE_GROUP</td>
1.161 leot 11098: </tr>
11099: <tr>
1.197 leot 11100: <td>APACHE_MODULE_NAME</td>
1.200 cirnatda 11101: <td>APACHE_MODULE_SRC</td>
1.159 rillig 11102: </tr>
11103: <tr>
1.197 leot 11104: <td>APACHE_MODULE_SRCDIR</td>
1.200 cirnatda 11105: <td>APACHE_PKG_PREFIX</td>
1.156 leot 11106: </tr>
11107: <tr>
1.197 leot 11108: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.200 cirnatda 11109: <td>APACHE_SUEXEC_DOCROOT</td>
1.156 leot 11110: </tr>
11111: <tr>
1.197 leot 11112: <td>APACHE_USER</td>
1.200 cirnatda 11113: <td>APPEND_ABI</td>
1.156 leot 11114: </tr>
11115: <tr>
1.197 leot 11116: <td>APPEND_ELF</td>
1.200 cirnatda 11117: <td>ARLA_CACHE</td>
1.156 leot 11118: </tr>
11119: <tr>
1.197 leot 11120: <td>AUDIT_PACKAGES_FLAGS</td>
1.200 cirnatda 11121: <td>AUTOCONF_REQD</td>
1.156 leot 11122: </tr>
11123: <tr>
1.197 leot 11124: <td>AUTOMAKE_OVERRIDE</td>
1.200 cirnatda 11125: <td>AUTOMAKE_REQD</td>
1.156 leot 11126: </tr>
11127: <tr>
1.197 leot 11128: <td>AUTO_MKDIRS</td>
1.200 cirnatda 11129: <td>BDB185_DEFAULT</td>
1.156 leot 11130: </tr>
11131: <tr>
1.197 leot 11132: <td>BDBBASE</td>
1.200 cirnatda 11133: <td>BDB_ACCEPTED</td>
1.156 leot 11134: </tr>
11135: <tr>
1.197 leot 11136: <td>BDB_DEFAULT</td>
1.200 cirnatda 11137: <td>BDB_LIBS</td>
1.156 leot 11138: </tr>
11139: <tr>
1.197 leot 11140: <td>BDB_TYPE</td>
1.200 cirnatda 11141: <td>BINCIMAP_GROUP</td>
1.156 leot 11142: </tr>
11143: <tr>
1.198 leot 11144: <td>BINCIMAP_USER</td>
1.200 cirnatda 11145: <td>BIND_DIR</td>
1.198 leot 11146: </tr>
11147: <tr>
1.197 leot 11148: <td>BIND_GROUP</td>
1.200 cirnatda 11149: <td>BIND_USER</td>
1.156 leot 11150: </tr>
11151: <tr>
1.197 leot 11152: <td>BINOWN</td>
1.200 cirnatda 11153: <td>BINPKG_SITES</td>
1.156 leot 11154: </tr>
11155: <tr>
1.197 leot 11156: <td>BIN_INSTALL_FLAGS</td>
1.200 cirnatda 11157: <td>BISON_PKGDATADIR</td>
1.189 bacon 11158: </tr>
11159: <tr>
1.197 leot 11160: <td>BLAS_ACCEPTED</td>
1.200 cirnatda 11161: <td>BLAS_LIBS</td>
1.156 leot 11162: </tr>
11163: <tr>
1.197 leot 11164: <td>BLAS_TYPE</td>
1.200 cirnatda 11165: <td>BOOTSTRAP_DEPENDS</td>
1.177 leot 11166: </tr>
11167: <tr>
1.197 leot 11168: <td>BOOTSTRAP_SETUPTOOLS</td>
1.200 cirnatda 11169: <td>BROKEN</td>
1.156 leot 11170: </tr>
11171: <tr>
1.197 leot 11172: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.200 cirnatda 11173: <td>BROKEN_ON_PLATFORM</td>
1.156 leot 11174: </tr>
11175: <tr>
1.197 leot 11176: <td>BSDSRCDIR</td>
1.200 cirnatda 11177: <td>BSDXSRCDIR</td>
1.156 leot 11178: </tr>
11179: <tr>
1.197 leot 11180: <td>BSD_MAKE_ENV</td>
1.200 cirnatda 11181: <td>BUILDLINK_AUTO_DIRS</td>
1.156 leot 11182: </tr>
11183: <tr>
1.197 leot 11184: <td>BUILDLINK_AUTO_VARS</td>
1.200 cirnatda 11185: <td>BUILDLINK_CFLAGS</td>
1.156 leot 11186: </tr>
11187: <tr>
1.197 leot 11188: <td>BUILDLINK_CONTENTS_FILTER</td>
1.156 leot 11189: <td>BUILDLINK_CPPFLAGS</td>
11190: </tr>
11191: <tr>
11192: <td>BUILDLINK_FILES</td>
1.189 bacon 11193: <td>BUILDLINK_FILES_CMD</td>
1.156 leot 11194: </tr>
11195: <tr>
11196: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.189 bacon 11197: <td>BUILDLINK_LDFLAGS</td>
1.156 leot 11198: </tr>
11199: <tr>
11200: <td>BUILDLINK_LIBS</td>
1.189 bacon 11201: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.156 leot 11202: </tr>
11203: <tr>
11204: <td>BUILDLINK_PKGNAME</td>
1.189 bacon 11205: <td>BUILDLINK_PREFIX</td>
1.156 leot 11206: </tr>
11207: <tr>
11208: <td>BUILDLINK_RPATHDIRS</td>
1.189 bacon 11209: <td>BUILDLINK_TREE</td>
1.156 leot 11210: </tr>
11211: <tr>
11212: <td>BUILD_DEFS</td>
1.189 bacon 11213: <td>BUILD_DEFS_EFFECTS</td>
1.156 leot 11214: </tr>
11215: <tr>
11216: <td>BUILD_DEPENDS</td>
1.189 bacon 11217: <td>BUILD_DIRS</td>
1.156 leot 11218: </tr>
11219: <tr>
11220: <td>BUILD_ENV_SHELL</td>
1.189 bacon 11221: <td>BUILD_MAKE_CMD</td>
1.156 leot 11222: </tr>
11223: <tr>
11224: <td>BUILD_MAKE_FLAGS</td>
1.189 bacon 11225: <td>BUILD_TARGET</td>
1.156 leot 11226: </tr>
11227: <tr>
11228: <td>BUILTIN_FIND_FILES</td>
1.189 bacon 11229: <td>BUILTIN_FIND_FILES_VAR</td>
1.156 leot 11230: </tr>
11231: <tr>
11232: <td>BUILTIN_FIND_GREP</td>
1.189 bacon 11233: <td>BUILTIN_FIND_HEADERS</td>
1.156 leot 11234: </tr>
11235: <tr>
11236: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.195 gutterid 11237: <td>BUILTIN_FIND_PKGCONFIG</td>
11238: </tr>
11239: <tr>
11240: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.189 bacon 11241: <td>BUILTIN_PKG</td>
1.156 leot 11242: </tr>
11243: <tr>
11244: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.189 bacon 11245: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.156 leot 11246: </tr>
11247: <tr>
11248: <td>BUILTIN_VERSION_SCRIPT</td>
1.189 bacon 11249: <td>BUILTIN_X11_TYPE</td>
1.156 leot 11250: </tr>
11251: <tr>
11252: <td>BUILTIN_X11_VERSION</td>
1.189 bacon 11253: <td>CACTI_GROUP</td>
1.156 leot 11254: </tr>
11255: <tr>
11256: <td>CACTI_USER</td>
1.189 bacon 11257: <td>CANNA_GROUP</td>
1.156 leot 11258: </tr>
11259: <tr>
11260: <td>CANNA_USER</td>
1.189 bacon 11261: <td>CAT</td>
1.156 leot 11262: </tr>
11263: <tr>
11264: <td>CCACHE_BASE</td>
1.189 bacon 11265: <td>CCACHE_DIR</td>
1.156 leot 11266: </tr>
11267: <tr>
11268: <td>CCACHE_LOGFILE</td>
1.189 bacon 11269: <td>CC_VERSION</td>
1.156 leot 11270: </tr>
11271: <tr>
11272: <td>CC_VERSION_STRING</td>
1.189 bacon 11273: <td>CDRECORD_CONF</td>
1.156 leot 11274: </tr>
11275: <tr>
11276: <td>CDROM_PKG_URL_DIR</td>
1.189 bacon 11277: <td>CDROM_PKG_URL_HOST</td>
1.156 leot 11278: </tr>
11279: <tr>
1.189 bacon 11280: <td>CHECK_COMPILER</td>
1.200 cirnatda 11281: <td>CHECK_FAKEHOME</td>
1.197 leot 11282: </tr>
11283: <tr>
11284: <td>CHECK_FILES</td>
1.200 cirnatda 11285: <td>CHECK_FILES_SKIP</td>
1.177 leot 11286: </tr>
11287: <tr>
1.197 leot 11288: <td>CHECK_FILES_STRICT</td>
1.200 cirnatda 11289: <td>CHECK_HEADERS</td>
1.161 leot 11290: </tr>
11291: <tr>
1.197 leot 11292: <td>CHECK_HEADERS_SKIP</td>
1.200 cirnatda 11293: <td>CHECK_INTERPRETER</td>
1.159 rillig 11294: </tr>
11295: <tr>
1.197 leot 11296: <td>CHECK_INTERPRETER_SKIP</td>
1.200 cirnatda 11297: <td>CHECK_PERMS</td>
1.156 leot 11298: </tr>
11299: <tr>
1.197 leot 11300: <td>CHECK_PERMS_AUTOFIX</td>
1.200 cirnatda 11301: <td>CHECK_PERMS_SKIP</td>
1.156 leot 11302: </tr>
11303: <tr>
1.197 leot 11304: <td>CHECK_PORTABILITY</td>
1.200 cirnatda 11305: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.156 leot 11306: </tr>
11307: <tr>
1.197 leot 11308: <td>CHECK_PORTABILITY_SKIP</td>
1.200 cirnatda 11309: <td>CHECK_RELRO</td>
1.156 leot 11310: </tr>
11311: <tr>
1.197 leot 11312: <td>CHECK_RELRO_SKIP</td>
1.200 cirnatda 11313: <td>CHECK_RELRO_SUPPORTED</td>
1.156 leot 11314: </tr>
11315: <tr>
1.197 leot 11316: <td>CHECK_SHLIBS</td>
1.200 cirnatda 11317: <td>CHECK_SHLIBS_BLACKLIST</td>
1.156 leot 11318: </tr>
11319: <tr>
1.197 leot 11320: <td>CHECK_SHLIBS_SKIP</td>
1.200 cirnatda 11321: <td>CHECK_SHLIBS_SUPPORTED</td>
1.156 leot 11322: </tr>
11323: <tr>
1.197 leot 11324: <td>CHECK_SSP</td>
1.200 cirnatda 11325: <td>CHECK_SSP_SKIP</td>
1.156 leot 11326: </tr>
11327: <tr>
1.197 leot 11328: <td>CHECK_SSP_SUPPORTED</td>
1.200 cirnatda 11329: <td>CHECK_STRIPPED</td>
1.156 leot 11330: </tr>
11331: <tr>
1.197 leot 11332: <td>CHECK_STRIPPED_SKIP</td>
1.200 cirnatda 11333: <td>CHECK_WRKREF</td>
1.156 leot 11334: </tr>
11335: <tr>
1.197 leot 11336: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.200 cirnatda 11337: <td>CHECK_WRKREF_SKIP</td>
1.156 leot 11338: </tr>
11339: <tr>
1.197 leot 11340: <td>CLAMAV_DBDIR</td>
1.200 cirnatda 11341: <td>CLAMAV_GROUP</td>
1.156 leot 11342: </tr>
11343: <tr>
1.197 leot 11344: <td>CLAMAV_USER</td>
1.200 cirnatda 11345: <td>CLANGBASE</td>
1.156 leot 11346: </tr>
11347: <tr>
1.197 leot 11348: <td>CLEANDEPENDS</td>
1.200 cirnatda 11349: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.156 leot 11350: </tr>
11351: <tr>
1.197 leot 11352: <td>CMAKE_INSTALL_NAME_DIR</td>
1.200 cirnatda 11353: <td>CMAKE_INSTALL_PREFIX</td>
1.156 leot 11354: </tr>
11355: <tr>
1.197 leot 11356: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.200 cirnatda 11357: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.156 leot 11358: </tr>
11359: <tr>
1.197 leot 11360: <td>CMAKE_PREFIX_PATH</td>
1.191 bacon 11361: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.177 leot 11362: </tr>
11363: <tr>
1.191 bacon 11364: <td>COMPILER_RPATH_FLAG</td>
1.156 leot 11365: <td>COMPILER_USE_SYMLINKS</td>
11366: </tr>
11367: <tr>
1.191 bacon 11368: <td>CONFIGURE_ARGS</td>
1.156 leot 11369: <td>CONFIGURE_DIRS</td>
11370: </tr>
11371: <tr>
1.191 bacon 11372: <td>CONFIGURE_ENV</td>
1.172 rillig 11373: <td>CONFIGURE_ENV_SHELL</td>
1.156 leot 11374: </tr>
11375: <tr>
1.191 bacon 11376: <td>CONFIGURE_HAS_INFODIR</td>
1.156 leot 11377: <td>CONFIGURE_HAS_MANDIR</td>
11378: </tr>
11379: <tr>
1.191 bacon 11380: <td>CONFIGURE_SCRIPT</td>
1.156 leot 11381: <td>CONFIG_SHELL</td>
11382: </tr>
11383: <tr>
1.191 bacon 11384: <td>CONFIG_SHELL_FLAGS</td>
1.156 leot 11385: <td>CONF_FILES</td>
11386: </tr>
11387: <tr>
1.191 bacon 11388: <td>CONF_FILES_MODE</td>
1.156 leot 11389: <td>CONF_FILES_PERMS</td>
11390: </tr>
11391: <tr>
1.191 bacon 11392: <td>CONSERVER_DEFAULTHOST</td>
1.156 leot 11393: <td>CONSERVER_DEFAULTPORT</td>
11394: </tr>
11395: <tr>
1.191 bacon 11396: <td>CP</td>
1.156 leot 11397: <td>CPP</td>
11398: </tr>
11399: <tr>
1.191 bacon 11400: <td>CPP_PRECOMP_FLAGS</td>
1.156 leot 11401: <td>CREATE_WRKDIR_SYMLINK</td>
11402: </tr>
11403: <tr>
1.191 bacon 11404: <td>CROSSBASE</td>
1.156 leot 11405: <td>CTFCONVERT</td>
11406: </tr>
11407: <tr>
1.191 bacon 11408: <td>CTF_FILES_SKIP</td>
1.156 leot 11409: <td>CTF_SUPPORTED</td>
11410: </tr>
11411: <tr>
1.191 bacon 11412: <td>CTYPE</td>
1.156 leot 11413: <td>CUPS_GROUP</td>
11414: </tr>
11415: <tr>
1.191 bacon 11416: <td>CUPS_SYSTEM_GROUPS</td>
1.156 leot 11417: <td>CUPS_USER</td>
11418: </tr>
11419: <tr>
1.191 bacon 11420: <td>CURSES_DEFAULT</td>
1.156 leot 11421: <td>CURSES_TYPE</td>
1.177 leot 11422: </tr>
11423: <tr>
1.160 brook 11424: <td>CXX</td>
1.200 cirnatda 11425: <td>CYRUS_GROUP</td>
1.197 leot 11426: </tr>
11427: <tr>
11428: <td>CYRUS_IDLE</td>
1.200 cirnatda 11429: <td>CYRUS_USER</td>
1.159 rillig 11430: </tr>
11431: <tr>
1.197 leot 11432: <td>DAEMONTOOLS_GROUP</td>
1.200 cirnatda 11433: <td>DAEMONTOOLS_LOG_USER</td>
1.156 leot 11434: </tr>
11435: <tr>
1.197 leot 11436: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.200 cirnatda 11437: <td>DARWIN_REQUIRES_FILTER</td>
1.156 leot 11438: </tr>
11439: <tr>
1.197 leot 11440: <td>DBUS_GROUP</td>
1.200 cirnatda 11441: <td>DBUS_USER</td>
1.195 gutterid 11442: </tr>
11443: <tr>
1.197 leot 11444: <td>DEFANG_GROUP</td>
1.200 cirnatda 11445: <td>DEFANG_USER</td>
1.156 leot 11446: </tr>
11447: <tr>
1.197 leot 11448: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.200 cirnatda 11449: <td>DEFAULT_DISTFILES</td>
1.156 leot 11450: </tr>
11451: <tr>
1.197 leot 11452: <td>DEFAULT_IRC_SERVER</td>
1.200 cirnatda 11453: <td>DEFAULT_SERIAL_DEVICE</td>
1.156 leot 11454: </tr>
11455: <tr>
1.197 leot 11456: <td>DEF_UMASK</td>
1.200 cirnatda 11457: <td>DEINSTALLDEPENDS</td>
1.156 leot 11458: </tr>
11459: <tr>
1.197 leot 11460: <td>DEINSTALL_SRC</td>
1.200 cirnatda 11461: <td>DEINSTALL_TEMPLATES</td>
1.156 leot 11462: </tr>
11463: <tr>
1.197 leot 11464: <td>DELAYED_ERROR_MSG</td>
1.200 cirnatda 11465: <td>DELAYED_WARNING_MSG</td>
1.156 leot 11466: </tr>
11467: <tr>
1.197 leot 11468: <td>DEPENDS</td>
1.200 cirnatda 11469: <td>DEPENDS_TARGET</td>
1.156 leot 11470: </tr>
11471: <tr>
1.197 leot 11472: <td>DEPENDS_TYPE</td>
1.200 cirnatda 11473: <td>DESTDIR</td>
1.156 leot 11474: </tr>
11475: <tr>
1.197 leot 11476: <td>DESTDIR_VARNAME</td>
1.200 cirnatda 11477: <td>DIALER_GROUP</td>
1.156 leot 11478: </tr>
11479: <tr>
1.197 leot 11480: <td>DIGEST_REQD</td>
1.200 cirnatda 11481: <td>DISTDIR</td>
1.156 leot 11482: </tr>
11483: <tr>
1.197 leot 11484: <td>DISTFILES</td>
1.200 cirnatda 11485: <td>DISTINFO_FILE</td>
1.156 leot 11486: </tr>
11487: <tr>
1.197 leot 11488: <td>DISTNAME</td>
1.200 cirnatda 11489: <td>DIST_PATH</td>
1.156 leot 11490: </tr>
11491: <tr>
1.197 leot 11492: <td>DIST_SUBDIR</td>
1.200 cirnatda 11493: <td>DJBDNS_AXFR_USER</td>
1.156 leot 11494: </tr>
11495: <tr>
1.197 leot 11496: <td>DJBDNS_CACHE_USER</td>
1.200 cirnatda 11497: <td>DJBDNS_DJBDNS_GROUP</td>
1.156 leot 11498: </tr>
11499: <tr>
1.197 leot 11500: <td>DJBDNS_LOG_USER</td>
1.200 cirnatda 11501: <td>DJBDNS_RBL_USER</td>
1.156 leot 11502: </tr>
11503: <tr>
1.197 leot 11504: <td>DJBDNS_TINY_USER</td>
1.200 cirnatda 11505: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.156 leot 11506: </tr>
11507: <tr>
1.197 leot 11508: <td>DL_AUTO_VARS</td>
1.200 cirnatda 11509: <td>DL_CFLAGS</td>
1.156 leot 11510: </tr>
11511: <tr>
1.197 leot 11512: <td>DL_LDFLAGS</td>
1.200 cirnatda 11513: <td>DL_LIBS</td>
1.156 leot 11514: </tr>
11515: <tr>
1.197 leot 11516: <td>DNS</td>
1.200 cirnatda 11517: <td>DOCOWN</td>
1.156 leot 11518: </tr>
11519: <tr>
1.197 leot 11520: <td>DOWNLOADED_DISTFILE</td>
1.200 cirnatda 11521: <td>DT_LAYOUT</td>
1.156 leot 11522: </tr>
11523: <tr>
1.197 leot 11524: <td>DYNAMIC_SITES_CMD</td>
1.200 cirnatda 11525: <td>DYNAMIC_SITES_SCRIPT</td>
1.156 leot 11526: </tr>
11527: <tr>
1.197 leot 11528: <td>ECHO</td>
1.200 cirnatda 11529: <td>ECHO_N</td>
1.156 leot 11530: </tr>
11531: <tr>
1.197 leot 11532: <td>ELK_GUI</td>
1.200 cirnatda 11533: <td>EMACS_TYPE</td>
1.156 leot 11534: </tr>
11535: <tr>
1.197 leot 11536: <td>EMULDIR</td>
1.200 cirnatda 11537: <td>EMULSUBDIR</td>
1.156 leot 11538: </tr>
11539: <tr>
1.197 leot 11540: <td>EMULSUBDIRSLASH</td>
1.200 cirnatda 11541: <td>EMUL_ARCH</td>
1.156 leot 11542: </tr>
11543: <tr>
1.197 leot 11544: <td>EMUL_DISTRO</td>
1.200 cirnatda 11545: <td>EMUL_EXEC_FMT</td>
1.156 leot 11546: </tr>
11547: <tr>
1.197 leot 11548: <td>EMUL_IS_NATIVE</td>
1.200 cirnatda 11549: <td>EMUL_MODULES</td>
1.156 leot 11550: </tr>
11551: <tr>
1.197 leot 11552: <td>EMUL_OPSYS</td>
1.200 cirnatda 11553: <td>EMUL_PKG_FMT</td>
1.156 leot 11554: </tr>
11555: <tr>
1.197 leot 11556: <td>EMUL_PLATFORM</td>
1.200 cirnatda 11557: <td>EMUL_PLATFORMS</td>
1.156 leot 11558: </tr>
11559: <tr>
1.197 leot 11560: <td>EMUL_PREFER</td>
1.200 cirnatda 11561: <td>EMUL_REQD</td>
1.156 leot 11562: </tr>
11563: <tr>
1.197 leot 11564: <td>EMUL_TYPE</td>
1.200 cirnatda 11565: <td>ERROR_MSG</td>
1.156 leot 11566: </tr>
11567: <tr>
1.197 leot 11568: <td>EXIM_GROUP</td>
1.200 cirnatda 11569: <td>EXIM_USER</td>
1.156 leot 11570: </tr>
11571: <tr>
1.197 leot 11572: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.200 cirnatda 11573: <td>EXTRACTOR</td>
1.156 leot 11574: </tr>
11575: <tr>
1.197 leot 11576: <td>EXTRACT_CMD</td>
1.200 cirnatda 11577: <td>EXTRACT_CMD_DEFAULT</td>
1.156 leot 11578: </tr>
11579: <tr>
1.197 leot 11580: <td>EXTRACT_DIR</td>
1.200 cirnatda 11581: <td>EXTRACT_ELEMENTS</td>
1.156 leot 11582: </tr>
11583: <tr>
1.197 leot 11584: <td>EXTRACT_ENV</td>
1.200 cirnatda 11585: <td>EXTRACT_ONLY</td>
1.156 leot 11586: </tr>
11587: <tr>
1.197 leot 11588: <td>EXTRACT_OPTS</td>
1.200 cirnatda 11589: <td>EXTRACT_SUFX</td>
1.156 leot 11590: </tr>
11591: <tr>
1.197 leot 11592: <td>EXTRACT_USING</td>
1.200 cirnatda 11593: <td>FAIL</td>
1.156 leot 11594: </tr>
11595: <tr>
1.197 leot 11596: <td>FAILOVER_FETCH</td>
1.200 cirnatda 11597: <td>FAIL_MSG</td>
1.177 leot 11598: </tr>
11599: <tr>
1.197 leot 11600: <td>FAKE_NCURSES</td>
1.200 cirnatda 11601: <td>FAM</td>
1.156 leot 11602: </tr>
11603: <tr>
1.197 leot 11604: <td>FAM_ACCEPTED</td>
1.200 cirnatda 11605: <td>FAM_DEFAULT</td>
1.156 leot 11606: </tr>
11607: <tr>
1.197 leot 11608: <td>FAM_SERVER</td>
1.200 cirnatda 11609: <td>FCPATH</td>
1.156 leot 11610: </tr>
11611: <tr>
1.197 leot 11612: <td>FEATURE_CPPFLAGS</td>
1.200 cirnatda 11613: <td>FEATURE_LDFLAGS</td>
1.156 leot 11614: </tr>
11615: <tr>
1.197 leot 11616: <td>FEATURE_LIBS</td>
1.200 cirnatda 11617: <td>FETCH_AFTER_ARGS</td>
1.156 leot 11618: </tr>
11619: <tr>
1.197 leot 11620: <td>FETCH_BEFORE_ARGS</td>
1.200 cirnatda 11621: <td>FETCH_CMD</td>
1.156 leot 11622: </tr>
11623: <tr>
1.197 leot 11624: <td>FETCH_OUTPUT_ARGS</td>
1.200 cirnatda 11625: <td>FETCH_PROXY</td>
1.156 leot 11626: </tr>
11627: <tr>
1.197 leot 11628: <td>FETCH_RESUME_ARGS</td>
1.200 cirnatda 11629: <td>FETCH_TIMEOUT</td>
1.156 leot 11630: </tr>
11631: <tr>
1.197 leot 11632: <td>FETCH_USE_IPV4_ONLY</td>
1.200 cirnatda 11633: <td>FETCH_USING</td>
1.189 bacon 11634: </tr>
11635: <tr>
1.197 leot 11636: <td>FILES_SUBST</td>
1.200 cirnatda 11637: <td>FILES_SUBST_SED</td>
1.156 leot 11638: </tr>
11639: <tr>
1.197 leot 11640: <td>FIX_SYSTEM_HEADERS</td>
1.200 cirnatda 11641: <td>FLUXBOX_USE_GNOME</td>
1.156 leot 11642: </tr>
11643: <tr>
1.197 leot 11644: <td>FLUXBOX_USE_KDE</td>
1.200 cirnatda 11645: <td>FLUXBOX_USE_XFT</td>
1.156 leot 11646: </tr>
11647: <tr>
1.197 leot 11648: <td>FLUXBOX_USE_XINERAMA</td>
1.180 rillig 11649: <td>FONTS_DIRS</td>
1.161 leot 11650: </tr>
11651: <tr>
1.191 bacon 11652: <td>FONTS_VERBOSE</td>
1.180 rillig 11653: <td>FOO_HACKS_MK</td>
1.177 leot 11654: </tr>
11655: <tr>
1.191 bacon 11656: <td>FOX_USE_XUNICODE</td>
1.180 rillig 11657: <td>FREEWNN_GROUP</td>
1.156 leot 11658: </tr>
11659: <tr>
1.191 bacon 11660: <td>FREEWNN_USER</td>
1.180 rillig 11661: <td>FTP_PKG_URL_DIR</td>
1.156 leot 11662: </tr>
11663: <tr>
1.191 bacon 11664: <td>FTP_PKG_URL_HOST</td>
1.180 rillig 11665: <td>GAMEDATAMODE</td>
1.156 leot 11666: </tr>
11667: <tr>
1.191 bacon 11668: <td>GAMEDATA_PERMS</td>
1.180 rillig 11669: <td>GAMEDIRMODE</td>
1.156 leot 11670: </tr>
11671: <tr>
1.191 bacon 11672: <td>GAMEDIR_PERMS</td>
1.180 rillig 11673: <td>GAMEGRP</td>
1.156 leot 11674: </tr>
11675: <tr>
1.191 bacon 11676: <td>GAMEMODE</td>
1.180 rillig 11677: <td>GAMEOWN</td>
1.156 leot 11678: </tr>
11679: <tr>
1.191 bacon 11680: <td>GAMES_GROUP</td>
1.180 rillig 11681: <td>GAMES_USER</td>
1.156 leot 11682: </tr>
11683: <tr>
1.191 bacon 11684: <td>GCC</td>
1.180 rillig 11685: <td>GCCBASE</td>
1.156 leot 11686: </tr>
11687: <tr>
1.191 bacon 11688: <td>GCC_REQD</td>
1.180 rillig 11689: <td>GCC_VERSION_SUFFIX</td>
1.156 leot 11690: </tr>
11691: <tr>
1.191 bacon 11692: <td>GEM_BUILD</td>
1.180 rillig 11693: <td>GEM_CLEANBUILD</td>
1.156 leot 11694: </tr>
11695: <tr>
1.191 bacon 11696: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.180 rillig 11697: <td>GEM_DOCDIR</td>
1.156 leot 11698: </tr>
11699: <tr>
1.191 bacon 11700: <td>GEM_EXTSDIR</td>
1.180 rillig 11701: <td>GEM_HOME</td>
1.177 leot 11702: </tr>
11703: <tr>
1.191 bacon 11704: <td>GEM_KEEPBUILD</td>
1.180 rillig 11705: <td>GEM_LIBDIR</td>
1.156 leot 11706: </tr>
11707: <tr>
1.191 bacon 11708: <td>GEM_NAME</td>
1.180 rillig 11709: <td>GEM_PATH</td>
1.156 leot 11710: </tr>
11711: <tr>
1.198 leot 11712: <td>GEM_PLUGINSDIR</td>
1.191 bacon 11713: <td>GEM_SPECFILE</td>
1.198 leot 11714: </tr>
11715: <tr>
1.180 rillig 11716: <td>GENERATE_PLIST</td>
1.201 cirnatda 11717: <td>GHC</td>
1.156 leot 11718: </tr>
11719: <tr>
1.201 cirnatda 11720: <td>GHOSTSCRIPT_REQD</td>
1.180 rillig 11721: <td>GITHUB_PROJECT</td>
1.156 leot 11722: </tr>
11723: <tr>
1.201 cirnatda 11724: <td>GITHUB_RELEASE</td>
1.200 cirnatda 11725: <td>GITHUB_SUBMODULES</td>
1.177 leot 11726: </tr>
11727: <tr>
1.201 cirnatda 11728: <td>GITHUB_TAG</td>
1.191 bacon 11729: <td>GITHUB_TYPE</td>
1.159 rillig 11730: </tr>
11731: <tr>
1.201 cirnatda 11732: <td>GNU</td>
1.191 bacon 11733: <td>GNU_CONFIGURE</td>
1.156 leot 11734: </tr>
11735: <tr>
1.201 cirnatda 11736: <td>GNU_CONFIGURE_INFODIR</td>
1.191 bacon 11737: <td>GNU_CONFIGURE_MANDIR</td>
1.156 leot 11738: </tr>
11739: <tr>
1.201 cirnatda 11740: <td>GNU_CONFIGURE_QUIET</td>
1.191 bacon 11741: <td>GNU_CONFIGURE_STRICT</td>
1.156 leot 11742: </tr>
11743: <tr>
1.201 cirnatda 11744: <td>GODEP_REDIRECTS</td>
1.191 bacon 11745: <td>GO_BUILD_PATTERN</td>
1.156 leot 11746: </tr>
11747: <tr>
1.201 cirnatda 11748: <td>GO_DEPS</td>
1.191 bacon 11749: <td>GO_DIST_BASE</td>
1.156 leot 11750: </tr>
11751: <tr>
1.201 cirnatda 11752: <td>GO_MODULE_FILES</td>
1.191 bacon 11753: <td>GO_SRCPATH</td>
1.156 leot 11754: </tr>
11755: <tr>
1.201 cirnatda 11756: <td>GO_VERSION_DEFAULT</td>
1.191 bacon 11757: <td>GROUP_SPECIFIC_PKGS</td>
1.156 leot 11758: </tr>
11759: <tr>
1.201 cirnatda 11760: <td>GRUB_NETWORK_CARDS</td>
1.191 bacon 11761: <td>GRUB_PRESET_COMMAND</td>
1.156 leot 11762: </tr>
11763: <tr>
1.201 cirnatda 11764: <td>GRUB_SCAN_ARGS</td>
1.191 bacon 11765: <td>GZIP</td>
1.197 leot 11766: </tr>
11767: <tr>
1.201 cirnatda 11768: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.197 leot 11769: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.156 leot 11770: </tr>
11771: <tr>
1.201 cirnatda 11772: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.197 leot 11773: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.156 leot 11774: </tr>
11775: <tr>
1.201 cirnatda 11776: <td>HAS_CONFIGURE</td>
1.197 leot 11777: <td>HEADER_TEMPLATES</td>
1.156 leot 11778: </tr>
11779: <tr>
1.201 cirnatda 11780: <td>HOMEPAGE</td>
1.191 bacon 11781: <td>HOST_PKGTOOLS_ARGS</td>
1.156 leot 11782: </tr>
11783: <tr>
1.201 cirnatda 11784: <td>HOST_SPECIFIC_PKGS</td>
1.191 bacon 11785: <td>HOWL_GROUP</td>
1.156 leot 11786: </tr>
11787: <tr>
1.201 cirnatda 11788: <td>HOWL_USER</td>
1.191 bacon 11789: <td>ICCBASE</td>
11790: </tr>
11791: <tr>
1.201 cirnatda 11792: <td>ICECAST_CHROOTDIR</td>
1.180 rillig 11793: <td>ICON_THEMES</td>
1.156 leot 11794: </tr>
11795: <tr>
1.201 cirnatda 11796: <td>IDOBASE</td>
1.180 rillig 11797: <td>IGNORE_CCACHE</td>
1.156 leot 11798: </tr>
11799: <tr>
1.201 cirnatda 11800: <td>IGNORE_INFO_DIRS</td>
1.180 rillig 11801: <td>IGNORE_INTERACTIVE_FETCH</td>
1.156 leot 11802: </tr>
11803: <tr>
1.201 cirnatda 11804: <td>IMAKE</td>
1.180 rillig 11805: <td>IMAKEOPTS</td>
1.156 leot 11806: </tr>
11807: <tr>
1.201 cirnatda 11808: <td>IMAKE_MAKE</td>
1.180 rillig 11809: <td>IMAKE_MANINSTALL</td>
1.156 leot 11810: </tr>
11811: <tr>
1.201 cirnatda 11812: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.180 rillig 11813: <td>IMDICTDIR</td>
1.156 leot 11814: </tr>
11815: <tr>
1.201 cirnatda 11816: <td>INCOMPAT_CURSES</td>
1.180 rillig 11817: <td>INFO_DIR</td>
1.156 leot 11818: </tr>
11819: <tr>
1.201 cirnatda 11820: <td>INFO_FILES</td>
1.180 rillig 11821: <td>INFO_FILES_VERBOSE</td>
1.156 leot 11822: </tr>
11823: <tr>
1.201 cirnatda 11824: <td>INFO_MSG</td>
1.180 rillig 11825: <td>INIT_SYSTEM</td>
1.156 leot 11826: </tr>
11827: <tr>
1.201 cirnatda 11828: <td>INN_DATA_DIR</td>
1.180 rillig 11829: <td>INN_GROUP</td>
1.172 rillig 11830: </tr>
11831: <tr>
1.201 cirnatda 11832: <td>INN_USER</td>
1.180 rillig 11833: <td>INSTALLATION_DIRS</td>
1.156 leot 11834: </tr>
11835: <tr>
1.201 cirnatda 11836: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.180 rillig 11837: <td>INSTALL_ENV</td>
1.156 leot 11838: </tr>
11839: <tr>
1.201 cirnatda 11840: <td>INSTALL_SH_OVERRIDE</td>
1.180 rillig 11841: <td>INSTALL_SRC</td>
1.156 leot 11842: </tr>
11843: <tr>
1.201 cirnatda 11844: <td>INSTALL_TEMPLATES</td>
1.180 rillig 11845: <td>INSTALL_UNSTRIPPED</td>
1.156 leot 11846: </tr>
11847: <tr>
1.201 cirnatda 11848: <td>IRCD_HYBRID_IRC_GROUP</td>
1.180 rillig 11849: <td>IRCD_HYBRID_IRC_USER</td>
1.156 leot 11850: </tr>
11851: <tr>
1.201 cirnatda 11852: <td>IRCD_HYBRID_MAXCONN</td>
1.180 rillig 11853: <td>IRCD_HYBRID_NICLEN</td>
1.156 leot 11854: </tr>
11855: <tr>
1.201 cirnatda 11856: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.180 rillig 11857: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.156 leot 11858: </tr>
11859: <tr>
1.201 cirnatda 11860: <td>IRCD_HYBRID_TOPICLEN</td>
1.180 rillig 11861: <td>IRIX</td>
1.156 leot 11862: </tr>
11863: <tr>
1.201 cirnatda 11864: <td>IRRD_USE_PGP</td>
1.180 rillig 11865: <td>JABBERD_GROUP</td>
1.156 leot 11866: </tr>
11867: <tr>
1.201 cirnatda 11868: <td>JABBERD_LOGDIR</td>
1.180 rillig 11869: <td>JABBERD_PIDDIR</td>
1.156 leot 11870: </tr>
11871: <tr>
1.201 cirnatda 11872: <td>JABBERD_SPOOLDIR</td>
1.180 rillig 11873: <td>JABBERD_USER</td>
1.177 leot 11874: </tr>
11875: <tr>
1.201 cirnatda 11876: <td>JAKARTA_HOME</td>
1.180 rillig 11877: <td>JAVA_BINPREFIX</td>
1.156 leot 11878: </tr>
11879: <tr>
1.201 cirnatda 11880: <td>JAVA_CLASSPATH</td>
1.180 rillig 11881: <td>JAVA_HOME</td>
1.156 leot 11882: </tr>
11883: <tr>
1.201 cirnatda 11884: <td>JAVA_LD_LIBRARY_PATH</td>
1.180 rillig 11885: <td>JAVA_NAME</td>
1.156 leot 11886: </tr>
11887: <tr>
1.201 cirnatda 11888: <td>JAVA_UNLIMIT</td>
1.180 rillig 11889: <td>JAVA_WRAPPERS</td>
1.156 leot 11890: </tr>
11891: <tr>
1.201 cirnatda 11892: <td>JPEG_ACCEPTED</td>
1.180 rillig 11893: <td>JPEG_DEFAULT</td>
1.156 leot 11894: </tr>
11895: <tr>
1.201 cirnatda 11896: <td>KERBEROS</td>
1.180 rillig 11897: <td>KERMIT_SUID_UUCP</td>
1.156 leot 11898: </tr>
11899: <tr>
1.201 cirnatda 11900: <td>KJS_USE_PCRE</td>
1.180 rillig 11901: <td>KNEWS_DOMAIN_FILE</td>
1.156 leot 11902: </tr>
11903: <tr>
1.201 cirnatda 11904: <td>KNEWS_DOMAIN_NAME</td>
1.180 rillig 11905: <td>KRB5_ACCEPTED</td>
1.177 leot 11906: </tr>
11907: <tr>
1.201 cirnatda 11908: <td>KRB5_DEFAULT</td>
1.180 rillig 11909: <td>LANGUAGES</td>
1.156 leot 11910: </tr>
11911: <tr>
1.201 cirnatda 11912: <td>LAPACK_LIBS</td>
1.180 rillig 11913: <td>LATEX2HTML_ICONPATH</td>
1.156 leot 11914: </tr>
11915: <tr>
1.201 cirnatda 11916: <td>LDCONFIG_ADD_CMD</td>
1.180 rillig 11917: <td>LDCONFIG_REMOVE_CMD</td>
1.156 leot 11918: </tr>
11919: <tr>
1.201 cirnatda 11920: <td>LEAFNODE_DATA_DIR</td>
1.180 rillig 11921: <td>LEAFNODE_GROUP</td>
1.156 leot 11922: </tr>
11923: <tr>
1.201 cirnatda 11924: <td>LEAFNODE_USER</td>
1.180 rillig 11925: <td>LIBDVDCSS_HOMEPAGE</td>
1.157 leot 11926: </tr>
11927: <tr>
1.201 cirnatda 11928: <td>LIBDVDCSS_MASTER_SITES</td>
1.180 rillig 11929: <td>LIBRSVG_TYPE</td>
1.156 leot 11930: </tr>
11931: <tr>
1.201 cirnatda 11932: <td>LIBTOOL</td>
1.180 rillig 11933: <td>LIBTOOLIZE_PLIST</td>
1.156 leot 11934: </tr>
11935: <tr>
1.201 cirnatda 11936: <td>LIBTOOL_M4_OVERRIDE</td>
1.180 rillig 11937: <td>LIBUSB_TYPE</td>
1.177 leot 11938: </tr>
11939: <tr>
1.201 cirnatda 11940: <td>LICENSE</td>
1.180 rillig 11941: <td>LINKER_RPATH_FLAG</td>
1.156 leot 11942: </tr>
11943: <tr>
1.201 cirnatda 11944: <td>LINK_RPATH_FLAG</td>
1.191 bacon 11945: <td>LINUX_LOCALES</td>
1.197 leot 11946: </tr>
11947: <tr>
1.201 cirnatda 11948: <td>LOCALBASE</td>
1.197 leot 11949: <td>LOCALBASE_LOCKTYPE</td>
1.156 leot 11950: </tr>
11951: <tr>
1.201 cirnatda 11952: <td>LOCALPATCHES</td>
1.197 leot 11953: <td>LOVE_DATA</td>
1.156 leot 11954: </tr>
11955: <tr>
1.201 cirnatda 11956: <td>LOVE_GAME</td>
1.197 leot 11957: <td>LOVE_VERSION</td>
1.156 leot 11958: </tr>
11959: <tr>
1.201 cirnatda 11960: <td>LP64PLATFORMS</td>
1.197 leot 11961: <td>MACHINE_PLATFORM</td>
1.156 leot 11962: </tr>
11963: <tr>
1.201 cirnatda 11964: <td>MAILAGENT_DOMAIN</td>
1.197 leot 11965: <td>MAILAGENT_EMAIL</td>
1.156 leot 11966: </tr>
11967: <tr>
1.201 cirnatda 11968: <td>MAILAGENT_FQDN</td>
1.197 leot 11969: <td>MAILAGENT_ORGANIZATION</td>
1.156 leot 11970: </tr>
11971: <tr>
1.201 cirnatda 11972: <td>MAJORDOMO_HOMEDIR</td>
1.180 rillig 11973: <td>MAKEINFO_ARGS</td>
1.156 leot 11974: </tr>
11975: <tr>
1.201 cirnatda 11976: <td>MAKE_DIRS</td>
1.180 rillig 11977: <td>MAKE_DIRS_PERMS</td>
1.156 leot 11978: </tr>
11979: <tr>
1.201 cirnatda 11980: <td>MAKE_ENV</td>
1.180 rillig 11981: <td>MAKE_FILE</td>
1.156 leot 11982: </tr>
11983: <tr>
1.201 cirnatda 11984: <td>MAKE_FLAGS</td>
1.180 rillig 11985: <td>MAKE_JOBS</td>
1.156 leot 11986: </tr>
11987: <tr>
1.201 cirnatda 11988: <td>MAKE_JOBS_SAFE</td>
1.180 rillig 11989: <td>MAKE_PROGRAM</td>
1.156 leot 11990: </tr>
11991: <tr>
1.201 cirnatda 11992: <td>MANCOMPRESSED_IF_MANZ</td>
1.188 leot 11993: <td>MANINSTALL</td>
1.189 bacon 11994: </tr>
11995: <tr>
1.201 cirnatda 11996: <td>MANZ</td>
1.189 bacon 11997: <td>MASTER_SITES</td>
1.156 leot 11998: </tr>
11999: <tr>
1.201 cirnatda 12000: <td>MASTER_SITE_BACKUP</td>
1.189 bacon 12001: <td>MASTER_SITE_LOCAL</td>
1.156 leot 12002: </tr>
12003: <tr>
1.201 cirnatda 12004: <td>MASTER_SITE_MOZILLA</td>
1.189 bacon 12005: <td>MASTER_SITE_OVERRIDE</td>
1.156 leot 12006: </tr>
12007: <tr>
1.201 cirnatda 12008: <td>MASTER_SITE_PERL_CPAN</td>
1.189 bacon 12009: <td>MASTER_SORT</td>
1.156 leot 12010: </tr>
12011: <tr>
1.201 cirnatda 12012: <td>MASTER_SORT_RANDOM</td>
1.189 bacon 12013: <td>MASTER_SORT_REGEX</td>
1.156 leot 12014: </tr>
12015: <tr>
1.201 cirnatda 12016: <td>MECAB_CHARSET</td>
1.189 bacon 12017: <td>MEDIATOMB_GROUP</td>
1.156 leot 12018: </tr>
12019: <tr>
1.201 cirnatda 12020: <td>MEDIATOMB_USER</td>
1.189 bacon 12021: <td>MIPSPROBASE</td>
1.156 leot 12022: </tr>
12023: <tr>
1.201 cirnatda 12024: <td>MIREDO_GROUP</td>
1.189 bacon 12025: <td>MIREDO_USER</td>
1.156 leot 12026: </tr>
12027: <tr>
1.201 cirnatda 12028: <td>MISSING_FEATURES</td>
1.189 bacon 12029: <td>MKDIR</td>
1.156 leot 12030: </tr>
12031: <tr>
1.201 cirnatda 12032: <td>MLDONKEY_GROUP</td>
1.189 bacon 12033: <td>MLDONKEY_HOME</td>
1.156 leot 12034: </tr>
12035: <tr>
1.201 cirnatda 12036: <td>MLDONKEY_USER</td>
1.189 bacon 12037: <td>MONOTONE_GROUP</td>
1.156 leot 12038: </tr>
12039: <tr>
1.201 cirnatda 12040: <td>MONOTONE_USER</td>
1.189 bacon 12041: <td>MOTIFBASE</td>
1.156 leot 12042: </tr>
12043: <tr>
1.201 cirnatda 12044: <td>MOTIF_TYPE</td>
1.189 bacon 12045: <td>MOTIF_TYPE_DEFAULT</td>
1.156 leot 12046: </tr>
12047: <tr>
1.201 cirnatda 12048: <td>MPI_TYPE</td>
1.189 bacon 12049: <td>MSGFMT_STRIP_MSGCTXT</td>
1.156 leot 12050: </tr>
12051: <tr>
1.201 cirnatda 12052: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.189 bacon 12053: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.197 leot 12054: </tr>
12055: <tr>
1.201 cirnatda 12056: <td>MV</td>
1.197 leot 12057: <td>MYSQL_CHARSET</td>
1.156 leot 12058: </tr>
12059: <tr>
1.201 cirnatda 12060: <td>MYSQL_DATADIR</td>
1.197 leot 12061: <td>MYSQL_EXTRA_CHARSET</td>
1.156 leot 12062: </tr>
12063: <tr>
1.201 cirnatda 12064: <td>MYSQL_GROUP</td>
1.200 cirnatda 12065: <td>MYSQL_USER</td>
1.156 leot 12066: </tr>
12067: <tr>
1.197 leot 12068: <td>MYSQL_VERSION</td>
1.200 cirnatda 12069: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.156 leot 12070: </tr>
12071: <tr>
1.201 cirnatda 12072: <td>MYSQL_VERSIONS_ALL</td>
1.197 leot 12073: <td>MYSQL_VERSION_DEFAULT</td>
1.195 gutterid 12074: </tr>
12075: <tr>
1.201 cirnatda 12076: <td>NAGIOSCMD_GROUP</td>
1.197 leot 12077: <td>NAGIOSDIR</td>
1.156 leot 12078: </tr>
12079: <tr>
1.201 cirnatda 12080: <td>NAGIOS_GROUP</td>
1.197 leot 12081: <td>NAGIOS_USER</td>
1.156 leot 12082: </tr>
12083: <tr>
1.201 cirnatda 12084: <td>NATIVE_APPEND_ABI</td>
1.197 leot 12085: <td>NATIVE_APPEND_ELF</td>
1.156 leot 12086: </tr>
12087: <tr>
1.201 cirnatda 12088: <td>NATIVE_EXEC_FMT</td>
1.197 leot 12089: <td>NATIVE_MACHINE_PLATFORM</td>
1.156 leot 12090: </tr>
12091: <tr>
1.201 cirnatda 12092: <td>NATIVE_OBJECT_FMT</td>
1.197 leot 12093: <td>NBPAX_PROGRAM_PREFIX</td>
1.156 leot 12094: </tr>
12095: <tr>
1.201 cirnatda 12096: <td>NETBSD_LOGIN_NAME</td>
1.197 leot 12097: <td>NMH_EDITOR</td>
1.156 leot 12098: </tr>
12099: <tr>
1.201 cirnatda 12100: <td>NMH_MTA</td>
1.197 leot 12101: <td>NMH_PAGER</td>
1.178 rillig 12102: </tr>
12103: <tr>
1.201 cirnatda 12104: <td>NOLOGIN</td>
1.197 leot 12105: <td>NOTE</td>
1.156 leot 12106: </tr>
12107: <tr>
1.201 cirnatda 12108: <td>NOT_FOR_PLATFORM</td>
1.197 leot 12109: <td>NOT_PAX_ASLR_SAFE</td>
1.156 leot 12110: </tr>
12111: <tr>
1.201 cirnatda 12112: <td>NOT_PAX_MPROTECT_SAFE</td>
1.197 leot 12113: <td>NO_BUILD</td>
1.156 leot 12114: </tr>
12115: <tr>
1.201 cirnatda 12116: <td>NO_CHECKSUM</td>
1.197 leot 12117: <td>NO_CONFIGURE</td>
1.156 leot 12118: </tr>
12119: <tr>
1.201 cirnatda 12120: <td>NO_SKIP</td>
1.197 leot 12121: <td>NS_PREFERRED</td>
1.156 leot 12122: </tr>
12123: <tr>
1.201 cirnatda 12124: <td>NULLMAILER_GROUP</td>
1.197 leot 12125: <td>NULLMAILER_USER</td>
1.156 leot 12126: </tr>
12127: <tr>
1.201 cirnatda 12128: <td>OASIS</td>
1.197 leot 12129: <td>OASIS_BUILD_ARGS</td>
1.156 leot 12130: </tr>
12131: <tr>
1.201 cirnatda 12132: <td>OBJHOSTNAME</td>
1.197 leot 12133: <td>OBJMACHINE</td>
1.156 leot 12134: </tr>
12135: <tr>
1.201 cirnatda 12136: <td>OCAML_FINDLIB_DIRS</td>
1.197 leot 12137: <td>OCAML_FINDLIB_REGISTER</td>
1.156 leot 12138: </tr>
12139: <tr>
1.201 cirnatda 12140: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.197 leot 12141: <td>OCAML_SITELIBDIR</td>
1.156 leot 12142: </tr>
12143: <tr>
1.201 cirnatda 12144: <td>OCAML_TOPKG_DOCDIR</td>
1.197 leot 12145: <td>OCAML_USE_DUNE</td>
1.156 leot 12146: </tr>
12147: <tr>
1.201 cirnatda 12148: <td>OCAML_USE_FINDLIB</td>
1.197 leot 12149: <td>OCAML_USE_JBUILDER</td>
1.156 leot 12150: </tr>
12151: <tr>
1.201 cirnatda 12152: <td>OCAML_USE_OASIS</td>
1.197 leot 12153: <td>OCAML_USE_OASIS_DYNRUN</td>
1.156 leot 12154: </tr>
12155: <tr>
1.201 cirnatda 12156: <td>OCAML_USE_OPAM</td>
1.197 leot 12157: <td>OCAML_USE_OPT_COMPILER</td>
1.156 leot 12158: </tr>
12159: <tr>
1.201 cirnatda 12160: <td>OCAML_USE_TOPKG</td>
1.197 leot 12161: <td>OMF</td>
1.156 leot 12162: </tr>
12163: <tr>
1.201 cirnatda 12164: <td>ONLY_FOR_COMPILER</td>
1.197 leot 12165: <td>ONLY_FOR_PLATFORM</td>
1.156 leot 12166: </tr>
12167: <tr>
1.201 cirnatda 12168: <td>OPENSSH_CHROOT</td>
1.197 leot 12169: <td>OPENSSH_GROUP</td>
1.156 leot 12170: </tr>
12171: <tr>
1.201 cirnatda 12172: <td>OPENSSH_USER</td>
1.197 leot 12173: <td>OPSYS</td>
1.156 leot 12174: </tr>
12175: <tr>
1.201 cirnatda 12176: <td>OPSYS_EMULDIR</td>
1.197 leot 12177: <td>OS</td>
1.156 leot 12178: </tr>
12179: <tr>
1.201 cirnatda 12180: <td>OSS_TYPE</td>
1.197 leot 12181: <td>OSX</td>
1.177 leot 12182: </tr>
12183: <tr>
1.201 cirnatda 12184: <td>OSX_TOLERATE_SDK_SKEW</td>
1.195 gutterid 12185: <td>OS_VARIANT</td>
1.197 leot 12186: </tr>
12187: <tr>
1.201 cirnatda 12188: <td>OS_VERSION</td>
1.197 leot 12189: <td>OTF_FONTS_DIR</td>
1.156 leot 12190: </tr>
12191: <tr>
1.201 cirnatda 12192: <td>OVERRIDE_DIRDEPTH</td>
1.197 leot 12193: <td>OVERRIDE_GEMSPEC</td>
1.156 leot 12194: </tr>
12195: <tr>
1.201 cirnatda 12196: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.191 bacon 12197: <td>OWN_DIRS</td>
1.161 leot 12198: </tr>
12199: <tr>
1.201 cirnatda 12200: <td>OWN_DIRS_PERMS</td>
1.191 bacon 12201: <td>P4GROUP</td>
1.156 leot 12202: </tr>
12203: <tr>
1.201 cirnatda 12204: <td>P4PORT</td>
1.191 bacon 12205: <td>P4ROOT</td>
1.156 leot 12206: </tr>
12207: <tr>
1.201 cirnatda 12208: <td>P4USER</td>
1.191 bacon 12209: <td>PACKAGES</td>
1.156 leot 12210: </tr>
12211: <tr>
1.201 cirnatda 12212: <td>PALMOS_DEFAULT_SDK</td>
1.191 bacon 12213: <td>PAMBASE</td>
1.156 leot 12214: </tr>
12215: <tr>
1.201 cirnatda 12216: <td>PAM_DEFAULT</td>
1.191 bacon 12217: <td>PAPERSIZE</td>
1.156 leot 12218: </tr>
12219: <tr>
1.201 cirnatda 12220: <td>PASSIVE_FETCH</td>
1.191 bacon 12221: <td>PATCHDIR</td>
1.156 leot 12222: </tr>
12223: <tr>
1.201 cirnatda 12224: <td>PATCHFILES</td>
1.191 bacon 12225: <td>PATCH_ARGS</td>
1.156 leot 12226: </tr>
12227: <tr>
1.201 cirnatda 12228: <td>PATCH_DEBUG</td>
1.191 bacon 12229: <td>PATCH_DIST_ARGS</td>
1.169 rillig 12230: </tr>
12231: <tr>
1.201 cirnatda 12232: <td>PATCH_DIST_CAT</td>
1.191 bacon 12233: <td>PATCH_DIST_STRIP</td>
1.156 leot 12234: </tr>
12235: <tr>
1.201 cirnatda 12236: <td>PATCH_FUZZ_FACTOR</td>
1.191 bacon 12237: <td>PATCH_STRIP</td>
1.201 cirnatda 12238: </tr>
12239: <tr>
1.195 gutterid 12240: <td>PATH</td>
1.201 cirnatda 12241: <td>PCCBASE</td>
1.156 leot 12242: </tr>
12243: <tr>
1.195 gutterid 12244: <td>PEAR_CMD</td>
1.201 cirnatda 12245: <td>PEAR_LIB</td>
1.177 leot 12246: </tr>
12247: <tr>
1.195 gutterid 12248: <td>PEAR_PACKAGE_XML</td>
1.201 cirnatda 12249: <td>PERL5</td>
1.161 leot 12250: </tr>
12251: <tr>
1.195 gutterid 12252: <td>PERL5_CONFIGURE</td>
1.201 cirnatda 12253: <td>PERL5_CONFIGURE_DIRS</td>
1.161 leot 12254: </tr>
12255: <tr>
1.195 gutterid 12256: <td>PERL5_LDFLAGS</td>
1.201 cirnatda 12257: <td>PERL5_LICENSE</td>
1.156 leot 12258: </tr>
12259: <tr>
1.195 gutterid 12260: <td>PERL5_MODULE_TYPE</td>
1.201 cirnatda 12261: <td>PERL5_PACKLIST</td>
1.156 leot 12262: </tr>
12263: <tr>
1.195 gutterid 12264: <td>PERL5_PACKLIST_DIR</td>
1.201 cirnatda 12265: <td>PERL5_PERLBASE</td>
1.156 leot 12266: </tr>
12267: <tr>
1.195 gutterid 12268: <td>PERL5_SITEBASE</td>
1.201 cirnatda 12269: <td>PERL5_USE_PACKLIST</td>
1.156 leot 12270: </tr>
12271: <tr>
1.195 gutterid 12272: <td>PERL5_VENDORBASE</td>
1.201 cirnatda 12273: <td>PFCTL</td>
1.156 leot 12274: </tr>
12275: <tr>
1.195 gutterid 12276: <td>PFVAR_H</td>
1.201 cirnatda 12277: <td>PF_VERSION</td>
1.156 leot 12278: </tr>
12279: <tr>
1.195 gutterid 12280: <td>PGGROUP</td>
1.201 cirnatda 12281: <td>PGHOME</td>
1.156 leot 12282: </tr>
12283: <tr>
1.195 gutterid 12284: <td>PGPKGSRCDIR</td>
1.201 cirnatda 12285: <td>PGSQL_TYPE</td>
1.156 leot 12286: </tr>
12287: <tr>
1.195 gutterid 12288: <td>PGSQL_VERSION</td>
1.201 cirnatda 12289: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.156 leot 12290: </tr>
12291: <tr>
1.191 bacon 12292: <td>PGSQL_VERSION_DEFAULT</td>
1.201 cirnatda 12293: <td>PGUSER</td>
1.156 leot 12294: </tr>
12295: <tr>
1.191 bacon 12296: <td>PG_LIB_EXT</td>
1.201 cirnatda 12297: <td>PHP</td>
1.156 leot 12298: </tr>
12299: <tr>
1.191 bacon 12300: <td>PHPCOMMON_MK</td>
1.201 cirnatda 12301: <td>PHPPKGSRCDIR</td>
1.156 leot 12302: </tr>
12303: <tr>
1.191 bacon 12304: <td>PHP_BASE_VERS</td>
1.201 cirnatda 12305: <td>PHP_CHECK_INSTALLED</td>
1.156 leot 12306: </tr>
12307: <tr>
1.191 bacon 12308: <td>PHP_EXTENSION_DIR</td>
1.201 cirnatda 12309: <td>PHP_INITIAL_TEENY</td>
1.156 leot 12310: </tr>
12311: <tr>
1.191 bacon 12312: <td>PHP_PKG_PREFIX</td>
1.201 cirnatda 12313: <td>PHP_VERSION</td>
1.156 leot 12314: </tr>
12315: <tr>
1.191 bacon 12316: <td>PHP_VERSIONS_ACCEPTED</td>
1.201 cirnatda 12317: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.156 leot 12318: </tr>
12319: <tr>
1.191 bacon 12320: <td>PHP_VERSION_DEFAULT</td>
1.201 cirnatda 12321: <td>PHP_VERSION_REQD</td>
1.156 leot 12322: </tr>
12323: <tr>
1.191 bacon 12324: <td>PILRC_USE_GTK</td>
1.201 cirnatda 12325: <td>PKGCONFIG_BASE</td>
1.156 leot 12326: </tr>
12327: <tr>
1.191 bacon 12328: <td>PKGCONFIG_FILE</td>
1.201 cirnatda 12329: <td>PKGCONFIG_OVERRIDE</td>
1.156 leot 12330: </tr>
12331: <tr>
1.191 bacon 12332: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.201 cirnatda 12333: <td>PKGDIR</td>
1.156 leot 12334: </tr>
12335: <tr>
1.191 bacon 12336: <td>PKGGNUDIR</td>
1.201 cirnatda 12337: <td>PKGINFODIR</td>
1.156 leot 12338: </tr>
12339: <tr>
1.191 bacon 12340: <td>PKGLOCALEDIR</td>
1.201 cirnatda 12341: <td>PKGMANDIR</td>
1.156 leot 12342: </tr>
12343: <tr>
1.191 bacon 12344: <td>PKGNAME</td>
1.201 cirnatda 12345: <td>PKGNAME_REQD</td>
1.156 leot 12346: </tr>
12347: <tr>
1.191 bacon 12348: <td>PKGPATH</td>
1.201 cirnatda 12349: <td>PKGREVISION</td>
1.156 leot 12350: </tr>
12351: <tr>
1.191 bacon 12352: <td>PKGSRC_BLAS_TYPES</td>
1.201 cirnatda 12353: <td>PKGSRC_CHANGES</td>
1.177 leot 12354: </tr>
12355: <tr>
1.191 bacon 12356: <td>PKGSRC_COMPILER</td>
1.201 cirnatda 12357: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.156 leot 12358: </tr>
12359: <tr>
1.191 bacon 12360: <td>PKGSRC_LOCKTYPE</td>
1.201 cirnatda 12361: <td>PKGSRC_MAKE_ENV</td>
1.159 rillig 12362: </tr>
12363: <tr>
1.191 bacon 12364: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.201 cirnatda 12365: <td>PKGSRC_MKPIE</td>
1.156 leot 12366: </tr>
12367: <tr>
1.191 bacon 12368: <td>PKGSRC_MKREPRO</td>
1.201 cirnatda 12369: <td>PKGSRC_RUN_TEST</td>
1.156 leot 12370: </tr>
12371: <tr>
1.191 bacon 12372: <td>PKGSRC_SETENV</td>
1.201 cirnatda 12373: <td>PKGSRC_SLEEPSECS</td>
1.156 leot 12374: </tr>
12375: <tr>
1.191 bacon 12376: <td>PKGSRC_TODO</td>
1.201 cirnatda 12377: <td>PKGSRC_USE_CTF</td>
1.156 leot 12378: </tr>
12379: <tr>
1.191 bacon 12380: <td>PKGSRC_USE_FORTIFY</td>
1.201 cirnatda 12381: <td>PKGSRC_USE_RELRO</td>
1.156 leot 12382: </tr>
12383: <tr>
1.191 bacon 12384: <td>PKGSRC_USE_SSP</td>
1.201 cirnatda 12385: <td>PKGSRC_USE_STACK_CHECK</td>
1.156 leot 12386: </tr>
12387: <tr>
1.191 bacon 12388: <td>PKGTASKS_DATAFILE</td>
1.201 cirnatda 12389: <td>PKGTOOLS_ARGS</td>
1.156 leot 12390: </tr>
12391: <tr>
1.191 bacon 12392: <td>PKGTOOLS_ENV</td>
1.201 cirnatda 12393: <td>PKG_ALTERNATIVES</td>
1.156 leot 12394: </tr>
12395: <tr>
1.191 bacon 12396: <td>PKG_APACHE</td>
1.201 cirnatda 12397: <td>PKG_APACHE_ACCEPTED</td>
1.156 leot 12398: </tr>
12399: <tr>
1.191 bacon 12400: <td>PKG_APACHE_DEFAULT</td>
1.201 cirnatda 12401: <td>PKG_BEST_EXISTS</td>
1.156 leot 12402: </tr>
12403: <tr>
1.191 bacon 12404: <td>PKG_BUILD_OPTIONS</td>
1.201 cirnatda 12405: <td>PKG_COMPRESSION</td>
1.156 leot 12406: </tr>
12407: <tr>
1.191 bacon 12408: <td>PKG_CONFIG</td>
1.201 cirnatda 12409: <td>PKG_CONFIG_PERMS</td>
1.156 leot 12410: </tr>
12411: <tr>
1.191 bacon 12412: <td>PKG_CREATE_USERGROUP</td>
1.201 cirnatda 12413: <td>PKG_DB_TMPDIR</td>
1.156 leot 12414: </tr>
12415: <tr>
1.191 bacon 12416: <td>PKG_DEBUG_LEVEL</td>
1.201 cirnatda 12417: <td>PKG_DEFAULT_OPTIONS</td>
1.156 leot 12418: </tr>
12419: <tr>
1.191 bacon 12420: <td>PKG_DESTDIR_SUPPORT</td>
1.201 cirnatda 12421: <td>PKG_DEVELOPER</td>
1.156 leot 12422: </tr>
12423: <tr>
1.191 bacon 12424: <td>PKG_DISABLED_OPTIONS</td>
1.201 cirnatda 12425: <td>PKG_FATAL_ERRORS</td>
1.156 leot 12426: </tr>
12427: <tr>
1.191 bacon 12428: <td>PKG_FC</td>
1.201 cirnatda 12429: <td>PKG_FILELIST_CMD</td>
1.156 leot 12430: </tr>
12431: <tr>
1.191 bacon 12432: <td>PKG_GECOS</td>
1.201 cirnatda 12433: <td>PKG_GID</td>
1.156 leot 12434: </tr>
12435: <tr>
1.191 bacon 12436: <td>PKG_GROUPS</td>
1.201 cirnatda 12437: <td>PKG_GROUPS_VARS</td>
1.156 leot 12438: </tr>
12439: <tr>
1.191 bacon 12440: <td>PKG_HOME</td>
1.201 cirnatda 12441: <td>PKG_INIT_SCRIPTS</td>
1.156 leot 12442: </tr>
12443: <tr>
1.191 bacon 12444: <td>PKG_JAVA_HOME</td>
1.201 cirnatda 12445: <td>PKG_JVM</td>
1.156 leot 12446: </tr>
12447: <tr>
1.191 bacon 12448: <td>PKG_JVMS_ACCEPTED</td>
1.201 cirnatda 12449: <td>PKG_JVM_DEFAULT</td>
1.156 leot 12450: </tr>
12451: <tr>
1.191 bacon 12452: <td>PKG_LEGACY_OPTIONS</td>
1.201 cirnatda 12453: <td>PKG_LIBTOOL</td>
1.156 leot 12454: </tr>
12455: <tr>
1.191 bacon 12456: <td>PKG_OPTIONS</td>
1.201 cirnatda 12457: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.156 leot 12458: </tr>
12459: <tr>
1.191 bacon 12460: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.201 cirnatda 12461: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.156 leot 12462: </tr>
12463: <tr>
1.191 bacon 12464: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.201 cirnatda 12465: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.156 leot 12466: </tr>
12467: <tr>
1.191 bacon 12468: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.201 cirnatda 12469: <td>PKG_OPTIONS_VAR</td>
1.156 leot 12470: </tr>
12471: <tr>
1.191 bacon 12472: <td>PKG_PHP</td>
1.201 cirnatda 12473: <td>PKG_PHP_MAJOR_VERS</td>
1.156 leot 12474: </tr>
12475: <tr>
1.191 bacon 12476: <td>PKG_PHP_VERSION</td>
1.201 cirnatda 12477: <td>PKG_RCD_SCRIPTS</td>
1.156 leot 12478: </tr>
12479: <tr>
1.191 bacon 12480: <td>PKG_REFCOUNT_DBDIR</td>
1.201 cirnatda 12481: <td>PKG_REGISTER_SHELLS</td>
1.156 leot 12482: </tr>
12483: <tr>
1.191 bacon 12484: <td>PKG_RESUME_TRANSFERS</td>
1.201 cirnatda 12485: <td>PKG_SHELL</td>
1.156 leot 12486: </tr>
12487: <tr>
1.191 bacon 12488: <td>PKG_SUGGESTED_OPTIONS</td>
1.201 cirnatda 12489: <td>PKG_SUPPORTED_OPTIONS</td>
1.156 leot 12490: </tr>
12491: <tr>
1.191 bacon 12492: <td>PKG_SYSCONFBASE</td>
1.201 cirnatda 12493: <td>PKG_SYSCONFBASEDIR</td>
1.156 leot 12494: </tr>
12495: <tr>
1.191 bacon 12496: <td>PKG_SYSCONFDIR</td>
1.201 cirnatda 12497: <td>PKG_SYSCONFDIR_PERMS</td>
1.156 leot 12498: </tr>
12499: <tr>
1.191 bacon 12500: <td>PKG_SYSCONFSUBDIR</td>
1.201 cirnatda 12501: <td>PKG_SYSCONFVAR</td>
1.156 leot 12502: </tr>
12503: <tr>
1.191 bacon 12504: <td>PKG_TOOLS_BIN</td>
1.201 cirnatda 12505: <td>PKG_UID</td>
1.156 leot 12506: </tr>
12507: <tr>
1.191 bacon 12508: <td>PKG_UPDATE_FONTS_DB</td>
1.201 cirnatda 12509: <td>PKG_USERS</td>
1.156 leot 12510: </tr>
12511: <tr>
1.191 bacon 12512: <td>PKG_USERS_VARS</td>
1.201 cirnatda 12513: <td>PKG_VERBOSE</td>
1.156 leot 12514: </tr>
12515: <tr>
1.201 cirnatda 12516: <td>PLEASE</td>
1.191 bacon 12517: <td>PLIST</td>
1.156 leot 12518: </tr>
12519: <tr>
1.180 rillig 12520: <td>PLIST_AWK</td>
1.191 bacon 12521: <td>PLIST_AWK_ENV</td>
1.156 leot 12522: </tr>
12523: <tr>
1.180 rillig 12524: <td>PLIST_SRC</td>
1.191 bacon 12525: <td>PLIST_SUBST</td>
1.156 leot 12526: </tr>
12527: <tr>
1.180 rillig 12528: <td>PLIST_TYPE</td>
1.191 bacon 12529: <td>PLIST_VARS</td>
1.156 leot 12530: </tr>
12531: <tr>
1.180 rillig 12532: <td>POPTOP_USE_MPPE</td>
1.191 bacon 12533: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.156 leot 12534: </tr>
12535: <tr>
1.180 rillig 12536: <td>POST_FETCH_HOOK</td>
1.191 bacon 12537: <td>PREFER</td>
1.156 leot 12538: </tr>
12539: <tr>
1.180 rillig 12540: <td>PREFER_NATIVE</td>
1.191 bacon 12541: <td>PREFER_NATIVE_PTHREADS</td>
1.156 leot 12542: </tr>
12543: <tr>
1.180 rillig 12544: <td>PREFER_PKGSRC</td>
1.191 bacon 12545: <td>PREFIX</td>
1.156 leot 12546: </tr>
12547: <tr>
1.180 rillig 12548: <td>PREPEND_PATH</td>
1.191 bacon 12549: <td>PRE_ROOT_CMD</td>
1.156 leot 12550: </tr>
12551: <tr>
1.180 rillig 12552: <td>PRIVILEGED_STAGES</td>
1.191 bacon 12553: <td>PS</td>
1.156 leot 12554: </tr>
12555: <tr>
1.180 rillig 12556: <td>PTHREAD_AUTO_VARS</td>
1.191 bacon 12557: <td>PTHREAD_CFLAGS</td>
1.156 leot 12558: </tr>
12559: <tr>
1.180 rillig 12560: <td>PTHREAD_LDFLAGS</td>
1.191 bacon 12561: <td>PTHREAD_LIBS</td>
1.156 leot 12562: </tr>
12563: <tr>
1.180 rillig 12564: <td>PTHREAD_OPTS</td>
1.191 bacon 12565: <td>PTHREAD_TYPE</td>
1.156 leot 12566: </tr>
12567: <tr>
1.180 rillig 12568: <td>PVM_SSH</td>
1.191 bacon 12569: <td>PYPKGPREFIX</td>
1.156 leot 12570: </tr>
12571: <tr>
1.180 rillig 12572: <td>PYTHON_FOR_BUILD_ONLY</td>
1.191 bacon 12573: <td>PYTHON_SELF_CONFLICT</td>
1.156 leot 12574: </tr>
12575: <tr>
1.180 rillig 12576: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.191 bacon 12577: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.156 leot 12578: </tr>
12579: <tr>
1.180 rillig 12580: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.191 bacon 12581: <td>PYTHON_VERSION_DEFAULT</td>
1.156 leot 12582: </tr>
12583: <tr>
1.180 rillig 12584: <td>PYTHON_VERSION_REQD</td>
1.191 bacon 12585: <td>PYVERSSUFFIX</td>
1.156 leot 12586: </tr>
12587: <tr>
1.180 rillig 12588: <td>PY_NO_EGG</td>
1.191 bacon 12589: <td>QMAILDIR</td>
1.156 leot 12590: </tr>
12591: <tr>
1.180 rillig 12592: <td>QMAIL_ALIAS_USER</td>
1.191 bacon 12593: <td>QMAIL_DAEMON_USER</td>
1.156 leot 12594: </tr>
12595: <tr>
1.180 rillig 12596: <td>QMAIL_LOG_USER</td>
1.191 bacon 12597: <td>QMAIL_NOFILES_GROUP</td>
1.156 leot 12598: </tr>
12599: <tr>
1.180 rillig 12600: <td>QMAIL_PASSWD_USER</td>
1.191 bacon 12601: <td>QMAIL_QMAIL_GROUP</td>
1.156 leot 12602: </tr>
12603: <tr>
1.180 rillig 12604: <td>QMAIL_QUEUE_DIR</td>
1.191 bacon 12605: <td>QMAIL_QUEUE_EXTRA</td>
1.156 leot 12606: </tr>
12607: <tr>
1.180 rillig 12608: <td>QMAIL_QUEUE_USER</td>
1.191 bacon 12609: <td>QMAIL_REMOTE_USER</td>
1.156 leot 12610: </tr>
12611: <tr>
1.180 rillig 12612: <td>QMAIL_ROOT_USER</td>
1.191 bacon 12613: <td>QMAIL_SEND_USER</td>
1.156 leot 12614: </tr>
12615: <tr>
1.180 rillig 12616: <td>QPOPPER_FAC</td>
1.191 bacon 12617: <td>QPOPPER_SPOOL_DIR</td>
1.156 leot 12618: </tr>
12619: <tr>
1.180 rillig 12620: <td>QPOPPER_USER</td>
1.191 bacon 12621: <td>RAKE_NAME</td>
1.156 leot 12622: </tr>
12623: <tr>
1.180 rillig 12624: <td>RASMOL_DEPTH</td>
1.191 bacon 12625: <td>RCD_SCRIPTS</td>
1.177 leot 12626: </tr>
12627: <tr>
1.180 rillig 12628: <td>RCD_SCRIPTS_DIR</td>
1.191 bacon 12629: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.159 rillig 12630: </tr>
12631: <tr>
1.180 rillig 12632: <td>RCD_SCRIPTS_MODE</td>
1.191 bacon 12633: <td>RCD_SCRIPTS_SHELL</td>
1.156 leot 12634: </tr>
12635: <tr>
1.180 rillig 12636: <td>RCD_SCRIPT_SRC</td>
1.200 cirnatda 12637: <td>RDOC</td>
1.197 leot 12638: </tr>
12639: <tr>
12640: <td>READLINE_DEFAULT</td>
1.200 cirnatda 12641: <td>READLINE_TYPE</td>
1.156 leot 12642: </tr>
12643: <tr>
1.197 leot 12644: <td>REAL_ROOT_GROUP</td>
1.200 cirnatda 12645: <td>REAL_ROOT_USER</td>
1.161 leot 12646: </tr>
12647: <tr>
1.197 leot 12648: <td>RECURSIVE_MAKE</td>
1.200 cirnatda 12649: <td>RELAY_CTRL_DIR</td>
1.156 leot 12650: </tr>
12651: <tr>
1.197 leot 12652: <td>RELRO_SUPPORTED</td>
1.200 cirnatda 12653: <td>REPLACE_AWK</td>
1.156 leot 12654: </tr>
12655: <tr>
1.197 leot 12656: <td>REPLACE_BASH</td>
1.200 cirnatda 12657: <td>REPLACE_CSH</td>
1.156 leot 12658: </tr>
12659: <tr>
1.197 leot 12660: <td>REPLACE_KSH</td>
1.200 cirnatda 12661: <td>REPLACE_PERL</td>
1.156 leot 12662: </tr>
12663: <tr>
1.197 leot 12664: <td>REPLACE_PERL6</td>
1.200 cirnatda 12665: <td>REPLACE_PHP</td>
1.156 leot 12666: </tr>
12667: <tr>
1.197 leot 12668: <td>REPLACE_PYTHON</td>
1.200 cirnatda 12669: <td>REPLACE_RUBY</td>
1.156 leot 12670: </tr>
12671: <tr>
1.197 leot 12672: <td>REPLACE_RUBY_DIRS</td>
1.200 cirnatda 12673: <td>REPLACE_RUBY_PAT</td>
1.166 leot 12674: </tr>
12675: <tr>
1.197 leot 12676: <td>REPLACE_SH</td>
1.200 cirnatda 12677: <td>REPLACE_TEXLUA</td>
1.156 leot 12678: </tr>
12679: <tr>
1.197 leot 12680: <td>REQD_DIRS</td>
1.200 cirnatda 12681: <td>REQD_DIRS_PERMS</td>
1.156 leot 12682: </tr>
12683: <tr>
1.197 leot 12684: <td>REQD_FILES</td>
1.200 cirnatda 12685: <td>REQD_FILES_MODE</td>
1.156 leot 12686: </tr>
12687: <tr>
1.197 leot 12688: <td>REQD_FILES_PERMS</td>
1.200 cirnatda 12689: <td>RESOLV_AUTO_VARS</td>
1.156 leot 12690: </tr>
12691: <tr>
1.197 leot 12692: <td>RESOLV_LDFLAGS</td>
1.200 cirnatda 12693: <td>RESOLV_LIBS</td>
1.156 leot 12694: </tr>
12695: <tr>
1.197 leot 12696: <td>RM</td>
1.200 cirnatda 12697: <td>ROOT_CMD</td>
1.197 leot 12698: </tr>
12699: <tr>
12700: <td>ROOT_GROUP</td>
1.192 kim 12701: <td>ROOT_USER</td>
1.156 leot 12702: </tr>
12703: <tr>
1.200 cirnatda 12704: <td>RPCGEN</td>
1.192 kim 12705: <td>RPM</td>
1.156 leot 12706: </tr>
12707: <tr>
1.200 cirnatda 12708: <td>RPM2PKG_PLIST</td>
1.192 kim 12709: <td>RPM2PKG_PREFIX</td>
1.156 leot 12710: </tr>
12711: <tr>
1.200 cirnatda 12712: <td>RPM2PKG_STAGE</td>
1.192 kim 12713: <td>RPM2PKG_STRIP</td>
1.156 leot 12714: </tr>
12715: <tr>
1.200 cirnatda 12716: <td>RPM2PKG_SUBPREFIX</td>
1.192 kim 12717: <td>RPMFILES</td>
1.156 leot 12718: </tr>
12719: <tr>
1.200 cirnatda 12720: <td>RPMIGNOREPATH</td>
1.192 kim 12721: <td>RPM_DB_PREFIX</td>
1.156 leot 12722: </tr>
12723: <tr>
1.200 cirnatda 12724: <td>RSSH_CVS_PATH</td>
1.192 kim 12725: <td>RSSH_RDIST_PATH</td>
1.156 leot 12726: </tr>
12727: <tr>
1.200 cirnatda 12728: <td>RSSH_RSYNC_PATH</td>
1.192 kim 12729: <td>RSSH_SCP_PATH</td>
1.156 leot 12730: </tr>
12731: <tr>
1.200 cirnatda 12732: <td>RSSH_SFTP_SERVER_PATH</td>
1.192 kim 12733: <td>RUBY</td>
1.156 leot 12734: </tr>
12735: <tr>
1.200 cirnatda 12736: <td>RUBYGEM</td>
1.192 kim 12737: <td>RUBYGEM_NAME</td>
1.156 leot 12738: </tr>
12739: <tr>
1.200 cirnatda 12740: <td>RUBYGEM_OPTIONS</td>
1.198 leot 12741: <td>RUBYGEM_VERBOSE</td>
12742: </tr>
12743: <tr>
1.200 cirnatda 12744: <td>RUBY_ABI_VERSION</td>
1.197 leot 12745: <td>RUBY_ARCH</td>
1.156 leot 12746: </tr>
12747: <tr>
1.200 cirnatda 12748: <td>RUBY_ARCHINC</td>
1.197 leot 12749: <td>RUBY_ARCHLIB</td>
1.156 leot 12750: </tr>
12751: <tr>
1.200 cirnatda 12752: <td>RUBY_BASE</td>
1.197 leot 12753: <td>RUBY_BASERIDIR</td>
1.156 leot 12754: </tr>
12755: <tr>
1.200 cirnatda 12756: <td>RUBY_BUILD_DOCUMENT</td>
1.197 leot 12757: <td>RUBY_DLEXT</td>
1.156 leot 12758: </tr>
12759: <tr>
1.200 cirnatda 12760: <td>RUBY_DOC</td>
1.197 leot 12761: <td>RUBY_DYNAMIC_DIRS</td>
1.156 leot 12762: </tr>
12763: <tr>
1.200 cirnatda 12764: <td>RUBY_EG</td>
1.197 leot 12765: <td>RUBY_ENCODING_ARG</td>
1.156 leot 12766: </tr>
12767: <tr>
1.200 cirnatda 12768: <td>RUBY_EXTCONF</td>
1.197 leot 12769: <td>RUBY_EXTCONF_CHECK</td>
1.156 leot 12770: </tr>
12771: <tr>
1.200 cirnatda 12772: <td>RUBY_EXTCONF_DEBUG</td>
1.197 leot 12773: <td>RUBY_EXTCONF_MAKEFILE</td>
1.156 leot 12774: </tr>
12775: <tr>
1.200 cirnatda 12776: <td>RUBY_GEM_BASE</td>
1.197 leot 12777: <td>RUBY_INC</td>
1.156 leot 12778: </tr>
12779: <tr>
1.200 cirnatda 12780: <td>RUBY_LIB</td>
1.197 leot 12781: <td>RUBY_LIB_BASE</td>
1.156 leot 12782: </tr>
12783: <tr>
1.200 cirnatda 12784: <td>RUBY_NAME</td>
1.197 leot 12785: <td>RUBY_NOVERSION</td>
1.156 leot 12786: </tr>
12787: <tr>
1.200 cirnatda 12788: <td>RUBY_PKGPREFIX</td>
1.197 leot 12789: <td>RUBY_RAILS</td>
1.156 leot 12790: </tr>
12791: <tr>
1.200 cirnatda 12792: <td>RUBY_RAILS52_VERSION</td>
1.197 leot 12793: <td>RUBY_RAILS60_VERSION</td>
1.156 leot 12794: </tr>
12795: <tr>
1.200 cirnatda 12796: <td>RUBY_RAILS61_VERSION</td>
1.180 rillig 12797: <td>RUBY_RAILS_ACCEPTED</td>
1.174 leot 12798: </tr>
12799: <tr>
1.200 cirnatda 12800: <td>RUBY_RAILS_DEFAULT</td>
1.180 rillig 12801: <td>RUBY_RAILS_REQD</td>
1.156 leot 12802: </tr>
12803: <tr>
1.200 cirnatda 12804: <td>RUBY_RAILS_STRICT_DEP</td>
1.180 rillig 12805: <td>RUBY_RIDIR</td>
1.156 leot 12806: </tr>
12807: <tr>
1.200 cirnatda 12808: <td>RUBY_SETUP</td>
1.180 rillig 12809: <td>RUBY_SHLIB</td>
1.156 leot 12810: </tr>
12811: <tr>
1.200 cirnatda 12812: <td>RUBY_SHLIBALIAS</td>
1.180 rillig 12813: <td>RUBY_SHLIBVER</td>
1.156 leot 12814: </tr>
12815: <tr>
1.200 cirnatda 12816: <td>RUBY_SIMPLE_INSTALL</td>
1.180 rillig 12817: <td>RUBY_SITEARCHLIB</td>
1.156 leot 12818: </tr>
12819: <tr>
1.200 cirnatda 12820: <td>RUBY_SITELIB</td>
1.180 rillig 12821: <td>RUBY_SITELIB_BASE</td>
1.156 leot 12822: </tr>
12823: <tr>
1.200 cirnatda 12824: <td>RUBY_SITERIDIR</td>
1.180 rillig 12825: <td>RUBY_SLEXT</td>
1.156 leot 12826: </tr>
12827: <tr>
1.200 cirnatda 12828: <td>RUBY_SRCDIR</td>
1.180 rillig 12829: <td>RUBY_STATICLIB</td>
1.156 leot 12830: </tr>
12831: <tr>
1.200 cirnatda 12832: <td>RUBY_SUFFIX</td>
1.180 rillig 12833: <td>RUBY_SYSRIDIR</td>
1.156 leot 12834: </tr>
12835: <tr>
1.200 cirnatda 12836: <td>RUBY_USE_PTHREAD</td>
1.180 rillig 12837: <td>RUBY_VENDORARCHLIB</td>
1.156 leot 12838: </tr>
12839: <tr>
1.200 cirnatda 12840: <td>RUBY_VENDORLIB</td>
1.180 rillig 12841: <td>RUBY_VENDORLIB_BASE</td>
1.156 leot 12842: </tr>
12843: <tr>
1.200 cirnatda 12844: <td>RUBY_VER</td>
1.180 rillig 12845: <td>RUBY_VERSION</td>
1.156 leot 12846: </tr>
12847: <tr>
1.200 cirnatda 12848: <td>RUBY_VERSIONS_ACCEPTED</td>
1.180 rillig 12849: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.156 leot 12850: </tr>
12851: <tr>
1.200 cirnatda 12852: <td>RUBY_VERSION_DEFAULT</td>
1.180 rillig 12853: <td>RUBY_VERSION_REQD</td>
1.156 leot 12854: </tr>
12855: <tr>
1.200 cirnatda 12856: <td>RUBY_VER_DIR</td>
1.180 rillig 12857: <td>RUN</td>
1.156 leot 12858: </tr>
12859: <tr>
1.200 cirnatda 12860: <td>RUN_LDCONFIG</td>
1.180 rillig 12861: <td>SAWFISH_THEMES</td>
1.156 leot 12862: </tr>
12863: <tr>
1.200 cirnatda 12864: <td>SCO</td>
1.180 rillig 12865: <td>SCREWS_GROUP</td>
1.156 leot 12866: </tr>
12867: <tr>
1.200 cirnatda 12868: <td>SCREWS_USER</td>
1.180 rillig 12869: <td>SCRIPTS_ENV</td>
1.156 leot 12870: </tr>
12871: <tr>
1.200 cirnatda 12872: <td>SCROLLKEEPER_DATADIR</td>
1.180 rillig 12873: <td>SCROLLKEEPER_REBUILDDB</td>
1.156 leot 12874: </tr>
12875: <tr>
1.200 cirnatda 12876: <td>SCROLLKEEPER_UPDATEDB</td>
1.180 rillig 12877: <td>SDIST_PAWD</td>
1.156 leot 12878: </tr>
12879: <tr>
1.200 cirnatda 12880: <td>SERIAL_DEVICES</td>
1.180 rillig 12881: <td>SETGIDGAME</td>
1.156 leot 12882: </tr>
12883: <tr>
1.200 cirnatda 12884: <td>SETGID_GAMES_PERMS</td>
1.180 rillig 12885: <td>SETUID_ROOT_PERMS</td>
1.156 leot 12886: </tr>
12887: <tr>
1.200 cirnatda 12888: <td>SH</td>
1.180 rillig 12889: <td>SHLIB</td>
1.177 leot 12890: </tr>
12891: <tr>
1.180 rillig 12892: <td>SIGN_PACKAGES</td>
1.194 leot 12893: <td>SILC_CLIENT_WITH_PERL</td>
1.156 leot 12894: </tr>
12895: <tr>
1.180 rillig 12896: <td>SITE_SPECIFIC_PKGS</td>
1.194 leot 12897: <td>SKIP_DEPENDS</td>
1.156 leot 12898: </tr>
12899: <tr>
1.180 rillig 12900: <td>SMF_INSTANCES</td>
1.194 leot 12901: <td>SMF_MANIFEST</td>
1.159 rillig 12902: </tr>
12903: <tr>
1.180 rillig 12904: <td>SMF_METHODS</td>
1.194 leot 12905: <td>SMF_METHOD_SHELL</td>
1.156 leot 12906: </tr>
12907: <tr>
1.180 rillig 12908: <td>SMF_METHOD_SRC</td>
1.194 leot 12909: <td>SMF_NAME</td>
1.156 leot 12910: </tr>
12911: <tr>
1.180 rillig 12912: <td>SMF_PREFIX</td>
1.194 leot 12913: <td>SMF_SRCDIR</td>
1.156 leot 12914: </tr>
12915: <tr>
1.180 rillig 12916: <td>SNIPROXY_GROUP</td>
1.194 leot 12917: <td>SNIPROXY_USER</td>
1.156 leot 12918: </tr>
12919: <tr>
1.180 rillig 12920: <td>SOURCE_BUFFSIZE</td>
1.194 leot 12921: <td>SPECIAL_PERMS</td>
1.156 leot 12922: </tr>
12923: <tr>
1.180 rillig 12924: <td>SPECIFIC_PKGS</td>
1.194 leot 12925: <td>SSH_SUID</td>
1.156 leot 12926: </tr>
12927: <tr>
1.180 rillig 12928: <td>SSP_SUPPORTED</td>
1.194 leot 12929: <td>SSYNC_PAWD</td>
1.156 leot 12930: </tr>
12931: <tr>
1.180 rillig 12932: <td>STEP_MSG</td>
1.194 leot 12933: <td>STRIP</td>
1.156 leot 12934: </tr>
12935: <tr>
1.180 rillig 12936: <td>STRIP_DBG</td>
1.194 leot 12937: <td>STRIP_DEBUG</td>
1.156 leot 12938: </tr>
12939: <tr>
1.180 rillig 12940: <td>STRIP_DEBUG_SUPPORTED</td>
1.194 leot 12941: <td>STRIP_FILES_SKIP</td>
1.156 leot 12942: </tr>
12943: <tr>
1.180 rillig 12944: <td>SU</td>
1.194 leot 12945: <td>SUBDIR</td>
1.156 leot 12946: </tr>
12947: <tr>
1.180 rillig 12948: <td>SUBST</td>
1.194 leot 12949: <td>SUBST_CLASSES</td>
1.174 leot 12950: </tr>
12951: <tr>
1.180 rillig 12952: <td>SUBST_FILES</td>
1.194 leot 12953: <td>SUBST_FILTER_CMD</td>
1.156 leot 12954: </tr>
12955: <tr>
1.180 rillig 12956: <td>SUBST_MESSAGE</td>
1.194 leot 12957: <td>SUBST_NOOP_OK</td>
1.156 leot 12958: </tr>
12959: <tr>
1.180 rillig 12960: <td>SUBST_SED</td>
1.194 leot 12961: <td>SUBST_SHOW_DIFF</td>
1.156 leot 12962: </tr>
12963: <tr>
1.180 rillig 12964: <td>SUBST_SKIP_TEXT_CHECK</td>
1.194 leot 12965: <td>SUBST_STAGE</td>
1.156 leot 12966: </tr>
12967: <tr>
1.180 rillig 12968: <td>SUBST_VARS</td>
1.194 leot 12969: <td>SUNWSPROBASE</td>
1.156 leot 12970: </tr>
12971: <tr>
1.180 rillig 12972: <td>SUSE_PREFER</td>
1.194 leot 12973: <td>SU_CMD</td>
1.177 leot 12974: </tr>
12975: <tr>
1.201 cirnatda 12976: <td>SYSCONFBASE</td>
1.189 bacon 12977: <td>TBL</td>
12978: </tr>
12979: <tr>
1.201 cirnatda 12980: <td>TERMCAP_TYPE</td>
1.189 bacon 12981: <td>TERMINFO_DEFAULT</td>
1.161 leot 12982: </tr>
12983: <tr>
1.201 cirnatda 12984: <td>TERMINFO_TYPE</td>
1.189 bacon 12985: <td>TEST</td>
1.159 rillig 12986: </tr>
12987: <tr>
1.201 cirnatda 12988: <td>TEST_DEPENDS</td>
1.189 bacon 12989: <td>TEST_DIRS</td>
1.156 leot 12990: </tr>
12991: <tr>
1.201 cirnatda 12992: <td>TEST_ENV</td>
1.189 bacon 12993: <td>TEST_ENV_SHELL</td>
1.156 leot 12994: </tr>
12995: <tr>
1.201 cirnatda 12996: <td>TEST_MAKE_CMD</td>
1.189 bacon 12997: <td>TEST_MAKE_FLAGS</td>
1.156 leot 12998: </tr>
12999: <tr>
1.201 cirnatda 13000: <td>TEST_TARGET</td>
1.189 bacon 13001: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.156 leot 13002: </tr>
13003: <tr>
1.201 cirnatda 13004: <td>TEXLIVE_REV</td>
1.189 bacon 13005: <td>TEXLIVE_UNVERSIONED</td>
1.156 leot 13006: </tr>
13007: <tr>
1.201 cirnatda 13008: <td>TEXMFSITE</td>
1.189 bacon 13009: <td>TEX_FORMATS</td>
1.156 leot 13010: </tr>
13011: <tr>
1.201 cirnatda 13012: <td>TEX_HYPHEN_DAT</td>
1.189 bacon 13013: <td>TEX_HYPHEN_DEF</td>
1.156 leot 13014: </tr>
13015: <tr>
1.201 cirnatda 13016: <td>TEX_TEXMF_DIRS</td>
1.189 bacon 13017: <td>THTTPD_LOG_FACILITY</td>
1.156 leot 13018: </tr>
13019: <tr>
1.201 cirnatda 13020: <td>TINYDYN_USER</td>
1.195 gutterid 13021: <td>TO</td>
1.156 leot 13022: </tr>
13023: <tr>
1.201 cirnatda 13024: <td>TOOLS_ALIASES</td>
1.195 gutterid 13025: <td>TOOLS_ALWAYS_WRAP</td>
1.156 leot 13026: </tr>
13027: <tr>
1.201 cirnatda 13028: <td>TOOLS_ARGS</td>
1.195 gutterid 13029: <td>TOOLS_BROKEN</td>
1.156 leot 13030: </tr>
13031: <tr>
1.201 cirnatda 13032: <td>TOOLS_CMD</td>
1.195 gutterid 13033: <td>TOOLS_CMDLINE_SED</td>
1.156 leot 13034: </tr>
13035: <tr>
1.201 cirnatda 13036: <td>TOOLS_CREATE</td>
1.195 gutterid 13037: <td>TOOLS_DIR</td>
1.156 leot 13038: </tr>
13039: <tr>
1.201 cirnatda 13040: <td>TOOLS_FAIL</td>
1.195 gutterid 13041: <td>TOOLS_GNU_MISSING</td>
1.156 leot 13042: </tr>
13043: <tr>
1.201 cirnatda 13044: <td>TOOLS_LDCONFIG</td>
1.195 gutterid 13045: <td>TOOLS_NOOP</td>
1.156 leot 13046: </tr>
13047: <tr>
1.201 cirnatda 13048: <td>TOOLS_PATH</td>
1.195 gutterid 13049: <td>TOOLS_SCRIPT</td>
1.161 leot 13050: </tr>
13051: <tr>
1.201 cirnatda 13052: <td>TOOL_DEPENDS</td>
1.180 rillig 13053: <td>TTF_FONTS_DIR</td>
1.197 leot 13054: </tr>
13055: <tr>
1.201 cirnatda 13056: <td>TYPE</td>
1.197 leot 13057: <td>UAC_REQD_EXECS</td>
1.156 leot 13058: </tr>
13059: <tr>
1.201 cirnatda 13060: <td>UCSPI_SSL_GROUP</td>
1.197 leot 13061: <td>UCSPI_SSL_USER</td>
1.156 leot 13062: </tr>
13063: <tr>
1.201 cirnatda 13064: <td>UNLIMIT_RESOURCES</td>
1.197 leot 13065: <td>UNPRIVILEGED</td>
1.156 leot 13066: </tr>
13067: <tr>
1.201 cirnatda 13068: <td>UNPRIVILEGED_GROUP</td>
1.197 leot 13069: <td>UNPRIVILEGED_GROUPS</td>
1.156 leot 13070: </tr>
13071: <tr>
1.201 cirnatda 13072: <td>UNPRIVILEGED_USER</td>
1.197 leot 13073: <td>UNWRAP_FILES</td>
1.156 leot 13074: </tr>
13075: <tr>
1.201 cirnatda 13076: <td>UNWRAP_PATTERNS</td>
1.197 leot 13077: <td>UPDATE_GEMSPEC</td>
1.156 leot 13078: </tr>
13079: <tr>
1.201 cirnatda 13080: <td>UPDATE_TARGET</td>
1.197 leot 13081: <td>URI</td>
1.156 leot 13082: </tr>
13083: <tr>
1.201 cirnatda 13084: <td>USERGROUP_PHASE</td>
1.197 leot 13085: <td>USERPPP_GROUP</td>
1.156 leot 13086: </tr>
13087: <tr>
1.201 cirnatda 13088: <td>USER_SPECIFIC_PKGS</td>
1.197 leot 13089: <td>USE_ABI_DEPENDS</td>
1.156 leot 13090: </tr>
13091: <tr>
1.201 cirnatda 13092: <td>USE_APR</td>
1.197 leot 13093: <td>USE_BSD_MAKEFILE</td>
1.156 leot 13094: </tr>
13095: <tr>
1.201 cirnatda 13096: <td>USE_BUILTIN</td>
1.197 leot 13097: <td>USE_CROSS_COMPILE</td>
1.156 leot 13098: </tr>
13099: <tr>
1.201 cirnatda 13100: <td>USE_CURSES</td>
1.197 leot 13101: <td>USE_CWRAPPERS</td>
1.156 leot 13102: </tr>
13103: <tr>
1.201 cirnatda 13104: <td>USE_DB185</td>
1.197 leot 13105: <td>USE_FEATURES</td>
1.156 leot 13106: </tr>
13107: <tr>
1.201 cirnatda 13108: <td>USE_GAMESGROUP</td>
1.197 leot 13109: <td>USE_GCC_RUNTIME</td>
1.156 leot 13110: </tr>
13111: <tr>
1.201 cirnatda 13112: <td>USE_IMAKE</td>
1.197 leot 13113: <td>USE_JAVA</td>
1.156 leot 13114: </tr>
13115: <tr>
1.201 cirnatda 13116: <td>USE_JAVA2</td>
1.197 leot 13117: <td>USE_LANGUAGES</td>
1.156 leot 13118: </tr>
13119: <tr>
1.201 cirnatda 13120: <td>USE_LIBTOOL</td>
1.197 leot 13121: <td>USE_NATIVE_GCC</td>
1.156 leot 13122: </tr>
13123: <tr>
1.201 cirnatda 13124: <td>USE_NETBSD_REPO</td>
1.197 leot 13125: <td>USE_PKGSRC_GCC</td>
1.156 leot 13126: </tr>
13127: <tr>
1.201 cirnatda 13128: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.197 leot 13129: <td>USE_PKGTASKS</td>
1.156 leot 13130: </tr>
13131: <tr>
1.201 cirnatda 13132: <td>USE_PKG_ADMIN_DIGEST</td>
1.197 leot 13133: <td>USE_RUBY_EXTCONF</td>
1.156 leot 13134: </tr>
13135: <tr>
1.201 cirnatda 13136: <td>USE_RUBY_INSTALL</td>
1.197 leot 13137: <td>USE_RUBY_SETUP</td>
1.156 leot 13138: </tr>
13139: <tr>
1.201 cirnatda 13140: <td>USE_RUBY_SETUP_PKG</td>
1.197 leot 13141: <td>USE_TOOLS</td>
1.156 leot 13142: </tr>
13143: <tr>
1.201 cirnatda 13144: <td>UUCP_GROUP</td>
1.197 leot 13145: <td>UUCP_USER</td>
1.156 leot 13146: </tr>
13147: <tr>
1.201 cirnatda 13148: <td>VARBASE</td>
1.197 leot 13149: <td>VARNAME</td>
1.156 leot 13150: </tr>
13151: <tr>
1.201 cirnatda 13152: <td>VIM_EXTRA_OPTS</td>
1.197 leot 13153: <td>WARNING_MSG</td>
1.156 leot 13154: </tr>
13155: <tr>
1.201 cirnatda 13156: <td>WCALC_CGIDIR</td>
1.197 leot 13157: <td>WCALC_CGIPATH</td>
1.156 leot 13158: </tr>
13159: <tr>
1.201 cirnatda 13160: <td>WCALC_HTMLDIR</td>
1.197 leot 13161: <td>WCALC_HTMLPATH</td>
1.156 leot 13162: </tr>
13163: <tr>
1.201 cirnatda 13164: <td>WDM_MANAGERS</td>
1.197 leot 13165: <td>WRAPPER_CC</td>
1.156 leot 13166: </tr>
13167: <tr>
1.201 cirnatda 13168: <td>WRAPPER_REORDER_CMDS</td>
1.197 leot 13169: <td>WRKDIR</td>
1.189 bacon 13170: </tr>
13171: <tr>
1.201 cirnatda 13172: <td>WRKDIR_BASENAME</td>
1.197 leot 13173: <td>WRKDIR_LOCKTYPE</td>
1.156 leot 13174: </tr>
13175: <tr>
1.201 cirnatda 13176: <td>WRKLOG</td>
1.197 leot 13177: <td>WRKOBJDIR</td>
1.156 leot 13178: </tr>
13179: <tr>
1.201 cirnatda 13180: <td>WRKSRC</td>
1.197 leot 13181: <td>X10_PORT</td>
1.156 leot 13182: </tr>
13183: <tr>
1.201 cirnatda 13184: <td>X11</td>
1.197 leot 13185: <td>X11BASE</td>
1.156 leot 13186: </tr>
13187: <tr>
1.201 cirnatda 13188: <td>X11_PKGSRCDIR</td>
1.197 leot 13189: <td>X11_TYPE</td>
1.156 leot 13190: </tr>
13191: <tr>
1.201 cirnatda 13192: <td>X509_CERTIFICATE</td>
1.197 leot 13193: <td>X509_KEY</td>
1.156 leot 13194: </tr>
13195: <tr>
1.201 cirnatda 13196: <td>XAW_TYPE</td>
1.197 leot 13197: <td>XLOCK_DEFAULT_MODE</td>
1.156 leot 13198: </tr>
13199: <tr>
1.201 cirnatda 13200: <td>XMKMF</td>
1.197 leot 13201: <td>XMKMF_FLAGS</td>
1.159 rillig 13202: </tr>
13203: <tr>
1.201 cirnatda 13204: <td>XXX</td>
1.195 gutterid 13205: <td>YES</td>
1.156 leot 13206: </tr>
13207: <tr>
1.201 cirnatda 13208: <td>ZSH_STATIC</td>
1.195 gutterid 13209: <td>__stdc__</td>
1.201 cirnatda 13210: </tr>
13211: <tr>
1.180 rillig 13212: <td>_vargroups</td>
1.201 cirnatda 13213: <td>accept</td>
1.174 leot 13214: </tr>
13215: <tr>
1.180 rillig 13216: <td>acquire-localbase-lock</td>
1.201 cirnatda 13217: <td>acquire-lock</td>
1.156 leot 13218: </tr>
13219: <tr>
1.180 rillig 13220: <td>add</td>
1.201 cirnatda 13221: <td>administrator</td>
1.156 leot 13222: </tr>
13223: <tr>
1.180 rillig 13224: <td>alloca</td>
1.201 cirnatda 13225: <td>alternatives</td>
1.174 leot 13226: </tr>
13227: <tr>
1.180 rillig 13228: <td>aslr</td>
1.201 cirnatda 13229: <td>asprintf</td>
1.156 leot 13230: </tr>
13231: <tr>
1.180 rillig 13232: <td>atlas</td>
1.201 cirnatda 13233: <td>autoconf</td>
1.161 leot 13234: </tr>
13235: <tr>
1.180 rillig 13236: <td>automake</td>
1.201 cirnatda 13237: <td>autoreconf</td>
1.156 leot 13238: </tr>
13239: <tr>
1.180 rillig 13240: <td>awk</td>
1.201 cirnatda 13241: <td>bash</td>
1.156 leot 13242: </tr>
13243: <tr>
1.180 rillig 13244: <td>big-endian</td>
1.201 cirnatda 13245: <td>bin-install</td>
1.156 leot 13246: </tr>
13247: <tr>
1.180 rillig 13248: <td>bind</td>
1.201 cirnatda 13249: <td>binpkg-list</td>
1.177 leot 13250: </tr>
13251: <tr>
1.180 rillig 13252: <td>blas</td>
1.201 cirnatda 13253: <td>bootstrap-depends</td>
1.159 rillig 13254: </tr>
13255: <tr>
1.180 rillig 13256: <td>broken</td>
1.201 cirnatda 13257: <td>broken_on_platform</td>
1.156 leot 13258: </tr>
13259: <tr>
1.180 rillig 13260: <td>bsd</td>
1.201 cirnatda 13261: <td>bsd.prog.mk</td>
1.174 leot 13262: </tr>
13263: <tr>
1.180 rillig 13264: <td>build</td>
1.201 cirnatda 13265: <td>build-env</td>
1.156 leot 13266: </tr>
13267: <tr>
1.180 rillig 13268: <td>buildlink-directories</td>
1.201 cirnatda 13269: <td>buildlink-oss-soundcard-h</td>
1.156 leot 13270: </tr>
13271: <tr>
1.180 rillig 13272: <td>c</td>
1.201 cirnatda 13273: <td>c++</td>
1.156 leot 13274: </tr>
13275: <tr>
1.180 rillig 13276: <td>ccache</td>
1.201 cirnatda 13277: <td>cce</td>
1.156 leot 13278: </tr>
13279: <tr>
1.180 rillig 13280: <td>cdefs</td>
1.201 cirnatda 13281: <td>ceil</td>
1.174 leot 13282: </tr>
13283: <tr>
1.180 rillig 13284: <td>changes</td>
1.201 cirnatda 13285: <td>changes-entry</td>
1.156 leot 13286: </tr>
13287: <tr>
1.180 rillig 13288: <td>changes-entry-noupdate</td>
1.201 cirnatda 13289: <td>check</td>
1.156 leot 13290: </tr>
13291: <tr>
1.180 rillig 13292: <td>check-clean</td>
1.201 cirnatda 13293: <td>check-files</td>
1.156 leot 13294: </tr>
13295: <tr>
1.180 rillig 13296: <td>check-files-clean</td>
1.201 cirnatda 13297: <td>check-vulnerable</td>
1.156 leot 13298: </tr>
13299: <tr>
1.180 rillig 13300: <td>checksum</td>
1.201 cirnatda 13301: <td>checksum-phase</td>
1.156 leot 13302: </tr>
13303: <tr>
1.180 rillig 13304: <td>clean</td>
1.201 cirnatda 13305: <td>clean-depends</td>
1.156 leot 13306: </tr>
13307: <tr>
1.180 rillig 13308: <td>cleandir</td>
1.201 cirnatda 13309: <td>commit</td>
1.156 leot 13310: </tr>
13311: <tr>
1.180 rillig 13312: <td>commit-changes-entry</td>
1.201 cirnatda 13313: <td>compact</td>
1.156 leot 13314: </tr>
13315: <tr>
1.180 rillig 13316: <td>compiler</td>
1.201 cirnatda 13317: <td>conf</td>
1.156 leot 13318: </tr>
13319: <tr>
1.180 rillig 13320: <td>config.guess</td>
1.201 cirnatda 13321: <td>config.sub</td>
1.156 leot 13322: </tr>
13323: <tr>
1.180 rillig 13324: <td>configuration</td>
1.201 cirnatda 13325: <td>configure</td>
1.156 leot 13326: </tr>
13327: <tr>
1.180 rillig 13328: <td>configure-env</td>
1.201 cirnatda 13329: <td>configure-help</td>
1.156 leot 13330: </tr>
13331: <tr>
1.180 rillig 13332: <td>configure_args</td>
1.201 cirnatda 13333: <td>connect</td>
1.156 leot 13334: </tr>
13335: <tr>
1.180 rillig 13336: <td>cos</td>
1.201 cirnatda 13337: <td>cputime</td>
1.174 leot 13338: </tr>
13339: <tr>
1.180 rillig 13340: <td>create-usergroup</td>
1.201 cirnatda 13341: <td>csh</td>
1.156 leot 13342: </tr>
13343: <tr>
1.180 rillig 13344: <td>ctf</td>
1.201 cirnatda 13345: <td>debug</td>
1.161 leot 13346: </tr>
13347: <tr>
1.200 cirnatda 13348: <td>declaration</td>
1.201 cirnatda 13349: <td>declare</td>
1.197 leot 13350: </tr>
13351: <tr>
1.200 cirnatda 13352: <td>defined</td>
1.201 cirnatda 13353: <td>depend</td>
1.156 leot 13354: </tr>
13355: <tr>
1.200 cirnatda 13356: <td>dependencies</td>
1.201 cirnatda 13357: <td>depends</td>
1.156 leot 13358: </tr>
13359: <tr>
1.200 cirnatda 13360: <td>depends-checksum</td>
1.201 cirnatda 13361: <td>depends-fetch</td>
1.156 leot 13362: </tr>
13363: <tr>
1.200 cirnatda 13364: <td>deps</td>
1.201 cirnatda 13365: <td>describe</td>
1.156 leot 13366: </tr>
13367: <tr>
1.200 cirnatda 13368: <td>destdir</td>
1.201 cirnatda 13369: <td>disable</td>
1.156 leot 13370: </tr>
13371: <tr>
1.200 cirnatda 13372: <td>distclean</td>
1.201 cirnatda 13373: <td>distinfo</td>
1.156 leot 13374: </tr>
13375: <tr>
1.200 cirnatda 13376: <td>dl</td>
1.201 cirnatda 13377: <td>dlopen</td>
1.162 rillig 13378: </tr>
13379: <tr>
1.200 cirnatda 13380: <td>do-build</td>
1.201 cirnatda 13381: <td>do-buildlink</td>
1.156 leot 13382: </tr>
13383: <tr>
1.200 cirnatda 13384: <td>do-clean</td>
1.201 cirnatda 13385: <td>do-configure</td>
1.156 leot 13386: </tr>
13387: <tr>
1.200 cirnatda 13388: <td>do-configure-post-hook</td>
1.201 cirnatda 13389: <td>do-extract</td>
1.156 leot 13390: </tr>
13391: <tr>
1.195 gutterid 13392: <td>do-fetch</td>
1.201 cirnatda 13393: <td>emul</td>
1.174 leot 13394: </tr>
13395: <tr>
1.180 rillig 13396: <td>emul-distinfo</td>
1.201 cirnatda 13397: <td>emul-fetch</td>
1.156 leot 13398: </tr>
13399: <tr>
1.180 rillig 13400: <td>emulation</td>
1.201 cirnatda 13401: <td>emulator</td>
1.159 rillig 13402: </tr>
13403: <tr>
1.180 rillig 13404: <td>enable</td>
1.201 cirnatda 13405: <td>endian</td>
1.156 leot 13406: </tr>
13407: <tr>
1.200 cirnatda 13408: <td>enomem</td>
1.201 cirnatda 13409: <td>err</td>
1.197 leot 13410: </tr>
13411: <tr>
1.200 cirnatda 13412: <td>errx</td>
1.201 cirnatda 13413: <td>etc</td>
1.156 leot 13414: </tr>
13415: <tr>
1.200 cirnatda 13416: <td>exp</td>
1.201 cirnatda 13417: <td>extract-rpm</td>
1.156 leot 13418: </tr>
13419: <tr>
1.200 cirnatda 13420: <td>fabs</td>
1.201 cirnatda 13421: <td>feature</td>
1.174 leot 13422: </tr>
13423: <tr>
1.200 cirnatda 13424: <td>features</td>
1.201 cirnatda 13425: <td>fetch</td>
1.156 leot 13426: </tr>
13427: <tr>
1.200 cirnatda 13428: <td>fetch-list</td>
1.201 cirnatda 13429: <td>follows</td>
1.156 leot 13430: </tr>
13431: <tr>
1.200 cirnatda 13432: <td>forbids</td>
1.201 cirnatda 13433: <td>form</td>
1.156 leot 13434: </tr>
13435: <tr>
1.200 cirnatda 13436: <td>format</td>
1.201 cirnatda 13437: <td>fortify</td>
1.156 leot 13438: </tr>
13439: <tr>
1.195 gutterid 13440: <td>fortify_source</td>
1.201 cirnatda 13441: <td>friend</td>
1.156 leot 13442: </tr>
13443: <tr>
1.180 rillig 13444: <td>fts</td>
1.201 cirnatda 13445: <td>fts_close</td>
1.156 leot 13446: </tr>
13447: <tr>
1.180 rillig 13448: <td>fts_open</td>
1.201 cirnatda 13449: <td>fts_read</td>
1.156 leot 13450: </tr>
13451: <tr>
1.180 rillig 13452: <td>fts_set</td>
1.201 cirnatda 13453: <td>gcc</td>
1.174 leot 13454: </tr>
13455: <tr>
1.180 rillig 13456: <td>gethostbyaddr</td>
1.201 cirnatda 13457: <td>gethostbyname</td>
1.156 leot 13458: </tr>
13459: <tr>
1.180 rillig 13460: <td>gethostbyname2</td>
1.201 cirnatda 13461: <td>getopt_long</td>
1.156 leot 13462: </tr>
13463: <tr>
1.180 rillig 13464: <td>getprogname</td>
1.201 cirnatda 13465: <td>getservbyname</td>
1.174 leot 13466: </tr>
13467: <tr>
1.180 rillig 13468: <td>getservbyport</td>
1.201 cirnatda 13469: <td>getservent</td>
1.174 leot 13470: </tr>
13471: <tr>
1.180 rillig 13472: <td>gettext</td>
1.201 cirnatda 13473: <td>github</td>
1.156 leot 13474: </tr>
13475: <tr>
1.180 rillig 13476: <td>glob</td>
1.201 cirnatda 13477: <td>gnu</td>
1.159 rillig 13478: </tr>
13479: <tr>
1.180 rillig 13480: <td>gnu_configure_strict</td>
1.201 cirnatda 13481: <td>go</td>
1.156 leot 13482: </tr>
13483: <tr>
1.180 rillig 13484: <td>go-deps</td>
1.201 cirnatda 13485: <td>golang</td>
1.156 leot 13486: </tr>
13487: <tr>
1.180 rillig 13488: <td>guess-license</td>
1.201 cirnatda 13489: <td>hashbang</td>
1.156 leot 13490: </tr>
13491: <tr>
1.180 rillig 13492: <td>heimdal</td>
1.201 cirnatda 13493: <td>help</td>
1.156 leot 13494: </tr>
13495: <tr>
1.200 cirnatda 13496: <td>imake</td>
1.201 cirnatda 13497: <td>increment</td>
1.197 leot 13498: </tr>
13499: <tr>
1.200 cirnatda 13500: <td>inet_aton</td>
1.201 cirnatda 13501: <td>interp</td>
1.161 leot 13502: </tr>
13503: <tr>
1.200 cirnatda 13504: <td>interpreter</td>
1.201 cirnatda 13505: <td>intl</td>
1.156 leot 13506: </tr>
13507: <tr>
1.200 cirnatda 13508: <td>ip4</td>
1.201 cirnatda 13509: <td>ip6</td>
1.156 leot 13510: </tr>
13511: <tr>
1.200 cirnatda 13512: <td>ipv4</td>
1.201 cirnatda 13513: <td>ipv6</td>
1.156 leot 13514: </tr>
13515: <tr>
1.200 cirnatda 13516: <td>iso</td>
1.201 cirnatda 13517: <td>kerberos</td>
1.189 bacon 13518: </tr>
13519: <tr>
1.200 cirnatda 13520: <td>krb</td>
1.201 cirnatda 13521: <td>krb5</td>
1.189 bacon 13522: </tr>
13523: <tr>
1.200 cirnatda 13524: <td>ksh</td>
1.201 cirnatda 13525: <td>lapack</td>
1.156 leot 13526: </tr>
13527: <tr>
1.200 cirnatda 13528: <td>latex</td>
1.201 cirnatda 13529: <td>libintl_bindtextdomain</td>
1.177 leot 13530: </tr>
13531: <tr>
1.200 cirnatda 13532: <td>libintl_gettext</td>
1.201 cirnatda 13533: <td>libintl_textdomain</td>
1.156 leot 13534: </tr>
13535: <tr>
1.200 cirnatda 13536: <td>libnbcompat</td>
1.201 cirnatda 13537: <td>libs</td>
1.174 leot 13538: </tr>
13539: <tr>
1.200 cirnatda 13540: <td>libtool</td>
1.201 cirnatda 13541: <td>licence</td>
1.159 rillig 13542: </tr>
13543: <tr>
1.200 cirnatda 13544: <td>license</td>
1.201 cirnatda 13545: <td>lintl</td>
1.156 leot 13546: </tr>
13547: <tr>
1.200 cirnatda 13548: <td>little-endian</td>
1.201 cirnatda 13549: <td>lock</td>
1.156 leot 13550: </tr>
13551: <tr>
1.200 cirnatda 13552: <td>locking</td>
1.201 cirnatda 13553: <td>lvalue</td>
1.156 leot 13554: </tr>
13555: <tr>
1.200 cirnatda 13556: <td>make</td>
1.201 cirnatda 13557: <td>makesum</td>
1.156 leot 13558: </tr>
13559: <tr>
1.195 gutterid 13560: <td>memory</td>
1.201 cirnatda 13561: <td>meta</td>
1.156 leot 13562: </tr>
13563: <tr>
1.180 rillig 13564: <td>meta-package</td>
1.201 cirnatda 13565: <td>meta_package</td>
1.156 leot 13566: </tr>
13567: <tr>
1.180 rillig 13568: <td>mit-krb5</td>
1.201 cirnatda 13569: <td>mk.conf</td>
1.177 leot 13570: </tr>
13571: <tr>
1.180 rillig 13572: <td>mkl</td>
1.201 cirnatda 13573: <td>mount</td>
1.159 rillig 13574: </tr>
13575: <tr>
1.180 rillig 13576: <td>mprotect</td>
1.201 cirnatda 13577: <td>mremap</td>
1.156 leot 13578: </tr>
13579: <tr>
1.180 rillig 13580: <td>nb</td>
1.201 cirnatda 13581: <td>nbcompat</td>
1.156 leot 13582: </tr>
13583: <tr>
1.180 rillig 13584: <td>obstack</td>
1.201 cirnatda 13585: <td>obstack_ptr_grow</td>
1.156 leot 13586: </tr>
13587: <tr>
1.180 rillig 13588: <td>occurs</td>
1.201 cirnatda 13589: <td>only</td>
1.161 leot 13590: </tr>
13591: <tr>
1.180 rillig 13592: <td>openblas</td>
1.201 cirnatda 13593: <td>options</td>
1.156 leot 13594: </tr>
13595: <tr>
1.180 rillig 13596: <td>options.mk</td>
1.201 cirnatda 13597: <td>order</td>
1.156 leot 13598: </tr>
13599: <tr>
1.180 rillig 13600: <td>override</td>
1.201 cirnatda 13601: <td>override-intltool</td>
1.156 leot 13602: </tr>
13603: <tr>
1.180 rillig 13604: <td>override-message-intltool</td>
1.201 cirnatda 13605: <td>package</td>
1.156 leot 13606: </tr>
13607: <tr>
1.180 rillig 13608: <td>parallel</td>
1.201 cirnatda 13609: <td>path</td>
1.156 leot 13610: </tr>
13611: <tr>
1.180 rillig 13612: <td>pax</td>
1.201 cirnatda 13613: <td>paxctl</td>
1.156 leot 13614: </tr>
13615: <tr>
1.180 rillig 13616: <td>pbulk-index</td>
1.201 cirnatda 13617: <td>pc</td>
1.156 leot 13618: </tr>
13619: <tr>
1.180 rillig 13620: <td>perl</td>
1.201 cirnatda 13621: <td>perl5</td>
1.156 leot 13622: </tr>
13623: <tr>
1.180 rillig 13624: <td>perms</td>
1.201 cirnatda 13625: <td>php</td>
1.156 leot 13626: </tr>
13627: <tr>
1.180 rillig 13628: <td>pkg-build-options</td>
1.201 cirnatda 13629: <td>pkg-config</td>
1.156 leot 13630: </tr>
13631: <tr>
1.180 rillig 13632: <td>pkg_build_options</td>
1.201 cirnatda 13633: <td>platform</td>
1.156 leot 13634: </tr>
13635: <tr>
1.180 rillig 13636: <td>plist</td>
1.201 cirnatda 13637: <td>post-extract</td>
1.156 leot 13638: </tr>
13639: <tr>
1.180 rillig 13640: <td>post-fetch</td>
1.201 cirnatda 13641: <td>post-wrapper</td>
1.156 leot 13642: </tr>
13643: <tr>
1.180 rillig 13644: <td>pre-build-checks-hook</td>
1.201 cirnatda 13645: <td>pre-configure</td>
1.174 leot 13646: </tr>
13647: <tr>
1.180 rillig 13648: <td>pre-configure-checks-hook</td>
1.201 cirnatda 13649: <td>pre-extract</td>
1.156 leot 13650: </tr>
13651: <tr>
1.180 rillig 13652: <td>pre-fetch</td>
1.201 cirnatda 13653: <td>print-go-deps</td>
1.156 leot 13654: </tr>
13655: <tr>
1.180 rillig 13656: <td>print-plist</td>
1.201 cirnatda 13657: <td>print-summary-data</td>
1.156 leot 13658: </tr>
13659: <tr>
1.180 rillig 13660: <td>privileged-install-hook</td>
1.201 cirnatda 13661: <td>pypi</td>
1.156 leot 13662: </tr>
13663: <tr>
1.180 rillig 13664: <td>python</td>
1.201 cirnatda 13665: <td>readme-all</td>
1.156 leot 13666: </tr>
13667: <tr>
1.180 rillig 13668: <td>recv</td>
1.201 cirnatda 13669: <td>recvfrom</td>
1.174 leot 13670: </tr>
13671: <tr>
1.180 rillig 13672: <td>regcomp</td>
1.201 cirnatda 13673: <td>release-localbase-lock</td>
1.174 leot 13674: </tr>
13675: <tr>
1.180 rillig 13676: <td>release-lock</td>
1.201 cirnatda 13677: <td>relro</td>
1.156 leot 13678: </tr>
13679: <tr>
1.180 rillig 13680: <td>rename</td>
1.201 cirnatda 13681: <td>reorder</td>
1.156 leot 13682: </tr>
13683: <tr>
1.180 rillig 13684: <td>replace</td>
1.201 cirnatda 13685: <td>replace_interpreter</td>
1.156 leot 13686: </tr>
13687: <tr>
1.180 rillig 13688: <td>reproducible</td>
1.201 cirnatda 13689: <td>resolv</td>
1.156 leot 13690: </tr>
13691: <tr>
1.180 rillig 13692: <td>root</td>
1.201 cirnatda 13693: <td>ruby</td>
1.174 leot 13694: </tr>
13695: <tr>
1.180 rillig 13696: <td>send</td>
1.201 cirnatda 13697: <td>sendfile</td>
1.156 leot 13698: </tr>
13699: <tr>
1.180 rillig 13700: <td>sendto</td>
1.201 cirnatda 13701: <td>setenv</td>
1.156 leot 13702: </tr>
13703: <tr>
1.180 rillig 13704: <td>setgid</td>
1.201 cirnatda 13705: <td>setprogname</td>
1.156 leot 13706: </tr>
13707: <tr>
1.180 rillig 13708: <td>setuid</td>
1.201 cirnatda 13709: <td>sh</td>
1.156 leot 13710: </tr>
13711: <tr>
1.181 rillig 13712: <td>shebang</td>
1.201 cirnatda 13713: <td>show</td>
1.181 rillig 13714: </tr>
13715: <tr>
1.158 brook 13716: <td>show-all</td>
1.201 cirnatda 13717: <td>show-build-defs</td>
1.156 leot 13718: </tr>
13719: <tr>
1.158 brook 13720: <td>show-depends</td>
1.201 cirnatda 13721: <td>show-deps</td>
1.156 leot 13722: </tr>
13723: <tr>
1.158 brook 13724: <td>show-distfiles</td>
1.201 cirnatda 13725: <td>show-downlevel</td>
1.156 leot 13726: </tr>
13727: <tr>
1.158 brook 13728: <td>show-subdir-var</td>
1.201 cirnatda 13729: <td>show-tools</td>
1.156 leot 13730: </tr>
13731: <tr>
1.158 brook 13732: <td>show-var</td>
1.201 cirnatda 13733: <td>show-vars</td>
1.156 leot 13734: </tr>
13735: <tr>
1.158 brook 13736: <td>snprintf</td>
1.201 cirnatda 13737: <td>socket</td>
1.174 leot 13738: </tr>
13739: <tr>
1.170 rillig 13740: <td>ssp</td>
1.201 cirnatda 13741: <td>st_mode</td>
1.156 leot 13742: </tr>
13743: <tr>
1.170 rillig 13744: <td>stage-install</td>
1.201 cirnatda 13745: <td>strcasestr</td>
1.156 leot 13746: </tr>
13747: <tr>
1.162 rillig 13748: <td>strict</td>
1.201 cirnatda 13749: <td>strip</td>
1.162 rillig 13750: </tr>
13751: <tr>
1.174 leot 13752: <td>strndup</td>
1.201 cirnatda 13753: <td>strnlen</td>
1.156 leot 13754: </tr>
13755: <tr>
1.174 leot 13756: <td>strsep</td>
1.201 cirnatda 13757: <td>subst</td>
1.174 leot 13758: </tr>
13759: <tr>
13760: <td>substitutions</td>
1.201 cirnatda 13761: <td>sun</td>
1.177 leot 13762: </tr>
13763: <tr>
1.200 cirnatda 13764: <td>sunpro</td>
1.201 cirnatda 13765: <td>sunwspro</td>
1.197 leot 13766: </tr>
13767: <tr>
1.161 leot 13768: <td>symlink</td>
1.201 cirnatda 13769: <td>test</td>
1.161 leot 13770: </tr>
13771: <tr>
1.174 leot 13772: <td>test-env</td>
1.201 cirnatda 13773: <td>tex</td>
1.156 leot 13774: </tr>
13775: <tr>
1.174 leot 13776: <td>texlive</td>
1.201 cirnatda 13777: <td>tmp</td>
1.156 leot 13778: </tr>
13779: <tr>
1.174 leot 13780: <td>tool</td>
1.201 cirnatda 13781: <td>tools</td>
1.156 leot 13782: </tr>
13783: <tr>
1.174 leot 13784: <td>tools-libtool-m4-override</td>
1.201 cirnatda 13785: <td>type</td>
1.156 leot 13786: </tr>
13787: <tr>
1.174 leot 13788: <td>ulimit</td>
1.201 cirnatda 13789: <td>undefined</td>
1.156 leot 13790: </tr>
13791: <tr>
1.174 leot 13792: <td>undo-replace</td>
1.201 cirnatda 13793: <td>unlimit</td>
1.156 leot 13794: </tr>
13795: <tr>
1.174 leot 13796: <td>unprivileged</td>
1.201 cirnatda 13797: <td>unprivileged-install-hook</td>
1.156 leot 13798: </tr>
13799: <tr>
1.174 leot 13800: <td>unstripped</td>
1.201 cirnatda 13801: <td>update</td>
1.156 leot 13802: </tr>
13803: <tr>
1.174 leot 13804: <td>upload</td>
1.201 cirnatda 13805: <td>upload-distfiles</td>
1.156 leot 13806: </tr>
13807: <tr>
1.157 leot 13808: <td>use_tools</td>
1.201 cirnatda 13809: <td>user</td>
1.156 leot 13810: </tr>
13811: <tr>
1.157 leot 13812: <td>utimes</td>
1.201 cirnatda 13813: <td>vasprintf</td>
1.156 leot 13814: </tr>
13815: <tr>
1.157 leot 13816: <td>verbose</td>
1.201 cirnatda 13817: <td>vsnprintf</td>
1.156 leot 13818: </tr>
13819: <tr>
1.157 leot 13820: <td>warn</td>
1.201 cirnatda 13821: <td>warning</td>
1.156 leot 13822: </tr>
13823: <tr>
1.157 leot 13824: <td>warnings</td>
1.201 cirnatda 13825: <td>warnx</td>
1.156 leot 13826: </tr>
13827: <tr>
1.174 leot 13828: <td>wattr_off</td>
1.201 cirnatda 13829: <td>wattr_on</td>
1.156 leot 13830: </tr>
13831: <tr>
1.174 leot 13832: <td>work</td>
1.201 cirnatda 13833: <td>wrapper</td>
1.156 leot 13834: </tr>
13835: <tr>
1.174 leot 13836: <td>wrkdir</td>
1.201 cirnatda 13837: <td> </td>
1.156 leot 13838: </tr>
13839: </table>
1.154 rillig 13840: </div>
13841: <div class="appendix">
13842: <div class="titlepage"><div><div><h1 class="title">
13843: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 13844: <div class="toc">
13845: <p><b>Table of Contents</b></p>
1.100 leot 13846: <dl class="toc">
1.154 rillig 13847: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
13848: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1 dsieger 13849: </dl>
13850: </div>
13851: <p>This section contains information on editing the pkgsrc
13852: guide itself.</p>
1.41 asau 13853: <div class="sect1">
1.1 dsieger 13854: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 13855: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.1 dsieger 13856: <p>The pkgsrc guide's source code is stored in
13857: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
13858: are created from it:</p>
1.41 asau 13859: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 13860: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
13861: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.174 leot 13862: <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>
13863: <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 13864: The PDF version of the pkgsrc guide.</p></li>
1.174 leot 13865: <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 13866: PostScript version of the pkgsrc guide.</p></li>
13867: </ul></div>
13868: </div>
1.41 asau 13869: <div class="sect1">
1.1 dsieger 13870: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 13871: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.1 dsieger 13872: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 13873: <div class="procedure"><ol class="procedure" type="1">
1.190 bacon 13874: <li class="step"><p>Make sure you have checked out the htdocs repository
13875: into a sibling directory of your pkgsrc directory. You will need
13876: the ability to commit from both pkgsrc and htdocs.</p></li>
1.41 asau 13877: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 13878: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 13879: documentation) installed. These are automatically installed when
1.137 leot 13880: you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.41 asau 13881: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 13882: right directory. All further steps will take place
13883: here.</p></li>
1.41 asau 13884: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 13885: <code class="filename">files/</code>.</p></li>
1.41 asau 13886: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 13887: guide for valid XML and to build the final output files. If you
13888: get any errors at this stage, you can just edit the files, as
13889: there are only symbolic links in the working directory, pointing
13890: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 13891: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 13892: commit)</strong></span></p></li>
1.41 asau 13893: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 13894: regenerate the output files with the proper RCS
13895: Ids.</p></li>
1.41 asau 13896: <li class="step">
1.10 hubertf 13897: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 13898: commit the files in both <code class="filename">pkgsrc/doc</code> and
13899: <code class="filename">htdocs</code>.</p>
1.41 asau 13900: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 13901: <h3 class="title">Note</h3>
13902: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 13903: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
13904: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 13905: directory.</p>
13906: </div>
13907: </li>
13908: </ol></div>
13909: </div>
13910: </div>
13911: </div></body>
13912: </html>
CVSweb <webmaster@jp.NetBSD.org>