Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.189
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.166 leot 33: <div><p class="copyright">Copyright © 1994-2020 The NetBSD Foundation, Inc</p></div>
1.184 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.38 2020/06/20 05:31:10 rillig 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>
88: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
89: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
90: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
91: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
92: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.1 dsieger 93: </dl></dd>
1.154 rillig 94: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 95: <dd><dl>
1.154 rillig 96: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
97: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
98: <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 99: </dl></dd>
100: </dl></dd>
1.154 rillig 101: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 102: <dd><dl>
1.154 rillig 103: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
104: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
105: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
106: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 107: <dd><dl>
1.154 rillig 108: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
109: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
110: <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 111: </dl></dd>
1.154 rillig 112: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
113: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 114: </dl></dd>
1.154 rillig 115: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 116: <dd><dl>
1.154 rillig 117: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
118: <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 119: </dl></dd>
1.154 rillig 120: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 121: builds)</a></span></dt>
1.1 dsieger 122: <dd><dl>
1.154 rillig 123: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 124: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 125: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
126: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 127: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
128: <dd><dl>
1.179 rillig 129: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
130: <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 131: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
132: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
133: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
134: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
135: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
136: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
137: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
138: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 139: </dl></dd>
140: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 142: </dl></dd>
143: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
144: <dd><dl>
145: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
146: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
147: </dl></dd>
148: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
149: <dd><dl>
150: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
151: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
152: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
153: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
154: <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>
155: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
156: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
157: <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>
158: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
159: <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 160: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 161: <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>
162: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
163: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
164: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
165: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
166: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
167: <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 168: </dl></dd>
169: </dl></dd>
170: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
171: <dd><dl>
1.154 rillig 172: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 173: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 174: <dd><dl>
1.184 rillig 175: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
176: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
177: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 178: <dd><dl>
1.184 rillig 179: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
180: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
181: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
182: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
183: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 184: </dl></dd>
1.184 rillig 185: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
186: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
187: <dd><dl>
188: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
189: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
190: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
191: </dl></dd>
192: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
193: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 194: </dl></dd>
1.184 rillig 195: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 196: <dd><dl>
1.184 rillig 197: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
198: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
199: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
200: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
201: <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 202: <dd><dl>
1.184 rillig 203: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
204: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 205: </dl></dd>
1.184 rillig 206: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
207: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
208: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
209: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
210: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
211: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
212: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
213: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
214: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
215: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
216: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
217: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
218: </dl></dd>
219: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
220: <dd><dl>
221: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 222: <dd><dl>
1.184 rillig 223: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
224: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
225: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
226: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
1.6 rillig 227: </dl></dd>
1.184 rillig 228: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
229: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6 rillig 230: </dl></dd>
1.184 rillig 231: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 232: <dd><dl>
1.184 rillig 233: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
234: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
235: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
236: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 237: <dd><dl>
1.184 rillig 238: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
239: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
240: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
241: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 242: </dl></dd>
243: </dl></dd>
1.184 rillig 244: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 245: <dd><dl>
1.184 rillig 246: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
247: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
248: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
249: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 250: </dl></dd>
1.184 rillig 251: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 252: <dd><dl>
1.184 rillig 253: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
254: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
255: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
256: </dl></dd>
257: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
258: <dd><dl>
259: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
260: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 261: <dd><dl>
1.184 rillig 262: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
263: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 264: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
265: and
266: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
267: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 268: </dl></dd>
1.184 rillig 269: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
270: <dd><dl>
271: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
272: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
273: </dl></dd>
274: </dl></dd>
275: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 276: <dd><dl>
1.184 rillig 277: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
278: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
279: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
280: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
281: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
282: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
283: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
284: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
285: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 286: </dl></dd>
1.184 rillig 287: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
288: <dd><dl>
289: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
290: <dd><dl>
291: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
292: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 293: </dl></dd>
1.184 rillig 294: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 295: <dd><dl>
1.184 rillig 296: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
297: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
298: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
299: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
300: </dl></dd>
301: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
302: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
303: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
304: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
305: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
306: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
307: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.154 rillig 308: </dl></dd>
309: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
310: <dd><dl>
311: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
312: <dd><dl>
313: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
314: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
315: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
316: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
317: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
318: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
319: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
320: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
321: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
322: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
323: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
324: </dl></dd>
325: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
326: <dd><dl>
327: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
328: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
329: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
330: </dl></dd>
331: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
332: <dd><dl>
333: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
334: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
336: </dl></dd>
337: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
338: <dd><dl>
339: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
340: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
341: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
342: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
343: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
344: </dl></dd>
345: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
346: <dd><dl>
347: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
348: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 349: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
350: <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>
351: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 352: </dl></dd>
353: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
354: <dd><dl>
355: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
356: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
357: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
358: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
359: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
360: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
361: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
362: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
363: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
364: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
365: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
366: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
367: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
368: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
369: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
370: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
371: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
372: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 373: emulation</a></span></dt>
1.154 rillig 374: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
375: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 376: </dl></dd>
1.154 rillig 377: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 378: </dl></dd>
1.184 rillig 379: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
380: <dd><dl>
381: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
382: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
383: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
384: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
385: </dl></dd>
1.154 rillig 386: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 387: <dd><dl>
1.154 rillig 388: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
389: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
390: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
391: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
392: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
393: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
394: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
395: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
396: </dl></dd>
397: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 398: </dl></dd>
399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
400: <dd><dl>
1.184 rillig 401: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 402: <dd><dl>
1.184 rillig 403: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
404: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
405: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 406: <dd><dl>
1.184 rillig 407: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
408: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 409: </dl></dd>
1.184 rillig 410: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
411: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 412: <dd><dl>
1.184 rillig 413: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
414: <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 415: </dl></dd>
1.184 rillig 416: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 417: <dd><dl>
1.184 rillig 418: <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>
419: <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 420: </dl></dd>
421: </dl></dd>
1.184 rillig 422: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 423: <dd><dl>
1.184 rillig 424: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
425: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 426: <dd><dl>
1.184 rillig 427: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
428: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 429: </dl></dd>
430: </dl></dd>
1.184 rillig 431: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
432: <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 433: </dl></dd>
434: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
435: <dd><dl>
436: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
437: <dd><dl>
438: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
439: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
440: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 441: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 442: </dl></dd>
443: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
444: </dl></dd>
445: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
446: <dd><dl>
447: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
448: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
449: </dl></dd>
450: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
451: <dd><dl>
1.23 wiz 452: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
453: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
454: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
455: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
456: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148 leot 457: <code class="filename">stable</code>,
1.23 wiz 458: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 459: source packages</a></span></dt>
460: </dl></dd>
1.154 rillig 461: <dt><span class="appendix"><a href="#help-topics">D. Help topics</a></span></dt>
462: <dt><span class="appendix"><a href="#editing">E. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1 dsieger 463: <dd><dl>
1.154 rillig 464: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
465: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1 dsieger 466: </dl></dd>
467: </dl>
468: </div>
469: <div class="list-of-tables">
470: <p><b>List of Tables</b></p>
471: <dl>
472: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
473: </dt>
1.184 rillig 474: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 475: </dt>
1.184 rillig 476: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 477: </dt>
478: </dl>
479: </div>
1.41 asau 480: <div class="chapter">
481: <div class="titlepage"><div><div><h1 class="title">
482: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 483: <div class="toc">
484: <p><b>Table of Contents</b></p>
1.100 leot 485: <dl class="toc">
1.1 dsieger 486: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
487: <dd><dl>
488: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
489: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
490: </dl></dd>
491: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
492: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
493: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
494: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
495: </dl>
496: </div>
1.41 asau 497: <div class="sect1">
1.1 dsieger 498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
499: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
500: <p>There is a lot of software freely available for Unix-based
501: systems, which is usually available in form of the source code. Before
502: such software can be used, it needs to be configured to the local
503: system, compiled and installed, and this is exactly what The NetBSD
504: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
505: to handle binary packages, so that not every user has to build the
506: packages for himself, which is a time-costly task.</p>
507: <p>pkgsrc currently contains several thousand packages,
508: including:</p>
1.41 asau 509: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 510: <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 511: web server</p></li>
1.137 leot 512: <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 513: web browser</p></li>
1.137 leot 514: <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 515: Desktop Environment</p></li>
1.137 leot 516: <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 517: Desktop Environment</p></li>
518: </ul></div>
1.108 rillig 519: <p>… just to name a few.</p>
1.1 dsieger 520: <p>pkgsrc has built-in support for handling varying dependencies,
521: such as pthreads and X11, and extended features such as IPv6 support on
522: a range of platforms.</p>
1.41 asau 523: <div class="sect2">
1.1 dsieger 524: <div class="titlepage"><div><div><h3 class="title">
525: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
526: <p>
527: pkgsrc provides the following key features:
528: </p>
1.41 asau 529: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 530: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 531: and installation of binary packages. The source and latest
532: patches are retrieved from a master or mirror download site, checksum
533: verified, then built on your system. Support for binary-only
534: distributions is available for both native platforms and NetBSD
535: emulated platforms.</p></li>
1.23 wiz 536: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 537: including binaries, libraries, man pages and other
538: documentation.</p></li>
1.104 sevan 539: <li class="listitem"><p>Tracking of package dependencies automatically, including when
540: performing updates, to ensure required packages are installed. The
541: configuration files of various packages are handled automatically during
542: updates, so local changes are preserved.</p></li>
1.23 wiz 543: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 544: consists of highly portable code. This allows the greatest speed of
1.25 spz 545: development when porting to a new platform. This portability also
1.1 dsieger 546: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
547: platforms</em></span>.</p></li>
1.23 wiz 548: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 549: international encryption requirements and build-time options for a
550: large number of packages are all set in a simple, central
551: configuration file.</p></li>
1.23 wiz 552: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 553: freely available under a BSD license, so you may extend and adapt
554: pkgsrc to your needs. Support for local packages and patches is
555: available right out of the box, so you can configure it specifically
556: for your environment.</p></li>
557: </ul></div>
558: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 560: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 561: — That means, if a package contains bugs, it's better to find
1.1 dsieger 562: them and to complain about them rather than to just install the package
563: and hope that it works. There are numerous checks in pkgsrc that try to
1.175 gutterid 564: 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 565: of shell scripts), and post-installation checks (installed files,
566: references to shared libraries, script interpreters).</p></li>
1.23 wiz 567: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 568: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 569: pkgsrc has been ported to many operating systems. Care is taken that
570: packages behave the same on all platforms.</p></li>
571: </ul></div>
572: </div>
1.41 asau 573: <div class="sect2">
1.1 dsieger 574: <div class="titlepage"><div><div><h3 class="title">
575: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
576: <p>pkgsrc consists of both a source distribution and a binary
577: distribution for these operating systems. After retrieving the required
578: source or binaries, you can be up and running with pkgsrc in just
579: minutes!</p>
580: <p>pkgsrc was derived from FreeBSD's ports system, and
581: initially developed for NetBSD only. Since then, pkgsrc has
582: grown a lot, and now supports the following platforms:</p>
583: <div class="table">
584: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 585: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 586: <colgroup>
587: <col>
588: <col>
1.92 sevan 589: <col>
1.1 dsieger 590: </colgroup>
591: <thead><tr>
592: <th>Platform</th>
593: <th>Date Support Added</th>
1.92 sevan 594: <th>Notes</th>
1.1 dsieger 595: </tr></thead>
596: <tbody>
597: <tr>
1.174 leot 598: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 599: <td align="center">Aug 1997</td>
1.92 sevan 600: <td class="auto-generated"> </td>
1.1 dsieger 601: </tr>
602: <tr>
1.10 hubertf 603: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 604: <td align="center">Mar 1999</td>
1.151 sevan 605: <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 606: </tr>
607: <tr>
1.174 leot 608: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 609: <td align="center">Jun 1999</td>
1.151 sevan 610: <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 611: </tr>
612: <tr>
613: <td>
1.118 sevan 614: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 615: </td>
616: <td align="center">Oct 2001</td>
1.151 sevan 617: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.1 dsieger 618: </tr>
619: <tr>
1.174 leot 620: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 621: <td align="center">Nov 2002</td>
1.151 sevan 622: <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 623: </tr>
624: <tr>
1.174 leot 625: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 626: <td align="center">Nov 2002</td>
1.151 sevan 627: <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 628: </tr>
629: <tr>
1.174 leot 630: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 631: <td align="center">Dec 2002</td>
1.92 sevan 632: <td>
1.151 sevan 633: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
634: <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 635: </td>
1.1 dsieger 636: </tr>
637: <tr>
638: <td>BSD/OS</td>
639: <td align="center">Dec 2003</td>
1.92 sevan 640: <td class="auto-generated"> </td>
1.1 dsieger 641: </tr>
642: <tr>
1.174 leot 643: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 644: <td align="center">Dec 2003</td>
1.151 sevan 645: <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 646: </tr>
647: <tr>
648: <td>
1.174 leot 649: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 650: (Microsoft Windows Services for Unix)
651: </td>
652: <td align="center">Mar 2004</td>
1.151 sevan 653: <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 654: </tr>
655: <tr>
1.174 leot 656: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 657: <td align="center">Oct 2004</td>
1.92 sevan 658: <td class="auto-generated"> </td>
1.1 dsieger 659: </tr>
660: <tr>
1.10 hubertf 661: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 662: <td align="center">Nov 2004</td>
1.151 sevan 663: <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 664: </tr>
665: <tr>
1.174 leot 666: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 667: <td align="center">Apr 2007</td>
1.151 sevan 668: <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 669: </tr>
1.23 wiz 670: <tr>
1.174 leot 671: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.23 wiz 672: <td align="center">Sep 2010</td>
1.151 sevan 673: <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 674: </tr>
1.45 obache 675: <tr>
1.174 leot 676: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 677: <td align="center">Jan 2011</td>
1.92 sevan 678: <td class="auto-generated"> </td>
1.45 obache 679: </tr>
680: <tr>
1.174 leot 681: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.45 obache 682: <td align="center">Nov 2011</td>
1.151 sevan 683: <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 684: </tr>
685: <tr>
1.174 leot 686: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.45 obache 687: <td align="center">Mar 2013</td>
1.151 sevan 688: <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 689: </tr>
1.58 ryoon 690: <tr>
1.174 leot 691: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.58 ryoon 692: <td align="center">Jul 2013</td>
1.151 sevan 693: <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 694: </tr>
1.104 sevan 695: <tr>
1.174 leot 696: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.104 sevan 697: <td align="center">Jun 2014</td>
1.151 sevan 698: <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 699: </tr>
1.1 dsieger 700: </tbody>
701: </table></div>
702: </div>
703: <br class="table-break">
704: </div>
705: </div>
1.41 asau 706: <div class="sect1">
1.1 dsieger 707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
708: <a name="overview"></a>1.2. Overview</h2></div></div></div>
709: <p>This document is divided into three parts. The first,
1.10 hubertf 710: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 711: describes how one can use one of the packages in the Package
712: Collection, either by installing a precompiled binary package,
713: or by building one's own copy using the NetBSD package system.
1.10 hubertf 714: 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 715: package so it can be easily built by other NetBSD users without
716: knowing about the package's building details. The third part,
1.10 hubertf 717: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 718: is intended for those who want to understand how pkgsrc is
719: implemented.</p>
720: <p>This document is available in various formats:
1.10 hubertf 721: <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 722: </div>
1.41 asau 723: <div class="sect1">
1.1 dsieger 724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
725: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 726: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
727: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 728: terminology used within this document.</p>
1.41 asau 729: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 730: <dt><span class="term">Package</span></dt>
731: <dd><p>A set of files and building instructions
732: that describe what's necessary
733: to build a certain piece of software using
734: pkgsrc. Packages are traditionally stored under
1.123 wiz 735: <code class="filename">/usr/pkgsrc</code>,
736: but may be stored in any location,
737: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1 dsieger 738: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 739: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 740: is part of the NetBSD operating system and can be bootstrapped
741: to run on non-NetBSD operating systems as well. It handles
742: building (compiling), installing, and removing of
743: packages.</p></dd>
744: <dt><span class="term">Distfile</span></dt>
745: <dd><p>This term describes the file or files that are
746: provided by the author of the piece of software to
747: distribute his work. All the changes necessary to build on
748: NetBSD are reflected in the corresponding package. Usually
749: the distfile is in the form of a compressed tar-archive,
750: but other types are possible, too. Distfiles are usually
751: stored below
752: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
753: <dt><span class="term">Port</span></dt>
754: <dd><p>This is the term used by FreeBSD and OpenBSD people
755: for what we call a package.
1.23 wiz 756: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 757: architecture.</p></dd>
758: <dt><span class="term">Precompiled/binary package</span></dt>
759: <dd>
760: <p>A set of binaries built with pkgsrc from a distfile
761: and stuffed together in a single <code class="filename">.tgz</code>
762: file so it can be installed on machines of the same
763: machine architecture without the need to
764: recompile. Packages are usually generated in
765: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 766: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 767: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 768: especially in the context of precompiled packages.</p>
769: </dd>
770: <dt><span class="term">Program</span></dt>
771: <dd><p>The piece of software to be installed which will be
772: constructed from all the files in the distfile by the
773: actions defined in the corresponding package.</p></dd>
774: </dl></div>
1.41 asau 775: <div class="sect2">
1.1 dsieger 776: <div class="titlepage"><div><div><h3 class="title">
777: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 778: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 779: <dt><span class="term">pkgsrc users</span></dt>
780: <dd>
781: <p>The
782: pkgsrc users are people who use the packages provided by pkgsrc.
783: Typically they are system administrators. The people using the
1.23 wiz 784: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
785: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 786: <p>There are two kinds of pkgsrc users: Some only want to
787: install pre-built binary packages. Others build the pkgsrc
788: packages from source, either for installing them directly or for
1.10 hubertf 789: 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 790: documentation.</p>
791: </dd>
792: <dt><span class="term">package maintainers</span></dt>
793: <dd><p>A
1.10 hubertf 794: 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 795: <dt><span class="term">infrastructure developers</span></dt>
796: <dd><p>These people are involved in all those files
797: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 798: 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 799: too.</p></dd>
800: </dl></div>
801: </div>
802: </div>
1.41 asau 803: <div class="sect1">
1.1 dsieger 804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
805: <a name="typography"></a>1.4. Typography</h2></div></div></div>
806: <p>When giving examples for commands, shell prompts are used to
807: show if the command should/can be issued as root, or if
1.23 wiz 808: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 809: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
810: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
811: bourne shell and derivatives.</p>
1.1 dsieger 812: </div>
813: </div>
1.41 asau 814: <div class="part">
1.1 dsieger 815: <div class="titlepage"><div><div><h1 class="title">
816: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
817: <div class="toc">
818: <p><b>Table of Contents</b></p>
1.100 leot 819: <dl class="toc">
1.154 rillig 820: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
821: <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 822: <dd><dl>
1.154 rillig 823: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 824: <dd><dl>
1.154 rillig 825: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
826: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 827: </dl></dd>
1.154 rillig 828: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 829: <dd><dl>
1.154 rillig 830: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
831: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 832: </dl></dd>
833: </dl></dd>
1.154 rillig 834: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 835: <dd><dl>
1.154 rillig 836: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
837: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 838: </dl></dd>
1.154 rillig 839: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 840: <dd><dl>
1.154 rillig 841: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 842: <dd><dl>
1.154 rillig 843: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
844: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
845: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
846: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
847: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
848: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
849: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.1 dsieger 850: </dl></dd>
1.154 rillig 851: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 852: <dd><dl>
1.154 rillig 853: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
854: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
855: <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 856: </dl></dd>
857: </dl></dd>
1.154 rillig 858: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 859: <dd><dl>
1.154 rillig 860: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
861: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
862: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
863: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 864: <dd><dl>
1.154 rillig 865: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
866: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
867: <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 868: </dl></dd>
1.154 rillig 869: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
870: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 871: </dl></dd>
1.154 rillig 872: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 873: <dd><dl>
1.154 rillig 874: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
875: <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 876: </dl></dd>
1.154 rillig 877: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 878: builds)</a></span></dt>
1.1 dsieger 879: <dd><dl>
1.154 rillig 880: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 881: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 882: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
883: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 884: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
885: <dd><dl>
1.179 rillig 886: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
887: <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 888: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
889: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
890: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
891: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
892: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
893: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
894: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
895: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 896: </dl></dd>
897: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
898: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 899: </dl></dd>
900: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
901: <dd><dl>
902: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
903: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
904: </dl></dd>
905: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
906: <dd><dl>
907: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
908: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
909: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
910: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
911: <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>
912: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
913: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
914: <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>
915: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
916: <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 917: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 918: <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>
919: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
920: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
921: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
922: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
923: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
924: <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 925: </dl></dd>
926: </dl>
927: </div>
1.41 asau 928: <div class="chapter">
1.1 dsieger 929: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 930: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
931: <p>
932: To get help when using pkgsrc, the definitive source is this
933: document, the pkgsrc guide. If you don't find anything here,
934: there are alternatives:
935: </p>
936: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
937: <li class="listitem">
938: <p>
939: The built-in pkgsrc help, which is available after bootstrapping
940: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
941: help for any topic, such as a variable name like
942: <code class="varname">BUILD_DEFS</code>, a make target like
943: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
944: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
945: <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>
946: </li>
947: <li class="listitem"><p>
1.163 rillig 948: To see the value of a single variable, run <span class="command"><strong>bmake
949: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
950: </p></li>
951: <li class="listitem"><p>
952: To see the values of the most common variables, run
953: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
954: topic. To see the variables for a single topic, run
955: <span class="command"><strong>bmake
956: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
957: <span class="command"><strong>bmake show-all-fetch</strong></span>.
958: </p></li>
959: <li class="listitem"><p>
1.154 rillig 960: The pkgsrc-users mailing list, to which
961: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
962: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
963: questions</a>.</p></li>
964: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
965: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
966: or by using a specialized chat program such as
967: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
968: Pick any user name and join the channel #pkgsrc.</p></li>
969: </ul></div>
970: </div>
971: <div class="chapter">
972: <div class="titlepage"><div><div><h2 class="title">
973: <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 974: <div class="toc">
975: <p><b>Table of Contents</b></p>
1.100 leot 976: <dl class="toc">
1.154 rillig 977: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 978: <dd><dl>
1.154 rillig 979: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
980: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 981: </dl></dd>
1.154 rillig 982: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 983: <dd><dl>
1.154 rillig 984: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
985: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 986: </dl></dd>
987: </dl>
988: </div>
989: <p>Before you download and extract the files, you need to decide
990: where you want to extract them. When using pkgsrc as root user, pkgsrc
991: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
992: free to install the sources and binary packages wherever you want in
993: your filesystem, provided that the pathname does not contain white-space
994: or other characters that are interpreted specially by the shell and some
995: other programs. A safe bet is to use only letters, digits, underscores
996: and dashes.</p>
1.41 asau 997: <div class="sect1">
1.1 dsieger 998: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 999: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 1000: <p>Before you download any pkgsrc files, you should decide
1001: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1002: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1003: quarterly basis from the current branch and only gets modified
1004: for security updates. The names of the stable branches are built
1005: from the year and the quarter, for example
1.188 leot 1006: <code class="literal">2020Q2</code>.</p>
1.1 dsieger 1007: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 1008: want to download pkgsrc. You can get it as a tar file or via CVS.
1009: Both ways are described here.</p>
1.51 asau 1010: <p>Note that tar archive contains CVS working copy.
1011: Thus you can switch to using CVS at any later time.</p>
1.41 asau 1012: <div class="sect2">
1.1 dsieger 1013: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1014: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 1015: <p>The primary download location for all pkgsrc files is
1.151 sevan 1016: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 1017: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1018: (it points to the same location).
1019: There are a number of subdirectories for different purposes,
1020: 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>
1021: <p>The tar archive for the current branch is in the directory
1.151 sevan 1022: <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 1023: It is autogenerated weekly.</p>
1.51 asau 1024: <p>To save download time we provide bzip2- and
1025: xz-compressed archives which are published at
1.151 sevan 1026: <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 1027: and
1.151 sevan 1028: <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 1029: respectively.
1030: </p>
1031: <p>You can fetch the same files using FTP.</p>
1.188 leot 1032: <p>The tar file for the stable branch 2020Q2 is in the
1033: directory <code class="filename">pkgsrc-2020Q2</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2020Q2/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136 leot 1034: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 1035: <pre class="screen">
1.188 leot 1036: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2020Q2/pkgsrc.tar.gz</code></strong></pre>
1.78 snj 1037: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1038: or your web browser.</p>
1.12 weinem 1039: <p>Then, extract it with:</p>
1.78 snj 1040: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1041: <p>This will create the directory <code class="filename">pkgsrc/</code>
1042: in <code class="filename">/usr/</code> and all the package source will be
1043: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1044: <p>To download pkgsrc-current, run:</p>
1045: <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 1046: </div>
1.41 asau 1047: <div class="sect2">
1.1 dsieger 1048: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1049: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1050: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.188 leot 1051: <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-2020Q2 -P pkgsrc</code></strong>
1.23 wiz 1052: </pre>
1053: <p>This will create the directory <code class="filename">pkgsrc/</code>
1054: in your <code class="filename">/usr/</code> directory and all the package source
1055: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1056: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1057: <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 1058: </pre>
1.174 leot 1059: <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 1060: <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 1061: <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 1062: </pre>
1063: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1064: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1065: or better globally in <code class="filename">/etc/profile</code>:</p>
1066: <pre class="programlisting">
1067: # set CVS remote shell command
1068: CVS_RSH=ssh
1069: export CVS_RSH
1070: </pre>
1071: <p>By default, CVS doesn't do things like most people would expect it to do.
1072: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1073: in your home directory and saving the following lines to it.
1074: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1075: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1076: <pre class="programlisting">
1077: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1078: cvs -q
1.2 rillig 1079: checkout -P
1.4 rillig 1080: update -dP
1081: diff -upN
1.2 rillig 1082: rdiff -u
1.23 wiz 1083: release -d
1.2 rillig 1084: </pre>
1.1 dsieger 1085: </div>
1086: </div>
1.41 asau 1087: <div class="sect1">
1.1 dsieger 1088: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1089: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1090: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1091: (which also works if you have first installed it via a tar
1092: file). It saves bandwidth and hard disk activity, compared to
1093: downloading the tar file again.</p>
1.41 asau 1094: <div class="sect2">
1.1 dsieger 1095: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1096: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1097: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1098: <h3 class="title">Warning</h3>
1099: <p>When updating from a tar file, you first need to
1100: completely remove the old pkgsrc directory. Otherwise those
1101: files that have been removed from pkgsrc in the mean time will
1102: not be removed on your local disk, resulting in inconsistencies.
1103: When removing the old files, any changes that you have done to
1104: the pkgsrc files will be lost after updating. Therefore updating
1105: via CVS is strongly recommended.</p>
1106: </div>
1107: <p>Note that by default the distfiles and the binary packages
1108: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1109: before updating. You can also configure pkgsrc to store distfiles
1110: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1111: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154 rillig 1112: 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 1113: <p>To update pkgsrc from a tar file, download the tar file as
1114: explained above. Then, make sure that you have not made any
1115: changes to the files in the pkgsrc directory. Remove the pkgsrc
1116: directory and extract the new tar file. Done.</p>
1117: </div>
1.41 asau 1118: <div class="sect2">
1.1 dsieger 1119: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1120: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1121: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1122: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1123: </pre>
1124: <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>
1125: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1126: </pre>
1.41 asau 1127: <div class="sect3">
1.1 dsieger 1128: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1129: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1130: <p>When updating pkgsrc, the CVS program keeps track of the
1131: branch you selected. But if you, for whatever reason, want to
1132: switch from the stable branch to the current one, you can do it
1.23 wiz 1133: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1134: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1135: back to the stable branch, add the
1.188 leot 1136: <span class="quote">“<span class="quote">-rpkgsrc-2020Q2</span>”</span> option.</p>
1.1 dsieger 1137: </div>
1.41 asau 1138: <div class="sect3">
1.1 dsieger 1139: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1140: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1141: <p>When you update pkgsrc, the CVS program will only touch
1142: those files that are registered in the CVS repository. That
1143: means that any packages that you created on your own will stay
1144: unmodified. If you change files that are managed by CVS, later
1145: updates will try to merge your changes with those that have been
1146: done by others. See the CVS manual, chapter
1.23 wiz 1147: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1148: </div>
1149: </div>
1150: </div>
1151: </div>
1.41 asau 1152: <div class="chapter">
1.1 dsieger 1153: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1154: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1155: <div class="toc">
1156: <p><b>Table of Contents</b></p>
1.100 leot 1157: <dl class="toc">
1.154 rillig 1158: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1159: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1160: </dl>
1161: </div>
1.41 asau 1162: <div class="sect1">
1.1 dsieger 1163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1164: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1165: <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 1166: </div>
1.41 asau 1167: <div class="sect1">
1.1 dsieger 1168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1169: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1170: <p>pkgsrc can be bootstrapped for use in two different modes:
1171: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1172: to privileged one all programs are installed under one particular user
1.43 asau 1173: and cannot utilise privileged operations (packages don't create
1174: special users and all special file permissions like setuid are ignored).
1175: </p>
1.1 dsieger 1176: <p>Installing the bootstrap kit from source should be as simple as:</p>
1177: <pre class="screen">
1.60 asau 1178: <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 1179: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1180: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1181: </pre>
1.43 asau 1182: <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>
1183: <p>By default, in privileged mode pkgsrc uses
1184: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1185: where programs will be installed in,
1.118 sevan 1186: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1187: directory where pkgsrc will do its internal bookkeeping,
1188: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1189: where packages install their persistent data.
1190: In unprivileged mode pkgsrc uses
1191: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1192: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1193: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1194: </p>
1195: <p>You can change default layout using command-line arguments.
1196: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1197: </p>
1.41 asau 1198: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1199: <h3 class="title">Note</h3>
1.10 hubertf 1200: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1201: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1202: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1203: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1204: </div>
1.43 asau 1205: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1206: <h3 class="title">Note</h3>
1207: <p>It is possible to bootstrap multiple instances of pkgsrc
1208: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1209: corresponding to the installation you're working with to build
1210: and install packages.
1211: </p>
1212: </div>
1.1 dsieger 1213: </div>
1214: </div>
1.41 asau 1215: <div class="chapter">
1.1 dsieger 1216: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1217: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1218: <div class="toc">
1219: <p><b>Table of Contents</b></p>
1.100 leot 1220: <dl class="toc">
1.154 rillig 1221: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1222: <dd><dl>
1.154 rillig 1223: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1224: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1225: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
1226: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
1227: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1228: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. 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.7. Other administrative functions</a></span></dt>
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.179 rillig 1248: <p>On the <a class="ulink" href="http://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.179 rillig 1265:
1266: pkgsrc FTP server in the directory <a class="ulink" href="http://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5 weinem 1267: <p>This directory contains binary packages for multiple
1268: platforms. First, select your operating system. (Ignore the
1269: directories with version numbers attached to it, they just exist for
1270: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1271: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1272: <p>In this directory, you often find a file called
1273: <code class="filename">bootstrap.tar.gz</code> which contains the package
1274: management tools. If the file is missing, it is likely that your
1275: operating system already provides those tools. Download the file and
1276: extract it in the <code class="filename">/</code> directory. It will create
1277: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1278: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1279: </div>
1.41 asau 1280: <div class="sect2">
1.1 dsieger 1281: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1282: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1283: <p>In the directory from the last section, there is a
1.85 wiz 1284: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1285: binary packages that are available for the platform, excluding those
1286: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1287: medium you are using).</p>
1.9 rillig 1288: <p>To install packages directly from an FTP or HTTP server, run
1289: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1290: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1291: <pre class="screen">
1292: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.179 rillig 1293:
1294: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.169 rillig 1295: <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 1296: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1297: </pre>
1298: <p>Instead of URLs, you can also use local paths, for example if
1299: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1300: repository. If you want to install packages from multiple sources,
1301: you can separate them by a semicolon in
1302: <code class="varname">PKG_PATH</code>.</p>
1303: <p>After these preparations, installing a package is very
1304: easy:</p>
1305: <pre class="screen">
1.118 sevan 1306: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
1307: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.9 rillig 1308: </pre>
1.1 dsieger 1309: <p>Note that any prerequisite packages needed to run the
1310: package in question will be installed, too, assuming they are
1311: present where you install from.</p>
1.23 wiz 1312: <p>Adding packages might install vulnerable packages.
1313: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1314: regularly, especially after installing new packages, and verify
1315: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1316: <p>After you've installed packages, be sure to have
1317: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1318: <code class="varname">PATH</code> so you can actually start the just
1319: installed program.</p>
1320: </div>
1.41 asau 1321: <div class="sect2">
1.1 dsieger 1322: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1323: <a name="using.pkg_delete"></a>5.1.3. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1324: <p>To deinstall a package, it does not matter whether it was
1325: installed from source code or from a binary package. The
1.10 hubertf 1326: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1327: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1328: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1329: name can be given with or without version number. Wildcards can
1330: also be used to deinstall a set of packages, for example
1331: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1332: so that the shell does not expand them before
1333: <code class="literal">pkg_delete</code> sees them.</p>
1334: <p>The <code class="option">-r</code> option is very powerful: it
1335: removes all the packages that require the package in question
1336: and then removes the package itself. For example:
1337:
1338: </p>
1339: <pre class="screen">
1340: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1341: </pre>
1342: <p>
1343:
1344: will remove jpeg and all the packages that used it; this allows
1345: upgrading the jpeg package.</p>
1346: </div>
1.41 asau 1347: <div class="sect2">
1.1 dsieger 1348: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1349: <a name="using.pkg_info"></a>5.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1350: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1351: installed packages or binary package files.</p>
1352: </div>
1.41 asau 1353: <div class="sect2">
1.1 dsieger 1354: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1355: <a name="vulnerabilities"></a>5.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1356: <p>
1.164 leot 1357: The pkgsrc Security Team and Packages Groups maintain a list of
1.1 dsieger 1358: known security vulnerabilities to packages which are (or have been)
1359: included in pkgsrc. The list is available from the NetBSD
1.179 rillig 1360:
1361: FTP site at <a class="ulink" href="http://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">http://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
1.1 dsieger 1362: </p>
1363: <p>
1.22 jakllsch 1364: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1365: this list can be downloaded
1366: automatically, and a security audit of all packages installed on a system
1367: can take place.
1368: </p>
1369: <p>
1.22 jakllsch 1370: There are two components to auditing. The first
1371: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1372: is for downloading
1.1 dsieger 1373: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1374: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1375: installed packages are vulnerable. If a package is vulnerable, you
1376: will see output similar to the following:
1377: </p>
1378: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1379: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.1 dsieger 1380: <p>
1.22 jakllsch 1381: You may wish to have the
1.179 rillig 1382:
1383: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1384: file downloaded daily so that
1385: it remains current. This may be done by adding an appropriate entry
1.174 leot 1386: to the root users <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1387: </p>
1388: <pre class="screen">
1.121 sevan 1389: # Download vulnerabilities file
1.118 sevan 1390: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1391: # Audit the installed packages and email results to root
1392: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1393: root >/dev/null 2>&1
1.22 jakllsch 1394: </pre>
1395: <p>
1.118 sevan 1396: will update the vulnerability list every day at 3AM, followed by an audit
1397: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1398:
1.118 sevan 1399: On NetBSD this may be accomplished instead by adding the following
1400: line to <code class="filename">/etc/daily.conf</code>:
1401: </p>
1402: <pre class="screen">
1403: fetch_pkg_vulnerabilities=YES
1404: </pre>
1405: <p>
1406: to fetch the vulnerability list from the daily security script. The system
1407: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1408: desired (not required), by adding the following line to
1.118 sevan 1409: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1410: </p>
1411: <pre class="screen">
1.118 sevan 1412: check_pkg_vulnerabilities=YES
1.22 jakllsch 1413: </pre>
1414: <p>
1.174 leot 1415: see <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?security.conf+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.1 dsieger 1416: </p>
1417: </div>
1.41 asau 1418: <div class="sect2">
1.1 dsieger 1419: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1420: <a name="pkg_versions"></a>5.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.1 dsieger 1421: <p>
1.137 leot 1422: 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 1423: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1424: argument to check if your packages are up-to-date, e.g.
1425: </p>
1426: <pre class="screen">
1427: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1428: ...
1429: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1430: </pre>
1.10 hubertf 1431: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1432: package on your system and rebuild any dependencies.
1433: </p>
1434: </div>
1.41 asau 1435: <div class="sect2">
1.1 dsieger 1436: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1437: <a name="using.pkg_admin"></a>5.1.7. 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.174 leot 1606: <p>If you invoke the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><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.174 leot 1614: <p>If you want to know the value of a certain <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><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.174 leot 1617: target. e.g. to show the expansion of the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><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.174 leot 1630: install a binary package - if available - via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><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.174 leot 1634: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><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.174 leot 1673: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><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.143 maya 1768: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
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.174 leot 1815: privileges using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-9.0"><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.174 leot 2055: another system with <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><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.174 leot 2906: don't have a NetBSD-compatible <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-9.0"><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.174 leot 2958: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-9.0"><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.154 rillig 3020: See <a class="xref" href="#vulnerabilities" title="5.1.5. Checking for security vulnerabilities in installed packages">Section 5.1.5, “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.174 leot 3032: scripts and to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><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>
3282: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
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>
3301: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
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>
3304: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
3305: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
3306: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
3307: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
3308: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
3309: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
3310: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
3311: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
3312: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
3313: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 3314: emulation</a></span></dt>
1.154 rillig 3315: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
3316: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3317: </dl></dd>
1.154 rillig 3318: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3319: </dl></dd>
1.184 rillig 3320: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3321: <dd><dl>
3322: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3323: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3324: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3325: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3326: </dl></dd>
1.154 rillig 3327: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3328: <dd><dl>
1.154 rillig 3329: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3330: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3331: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3332: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3333: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3334: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3335: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3336: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3337: </dl></dd>
3338: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 3339: </dl>
3340: </div>
3341: </div>
1.41 asau 3342: <div class="chapter">
1.1 dsieger 3343: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3344: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3345: <p>
3346: To get help when developing pkgsrc, the definitive source is this
3347: document, the pkgsrc guide. If you don't find anything here,
3348: there are alternatives:
3349: </p>
3350: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3351: <li class="listitem">
3352: <p>
3353: The built-in pkgsrc help, which is available after bootstrapping
3354: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3355: help for any topic, such as a variable name like
3356: <code class="varname">BUILD_DEFS</code>, a make target like
3357: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3358: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
3359: <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>
3360: </li>
3361: <li class="listitem"><p>
1.163 rillig 3362: To see the value of a single variable, run <span class="command"><strong>bmake
3363: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3364: </p></li>
3365: <li class="listitem"><p>
3366: To see the values of the most common variables, run
3367: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3368: topic. To see the variables for a single topic, run
3369: <span class="command"><strong>bmake
3370: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3371: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3372: </p></li>
3373: <li class="listitem"><p>
1.154 rillig 3374: The tech-pkg mailing list, to which
3375: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3376: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3377: questions</a>.</p></li>
3378: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3379: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3380: or by using a specialized chat program such as
3381: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3382: Pick any user name and join the channel #pkgsrc.</p></li>
3383: </ul></div>
3384: </div>
3385: <div class="chapter">
3386: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 3387: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3388: <div class="toc">
3389: <p><b>Table of Contents</b></p>
1.100 leot 3390: <dl class="toc">
1.184 rillig 3391: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3392: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3393: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3394: <dd><dl>
3395: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3396: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3397: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3398: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3399: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3400: </dl></dd>
3401: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3402: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3403: <dd><dl>
3404: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3405: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3406: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3407: </dl></dd>
1.184 rillig 3408: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3409: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3410: </dl>
3411: </div>
1.184 rillig 3412: <p>Whenever you're preparing a package, there are a number of
3413: files involved which are described in the following
3414: sections.</p>
3415: <div class="sect1">
3416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3417: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3418: </h2></div></div></div>
3419: <p>Building, installation and creation of a binary package are all
3420: controlled by the package's <code class="filename">Makefile</code>.
3421: The <code class="filename">Makefile</code> describes various things about
3422: a package, for example from where to get it, how to configure,
3423: build, and install it.</p>
3424: <p>A package <code class="filename">Makefile</code> contains several
3425: sections that describe the package.</p>
3426: <p>In the first section there are the following variables, which
3427: should appear exactly in the order given here. The order and
3428: grouping of the variables is mostly historical and has no further
3429: meaning.</p>
3430: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3431: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3432: distribution file to be downloaded from the package's
3433: website.</p></li>
3434: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3435: package, as used by pkgsrc. You need to provide it if
3436: <code class="varname">DISTNAME</code> (which is the default) is not a good
3437: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3438: provided (no distribution file is required). Usually it is the pkgsrc
3439: directory name together with the version number. It must match the
3440: regular expression
3441: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3442: starts with a letter or digit, and contains only letters, digits,
3443: dashes, underscores, dots and plus signs.</p></li>
3444: <li class="listitem">
3445: <p><code class="varname">CATEGORIES</code> is a list of categories
3446: which the package fits in. You can choose any of the top-level
3447: directories of pkgsrc for it.</p>
3448: <p>Currently the following values are available for
3449: <code class="varname">CATEGORIES</code>. If more than
3450: one is used, they need to be separated by spaces:</p>
1.1 dsieger 3451: <pre class="programlisting">
1.184 rillig 3452: archivers cross geography meta-pkgs security
3453: audio databases graphics misc shells
3454: benchmarks devel ham multimedia sysutils
3455: biology editors inputmethod net textproc
3456: cad emulators lang news time
3457: chat finance mail parallel wm
3458: comms fonts math pkgtools www
3459: converters games mbone print x11
1.1 dsieger 3460: </pre>
3461: </li>
1.184 rillig 3462: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3463: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3464: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3465: and <code class="varname">DISTFILES</code> are discussed in detail in
3466: <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>
3467: </ul></div>
3468: <p>The second section contains information about separately
3469: downloaded patches, if any.
3470: </p>
3471: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3472: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3473: Name(s) of additional files that contain distribution patches.
3474: There is no default. pkgsrc will look for them at
3475: <code class="varname">PATCH_SITES</code>.
3476: They will automatically be uncompressed before patching if
3477: the names end with <code class="filename">.gz</code> or
3478: <code class="filename">.Z</code>.</p></li>
3479: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3480: Primary location(s) for distribution patch files (see
3481: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3482: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
3483: an argument to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
3484: help find the correct files to patch. It defaults to
3485: <span class="command"><strong>-p0</strong></span>.</p></li>
3486: </ul></div>
3487: <p>The third section contains the following variables.
3488: </p>
3489: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3490: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
3491: address of the person who feels responsible for this package,
3492: and who is most likely to look at problems or questions regarding
3493: this package which have been reported with <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
3494: Other developers may contact the <code class="varname">MAINTAINER</code>
3495: before making changes to the package, but are not required to
3496: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3497: to yourself. If you really can't maintain the package for future
3498: updates, set it to
3499: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
3500: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
3501: of <code class="varname">MAINTAINER</code> when you do not want other
3502: developers to update or change the package without contacting
3503: you first. A package Makefile should contain one of
3504: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3505: not both. </p></li>
3506: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3507: find more information about the package.</p></li>
3508: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3509: description of the package (should not include the package
3510: name).</p></li>
3511: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3512: 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>
3513: </ul></div>
3514: <p>Other variables that affect the build:
3515: </p>
3516: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3517: <p><code class="varname">WRKSRC</code>: The directory where the
3518: interesting distribution files of the package are found. The
3519: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3520: works for most packages.</p>
3521: <p>If a package doesn't create a subdirectory for itself
3522: (most GNU software does, for instance), but extracts itself in
3523: the current directory, you should set
3524: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3525: <p>If a package doesn't create a subdirectory with the
3526: name of <code class="varname">DISTNAME</code> but some different name,
3527: set <code class="varname">WRKSRC</code> to point to the proper name in
3528: <code class="filename">${WRKDIR}</code>, for example
3529: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
3530: <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>
3531: <p>The name of the working directory created by pkgsrc is
3532: taken from the <code class="varname">WRKDIR_BASENAME</code>
3533: variable. By default, its value is
3534: <code class="filename">work</code>. If you want to use the same
3535: pkgsrc tree for building different kinds of binary packages,
3536: you can change the variable according to your needs. Two
3537: other variables handle common cases of setting
3538: <code class="varname">WRKDIR_BASENAME</code> individually. If
3539: <code class="varname">OBJHOSTNAME</code> is defined in
3540: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3541: the host's name is attached to the directory name. If
3542: <code class="varname">OBJMACHINE</code> is defined, the platform name
3543: is attached, which might look like
3544: <code class="filename">work.i386</code> or
3545: <code class="filename">work.sparc</code>.</p>
3546: </li></ul></div>
3547: <p>Please pay attention to the following gotchas:</p>
3548: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3549: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3550: installed in compressed form by the package. For packages using
3551: BSD-style makefiles which honor MANZ, there is
3552: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3553: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3554: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3555: below).</p></li>
3556: <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>
3557: </ul></div>
3558: </div>
1.41 asau 3559: <div class="sect1">
1.1 dsieger 3560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 3561: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3562: </h2></div></div></div>
3563: <p>The <code class="filename">distinfo</code> file contains the message
3564: digest, or checksum, of each distfile needed for the package. This
3565: ensures that the distfiles retrieved from the Internet have not been
3566: corrupted during transfer or altered by a malign force to introduce
3567: a security hole. To provide maximum security, all distfiles are
3568: protected using three different message digest algorithms (SHA1,
3569: RMD160, SHA512), as well as the file size.</p>
3570: <p>The <code class="filename">distinfo</code> file also contains the
3571: checksums for all the patches found in the
3572: <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
3573: are only applied intentionally and that they don't accidentally change,
3574: e.g. when merging different changes together. They also make sure that
3575: new patches are actually added to CVS and old ones are removed.
3576: Too see whether the patches and the <code class="filename">distinfo</code> file
3577: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3578: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3579: <span class="command"><strong>make distinfo</strong></span> command.</p>
3580: <p>Some packages have different sets of distfiles depending on
3581: 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
3582: <code class="filename">distinfo</code> file and care should be taken when
3583: upgrading such a package to ensure distfile information is not
3584: lost.</p>
3585: </div>
3586: <div class="sect1">
3587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3588: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3589: </h2></div></div></div>
3590: <p>Some packages don't work out-of-the box on the various
3591: platforms that are supported by pkgsrc. These packages need
3592: to be patched to make them work. The patch files can be
3593: found in the <code class="filename">patches/</code> directory.</p>
3594: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3595: applied to the files in <code class="varname">WRKSRC</code> directory after
3596: extracting them, in alphabetic order.</p>
1.41 asau 3597: <div class="sect2">
1.1 dsieger 3598: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3599: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3600: <p>The <code class="filename">patch-*</code> files should be in
3601: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3602: problems. (To force patches to apply with fuzz you can set
3603: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3604: should contain only changes for a single file, and no file should be
3605: patched by more than one patch file. This helps to keep future
3606: modifications simple.</p>
3607: <p>Each patch file is structured as follows: In the first line,
3608: there is the RCS Id of the patch itself. The second line should be
3609: empty for aesthetic reasons. After that, there should be a comment for
3610: each change that the patch does. There are a number of standard
3611: cases:</p>
3612: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3613: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3614: mention the vulnerability ID (CAN, CVE).</p></li>
3615: <li class="listitem"><p>Patches that change source code should mention the
3616: platform and other environment (for example, the compiler) that the
3617: patch is needed for.</p></li>
3618: </ul></div>
3619: <p>The patch should be commented so that any
3620: developer who knows the code of the application can make some use of
3621: the patch. Special care should be taken for the upstream developers,
3622: since we generally want that they accept our patches, so we have less
3623: work in the future.</p>
1.1 dsieger 3624: </div>
1.41 asau 3625: <div class="sect2">
1.1 dsieger 3626: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3627: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3628: <p>One important thing to mention is to pay attention that no RCS
3629: IDs get stored in the patch files, as these will cause problems when
3630: later checked into the NetBSD CVS tree. Use the
3631: <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
3632: problems.</p>
3633: <p>For even more automation, we recommend using
3634: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
3635: whole set of patches. You just have to backup files before you
3636: edit them to <code class="filename">filename.orig</code>, e.g. with
3637: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3638: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3639: you upgrade a package this way, you can easily compare the new
3640: set of patches with the previously existing one with
3641: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3642: are replaced by new files, so carefully check if you want to take all
3643: the changes.</p>
3644: <p>When you have finished a package, remember to generate
3645: the checksums for the patch files by using the <span class="command"><strong>make
3646: 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>
3647: <p>When adding a patch that corrects a problem in the
3648: distfile (rather than e.g. enforcing pkgsrc's view of where
3649: man pages should go), send the patch as a bug report to the
3650: maintainer. This benefits non-pkgsrc users of the package,
3651: and usually makes it possible to remove the patch in future
3652: version.</p>
3653: <p>The file names of the patch files are usually of the form
3654: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3655: Many packages still use the previous convention
3656: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3657: but new patches should be of the form containing the filename.
3658: <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
3659: automatically.</p>
1.17 imil 3660: </div>
1.160 brook 3661: <div class="sect2">
3662: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3663: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3664: <p>If you want to share patches between multiple packages
3665: in pkgsrc, e.g. because they use the same distfiles, set
3666: <code class="varname">PATCHDIR</code> to the path where the patch files
3667: can be found, e.g.:</p>
3668: <pre class="programlisting">
3669: PATCHDIR= ../../editors/xemacs/patches
3670: </pre>
3671: <p>Patch files that are distributed by the author or other
3672: maintainers can be listed in
3673: <code class="varname">PATCHFILES</code>.</p>
3674: <p>If it is desired to store any patches that should not be
3675: committed into pkgsrc, they can be kept outside the pkgsrc
3676: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3677: directory tree there is expected to have the same
3678: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3679: patches are expected to be stored inside these dirs (also
3680: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3681: example, if you want to keep a private patch for
3682: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3683: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3684: files in the named directory are expected to be patch files,
3685: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3686: applied</em></span>.</p>
1.160 brook 3687: </div>
3688: <div class="sect2">
3689: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3690: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3691: <p>When fixing a portability issue in the code do not use
3692: preprocessor magic to check for the current operating system nor
3693: platform. Doing so hurts portability to other platforms because
3694: the OS-specific details are not abstracted appropriately.</p>
3695: <p>The general rule to follow is: instead of checking for the
3696: operating system the application is being built on, check for the
3697: specific <span class="emphasis"><em>features</em></span> you need. For example,
3698: instead of assuming that kqueue is available under NetBSD and
3699: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3700: kqueue support, add a check that detects kqueue itself —
3701: yes, this generally involves patching the
3702: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3703: that prevents some OSes from adopting interfaces from other OSes
3704: (e.g. Linux implementing kqueue), something that the above checks
3705: cannot take into account.</p>
3706: <p>Of course, checking for features generally involves more
3707: work on the developer's side, but the resulting changes are
3708: cleaner and there are chances they will work on many other
3709: platforms. Not to mention that there are higher chances of being
3710: later integrated into the mainstream sources. Remember:
3711: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3712: <p>Some typical examples:</p>
3713: <div class="table">
3714: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3715: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3716: <colgroup>
3717: <col>
3718: <col>
3719: <col>
3720: </colgroup>
3721: <thead><tr>
3722: <th>Where</th>
3723: <th>Incorrect</th>
3724: <th>Correct</th>
3725: </tr></thead>
3726: <tbody>
3727: <tr>
3728: <td>configure script</td>
3729: <td>
1.160 brook 3730: <pre class="programlisting">
1.184 rillig 3731: case ${target_os} in
3732: netbsd*) have_kvm=yes ;;
3733: *) have_kvm=no ;;
3734: esac
1.160 brook 3735: </pre>
1.184 rillig 3736: </td>
3737: <td>
1.160 brook 3738: <pre class="programlisting">
1.184 rillig 3739: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.160 brook 3740: </pre>
1.184 rillig 3741: </td>
3742: </tr>
3743: <tr>
3744: <td>C source file</td>
3745: <td>
1.1 dsieger 3746: <pre class="programlisting">
1.184 rillig 3747: #if defined(__NetBSD__)
3748: # include <sys/event.h>
3749: #endif
1.1 dsieger 3750: </pre>
1.184 rillig 3751: </td>
3752: <td>
1.1 dsieger 3753: <pre class="programlisting">
1.184 rillig 3754: #if defined(HAVE_SYS_EVENT_H)
3755: # include <sys/event.h>
3756: #endif
1.1 dsieger 3757: </pre>
1.184 rillig 3758: </td>
3759: </tr>
3760: <tr>
3761: <td>C source file</td>
3762: <td>
1.1 dsieger 3763: <pre class="programlisting">
1.184 rillig 3764: int
3765: monitor_file(...)
3766: {
3767: #if defined(__NetBSD__)
3768: int fd = kqueue();
3769: ...
3770: #else
3771: ...
3772: #endif
3773: }
1.1 dsieger 3774: </pre>
1.184 rillig 3775: </td>
3776: <td>
1.1 dsieger 3777: <pre class="programlisting">
1.184 rillig 3778: int
3779: monitor_file(...)
3780: {
3781: #if defined(HAVE_KQUEUE)
3782: int fd = kqueue();
3783: ...
3784: #else
3785: ...
3786: #endif
3787: }
1.1 dsieger 3788: </pre>
1.184 rillig 3789: </td>
3790: </tr>
3791: </tbody>
3792: </table></div>
3793: </div>
3794: <br class="table-break">
3795: </div>
3796: <div class="sect2">
3797: <div class="titlepage"><div><div><h3 class="title">
3798: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3799: <p>Always, always, <span class="strong"><strong>always</strong></span>
3800: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3801: improvements you do to a package to the mainstream developers.
3802: This is the only way to get their attention on portability issues
3803: and to ensure that future versions can be built out-of-the box on
3804: NetBSD. Furthermore, any user that gets newer distfiles will get
3805: the fixes straight from the packaged code.</p>
3806: <p>This generally involves cleaning up the patches
3807: (because sometimes the patches that are
3808: added to pkgsrc are quick hacks), filing bug reports in the
3809: appropriate trackers for the projects and working with the
3810: mainstream authors to accept your changes. It is
3811: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3812: the packages in pkgsrc are kept simple and thus further changes
3813: can be done without much hassle.</p>
3814: <p>When you have done this, please add a URL to the upstream
3815: bug report to the patch comment.</p>
3816: <p>Support the idea of free software!</p>
3817: </div>
1.1 dsieger 3818: </div>
1.184 rillig 3819: <div class="sect1">
3820: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3821: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3822: <div class="variablelist"><dl class="variablelist">
3823: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3824: <dd><p>A multi-line description of the piece of software. This should include
3825: any credits where they are due. Please bear in mind that others do not
3826: share your sense of humour (or spelling idiosyncrasies), and that others
3827: will read everything that you write here.</p></dd>
3828: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3829: <dd><p>This file governs the files that are installed on your
3830: system: all the binaries, manual pages, etc. There are other
3831: directives which may be entered in this file, to control the
3832: creation and deletion of directories, and the location of
3833: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3834: information.</p></dd>
3835: </dl></div>
3836: </div>
3837: <div class="sect1">
3838: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3839: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3840: <div class="sect2">
3841: <div class="titlepage"><div><div><h3 class="title">
3842: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3843: <div class="variablelist"><dl class="variablelist">
3844: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3845: <dd>
3846: <p>This shell script is invoked twice by <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
3847: First time after package extraction and before files are
3848: moved in place, the second time after the files to install
3849: are moved in place. This can be used to do any custom
3850: procedures not possible with @exec commands in
3851: <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
3852: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-9.0"><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>.
3853: Please note that you can modify variables in it easily by using
3854: <code class="varname">FILES_SUBST</code> in the package's
3855: <code class="filename">Makefile</code>:</p>
1.1 dsieger 3856: <pre class="programlisting">
1.184 rillig 3857: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3858: </pre>
1.184 rillig 3859: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3860: <code class="filename">INSTALL</code>. By default, substitution is
3861: performed for <code class="varname">PREFIX</code>,
3862: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3863: <code class="varname">VARBASE</code>, and a few others, type
3864: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3865: complete list.</p>
3866: </dd>
3867: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3868: <dd><p>This script is executed before and after any files are removed. It is
3869: this script's responsibility to clean up any additional messy details
3870: around the package's installation, since all pkg_delete knows is how to
3871: delete the files created in the original distribution.
3872: See <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
3873: and <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
3874: The same methods to replace variables can be used as for
3875: the <code class="filename">INSTALL</code> file.</p></dd>
3876: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3877: <dd>
3878: <p>This file is displayed after installation of the package.
3879: Useful for things like legal notices on almost-free
3880: software and hints for updating config files after
3881: installing modules for apache, PHP etc.
3882: Please note that you can modify variables in it easily by using
3883: <code class="varname">MESSAGE_SUBST</code> in the package's
3884: <code class="filename">Makefile</code>:</p>
1.1 dsieger 3885: <pre class="programlisting">
1.184 rillig 3886: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3887: </pre>
1.184 rillig 3888: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
3889: <code class="filename">MESSAGE</code>. By default, substitution is
3890: performed for <code class="varname">PKGNAME</code>,
3891: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
3892: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3893: <code class="varname">PKG_SYSCONFDIR</code>,
3894: <code class="varname">ROOT_GROUP</code>, and
3895: <code class="varname">ROOT_USER</code>.</p>
3896: <p>You can display a different or additional files by
3897: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3898: default is <code class="filename">MESSAGE</code>, if the file
3899: exists.</p>
3900: </dd>
3901: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
3902: <dd>
3903: <p>This file is used by the alternatives framework.
3904: It creates, configures, and destroys generic wrappers used to
3905: run programs with similar interfaces.
3906: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3907: for more information.</p>
3908: <p>Each line of the file contains two filenames, first
3909: the wrapper and then the alternative provided by the package.
3910: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3911: </dd>
3912: </dl></div>
3913: </div>
3914: <div class="sect2">
3915: <div class="titlepage"><div><div><h3 class="title">
3916: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
3917: <div class="variablelist"><dl class="variablelist">
3918: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3919: <dd><p>This file contains arbitrary things that could
3920: also go into a <code class="filename">Makefile</code>, but its purpose is
3921: to be used by more than one package. This file should only be
3922: used when the packages that will use the file are known in
3923: advance. For other purposes it is often better to write a
3924: <code class="filename">*.mk</code> file and give it a good name that
3925: describes what it does.</p></dd>
3926: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3927: <dd><p>This file contains the dependency information
3928: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
3929: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3930: <dd><p>This file contains workarounds for compiler bugs
3931: and similar things. It is included automatically by the pkgsrc
3932: infrastructure, so you don't need an extra
3933: <code class="literal">.include</code> line for
3934: it.</p></dd>
3935: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3936: <dd><p>This file contains the code for the
3937: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
3938: selected by the user. If a package has only one or two options,
3939: it is equally acceptable to put the code directly into the
3940: <code class="filename">Makefile</code>.</p></dd>
3941: </dl></div>
3942: </div>
3943: <div class="sect2">
3944: <div class="titlepage"><div><div><h3 class="title">
3945: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
3946: <div class="variablelist"><dl class="variablelist">
3947: <dt><span class="term"><code class="filename">README*</code></span></dt>
3948: <dd><p>These files do not take place in the creation of
3949: a package and thus are purely informative to the package
3950: developer.</p></dd>
3951: <dt><span class="term"><code class="filename">TODO</code></span></dt>
3952: <dd><p>This file contains things that need to be done
3953: to make the package even
3954: better.</p></dd>
3955: </dl></div>
3956: </div>
3957: </div>
3958: <div class="sect1">
3959: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3960: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
3961: </h2></div></div></div>
3962: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
3963: unpacked into the directory denoted by
3964: <code class="varname">WRKDIR</code>. It can be removed by running
3965: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
3966: directory is also used to keep various timestamp files.
3967: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
3968: The default is <code class="filename">${.CURDIR}/work</code>
3969: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
3970: if <code class="varname">OBJMACHINE</code> is set.</p>
1.1 dsieger 3971: </div>
1.184 rillig 3972: <div class="sect1">
3973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3974: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
3975: </h2></div></div></div>
3976: <p>If you have any files that you wish to be placed in the package
3977: prior to configuration or building, you can place these files here
3978: and use a <span class="command"><strong>${CP}</strong></span> command in the
3979: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
3980: <p>If you want to share files in this way with other
3981: packages, set the <code class="varname">FILESDIR</code> variable to point
3982: to the other package's <code class="filename">files</code> directory,
3983: e.g.:</p>
1.1 dsieger 3984: <pre class="programlisting">
1.184 rillig 3985: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 3986: </pre>
3987: </div>
3988: </div>
1.41 asau 3989: <div class="chapter">
1.1 dsieger 3990: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 3991: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.1 dsieger 3992: <div class="toc">
3993: <p><b>Table of Contents</b></p>
1.100 leot 3994: <dl class="toc">
1.184 rillig 3995: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3996: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3997: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3998: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3999: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4000: <dd><dl>
4001: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4002: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4003: </dl></dd>
4004: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4005: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4006: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4007: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4008: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4009: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4010: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4011: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4012: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4013: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4014: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4015: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.1 dsieger 4016: </dl>
4017: </div>
1.41 asau 4018: <div class="sect1">
1.1 dsieger 4019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4020: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4021: <p>This chapter gives a detailed description on how a package is
4022: built. Building a package is separated into different
4023: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4024: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4025: described in the following sections. Each phase is split into
4026: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4027: containing phase, prefixed by one of <code class="varname">pre-</code>,
4028: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4029: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4030: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4031: <p>Never override the regular targets (like
4032: <code class="varname">fetch</code>), if you have to, override the
4033: <code class="varname">do-*</code> ones instead.</p>
4034: <p>The basic steps for building a program are always the same. First
4035: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4036: the local system and then extracted. After any pkgsrc-specific patches
4037: to compile properly are applied, the software can be configured, then
4038: built (usually by compiling), and finally the generated binaries, etc.
4039: can be put into place on the system.</p>
4040: <p>To get more details about what is happening at each step,
4041: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4042: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4043: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4044: </div>
4045: <div class="sect1">
4046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4047: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4048: <p>Before outlining the process performed by the NetBSD package system in
4049: the next section, here's a brief discussion on where programs are
4050: installed, and which variables influence this.</p>
4051: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4052: where all files of the final program shall be installed. It is
4053: usually set to <code class="varname">LOCALBASE</code>
4054: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4055: for pkgs in the <code class="filename">cross</code> category. The value of
4056: <code class="varname">PREFIX</code> needs to be put
4057: into the various places in the program's source where paths to
4058: 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>
4059: <p>When choosing which of these variables to use,
4060: follow the following rules:</p>
1.41 asau 4061: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 4062: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4063: where the current pkg will be installed. When referring to a
4064: pkg's own installation path, use
4065: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
4066: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
4067: are installed. If you need to construct a -I or -L argument
4068: to the compiler to find includes and libraries installed by
4069: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
4070: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4071: installed all packages in <code class="filename">/usr/local</code>. As
4072: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4073: administrator, this variable is a misnomer.</p></li>
4074: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4075: distribution (from xsrc, etc.) is installed. When looking for
4076: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4077: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4078: <li class="listitem"><p>X11-based packages using imake must set
4079: <code class="varname">USE_IMAKE</code> to be installed correctly under
4080: <code class="varname">LOCALBASE</code>.</p></li>
4081: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
4082: install files according to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
4083: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4084: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4085: </ul></div>
4086: </div>
4087: <div class="sect1">
4088: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4089: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4090: <p>When building a package, various directories are used to store
4091: source files, temporary files, pkgsrc-internal files, and so on. These
4092: directories are explained here.</p>
4093: <p>Some of the directory variables contain relative pathnames. There
4094: are two common base directories for these relative directories:
4095: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4096: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4097: inside the package itself.</p>
4098: <div class="variablelist"><dl class="variablelist">
4099: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4100: <dd><p>This is an absolute pathname that points to the pkgsrc
4101: root directory. Generally, you don't need
4102: it.</p></dd>
4103: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4104: <dd><p>This is an absolute pathname that points to the
4105: current package.</p></dd>
4106: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
4107: <dd><p>This is a pathname relative to
4108: <code class="varname">PKGSRCDIR</code> that points to the current
4109: package.</p></dd>
4110: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4111: <dd><p>This is an absolute pathname pointing to the directory
4112: where all work takes place. The distfiles are extracted to this
4113: directory. It also contains temporary directories and log files used by
4114: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4115: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4116: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4117: <dd><p>This is an absolute pathname pointing to the directory
4118: where the distfiles are extracted. It is usually a direct subdirectory
4119: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4120: that isn't hidden. This variable may be changed by a package
4121: <code class="filename">Makefile</code>.</p></dd>
4122: </dl></div>
4123: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4124: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4125: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4126: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4127: If users would like to have their pkgsrc trees behave in a
4128: read-only manner, then the value of
4129: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4130: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 4131: </div>
1.41 asau 4132: <div class="sect1">
1.1 dsieger 4133: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4134: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4135: <p>You can run a particular phase by typing <span class="command"><strong>make
4136: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
4137: phase. This will automatically run all phases that are required for this
4138: phase. The default phase is <code class="varname">build</code>, that is, when you
4139: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
4140: the package will be built, but not installed.</p>
1.1 dsieger 4141: </div>
1.41 asau 4142: <div class="sect1">
1.1 dsieger 4143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4144: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4145: <p>The first step in building a package is to fetch the
4146: distribution files (distfiles) from the sites that are providing
4147: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4148: phase.</p>
1.41 asau 4149: <div class="sect2">
1.1 dsieger 4150: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 4151: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4152: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4153: defines all URLs from where the distfile, whose name is
4154: derived from the <code class="varname">DISTNAME</code> variable, is
4155: fetched. The more complicated cases are described
4156: below.</p>
4157: <p>The variable <code class="varname">DISTFILES</code> specifies
4158: the list of distfiles that have to be fetched. Its value
4159: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4160: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4161: so that most packages don't need to define it at all.
4162: <code class="varname">EXTRACT_SUFX</code> is
4163: <code class="literal">.tar.gz</code> by default, but can be changed
4164: freely. Note that if your package requires additional
4165: distfiles to the default one, you cannot just append the
4166: additional filenames using the <code class="literal">+=</code>
4167: operator, but you have write for example:</p>
4168: <pre class="programlisting">
4169: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4170: </pre>
4171: <p>Each distfile is fetched from a list of sites, usually
4172: <code class="varname">MASTER_SITES</code>. If the package has multiple
4173: <code class="varname">DISTFILES</code> or multiple
4174: <code class="varname">PATCHFILES</code> from different sites, you can
4175: set
4176: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4177: to the list of URLs where the file
4178: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4179: (including the suffix) can be found.</p>
4180: <pre class="programlisting">
4181: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4182: DISTFILES+= foo-file.tar.gz
4183: SITES.foo-file.tar.gz= \
4184: https://www.somewhere.com/somehow/ \
4185: https://www.somewhereelse.com/mirror/somehow/
4186: </pre>
4187: <p>When actually fetching the distfiles, each item from
4188: <code class="varname">MASTER_SITES</code> or
4189: <code class="varname">SITES.*</code> gets the name of each distfile
4190: appended to it, without an intermediate slash. Therefore,
4191: all site values have to end with a slash or other separator
4192: character. This allows for example to set
4193: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4194: that gets the name of the distfile as a parameter. In this
4195: case, the definition would look like:</p>
4196: <pre class="programlisting">
4197: MASTER_SITES= https://www.example.com/download.cgi?file=
4198: </pre>
4199: <p> The exception to this rule are URLs starting with a dash.
4200: In that case the URL is taken as is, fetched and the result
4201: stored under the name of the distfile. You can use this style
4202: for the case when the download URL style does not match the
4203: above common case. For example, if permanent download URL is a
4204: redirector to the real download URL, or the download file name
4205: is offered by an HTTP Content-Disposition header. In the
4206: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4207: created instead of the default
4208: <code class="filename">v1.0.0.tar.gz</code>.</p>
4209: <pre class="programlisting">
4210: DISTNAME= foo-1.0.0
4211: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4212: </pre>
4213: <p>There are some predefined values for
4214: <code class="varname">MASTER_SITES</code>, which can be used in
4215: packages. The names of the variables should speak for
4216: themselves.</p>
4217: <table border="0" summary="Simple list" class="simplelist">
4218: <tr>
4219: <td>MASTER_SITE_APACHE</td>
4220: <td>MASTER_SITE_BACKUP</td>
4221: </tr>
4222: <tr>
4223: <td>MASTER_SITE_CRATESIO</td>
4224: <td>MASTER_SITE_CYGWIN</td>
4225: </tr>
4226: <tr>
4227: <td>MASTER_SITE_DEBIAN</td>
4228: <td>MASTER_SITE_FREEBSD</td>
4229: </tr>
4230: <tr>
4231: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4232: <td>MASTER_SITE_GENTOO</td>
4233: </tr>
4234: <tr>
4235: <td>MASTER_SITE_GITHUB</td>
4236: <td>MASTER_SITE_GNOME</td>
4237: </tr>
4238: <tr>
4239: <td>MASTER_SITE_GNU</td>
4240: <td>MASTER_SITE_GNUSTEP</td>
4241: </tr>
4242: <tr>
4243: <td>MASTER_SITE_HASKELL_HACKAGE</td>
4244: <td>MASTER_SITE_IFARCHIVE</td>
4245: </tr>
4246: <tr>
4247: <td>MASTER_SITE_KDE</td>
4248: <td>MASTER_SITE_MOZILLA</td>
4249: </tr>
4250: <tr>
4251: <td>MASTER_SITE_MOZILLA_ALL</td>
4252: <td>MASTER_SITE_MYSQL</td>
4253: </tr>
4254: <tr>
4255: <td>MASTER_SITE_NETLIB</td>
4256: <td>MASTER_SITE_OPENBSD</td>
4257: </tr>
4258: <tr>
4259: <td>MASTER_SITE_OPENOFFICE</td>
4260: <td>MASTER_SITE_OSDN</td>
4261: </tr>
4262: <tr>
4263: <td>MASTER_SITE_PERL_CPAN</td>
4264: <td>MASTER_SITE_PGSQL</td>
4265: </tr>
4266: <tr>
4267: <td>MASTER_SITE_PYPI</td>
4268: <td>MASTER_SITE_RUBYGEMS</td>
4269: </tr>
4270: <tr>
4271: <td>MASTER_SITE_R_CRAN</td>
4272: <td>MASTER_SITE_SOURCEFORGE</td>
4273: </tr>
1.1 dsieger 4274: <tr>
1.184 rillig 4275: <td>MASTER_SITE_SUNSITE</td>
4276: <td>MASTER_SITE_SUSE</td>
1.1 dsieger 4277: </tr>
4278: <tr>
1.184 rillig 4279: <td>MASTER_SITE_TEX_CTAN</td>
4280: <td>MASTER_SITE_XCONTRIB</td>
1.1 dsieger 4281: </tr>
4282: <tr>
1.184 rillig 4283: <td>MASTER_SITE_XEMACS</td>
4284: <td>MASTER_SITE_XORG</td>
4285: </tr>
4286: </table>
4287: <p>Some explanations for the less self-explaining ones:
4288: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
4289: 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
4290: 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>
4291: <p>If you choose one of these predefined sites, you may
4292: want to specify a subdirectory of that site. Since these
4293: macros may expand to more than one actual site, you
4294: <span class="emphasis"><em>must</em></span> use the following construct to
4295: specify a subdirectory:</p>
1.1 dsieger 4296: <pre class="programlisting">
1.184 rillig 4297: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4298: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 4299: </pre>
1.184 rillig 4300: <p>Note the trailing slash after the subdirectory
4301: name.</p>
4302: </div>
4303: <div class="sect2">
4304: <div class="titlepage"><div><div><h3 class="title">
4305: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4306: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4307: all the distfiles exist in a local directory
4308: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4309: user). If the files do not exist, they are fetched using
4310: commands of the form</p>
1.1 dsieger 4311: <pre class="programlisting">
1.184 rillig 4312: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4313: </pre>
4314: <p>where <code class="literal">${site}</code> varies through
4315: several possibilities in turn: first,
4316: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4317: sites specified in either <code class="varname">SITES.file</code> if
4318: defined, else <code class="varname">MASTER_SITES</code> or
4319: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4320: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4321: all except the first and the last can be optionally sorted
4322: by the user, via setting either
4323: <code class="varname">MASTER_SORT_RANDOM</code>, and
4324: <code class="varname">MASTER_SORT_AWK</code> or
4325: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4326: <p> The specific command and arguments used depend on the
4327: <code class="varname">FETCH_USING</code> parameter. The example above is
4328: for <code class="literal">FETCH_USING=custom</code>.</p>
4329: <p>The distfiles mirror run by the NetBSD Foundation uses the
4330: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4331: distfiles, if they are freely distributable. Packages setting
4332: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4333: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4334: mirrored.</p>
1.1 dsieger 4335: </div>
4336: </div>
1.184 rillig 4337: <div class="sect1">
4338: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4339: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4340: <p>After the distfile(s) are fetched, their checksum is
4341: generated and compared with the checksums stored in the
4342: distinfo file. If the checksums don't match, the build is
4343: aborted. This is to ensure the same distfile is used for
4344: building, and that the distfile wasn't changed, e.g. by some
4345: malign force, deliberately changed distfiles on the master
4346: distribution site or network lossage.</p>
1.1 dsieger 4347: </div>
1.41 asau 4348: <div class="sect1">
1.1 dsieger 4349: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4350: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4351: <p>When the distfiles are present on the local system, they
4352: need to be extracted, as they usually come in the form of some
4353: compressed archive format.</p>
4354: <p>By default, all <code class="varname">DISTFILES</code> are
4355: extracted. If you only need some of them, you can set the
4356: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4357: files.</p>
4358: <p>Extracting the files is usually done by a little
4359: program, <code class="filename">mk/extract/extract</code>, which
4360: already knows how to extract various archive formats, so most
4361: likely you will not need to change anything here. But if you
4362: need, the following variables may help you:</p>
1.41 asau 4363: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4364: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4365: <dd><p>Use these variables to override the default
4366: options for an extract command, which are defined in
4367: <code class="filename">mk/extract/extract</code>.</p></dd>
4368: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4369: <dd><p>This variable can be set to
4370: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4371: (which is the default value), <code class="literal">pax</code>, or an
4372: absolute pathname pointing to the command with which tar
4373: archives should be extracted. It is preferred to choose bsdtar over gtar
4374: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 4375: </dl></div>
1.184 rillig 4376: <p>If the <code class="filename">extract</code> program doesn't
4377: serve your needs, you can also override the
4378: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4379: command used for extracting the files. This command is
4380: executed in the <code class="filename">${WRKSRC}</code>
4381: directory. During execution of this command, the shell
4382: variable <code class="varname">extract_file</code> holds the absolute
4383: pathname of the file that is going to be extracted.</p>
4384: <p>And if that still does not suffice, you can override the
4385: <code class="varname">do-extract</code> target in the package
4386: Makefile.</p>
1.1 dsieger 4387: </div>
1.41 asau 4388: <div class="sect1">
1.1 dsieger 4389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4390: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4391: <p>After extraction, all the patches named by the
4392: <code class="varname">PATCHFILES</code>, those present in the patches
4393: subdirectory of the package as well as in
4394: $LOCALPATCHES/$PKGPATH (e.g.
4395: <code class="filename">/usr/local/patches/graphics/png</code>) are
4396: applied. Patchfiles ending in <code class="filename">.Z</code> or
4397: <code class="filename">.gz</code> are uncompressed before they are
4398: applied, files ending in <code class="filename">.orig</code> or
4399: <code class="filename">.rej</code> are ignored. Any special options to
4400: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
4401: <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>
4402: <p>By default <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
4403: fail if the expected text from the patch context is not found in the
4404: patched file. If that happens, fix the patch file by comparing it
4405: with the actual text in the file to be patched.</p>
1.1 dsieger 4406: </div>
1.41 asau 4407: <div class="sect1">
1.1 dsieger 4408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4409: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4410: <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>.
4411: </p>
1.1 dsieger 4412: </div>
1.41 asau 4413: <div class="sect1">
1.1 dsieger 4414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4415: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4416: <p>This phase creates wrapper programs for the compilers and
4417: linkers. The following variables can be used to tweak the
4418: wrappers.</p>
4419: <div class="variablelist"><dl class="variablelist">
4420: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4421: <dd><p>The command used to print progress
4422: messages. Does nothing by default. Set to
4423: <code class="literal">${ECHO}</code> to see the progress
4424: messages.</p></dd>
4425: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4426: <dd><p>This variable can be set to
4427: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4428: depending on whether you want additional information in the
4429: wrapper log file.</p></dd>
4430: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4431: <dd><p>This variable can be set to
4432: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4433: on whether the wrapper should use its cache, which will
4434: improve the speed. The default value is
4435: <code class="literal">yes</code>, but is forced to
4436: <code class="literal">no</code> if the platform does not support
4437: it.</p></dd>
4438: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4439: <dd><p>A list of reordering commands. A reordering
4440: command has the form
4441: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4442: It ensures that that
4443: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4444: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4445: </p></dd>
4446: </dl></div>
4447: </div>
4448: <div class="sect1">
4449: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4450: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4451: <p>Most pieces of software need information on the header
4452: files, system calls, and library routines which are available
4453: on the platform they run on. The process of determining this
4454: information is known as configuration, and is usually
4455: automated. In most cases, a script is supplied with the
4456: distfiles, and its invocation results in generation of header
4457: files, Makefiles, etc.</p>
4458: <p>If the package contains a configure script, this can be
4459: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4460: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4461: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.187 rillig 4462: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4463: <p>In the <code class="literal">do-configure</code> stage, a rough
4464: equivalent of the following command is run. See
4465: <code class="filename">mk/configure/configure.mk</code>, target
4466: <code class="literal">do-configure-script</code> for the exact
4467: definition.</p>
4468: <pre class="programlisting">
4469: .for dir in ${CONFIGURE_DIRS}
4470: cd ${WRKSRC} && cd ${dir} \
4471: && env ${CONFIGURE_ENV} \
4472: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 4473: .endfor
1.1 dsieger 4474: </pre>
1.184 rillig 4475: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4476: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4477: <code class="varname">WRKSRC</code>. In each of these directories, the
4478: configure script is run with the environment
4479: <code class="varname">CONFIGURE_ENV</code> and arguments
4480: <code class="varname">CONFIGURE_ARGS</code>. The variables
4481: <code class="varname">CONFIGURE_ENV</code>,
4482: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4483: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4484: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4485: package.</p>
4486: <p>If the program uses the Perl way of configuration (mainly Perl
4487: modules, but not only), i.e. a file called
4488: <code class="filename">Makefile.PL</code>, it should include
4489: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4490: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4491: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4492: <p>If the program uses an <code class="filename">Imakefile</code>
4493: for configuration, the appropriate steps can be invoked by
4494: setting <code class="varname">USE_IMAKE</code> to
4495: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4496: You can add variables to xmkmf's environment by adding them to the
4497: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4498: <p>If the program uses <code class="filename">cmake</code>
4499: for configuration, the appropriate steps can be invoked by
4500: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
4501: You can add variables to cmake's environment by adding them to the
4502: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
4503: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
4504: The top directory argument is given by the
4505: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
4506: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
4507: <p>If there is no configure step at all, set
4508: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4509: </div>
1.41 asau 4510: <div class="sect1">
1.1 dsieger 4511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4512: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.187 rillig 4513: <p>For building a package, a rough equivalent of the following
4514: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4515: <code class="literal">do-build</code> for the exact definition.</p>
1.1 dsieger 4516: <pre class="programlisting">
1.187 rillig 4517: .for dir in ${BUILD_DIRS}
4518: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 4519: && env ${MAKE_ENV} \
1.187 rillig 4520: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 4521: -f ${MAKE_FILE} \
4522: ${BUILD_TARGET}
4523: .endfor
1.1 dsieger 4524: </pre>
1.184 rillig 4525: <p><code class="varname">BUILD_DIRS</code> (default:
4526: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4527: <code class="varname">WRKSRC</code>. In each of these directories,
4528: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4529: <code class="varname">MAKE_ENV</code> and arguments
4530: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4531: <code class="varname">MAKE_ENV</code>,
4532: <code class="varname">BUILD_MAKE_FLAGS</code>,
4533: <code class="varname">MAKE_FILE</code> and
4534: <code class="varname">BUILD_TARGET</code> may all be changed by the
4535: package.</p>
4536: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4537: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4538: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4539: default value of <code class="varname">MAKE_FILE</code> is
4540: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4541: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4542: <p>If there is no build step at all, set
4543: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4544: </div>
1.41 asau 4545: <div class="sect1">
1.1 dsieger 4546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4547: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4548: <p>[TODO]</p>
1.1 dsieger 4549: </div>
1.41 asau 4550: <div class="sect1">
1.1 dsieger 4551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4552: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4553: <p>Once the build stage has completed, the final step is to
4554: install the software in public directories, so users can
4555: access the programs and files.</p>
1.187 rillig 4556: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4557: of the following code is executed; see
4558: <code class="filename">mk/install/install.mk</code>, target
4559: <code class="literal">do-install</code> for the exact definition. Additionally,
4560: before and after this code, several consistency checks are run
4561: against the files-to-be-installed, see
4562: <code class="filename">mk/check/*.mk</code> for details.</p>
4563: <pre class="programlisting">
4564: .for dir in ${INSTALL_DIRS}
4565: cd ${WRKSRC} && cd ${dir} \
4566: && env ${INSTALL_ENV} ${MAKE_ENV} \
4567: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4568: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 4569: .endfor
1.1 dsieger 4570: </pre>
1.184 rillig 4571: <p>The variable's meanings are analogous to the ones in the
4572: <span class="emphasis"><em>build</em></span> phase.
4573: <code class="varname">INSTALL_DIRS</code> defaults to
4574: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4575: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4576: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4577: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4578: defined.</p>
4579: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4580: variables are useful. They are all variations of the
4581: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
4582: permissions preset. <code class="varname">INSTALL</code> is the plain
4583: install command. The specialized variants, together with their
4584: intended use, are:</p>
4585: <div class="variablelist"><dl class="variablelist">
4586: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4587: <dd><p>directories that contain
4588: binaries</p></dd>
4589: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4590: <dd><p>directories that contain
4591: scripts</p></dd>
4592: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4593: <dd><p>directories that contain shared and static
4594: libraries</p></dd>
4595: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4596: <dd><p>directories that contain data
4597: files</p></dd>
4598: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4599: <dd><p>directories that contain man
4600: pages</p></dd>
4601: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4602: <dd><p>directories that contain data files for games
4603: </p></dd>
4604: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4605: <dd><p>binaries that can be stripped from debugging
4606: symbols</p></dd>
4607: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4608: <dd><p>binaries that cannot be
4609: stripped</p></dd>
4610: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4611: <dd><p>game
4612: binaries</p></dd>
4613: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4614: <dd><p>shared and static
4615: libraries</p></dd>
4616: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4617: <dd><p>data files</p></dd>
4618: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4619: <dd><p>data files for
4620: games</p></dd>
4621: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4622: <dd><p>man pages</p></dd>
4623: </dl></div>
4624: <p>Some other variables are:</p>
4625: <div class="variablelist"><dl class="variablelist">
4626: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
4627: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?strip+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
4628: when installing binaries. Any debugging sections and symbols present in
4629: binaries will be preserved.
4630: </p></dd>
4631: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4632: <dd><p>A list of directories relative to
4633: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4634: beginning of the <span class="emphasis"><em>install</em></span> phase.
4635: The package is supposed to create all needed directories itself
4636: before installing files to it and list all other directories here.
4637: </p></dd>
4638: </dl></div>
4639: <p>In the rare cases that a package shouldn't install anything,
4640: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4641: mostly relevant for packages in the <code class="filename">regress</code>
4642: category.</p>
1.1 dsieger 4643: </div>
1.41 asau 4644: <div class="sect1">
1.1 dsieger 4645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4646: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4647: <p>Once the install stage has completed, a binary package of
4648: the installed files can be built. These binary packages can be
4649: used for quick installation without previous compilation, e.g. by
4650: the <span class="command"><strong>make bin-install</strong></span> or by using
4651: <span class="command"><strong>pkg_add</strong></span>.</p>
4652: <p>By default, the binary packages are created in
4653: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4654: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4655: one for each category in the <code class="varname">CATEGORIES</code>
4656: variable. <code class="varname">PACKAGES</code> defaults to
4657: <code class="filename">pkgsrc/packages</code>.</p>
1.1 dsieger 4658: </div>
1.41 asau 4659: <div class="sect1">
1.1 dsieger 4660: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4661: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4662: <p>Once you're finished with a package, you can clean the work
4663: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4664: to clean the work directories of all dependencies too, use
4665: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 4666: </div>
1.41 asau 4667: <div class="sect1">
1.1 dsieger 4668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4669: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.41 asau 4670: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4671: <dt><span class="term">pre/post-*</span></dt>
4672: <dd>
4673: <p>For any of the main targets described in the previous
4674: section (configure, build, install, etc.), two auxiliary
4675: targets exist with
4676: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4677: prefix for the main target's name. These targets are
4678: invoked before and after the main target is called,
4679: allowing extra configuration or installation steps be
4680: performed from a package's Makefile, for example, which
4681: a program's configure script or install target
4682: omitted.</p>
4683: <p>About 5% of the pkgsrc packages define their custom
4684: post-extract target, another 5% define pre-configure, and 10%
4685: define post-install. The other pre/post-* targets are defined
4686: even less often.</p>
4687: </dd>
4688: <dt><span class="term">do-*</span></dt>
1.1 dsieger 4689: <dd>
1.184 rillig 4690: <p>Should one of the main targets do the wrong thing,
4691: and should there be no variable to fix this, you can
4692: redefine it with the do-* target. (Note that redefining
4693: the target itself instead of the do-* target is a bad
4694: idea, as the pre-* and post-* targets won't be called
4695: anymore, etc.)</p>
4696: <p>About 15% of the pkgsrc packages override the default
4697: do-install, the other do-* targets are overridden even less
4698: often.</p>
1.1 dsieger 4699: </dd>
1.184 rillig 4700: <dt><span class="term">reinstall</span></dt>
1.1 dsieger 4701: <dd>
1.184 rillig 4702: <p>If you did a <span class="command"><strong>make install</strong></span> and
4703: you noticed some file was not installed properly, you
4704: can repeat the installation with this target, which will
4705: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4706: <p>This is the default value of
4707: <code class="varname">DEPENDS_TARGET</code> except in the case of
4708: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4709: package</strong></span>, where the defaults are
4710: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4711: respectively.</p>
1.1 dsieger 4712: </dd>
1.184 rillig 4713: <dt><span class="term">deinstall</span></dt>
4714: <dd>
4715: <p>This target does a <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
4716: current directory, effectively de-installing the
4717: package. The following variables can be used to tune the
4718: behaviour:</p>
4719: <div class="variablelist"><dl class="variablelist">
4720: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
4721: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
4722: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4723: <dd><p>Remove all packages that require (depend on)
4724: the given package. This can be used to remove any
4725: packages that may have been pulled in by a given
4726: package, e.g. if <span class="command"><strong>make deinstall
4727: DEINSTALLDEPENDS=1</strong></span> is done in
4728: <code class="filename">pkgsrc/x11/kde</code>, this is
4729: likely to remove whole KDE. Works by adding
4730: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4731: command line.</p></dd>
4732: </dl></div>
4733: </dd>
4734: <dt><span class="term">bin-install</span></dt>
4735: <dd><p>Install a binary package from local disk and via FTP
4736: from a list of sites (see the
4737: <code class="varname">BINPKG_SITES</code> variable), and do a
4738: <span class="command"><strong>make package</strong></span> if no binary package is
4739: available anywhere. The arguments given to
4740: <span class="command"><strong>pkg_add</strong></span> can be set via
4741: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4742: operation, etc.</p></dd>
4743: <dt><span class="term">install-clean</span></dt>
4744: <dd><p>This target removes the state files for the "install" and later
4745: phases so that the "install" target may be re-invoked. This can be
4746: used after editing the PLIST to install the package without
4747: rebuilding it.</p></dd>
4748: <dt><span class="term">build-clean</span></dt>
4749: <dd><p>This target removes the state files for the "build" and later
4750: phases so that the "build" target may be re-invoked.</p></dd>
4751: <dt><span class="term">update</span></dt>
4752: <dd>
4753: <p>This target causes the current package to be
4754: updated to the latest version. The package and all
4755: depending packages first get de-installed, then current
4756: versions of the corresponding packages get compiled and
4757: installed. This is similar to manually noting which
4758: packages are currently installed, then performing a
4759: series of <span class="command"><strong>make deinstall</strong></span> and
4760: <span class="command"><strong>make install</strong></span> (or whatever
4761: <code class="varname">UPDATE_TARGET</code> is set to) for these
4762: packages.</p>
4763: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4764: resume package updating in case a previous <span class="command"><strong>make
4765: update</strong></span> was interrupted for some reason.
4766: However, in this case, make sure you don't call
4767: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4768: list of dependent packages in <code class="varname">WRKDIR</code>.
4769: Otherwise, you lose the ability to automatically update
4770: the current package along with the dependent packages
4771: you have installed.</p>
4772: <p>Resuming an interrupted <span class="command"><strong>make
4773: update</strong></span> will only work as long as the package
4774: tree remains unchanged. If the source code for one of
4775: the packages to be updated has been changed, resuming
4776: <span class="command"><strong>make update</strong></span> will most certainly
4777: fail!</p>
4778: <p>The following variables can be used either on the
4779: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4780: alter the behaviour of <span class="command"><strong>make
4781: update</strong></span>:</p>
4782: <div class="variablelist"><dl class="variablelist">
4783: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4784: <dd><p>Install target to recursively use for the
4785: updated package and the dependent packages.
4786: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4787: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4788: <span class="command"><strong>make update</strong></span>. Other good
4789: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4790: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4791: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4792: endless loop!</p></dd>
4793: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4794: <dd><p>Don't clean up after updating. Useful if
4795: you want to leave the work sources of the updated
4796: packages around for inspection or other purposes.
4797: Be sure you eventually clean up the source tree
4798: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4799: or you may run into troubles with old source code
4800: still lying around on your next
4801: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4802: update</strong></span>.</p></dd>
4803: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4804: <dd><p>Deinstall each package before installing
4805: (making <code class="varname">DEPENDS_TARGET</code>). This
4806: may be necessary if the
4807: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4808: called after interrupting a running <span class="command"><strong>make
4809: update</strong></span>.</p></dd>
4810: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4811: <dd><p>Allows you to disable recursion and hardcode
4812: the target for packages. The default is
4813: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4814: facilitating a recursive update of prerequisite
4815: packages. Only set
4816: <code class="varname">DEPENDS_TARGET</code> if you want to
4817: disable recursive updates. Use
4818: <code class="varname">UPDATE_TARGET</code> instead to just
4819: set a specific target for each package to be
4820: installed during <span class="command"><strong>make update</strong></span>
4821: (see above).</p></dd>
4822: </dl></div>
4823: </dd>
4824: <dt><span class="term">clean-update</span></dt>
4825: <dd>
4826: <p>Clean the source tree for all packages that would
4827: get updated if <span class="command"><strong>make update</strong></span> was called
4828: from the current directory. This target should not be
4829: used if the current package (or any of its depending
4830: packages) have already been de-installed (e.g., after
4831: calling <span class="command"><strong>make update</strong></span>) or you may lose
4832: some packages you intended to update. As a rule of
4833: thumb: only use this target <span class="emphasis"><em>before</em></span>
4834: the first time you run <span class="command"><strong>make update</strong></span>
4835: and only if you have a dirty package tree (e.g., if you
4836: used <code class="varname">NOCLEAN</code>).</p>
4837: <p>If you are unsure about whether your tree is
4838: clean, you can either perform a <span class="command"><strong>make
4839: clean</strong></span> at the top of the tree, or use the
4840: following sequence of commands from the directory of the
4841: package you want to update (<span class="emphasis"><em>before</em></span>
4842: running <span class="command"><strong>make update</strong></span> for the first
4843: time, otherwise you lose all the packages you wanted to
4844: update!):</p>
4845: <pre class="screen">
4846: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
4847: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
4848: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
4849: </pre>
4850: <p>The following variables can be used either on the
4851: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
4852: <span class="command"><strong>make clean-update</strong></span>:</p>
4853: <div class="variablelist"><dl class="variablelist">
4854: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
4855: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
4856: reconstruct the list of directories to update for
4857: this package. Only use this if <span class="command"><strong>make
4858: update</strong></span> successfully installed all
4859: packages you wanted to update. Normally, this is
4860: done automatically on <span class="command"><strong>make
4861: update</strong></span>, but may have been suppressed by
4862: the <code class="varname">NOCLEAN</code> variable (see
4863: above).</p></dd>
4864: </dl></div>
4865: </dd>
4866: <dt><span class="term">replace</span></dt>
4867: <dd>
4868: <p>Update the installation of the current package. This
4869: differs from update in that it does not replace dependent
4870: 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
4871: target to work.</p>
4872: <p><span class="emphasis"><em>Be careful when using this
4873: target!</em></span> There are no guarantees that dependent
4874: packages will still work, in particular they will most
4875: certainly break if you <span class="command"><strong>make replace</strong></span> a
4876: library package whose shared library major version changed
4877: between your installed version and the new one. For this
4878: reason, this target is not officially supported and only
4879: recommended for advanced users.</p>
4880: </dd>
4881: <dt><span class="term">info</span></dt>
4882: <dd><p>This target invokes <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
4883: package. You can use this to check which version of a
4884: package is installed.</p></dd>
4885: <dt><span class="term">index</span></dt>
4886: <dd>
4887: <p>This is a top-level command, i.e. it should be used in
4888: the <code class="filename">pkgsrc</code> directory. It creates a
4889: database of all packages in the local pkgsrc tree, including
4890: dependencies, comment, maintainer, and some other useful
4891: information. Individual entries are created by running
4892: <span class="command"><strong>make describe</strong></span> in the packages'
4893: directories. This index file is saved as
4894: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
4895: verbose format by running <span class="command"><strong>make
4896: print-index</strong></span>. You can search in it with
4897: <span class="command"><strong>make search
4898: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
4899: extract a list of all packages that depend on a particular
4900: one by running <span class="command"><strong>make show-deps
4901: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
4902: <p>Running this command takes a very long time, some
4903: hours even on fast machines!</p>
4904: </dd>
4905: <dt><span class="term">readme</span></dt>
4906: <dd>
4907: <p>This target generates a
4908: <code class="filename">README.html</code> file, which can be
4909: 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
4910: contain references to any packages which are in the
4911: <code class="varname">PACKAGES</code> directory on the local
4912: host. The generated files can be made to refer to URLs
4913: based on <code class="varname">FTP_PKG_URL_HOST</code> and
4914: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
4915: wanted to generate <code class="filename">README.html</code>
4916: files which pointed to binary packages on the local
4917: machine, in the directory
4918: <code class="filename">/usr/packages</code>, set
4919: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
4920: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
4921: <code class="varname">${PACKAGES}</code> directory and its
4922: subdirectories will be searched for all the binary
4923: packages.</p>
4924: <p>The target can be run at the toplevel or in category
4925: directories, in which case it descends recursively.</p>
4926: </dd>
4927: <dt><span class="term">readme-all</span></dt>
4928: <dd><p>This is a top-level command, run it in
4929: <code class="filename">pkgsrc</code>. Use this target to create a
4930: file <code class="filename">README-all.html</code> which contains a
4931: list of all packages currently available in the NetBSD
4932: Packages Collection, together with the category they belong
4933: to and a short description. This file is compiled from the
4934: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
4935: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
4936: readme</strong></span>.</p></dd>
4937: <dt><span class="term">cdrom-readme</span></dt>
4938: <dd><p>This is very much the same as the
4939: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
4940: used when generating a pkgsrc tree to be written to a
4941: CD-ROM. This target also produces
4942: <code class="filename">README.html</code> files, and can be made
4943: to refer to URLs based on
4944: <code class="varname">CDROM_PKG_URL_HOST</code> and
4945: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
4946: <dt><span class="term">show-distfiles</span></dt>
4947: <dd><p>This target shows which distfiles and patchfiles
4948: are needed to build the package
4949: (<code class="varname">ALLFILES</code>, which contains all
4950: <code class="varname">DISTFILES</code> and
4951: <code class="varname">PATCHFILES</code>, but not
4952: <code class="filename">patches/*</code>).</p></dd>
4953: <dt><span class="term">show-downlevel</span></dt>
4954: <dd><p>This target shows nothing if the package is not
4955: installed. If a version of this package is installed,
4956: but is not the version provided in this version of
4957: pkgsrc, then a warning message is displayed. This target
4958: can be used to show which of your installed packages are
4959: downlevel, and so the old versions can be deleted, and
4960: the current ones added.</p></dd>
4961: <dt><span class="term">show-pkgsrc-dir</span></dt>
4962: <dd><p>This target shows the directory in the pkgsrc
4963: hierarchy from which the package can be built and
4964: installed. This may not be the same directory as the one
4965: from which the package was installed. This target is
4966: intended to be used by people who may wish to upgrade
4967: many packages on a single host, and can be invoked from
4968: the top-level pkgsrc Makefile by using the
4969: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
4970: <dt><span class="term">show-installed-depends</span></dt>
4971: <dd><p>This target shows which installed packages match
4972: the current package's <code class="varname">DEPENDS</code>. Useful
4973: if out of date dependencies are causing build
4974: problems.</p></dd>
4975: <dt><span class="term">print-build-depends-list</span></dt>
4976: <dd><p>This target shows the list of packages that the current package
4977: depends on for building.</p></dd>
4978: <dt><span class="term">print-run-depends-list</span></dt>
4979: <dd><p>This target shows the list of packages that the current package
4980: depends on for running.</p></dd>
4981: <dt><span class="term">check-shlibs</span></dt>
4982: <dd><p>After a package is installed, check all its
4983: binaries and (on ELF platforms) shared libraries to see
4984: if they find the shared libs they need. Run by default
4985: 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>
4986: <dt><span class="term">print-PLIST</span></dt>
4987: <dd>
4988: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
4989: upgraded pkg, this prints out an attempt to generate a
4990: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
4991: -newer work/.extract_done</strong></span>. An attempt is made
4992: to care for shared libs etc., but it is
4993: <span class="emphasis"><em>strongly</em></span> recommended to review the
4994: result before putting it into
4995: <code class="filename">PLIST</code>. On upgrades, it's useful to
4996: diff the output of this command against an already
4997: existing <code class="filename">PLIST</code> file.</p>
4998: <p>If the package installs files via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
4999: other methods that don't update file access times, be
5000: sure to add these files manually to your
5001: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5002: -newer</span>”</span> command used by this target won't catch
5003: them!</p>
5004: <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
5005: information on this target.</p>
5006: </dd>
5007: </dl></div>
5008: </div>
5009: </div>
5010: <div class="chapter">
5011: <div class="titlepage"><div><div><h2 class="title">
5012: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5013: <div class="toc">
5014: <p><b>Table of Contents</b></p>
5015: <dl class="toc">
5016: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5017: <dd><dl>
5018: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
5019: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
5020: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
5021: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
5022: </dl></dd>
5023: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5024: <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>
5025: </dl>
5026: </div>
5027: <p>When you find a package that is not yet in pkgsrc, you
5028: most likely have a URL from where you can download the source
5029: code. Starting with this URL, creating a package involves only a
5030: few steps.</p>
5031: <div class="procedure"><ol class="procedure" type="1">
5032: <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
5033: enable the basic quality checks.</p></li>
5034: <li class="step">
5035: <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
5036: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5037: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5038: <span class="command"><strong>mkpatches</strong></span>:</p>
5039: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5040: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5041: </li>
5042: <li class="step">
5043: <p>Choose one of the top-level directories as the category in
5044: which you want to place your package. You can also create a directory of
5045: your own (maybe called <code class="filename">local</code>). In that category
5046: directory, create another directory for your package and change into
5047: it:</p>
5048: <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>
5049: <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>
5050: </li>
5051: <li class="step">
5052: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
5053: you for a URL. Enter the URL of the distribution file (in most cases a
5054: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
5055: of your package are created automatically. The distribution file is
5056: extracted automatically to fill in some details in the
5057: <code class="filename">Makefile</code> that would otherwise have to be done
5058: manually:</p>
5059: <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>
5060: </li>
5061: <li class="step">
5062: <p>Examine the extracted files to determine the dependencies of
5063: your package. Ideally, this is mentioned in some
5064: <code class="filename">README</code> file, but things may differ. For each of
5065: these dependencies, look where it exists in pkgsrc, and if there is a
5066: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5067: line to your package <code class="filename">Makefile</code> which includes that
5068: file just before the last line. If the
5069: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5070: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5071: that the package's include files and libraries are provided.</p>
5072: <p>If you just need binaries from a package, add a
5073: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5074: version of the dependency and where it can be found in pkgsrc. This line
5075: should be placed in the third paragraph. If the dependency is only
5076: needed for building the package, but not when using it, use
5077: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5078: instead of <code class="varname">DEPENDS</code>.
5079: The difference between <code class="varname">TOOL_DEPENDS</code> and
5080: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5081: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
5082: packages, i.e. packages for the architecture where the package
5083: is built;
5084: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
5085: packages, i.e. packages for the architecture for which the package
5086: is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
5087: to specify a dependency used only for testing the resulting package
5088: built, using the upstream project's included test suite.
5089: Your package may then look like this:</p>
5090: <pre class="programlisting">
5091: [...]
5092:
5093: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5094: DEPENDS+= screen-[0-9]*:../../misc/screen
5095: DEPENDS+= screen>=4.0:../../misc/screen
5096:
5097: [...]
5098:
5099: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5100: .include "../../devel/glib2/buildlink3.mk"
5101: .include "../../mk/bsd.pkg.mk"
5102: </pre>
5103: </li>
5104: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5105: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5106: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5107: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5108: additional explanations.</p></li>
5109: <li class="step"><p>In many cases the package is not yet ready to build. You can
5110: 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
5111: over there, you can hopefully continue here.</p></li>
5112: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5113: directory from the extracted files. Besides these files, a lot of cache
5114: files and other system information has been saved in the working
5115: directory, which may become wrong after you edited the
5116: <code class="filename">Makefile</code>.</p></li>
5117: <li class="step">
5118: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5119: 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>
5120: <p>If the extracted files from the package need to be fixed, run multiple rounds of these commands:</p>
5121: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>make</code></strong>
5122: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5123: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
5124: <code class="prompt">$</code> <strong class="userinput"><code>make mps</code></strong>
5125: <code class="prompt">$</code> <strong class="userinput"><code>make clean</code></strong></pre>
5126: </li>
5127: <li class="step"><p>When the package builds fine, the next step is to install
5128: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5129: everything works.</p></li>
5130: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5131: contains a list of the files that are installed by the package, is
5132: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5133: >PLIST</strong></span> to generate a probably correct list. Check
5134: the file using your preferred text editor to see if the list of
5135: files looks plausible.</p></li>
5136: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5137: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5138: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5139: had been registered in the database of installed files, but with an
5140: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5141: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5142: registered with the list of files from
5143: <code class="filename">PLIST</code>.</p></li>
5144: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
5145: package from the set of installed files.</p></li>
5146: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5147: from above again in a single step, making sure that the PLIST is correct
5148: and the whole package is created as intended.</p></li>
5149: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything left to do.</p></li>
5150: <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>
5151: </ol></div>
5152: <div class="sect1">
5153: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5154: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5155: <div class="sect2">
5156: <div class="titlepage"><div><div><h3 class="title">
5157: <a name="creating.perl-module"></a>14.1.1. Perl modules</h3></div></div></div>
5158: <p>Simple Perl modules are handled automatically by
5159: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
5160: </div>
5161: <div class="sect2">
5162: <div class="titlepage"><div><div><h3 class="title">
5163: <a name="creating.python-module"></a>14.1.2. Python modules and programs</h3></div></div></div>
5164: <p>Python modules and programs packages are easily created using a
5165: set of predefined variables.</p>
5166: <p>
5167: If some Python versions are not supported by the software, set the
5168: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5169: that are not supported, e.g.
5170: </p>
5171: <pre class="programlisting">
5172: PYTHON_VERSIONS_INCOMPATIBLE= 27
5173: </pre>
5174: <p>
5175: If the packaged software is a Python module, include one of
5176: <code class="filename">../../lang/python/egg.mk</code>,
5177: <code class="filename">../../lang/python/distutils.mk</code>, or
5178: <code class="filename">../../lang/python/extension.mk</code>.</p>
5179: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
5180: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
5181: If the packaged software is using setuptools, you only need
5182: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
5183: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
5184: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>,
5185: so pkgsrc will use this framework.
5186: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>;
5187: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
5188: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
5189: to the name of the script.</p>
5190: <p>Either way, the package directory should be called
5191: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5192: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5193: </p>
5194: <pre class="programlisting">
5195: DISTNAME= foopymodule-1.2.10
5196: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5197: </pre>
5198: <p>If it is an application, include
5199: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5200: In order to correctly set the path to the Python interpreter, use the
5201: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5202: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5203: For example:
5204: </p>
5205: <pre class="programlisting">
5206: REPLACE_PYTHON= *.py
5207: </pre>
5208: <p>Some Python modules have separate distributions for Python-2.x
5209: and Python-3.x support. In pkgsrc this is handled by the
5210: <code class="filename">versioned_dependencies.mk</code> file. Set
5211: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
5212: packages that should be depended upon and include
5213: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
5214: then the pkgsrc infrastructure will depend on the appropriate package
5215: version. For example:
5216: </p>
5217: <pre class="programlisting">
5218: PYTHON_VERSIONED_DEPENDENCIES=dialog
5219: </pre>
5220: <p>
5221: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
5222: of supported packages.</p>
5223: </div>
5224: <div class="sect2">
5225: <div class="titlepage"><div><div><h3 class="title">
5226: <a name="creating.R-package"></a>14.1.3. R packages</h3></div></div></div>
5227: <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>
5228: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
5229: 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>.
5230: Individual packages (and optionally their dependencies) may be created
5231: and updated. R packages generally follow the same form, and most of
5232: the relevant information needed is contained in a
5233: <code class="filename">DESCRIPTION</code> file as part of each R package on
5234: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5235: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5236: creates or updates a package in the canonical form. The resulting
5237: package should be reviewed for correctness.</p>
5238: </div>
5239: <div class="sect2">
5240: <div class="titlepage"><div><div><h3 class="title">
5241: <a name="creating.TeX-package"></a>14.1.4. TeXlive packages</h3></div></div></div>
5242: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
5243: <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>
5244: <p>If the TeXlive package name is not known, it may be useful to
5245: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5246: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5247: 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
5248: archive</a>.</p>
5249: <p>If the TeXlive package name is known, download the files from
5250: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5251: archive</a>. For package <code class="filename">foo</code>, you will need
5252: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5253: also have associated documentation packages, so download
5254: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5255: should be placed in the appropriate category directory, which is often
5256: but not always <code class="filename">print</code>. Then run the following
5257: command in the category directory.</p>
5258: <pre class="programlisting">
5259: texlive2pkg foo.tar.xz foo.doc.tar.xz
5260: </pre>
5261: <p>This will create two packages, <code class="filename">tex-foo</code> and
5262: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5263: are correct.</p>
5264: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5265: currently does not include version information in package filenames
5266: and changes their contents periodically when updates occur.
5267: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5268: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5269: main one and the corresponding documentation, upload the distfiles
5270: with the following command in each package directory.</p>
5271: <pre class="programlisting">
5272: make upload-distfiles
5273: </pre>
5274: </div>
5275: </div>
5276: <div class="sect1">
5277: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5278: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5279: <div class="sect2">
5280: <div class="titlepage"><div><div><h3 class="title">
5281: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5282: <div class="sect3">
5283: <div class="titlepage"><div><div><h4 class="title">
5284: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5285: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5286: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5287: pkgsrc. As the description says it has to do with the web, the obvious
5288: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5289: <pre class="programlisting">
5290: <code class="prompt">$</code> mkdir www/nvu
5291: <code class="prompt">$</code> cd www/nvu
5292: </pre>
5293: <p>The web site says that the sources are available as a tar file, so
5294: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5295: <pre class="programlisting">
5296: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5297: </pre>
5298: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5299: below the <code class="varname">DISTNAME</code> line, as the package name should
5300: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5301: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5302: <code class="varname">COMMENT</code> fields. Then the package
5303: <code class="filename">Makefile</code> looked like that:</p>
5304: <pre class="programlisting">
5305: # $NetBSD $
5306: #
5307:
5308: DISTNAME= nvu-1.0-sources
5309: PKGNAME= nvu-1.0
5310: CATEGORIES= www
5311: MASTER_SITES= http://cvs.nvu.com/download/
5312: EXTRACT_SUFX= .tar.bz2
5313:
5314: MAINTAINER= rillig@NetBSD.org
5315: HOMEPAGE= http://cvs.nvu.com/
5316: COMMENT= Web Authoring System
5317:
5318: # url2pkg-marker (please do not remove this line.)
5319: .include "../../mk/bsd.pkg.mk"
5320: </pre>
5321: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5322: this is a workaround to prevent CVS expanding to the filename of the
5323: guide.</p>
5324: <p>Then, I quit the editor and watched pkgsrc downloading a large
5325: source archive:</p>
5326: <pre class="programlisting">
5327: url2pkg> Running "make makesum" ...
5328: => Required installed package digest>=20010302: digest-20060826 found
5329: => Fetching nvu-1.0-sources.tar.bz2
5330: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5331: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5332: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5333: url2pkg> Running "make extract" ...
5334: => Required installed package digest>=20010302: digest-20060826 found
5335: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5336: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5337: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5338: ===> Installing dependencies for nvu-1.0
5339: ===> Overriding tools for nvu-1.0
5340: ===> Extracting for nvu-1.0
5341: url2pkg> Adjusting the Makefile.
5342:
5343: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5344:
5345: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5346: </pre>
5347: </div>
5348: <div class="sect3">
5349: <div class="titlepage"><div><div><h4 class="title">
5350: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5351: <p>Now that the package has been extracted, let's see what's inside
5352: it. The package has a <code class="filename">README.txt</code>, but that only
5353: says something about mozilla, so it's probably useless for seeing what
5354: dependencies this package has. But since there is a GNU configure script
5355: in the package, let's hope that it will complain about everything it
5356: needs.</p>
5357: <pre class="programlisting">
5358: <code class="prompt">$</code> bmake
5359: => Required installed package digest>=20010302: digest-20060826 found
5360: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5361: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5362: ===> Patching for nvu-1.0
5363: ===> Creating toolchain wrappers for nvu-1.0
5364: ===> Configuring for nvu-1.0
5365: [...]
5366: configure: error: Perl 5.004 or higher is required.
5367: [...]
5368: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5369: [...]
5370: </pre>
5371: <p>That worked quite well. So I opened the package Makefile in my
5372: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5373: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5374: package have changed now, and since a perl wrapper is automatically
5375: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5376: from scratch.</p>
5377: <pre class="programlisting">
5378: <code class="prompt">$</code> bmake clean
5379: ===> Cleaning for nvu-1.0
5380: <code class="prompt">$</code> bmake
5381: [...]
5382: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5383: GNU Make. You will not be able to build Mozilla without GNU Make.
5384: [...]
5385: </pre>
5386: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5387: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5388: <pre class="programlisting">
5389: [...]
5390: checking for GTK - version >= 1.2.0... no
5391: *** Could not run GTK test program, checking why...
5392: [...]
5393: </pre>
5394: <p>Now to the other dependencies. The first question is: Where is the
5395: GTK package hidden in pkgsrc?</p>
5396: <pre class="programlisting">
5397: <code class="prompt">$</code> echo ../../*/gtk*
5398: [many packages ...]
5399: <code class="prompt">$</code> echo ../../*/gtk
5400: ../../x11/gtk
5401: <code class="prompt">$</code> echo ../../*/gtk2
5402: ../../x11/gtk2
5403: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5404: ../../x11/gtk2/buildlink3.mk
5405: </pre>
5406: <p>The first try was definitely too broad. The second one had exactly
5407: one result, which is very good. But there is one pitfall with GNOME
5408: packages. Before GNOME 2 had been released, there were already many
5409: GNOME 1 packages in pkgsrc. To be able to continue to use these
5410: packages, the GNOME 2 packages were imported as separate packages, and
5411: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5412: whether this was the case here, and indeed it was.</p>
5413: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5414: file, adding the dependency is very easy. I just inserted an
5415: <code class="literal">.include</code> line before the last line of the package
5416: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5417: <pre class="programlisting">
5418: [...]
5419: .include "../../x11/gtk2/buildlink3.mk"
5420: .include "../../mk/bsd.pkg.mk
5421: </pre>
5422: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5423: was:</p>
1.1 dsieger 5424: <pre class="programlisting">
1.184 rillig 5425: [...]
5426: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5427: checking for GTK - version >= 1.2.0... no
5428: *** Could not run GTK test program, checking why...
5429: *** The test program failed to compile or link. See the file config.log for the
5430: *** exact error that occured. This usually means GTK was incorrectly installed
5431: *** or that you have moved GTK since it was installed. In the latter case, you
5432: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5433: configure: error: Test for GTK failed.
5434: [...]
1.111 sevan 5435: </pre>
1.184 rillig 5436: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5437: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5438: told me that this package really wanted to have the GNOME 1 version of
5439: GTK. If the package had looked for GTK2, it would have looked for
5440: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5441: So I changed the <code class="literal">x11/gtk2</code> to
5442: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5443: and tried again.</p>
1.18 snj 5444: <pre class="programlisting">
1.184 rillig 5445: [...]
5446: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5447: In file included from xpidl.c:42:
5448: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5449: In file included from xpidl.c:42:
5450: xpidl.h:132: error: parse error before "IDL_ns"
5451: [...]
1.111 sevan 5452: </pre>
1.184 rillig 5453: <p>The package still does not find all of its dependencies. Now the
5454: question is: Which package provides the
5455: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.18 snj 5456: <pre class="programlisting">
1.184 rillig 5457: <code class="prompt">$</code> echo ../../*/*idl*
5458: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5459: <code class="prompt">$</code> echo ../../*/*IDL*
5460: ../../net/libIDL
1.111 sevan 5461: </pre>
1.184 rillig 5462: <p>Let's take the one from the second try. So I included the
5463: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5464: again. But the error didn't change. After digging through some of the
5465: code, I concluded that the build process of the package was broken and
5466: couldn't have ever worked, but since the Mozilla source tree is quite
5467: large, I didn't want to fix it. So I added the following to the package
5468: <code class="filename">Makefile</code> and tried again:</p>
1.86 wiz 5469: <pre class="programlisting">
1.184 rillig 5470: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5471: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.111 sevan 5472: </pre>
1.184 rillig 5473: <p>The latter line is needed because the package expects the library
5474: <code class="filename">libIDL.so</code>, but only
5475: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5476: wrapper to rewrite that on the fly.</p>
5477: <p>The next problem was related to a recent change of the FreeType
5478: 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>
5479: which patch files were relevant for this issue and copied them to the
5480: <code class="filename">patches</code> directory. Then I retried, fixed the
5481: patches so that they applied cleanly and retried again. This time,
5482: everything worked.</p>
1.86 wiz 5483: </div>
1.184 rillig 5484: <div class="sect3">
5485: <div class="titlepage"><div><div><h4 class="title">
5486: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 5487: <pre class="programlisting">
1.184 rillig 5488: <code class="prompt">$</code> bmake CHECK_FILES=no install
5489: [...]
5490: <code class="prompt">$</code> bmake print-PLIST >PLIST
5491: <code class="prompt">$</code> bmake deinstall
5492: <code class="prompt">$</code> bmake install
1.111 sevan 5493: </pre>
1.184 rillig 5494: </div>
5495: </div>
1.1 dsieger 5496: </div>
5497: </div>
1.41 asau 5498: <div class="chapter">
1.1 dsieger 5499: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 5500: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 5501: <div class="toc">
5502: <p><b>Table of Contents</b></p>
1.100 leot 5503: <dl class="toc">
1.184 rillig 5504: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5505: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5506: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5507: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5508: <dd><dl>
5509: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5510: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5511: <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>
5512: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 5513: </dl></dd>
5514: </dl>
5515: </div>
1.184 rillig 5516: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5517: each of which forms a well-defined part of the pkgsrc system. Using
5518: the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
5519: like pkgsrc requires some discipline to keep the code correct and
5520: understandable.</p>
5521: <p>The basic ingredients for <code class="filename">Makefile</code>
5522: programming are variables and shell
5523: commands. Among these shell commands may even be more complex ones
5524: like <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
5525: as intended it is necessary to quote all variables correctly when they
5526: are used.</p>
5527: <p>This chapter describes some patterns that appear quite often in
5528: <code class="filename">Makefile</code>s, including the pitfalls that come along
5529: with them.</p>
1.41 asau 5530: <div class="sect1">
1.1 dsieger 5531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5532: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5533: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5534: <p>When you are creating a file as a
5535: target of a rule, always write the data to a temporary file first
5536: and finally rename that file. Otherwise there might occur an error
5537: in the middle of generating the file, and when the user runs
5538: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
5539: regenerated properly. Example:</p>
1.1 dsieger 5540: <pre class="programlisting">
1.184 rillig 5541: wrong:
5542: @echo "line 1" > ${.TARGET}
5543: @echo "line 2" >> ${.TARGET}
5544: @false
5545:
5546: correct:
5547: @echo "line 1" > ${.TARGET}.tmp
5548: @echo "line 2" >> ${.TARGET}.tmp
5549: @false
5550: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 5551: </pre>
1.184 rillig 5552: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5553: <code class="filename">wrong</code> will exist, although there was an error
5554: message in the first run. On the other hand, running <span class="command"><strong>make
5555: correct</strong></span> gives an error message twice, as expected.</p>
5556: <p>You might remember that <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
5557: <code class="literal">${.TARGET}</code> in case of error, but this only
5558: happens when it is interrupted, for example by pressing
5559: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
5560: when one of the commands fails (like <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
5561: </li></ul></div>
5562: </div>
5563: <div class="sect1">
5564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5565: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5566: <p><code class="filename">Makefile</code> variables contain strings that
5567: can be processed using the five operators <code class="code">=</code>,
5568: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
5569: <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
5570: page.</p>
5571: <p>When a variable's value is parsed from a
5572: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5573: the backslash character <code class="code">\</code> are handled specially. If a
5574: backslash is the last character in a line, that backslash is removed
5575: from the line and the line continues with the next line of the file.</p>
5576: <p>The <code class="code">#</code> character starts a comment that reaches
5577: until the end of the line. To get an actual <code class="code">#</code> character,
5578: such as in a URL, write <code class="code">\#</code> instead.</p>
5579: <p>The evaluation of variables either happens immediately or lazy.
5580: It happens immediately when the variable occurs on the right-hand
5581: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5582: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5583: In the other cases, it is evaluated lazily.</p>
5584: <p>Some of the modifiers split the string into words and then
5585: operate on the words, others operate on the string as a whole. When a
5586: string is split into words, double quotes and single quotes are
5587: interpreted as delimiters, just like in <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?sh+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
5588: <div class="sect2">
5589: <div class="titlepage"><div><div><h3 class="title">
5590: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5591: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5592: <li class="listitem"><p>All variable names starting with an underscore
5593: are reserved for use by the pkgsrc infrastructure. They shall
5594: not be used by packages.</p></li>
5595: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5596: lowercase variable names for the iteration
5597: variables.</p></li>
5598: <li class="listitem"><p>All list variables should have a plural name,
5599: such as <code class="varname">PKG_OPTIONS</code> or
5600: <code class="varname">DISTFILES</code>.</p></li>
5601: </ul></div>
5602: </div>
5603: </div>
5604: <div class="sect1">
5605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5606: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5607: <div class="sect2">
5608: <div class="titlepage"><div><div><h3 class="title">
5609: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5610: <p>When adding a string that possibly contains whitespace or quotes to
5611: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5612: modifier.</p>
5613: <p>When adding another list to a list (example 2), it must not be
5614: quoted, since its elements are already quoted.</p>
1.1 dsieger 5615: <pre class="programlisting">
1.184 rillig 5616: STRING= foo * bar `date`
5617: LIST= # empty
5618: ANOTHER_LIST= a=b c=d
5619:
5620: LIST+= ${STRING:Q} # 1
5621: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 5622: </pre>
1.184 rillig 5623: </div>
5624: <div class="sect2">
5625: <div class="titlepage"><div><div><h3 class="title">
5626: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5627: <p>Echoing a string containing special characters needs special
5628: work.</p>
1.1 dsieger 5629: <pre class="programlisting">
1.184 rillig 5630: STRING= foo bar < > * `date` $$HOME ' "
5631: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5632:
5633: all:
5634: echo ${STRING} # 1
5635: echo ${STRING:Q} # 2
5636: printf '%s\n' ${STRING:Q}'' # 3
5637: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 5638: </pre>
1.184 rillig 5639: <p>Example 1 leads to a syntax error in the shell, as the characters
5640: are just copied.</p>
5641: <p>Example 2 quotes the string so that the shell interprets it
5642: correctly. But the echo command may additionally interpret strings with a
5643: leading dash or those containing backslashes.</p>
5644: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
5645: interprets the format string, but not the next argument. The trailing
5646: single quotes handle the case when the string is empty. In that case, the
5647: :Q modifier would result in an empty string too, which would then be
5648: skipped by the shell. For <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
5649: but other programs may care.</p>
5650: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5651: need to be quoted because the quoting has already been done
5652: when adding elements to the list.</p>
1.1 dsieger 5653: </div>
1.41 asau 5654: <div class="sect2">
1.1 dsieger 5655: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 5656: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5657: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5658: GNU-style configure script (especially those that call other configure
5659: scripts), it must not have leading or trailing whitespace, since
5660: otherwise the configure script gets confused. To trim leading and
5661: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5662: following example:</p>
1.1 dsieger 5663: <pre class="programlisting">
1.184 rillig 5664: CPPFLAGS= # empty
5665: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5666: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 5667:
1.184 rillig 5668: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 5669:
1.184 rillig 5670: all:
5671: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5672: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5673: </pre>
5674: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5675: trailing whitespace because the <code class="code">+=</code> operator always adds a
5676: space.</p>
5677: </div>
5678: <div class="sect2">
5679: <div class="titlepage"><div><div><h3 class="title">
5680: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5681: <p>When a possibly empty variable is used in a shell program, it may
5682: lead to a syntax error.</p>
5683: <pre class="programlisting">
5684: EGFILES= # empty
1.1 dsieger 5685:
1.184 rillig 5686: install-examples: # produces a syntax error in the shell
5687: for egfile in ${EGFILES}; do \
5688: echo "Installing $$egfile"; \
5689: done
5690: </pre>
5691: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
5692: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
5693: To fix this syntax error, use one of the snippets below.</p>
5694: <pre class="programlisting">
5695: EMPTY= # empty
1.1 dsieger 5696:
1.184 rillig 5697: install-examples:
5698: for egfile in ${EGFILES} ""; do \
5699: [ -n "$$egfile" ] || continue; \
5700: echo "Installing $$egfile"; \
5701: done
5702: </pre>
5703: <p>In this case, an empty string is appended to the iteration list (to
5704: prevent the syntax error) and filtered out later.</p>
5705: <pre class="programlisting">
5706: EGFILES= # empty
1.1 dsieger 5707:
1.184 rillig 5708: install-examples:
5709: .for egfile in ${EGFILES}
5710: echo "Installing ${egfile}"
5711: .endfor
1.1 dsieger 5712: </pre>
1.184 rillig 5713: <p>If one of the filenames contains special characters, it should be
5714: enclosed in single or double quotes.</p>
5715: <p>To have a shell command test whether a make variable is empty, use
5716: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5717: </div>
5718: </div>
5719: </div>
5720: <div class="chapter">
5721: <div class="titlepage"><div><div><h2 class="title">
5722: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5723: <div class="toc">
5724: <p><b>Table of Contents</b></p>
5725: <dl class="toc">
5726: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5727: <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>
5728: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5729: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5730: </dl>
1.1 dsieger 5731: </div>
1.184 rillig 5732: <p>Many packages have the ability to be built to support different
5733: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5734: in pkgsrc that provides generic handling of those options that
5735: determine different ways in which the packages can be built. It's
5736: possible for the user to specify exactly which sets of options will be
5737: built into a package or to allow a set of global default options
5738: apply.</p>
5739: <p>There are two broad classes of behaviors that one might want to
5740: control via options. One is whether some particular feature is
5741: enabled in a program that will be built anyway, often by including or
5742: not including a dependency on some other package. The other is
5743: whether or not an additional program will be built as part of the
5744: package. Generally, it is better to make a split package for such
5745: additional programs instead of using options, because it enables
5746: binary packages to be built which can then be added separately. For
5747: example, the foo package might have minimal dependencies (those
5748: packages without which foo doesn't make sense), and then the foo-gfoo
5749: package might include the GTK frontend program gfoo. This is better
5750: than including a gtk option to foo that adds gfoo, because either that
5751: option is default, in which case binary users can't get foo without
5752: gfoo, or not default, in which case they can't get gfoo. With split
5753: packages, they can install foo without having GTK, and later decide to
5754: install gfoo (pulling in GTK at that time). This is an advantage to
5755: source users too, avoiding the need for rebuilds.</p>
5756: <p>Plugins with widely varying dependencies should usually be split
5757: instead of options.</p>
5758: <p>It is often more work to maintain split packages, especially if
5759: the upstream package does not support this. The decision of split
5760: vs. option should be made based on the likelihood that users will want
5761: or object to the various pieces, the size of the dependencies that are
5762: included, and the amount of work.</p>
5763: <p>A further consideration is licensing. Non-free parts, or parts
5764: that depend on non-free dependencies (especially plugins) should
5765: almost always be split if feasible.</p>
5766: <div class="sect1">
5767: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5768: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5769: <p>Global default options are listed in
5770: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5771: that should be built into every package if that option is supported.
5772: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5773: </div>
1.41 asau 5774: <div class="sect1">
1.1 dsieger 5775: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5776: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5777: </h2></div></div></div>
5778: <p>The following example shows how
5779: <code class="filename">bsd.options.mk</code> should be used
5780: by the hypothetical ``wibble'' package, either in the package
5781: <code class="filename">Makefile</code>, or in a file,
5782: e.g. <code class="filename">options.mk</code>, that is included by the
5783: main package <code class="filename">Makefile</code>.</p>
1.1 dsieger 5784: <pre class="programlisting">
1.184 rillig 5785: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5786: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5787: PKG_OPTIONS_OPTIONAL_GROUPS= database
5788: PKG_OPTIONS_GROUP.database= mysql pgsql
5789: PKG_SUGGESTED_OPTIONS= wibble-foo
5790: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5791: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5792:
5793: .include "../../mk/bsd.prefs.mk"
5794:
5795: # this package was previously named wibble2
5796: .if defined(PKG_OPTIONS.wibble2)
5797: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5798: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5799: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5800: .endif
5801:
5802: .include "../../mk/bsd.options.mk"
5803:
5804: # Package-specific option-handling
1.1 dsieger 5805:
1.184 rillig 5806: ###
5807: ### FOO support
5808: ###
5809: .if !empty(PKG_OPTIONS:Mwibble-foo)
5810: CONFIGURE_ARGS+= --enable-foo
5811: .endif
1.1 dsieger 5812:
1.184 rillig 5813: ###
5814: ### LDAP support
5815: ###
5816: .if !empty(PKG_OPTIONS:Mldap)
5817: . include "../../databases/openldap-client/buildlink3.mk"
5818: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5819: .endif
1.1 dsieger 5820:
1.184 rillig 5821: ###
5822: ### database support
5823: ###
5824: .if !empty(PKG_OPTIONS:Mmysql)
5825: . include "../../mk/mysql.buildlink3.mk"
5826: .endif
5827: .if !empty(PKG_OPTIONS:Mpgsql)
5828: . include "../../mk/pgsql.buildlink3.mk"
5829: .endif
5830: </pre>
5831: <p>The first section contains the information about which build
5832: options are supported by the package, and any default options settings
5833: if needed.</p>
5834: <div class="orderedlist"><ol class="orderedlist" type="1">
5835: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
5836: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
5837: options. It should be set to
5838: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5839: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5840: at the point where the options are processed.</p></li>
5841: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
5842: build options supported by the package.</p></li>
5843: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
5844: list of names of groups of mutually exclusive options. The options in
5845: each group are listed in
5846: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5847: The most specific setting of any option from the group takes
5848: precedence over all other options in the group. Options from the
5849: groups will be automatically added to
5850: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
5851: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
5852: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5853: packages will fail if no option from the group is
5854: selected.</p></li>
5855: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
5856: of names of sets of options. At least one option from each set must
5857: be selected. The options in each set are listed in
5858: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5859: Options from the sets will be automatically added to
5860: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5861: fail if no option from the set is selected.</p></li>
5862: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
5863: build options which are enabled by default.</p></li>
5864: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
5865: of
5866: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
5867: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
5868: their option counterparts. Pairs should be added with
5869: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
5870: warning will be issued if the user uses a legacy
5871: variable.</p></li>
5872: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
5873: of
5874: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
5875: pairs that map options that have been renamed to their new
5876: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
5877: the listing of global legacy options. A warning will be issued if
5878: the user uses a legacy option.</p></li>
5879: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
5880: options implied by deprecated variables used. This can be used for
5881: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5882: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5883: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
5884: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
5885: a list of warnings about deprecated variables or options used, and
5886: what to use instead.</p></li>
5887: </ol></div>
5888: <p>A package should never modify
5889: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5890: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5891: To suggest a default set of options, use
5892: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5893: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5894: including <code class="filename">bsd.options.mk</code>. If none of
5895: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5896: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5897: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5898: happen with platform-specific options if none of them is supported on
5899: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5900: empty list and the package is otherwise treated as not using the
5901: options framework.</p>
5902: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5903: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5904: build options, properly filtered to remove unsupported and duplicate
5905: options.</p>
5906: <p>The remaining sections contain the logic that is specific to
5907: each option. The correct way to check for an option is to check
5908: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5909: <pre class="programlisting">
5910: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.1 dsieger 5911: </pre>
5912: </div>
1.184 rillig 5913: <div class="sect1">
5914: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5915: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
5916: <p>Options that enable similar features in different packages (like
5917: optional support for a library) should use a common name in all
5918: packages that support it (like the name of the library). If another
5919: package already has an option with the same meaning, use the same
5920: name.</p>
5921: <p>Options that enable features specific to one package, where it's
5922: unlikely that another (unrelated) package has the same (or a similar)
5923: optional feature, should use a name prefixed with
5924: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5925: <p>If a group of related packages share an optional feature
5926: specific to that group, prefix it with the name of the
5927: <span class="quote">“<span class="quote">main</span>”</span> package
5928: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5929: <p>For new options, add a line to
5930: <code class="filename">mk/defaults/options.description</code>. Lines have two
5931: fields, separated by tab. The first field is the option name, the
5932: second its description. The description should be a whole sentence
5933: (starting with an uppercase letter and ending with a period) that
5934: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5935: support.</span>”</span> The file is sorted by option names.</p>
5936: </div>
5937: <div class="sect1">
5938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5939: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
5940: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
5941: different dependencies based on the options with which the package was
5942: built. For querying these options, the file
5943: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5944: typical example looks like this:</p>
1.1 dsieger 5945: <pre class="programlisting">
1.184 rillig 5946: pkgbase := libpurple
5947: .include "../../mk/pkg-build-options.mk"
5948:
5949: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5950: ...
5951: .endif
1.117 sevan 5952: </pre>
1.184 rillig 5953: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5954: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5955: options of the libpurple package, which can then be queried like
5956: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5957: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5958: details.</p>
1.1 dsieger 5959: </div>
5960: </div>
1.41 asau 5961: <div class="chapter">
1.1 dsieger 5962: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 5963: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 5964: <div class="toc">
5965: <p><b>Table of Contents</b></p>
1.100 leot 5966: <dl class="toc">
1.184 rillig 5967: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
5968: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
5969: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 5970: </dl>
5971: </div>
1.184 rillig 5972: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
5973: by pkgsrc and also for individual packages to define what commands
5974: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
5975: or for later run-time of an installed packaged (such as
5976: <code class="varname">DEPENDS</code>).
5977: If the native system provides an adequate tool, then in many cases, a pkgsrc
5978: package will not be used.</p>
5979: <p>When building a package, the replacement tools are
5980: made available in a directory (as symlinks or wrapper scripts)
5981: that is early in the executable search path. Just like the buildlink
5982: system, this helps with consistent builds.</p>
5983: <p>A tool may be needed to help build a specific package. For example,
5984: perl, GNU make (gmake) or yacc may be needed.</p>
5985: <p>Also a tool may be needed, for example, because the native system's supplied
5986: tool may be inefficient for building a package with pkgsrc.
5987: For example, a package may need GNU awk, bison (instead of
5988: yacc) or a better sed.</p>
5989: <p>The tools used by a package can be listed by running
5990: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 5991: <div class="sect1">
1.1 dsieger 5992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5993: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
5994: <p>The default set of tools used by pkgsrc is defined in
5995: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
5996: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
5997: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
5998: These can be seen by running:
5999: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6000: <p>If a package needs a specific program to build
6001: then the <code class="varname">USE_TOOLS</code> variable can be used
6002: to define the tools needed.</p>
1.1 dsieger 6003: </div>
1.184 rillig 6004: <div class="sect1">
6005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6006: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6007: <p>In the following examples, the :run means that it is needed at
6008: run-time (and becomes a DEPENDS).
6009: The default is a build dependency which can be set with
6010: :build. (So in this example, it is the same as gmake:build
6011: and pkg-config:build.)</p>
1.1 dsieger 6012: <pre class="programlisting">
1.184 rillig 6013: USE_TOOLS+= gmake perl:run pkg-config
1.1 dsieger 6014: </pre>
1.184 rillig 6015: <p>When using the tools framework, a
6016: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6017: which contains the full path to the appropriate tool. For example,
6018: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6019: on Linux systems.</p>
6020: <p>If you always need a pkgsrc version of the
6021: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6022: </p>
1.1 dsieger 6023: </div>
1.184 rillig 6024: <div class="sect1">
6025: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6026: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6027: <p>When improving or porting pkgsrc to a new platform, have a look
6028: at (or create) the corresponding platform specific make file fragment under
6029: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6030: the name of the common tools. For example:</p>
1.1 dsieger 6031: <pre class="programlisting">
1.184 rillig 6032: .if exists(/usr/bin/bzcat)
6033: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6034: .elif exists(/usr/bin/bzip2)
6035: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6036: .endif
6037:
6038: TOOLS_PLATFORM.true?= true # shell builtin
1.1 dsieger 6039: </pre>
6040: </div>
6041: </div>
1.184 rillig 6042: <div class="chapter">
6043: <div class="titlepage"><div><div><h2 class="title">
6044: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6045: <div class="toc">
6046: <p><b>Table of Contents</b></p>
6047: <dl class="toc">
6048: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6049: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6050: <dd><dl>
6051: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6052: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6053: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6054: and
6055: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6056: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6057: </dl></dd>
6058: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
6059: <dd><dl>
6060: <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>
6061: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
6062: </dl></dd>
6063: </dl>
1.1 dsieger 6064: </div>
1.184 rillig 6065: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6066: are seen by a package's configure and build processes. This is implemented
6067: in a two step process:</p>
6068: <div class="orderedlist"><ol class="orderedlist" type="1">
6069: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6070: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6071: of <code class="varname">WRKDIR</code>.</p></li>
6072: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6073: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6074: <code class="option">-L${LOCALBASE}/lib</code> into references to
6075: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6076: native compiler on some operating systems look like GCC, so that
6077: packages that expect GCC won't require modifications to build with
6078: those native compilers.</p></li>
6079: </ol></div>
6080: <p>This normalizes the environment in which a package is built so that the
6081: package may be built consistently despite what other software may be
6082: installed. Please note that the normal system header and library paths,
6083: e.g. <code class="filename">/usr/include</code>,
6084: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6085: designed to insulate the package build from non-system-supplied
6086: software.</p>
1.41 asau 6087: <div class="sect1">
1.1 dsieger 6088: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6089: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6090: <p>The process of converting packages to use the buildlink3
6091: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6092: The things to keep in mind are:</p>
1.23 wiz 6093: <div class="orderedlist"><ol class="orderedlist" type="1">
1.184 rillig 6094: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6095: instead of the actual toolchain. Some packages are tricky,
6096: and the only way to know for sure is the check
6097: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6098: wrappers are being invoked.</p></li>
6099: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6100: the package Makefile, e.g. Java VMs, standalone shells,
6101: etc., because the code to symlink files into
6102: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6103: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6104: </p></li>
6105: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6106: <code class="filename">buildlink3.mk</code> files that you list in a
6107: package's Makefile are added as dependencies for that package.
6108: </p></li>
6109: </ol></div>
6110: <p>If a dependency on a particular package is required for its libraries and
6111: headers, then we replace:</p>
6112: <pre class="programlisting">
6113: DEPENDS+= foo>=1.1.0:../../category/foo
6114: </pre>
6115: <p>with</p>
6116: <pre class="programlisting">
6117: .include "../../category/foo/buildlink3.mk"
6118: </pre>
6119: <p>The buildlink3.mk files usually define the required dependencies.
6120: If you need a newer version of the dependency when using buildlink3.mk
6121: files, then you can define it in your Makefile; for example:</p>
1.1 dsieger 6122: <pre class="programlisting">
1.184 rillig 6123: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6124: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 6125: </pre>
1.184 rillig 6126: <p>There are several <code class="filename">buildlink3.mk</code>
6127: files in <code class="filename">pkgsrc/mk</code>
6128: that handle special package issues:</p>
6129: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6130: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6131: the native or a pkgsrc Berkeley DB implementation based on
6132: the values of <code class="varname">BDB_ACCEPTED</code> and
6133: <code class="varname">BDB_DEFAULT</code>.</p></li>
6134: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6135: comes with neither Curses nor NCurses, this will take care
6136: 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>
6137: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6138: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6139: adding a dependency on Heimdal or MIT-krb5 for packages that
6140: require a Kerberos 5 implementation.</p></li>
6141: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6142: system-provided Motif installation or adds a dependency on
6143: <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
6144: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6145: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6146: to choose which Motif version will be used.</p></li>
6147: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6148: system-provided GNU readline or editline (libedit) installation,
6149: 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>,
6150: <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
6151: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6152: If your package really needs GNU readline library, its Makefile
6153: should include <code class="filename">devel/readline/buildlink3.mk</code>
6154: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6155: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6156: variables that may be used by packages that use the
6157: Open Sound System (OSS) API.</p></li>
6158: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6159: any of the Postgres versions in the variable
6160: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6161: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6162: the file for more information.</p></li>
6163: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6164: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
6165: 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>
6166: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6167: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6168: library.</p></li>
6169: </ul></div>
6170: <p>The comments in those <code class="filename">buildlink3.mk</code>
6171: files provide a more complete
6172: description of how to use them properly.</p>
1.1 dsieger 6173: </div>
1.41 asau 6174: <div class="sect1">
1.1 dsieger 6175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6176: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6177: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6178: included by Makefiles to indicate the need to compile and link
6179: against header files and libraries provided by the package. A
6180: <code class="filename">buildlink3.mk</code> file should always provide
6181: enough information to add the correct type of dependency
6182: relationship and include any other
6183: <code class="filename">buildlink3.mk</code> files that it needs to find
6184: headers and libraries that it needs in turn.</p>
6185: <p>To generate an initial <code class="filename">buildlink3.mk</code>
6186: 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>
6187: package is highly recommended. For most packages, the following
6188: command will generate a good starting point for
6189: <code class="filename">buildlink3.mk</code> files:</p>
6190: <pre class="screen">
6191: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6192: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6193: </pre>
1.41 asau 6194: <div class="sect2">
1.1 dsieger 6195: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6196: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6197: <p>The following real-life example
6198: <code class="filename">buildlink3.mk</code> is taken
6199: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.1 dsieger 6200: <pre class="programlisting">
1.184 rillig 6201: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
6202:
6203: BUILDLINK_TREE+= tiff
6204:
6205: .if !defined(TIFF_BUILDLINK3_MK)
6206: TIFF_BUILDLINK3_MK:=
6207:
6208: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6209: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6210: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6211:
6212: .include "../../devel/zlib/buildlink3.mk"
6213: .include "../../graphics/jpeg/buildlink3.mk"
6214: .endif # TIFF_BUILDLINK3_MK
6215:
6216: BUILDLINK_TREE+= -tiff
1.1 dsieger 6217: </pre>
1.184 rillig 6218: <p>The header and footer manipulate
6219: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6220: <code class="filename">buildlink3.mk</code> files and is used to track
6221: the dependency tree.</p>
6222: <p>The main section is protected from multiple inclusion
6223: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6224: added. Several important variables are set in the section:</p>
6225: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6226: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6227: is the dependency version recorded in the installed
1.184 rillig 6228: package; this should always be set using
6229: <span class="command"><strong>+=</strong></span> to ensure that
6230: we're appending to any pre-existing list of values. This
1.185 wiz 6231: variable should be set to the last version of the
1.184 rillig 6232: package that had an backwards-incompatible API change.
6233: </p></li>
6234: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6235: is the location of the <em class="replaceable"><code>pkg</code></em>
6236: pkgsrc directory.</p></li>
6237: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6238: (not shown above) controls whether we use
6239: <code class="varname">BUILD_DEPENDS</code> or
6240: <code class="varname">DEPENDS</code> to add the dependency on
6241: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6242: selected by setting
6243: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6244: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
6245: used.</p></li>
6246: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6247: and
6248: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6249: (not shown above) are lists of subdirectories of
6250: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6251: to add to the header and library search paths. These
6252: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6253: respectively.</p></li>
6254: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6255: (not shown above) is the list of preprocessor flags to add
6256: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6257: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6258: should be avoided and instead be handled using
6259: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6260: above.</p></li>
6261: </ul></div>
6262: <p>The following variables are all optionally defined within
6263: this second section (protected against multiple inclusion) and
6264: control which package files are symlinked into
6265: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6266: transformed during the symlinking:</p>
6267: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6268: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6269: (not shown above) is a shell glob pattern relative to
6270: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6271: to be symlinked into
6272: <code class="filename">${BUILDLINK_DIR}</code>,
6273: e.g. <code class="filename">include/*.h</code>.</p></li>
6274: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6275: (not shown above) is a shell pipeline that
6276: outputs to stdout a list of files relative to
6277: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6278: The resulting files are to be symlinked
6279: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6280: this takes the <code class="filename">+CONTENTS</code> of a
6281: <em class="replaceable"><code>pkg</code></em> and filters it through
6282: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6283: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6284: (not shown above) is a filter command that filters
6285: <code class="filename">+CONTENTS</code> input into a list of files
6286: relative to
6287: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6288: on stdout. By default,
6289: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6290: outputs the contents of the <code class="filename">include</code>
6291: and <code class="filename">lib</code> directories in the package
6292: <code class="filename">+CONTENTS</code>.</p></li>
6293: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6294: (not shown above) is a list of sed arguments used to
6295: transform the name of the source filename into a
6296: destination filename, e.g. <span class="command"><strong>-e
6297: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6298: </ul></div>
6299: <p>This section can additionally include any
6300: <code class="filename">buildlink3.mk</code> needed for
6301: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6302: Including these <code class="filename">buildlink3.mk</code> files
6303: means that the headers and libraries for these
6304: dependencies are also symlinked into
6305: <code class="filename">${BUILDLINK_DIR}</code>
6306: whenever the <em class="replaceable"><code>pkg</code></em>
6307: <code class="filename">buildlink3.mk</code>
6308: file is included. Dependencies are only added for directly
6309: include <code class="filename">buildlink3.mk</code> files.</p>
6310: <p>When providing a <code class="filename">buildlink3.mk</code> and
6311: including other <code class="filename">buildlink3.mk</code> files in it,
6312: please only add necessary ones, i.e., those whose libraries or
6313: header files are automatically exposed when the package is
6314: use.</p>
6315: <p>In particular, if only an executable
6316: (<code class="filename">bin/foo</code>) is linked against a library, that
6317: library does not need to be propagated in the
6318: <code class="filename">buildlink3.mk</code> file.</p>
6319: <p>The following steps should help you decide if a
6320: <code class="filename">buildlink3.mk</code> file needs to be included:
6321: </p>
6322: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6323: <li class="listitem"><p>Look at the installed header files: What
6324: headers do they include? The packages providing these files
6325: must be buildlinked.</p></li>
6326: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6327: libraries and look against what other libraries they link.
6328: Some of the packages providing these probably need to be
6329: buildlinked; however, it's not automatic, since e.g. GTK on
6330: some systems pulls in the X libraries, so they will show up in
6331: the <code class="filename">ldd</code> output, while on others (like OS
6332: X) it won't. <code class="filename">ldd</code> output can thus only be
6333: used as a hint.</p></li>
6334: </ul></div>
6335: <p>
6336: </p>
6337: </div>
1.41 asau 6338: <div class="sect2">
1.1 dsieger 6339: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6340: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6341: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6342: and
6343: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6344: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.185 wiz 6345: <p>Both variables set lower bounds for a version of this package.
6346: The two variables differ in that one describes source
1.184 rillig 6347: compatibility (API) and the other binary compatibility (ABI).
6348: The difference is that a change in the API breaks compilation of
6349: programs while changes in the ABI stop compiled programs from
6350: running.</p>
1.185 wiz 6351: <p>The
6352: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6353: variable in a <code class="filename">buildlink3.mk</code> should be
6354: changed very rarely. (One possible scenario: If all packages
6355: using this package need a higher version than defined in the
6356: <code class="filename">buildlink3.mk</code>,
1.184 rillig 6357: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6358: could be updated to that higher version.)</p>
6359: <p>On the other hand, changes to
1.184 rillig 6360: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6361: are more common. The variable will need to be updated every
6362: time the major version of one of its shared libraries is changed,
6363: or any other change where a binary built against the previous
6364: version of the package will not run against the new version any
6365: longer.</p>
6366: <p>In such a case, the package's
1.184 rillig 6367: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6368: must be increased to require the new package version. Then the
6369: <code class="varname">PKGREVISION</code> of all packages
6370: <em class="replaceable"><code>foo</code></em> that depend on this package need
6371: to be increased, and if they have
6372: <code class="filename">buildlink3.mk</code> files,
6373: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6374: in their <code class="filename">buildlink3.mk</code> files must be
6375: increased to the new version as well. This is required so that a
6376: package will pull in the versions of the packages that use the
6377: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6378: uniquely identify the packages built against the new ABI. The
6379: <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
6380: help with these updates.</p>
6381: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6382: about dependencies on other packages, including the
6383: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.184 rillig 6384: <p>Please take careful consideration before adjusting
6385: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6386: or
6387: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6388: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6389: cause unneeded package deletions and rebuilds. In many cases,
6390: new versions of packages work just fine with older
6391: dependencies.</p>
1.184 rillig 6392: <p>Also it is not needed to set
6393: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6394: when it is identical to
6395: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.1 dsieger 6396: </div>
6397: </div>
1.41 asau 6398: <div class="sect1">
1.1 dsieger 6399: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6400: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6401: <p>Some packages in pkgsrc install headers and libraries that
6402: coincide with headers and libraries present in the base system.
6403: Aside from a <code class="filename">buildlink3.mk</code> file, these
6404: packages should also include a <code class="filename">builtin.mk</code>
6405: file that includes the necessary checks to decide whether using
6406: the built-in software or the pkgsrc software is
6407: appropriate.</p>
6408: <p>The only requirements of a builtin.mk file for
6409: <em class="replaceable"><code>pkg</code></em> are:</p>
6410: <div class="orderedlist"><ol class="orderedlist" type="1">
6411: <li class="listitem"><p>It should set
6412: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6413: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6414: after it is included.</p></li>
6415: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6416: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6417: which is already set before the
6418: <code class="filename">builtin.mk</code> file is included.</p></li>
6419: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6420: is <span class="emphasis"><em>very</em></span> important and takes careful
6421: attention to <code class="filename">Makefile</code> coding.</p></li>
6422: </ol></div>
6423: <div class="sect2">
6424: <div class="titlepage"><div><div><h3 class="title">
6425: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6426: <p>The following is the recommended template for builtin.mk
6427: files:</p>
1.1 dsieger 6428: <pre class="programlisting">
1.184 rillig 6429: .if !defined(IS_BUILTIN.foo)
6430: #
6431: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6432: # genuinely exists in the system or not.
6433: #
6434: IS_BUILTIN.foo?= no
1.1 dsieger 6435:
1.184 rillig 6436: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6437: # version can be determined.
6438: #
6439: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6440: BUILTIN_PKG.foo?= foo-1.0
6441: . endif
6442: .endif # IS_BUILTIN.foo
1.1 dsieger 6443:
1.184 rillig 6444: .if !defined(USE_BUILTIN.foo)
6445: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6446: . if defined(BUILTIN_PKG.foo)
6447: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6448: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6449: USE_BUILTIN.foo!= \
6450: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6451: && ${ECHO} "yes" || ${ECHO} "no"
6452: . endif
6453: . endfor
6454: . endif
6455: .endif # USE_BUILTIN.foo
1.1 dsieger 6456:
1.184 rillig 6457: CHECK_BUILTIN.foo?= no
6458: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6459: #
6460: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6461: # "yes" or "no".
6462: #
6463: .endif # CHECK_BUILTIN.foo
1.1 dsieger 6464: </pre>
1.184 rillig 6465: <p>The first section sets
6466: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6467: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6468: in the base system. This should not be a base system software
6469: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6470: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6471: included as part of the base system. This variable is only
6472: used internally within the <code class="filename">builtin.mk</code>
6473: file.</p>
6474: <p>The second section sets
6475: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6476: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6477: system if it exists (if
6478: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6479: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6480: within the <code class="filename">builtin.mk</code> file.</p>
6481: <p>The third section sets
6482: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6483: and is <span class="emphasis"><em>required</em></span> in all
6484: <code class="filename">builtin.mk</code> files. The code in this
6485: section must make the determination whether the built-in
6486: software is adequate to satisfy the dependencies listed in
6487: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6488: This is typically done by comparing
6489: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6490: against each of the dependencies in
6491: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6492: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6493: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6494: end of the <code class="filename">builtin.mk</code> file. Note that
6495: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6496: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6497: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6498: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6499: that the built-in version of the software is similar enough to
6500: be used as a replacement.</p>
6501: <p>The last section is guarded by
6502: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6503: and includes code that uses the value of
6504: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6505: set in the previous section. This typically includes, e.g.,
6506: adding additional dependency restrictions and listing additional
6507: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6508: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6509: </div>
6510: <div class="sect2">
6511: <div class="titlepage"><div><div><h3 class="title">
6512: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
6513: <p>When building packages, it's possible to choose whether to set
6514: a global preference for using either the built-in (native)
6515: version or the pkgsrc version of software to satisfy a
6516: dependency. This is controlled by setting
6517: <code class="varname">PREFER_PKGSRC</code> and
6518: <code class="varname">PREFER_NATIVE</code>. These variables take values
6519: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
6520: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
6521: use the pkgsrc versions of software, while
6522: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
6523: built-in versions. Preferences are determined by the most
6524: specific instance of the package in either
6525: <code class="varname">PREFER_PKGSRC</code> or
6526: <code class="varname">PREFER_NATIVE</code>. If a package is specified
6527: in neither or in both variables, then
6528: <code class="varname">PREFER_PKGSRC</code> has precedence over
6529: <code class="varname">PREFER_NATIVE</code>. For example, to require
6530: using pkgsrc versions of software for all but the most basic
6531: bits on a NetBSD system, you can set:</p>
1.1 dsieger 6532: <pre class="programlisting">
1.184 rillig 6533: PREFER_PKGSRC= yes
6534: PREFER_NATIVE= getopt skey tcp_wrappers
6535: </pre>
6536: <p>A package <span class="emphasis"><em>must</em></span> have a
6537: <code class="filename">builtin.mk</code>
6538: file to be listed in <code class="varname">PREFER_NATIVE</code>,
6539: otherwise it is simply ignored in that list.</p>
6540: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
6541: straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
6542: bootstrap.
6543: Switching between settings globally at a later date can introduce
6544: complications with dependency resolution. This is caused by packages
6545: built with the opposite preference being installed alongside each other.</p>
6546: <pre class="screen">
6547: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
1.1 dsieger 6548: </pre>
6549: </div>
1.7 rillig 6550: </div>
1.1 dsieger 6551: </div>
1.41 asau 6552: <div class="chapter">
1.1 dsieger 6553: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 6554: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.1 dsieger 6555: <div class="toc">
6556: <p><b>Table of Contents</b></p>
1.100 leot 6557: <dl class="toc">
1.184 rillig 6558: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6559: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6560: <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>
6561: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6562: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6563: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6564: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6565: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6566: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 6567: </dl>
6568: </div>
1.184 rillig 6569: <p>The <code class="filename">PLIST</code> file contains a package's
6570: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6571: the package (relative to the <code class="filename">${PREFIX}</code>
6572: directory it's been installed in) plus some additional statements
6573: - see the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
6574: This chapter addresses some issues that need attention when
6575: dealing with the <code class="filename">PLIST</code> file (or files, see
6576: below!).</p>
1.41 asau 6577: <div class="sect1">
1.1 dsieger 6578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6579: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6580: <p>Be sure to add a RCS ID line as the first thing in any
6581: <code class="filename">PLIST</code> file you write:</p>
6582: <pre class="programlisting">
6583: @comment $NetBSD $
6584: </pre>
6585: <p>An artificial space has been added between NetBSD and $, this is a
6586: workaround here to prevent CVS expanding to the filename of the guide. When
6587: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6588: </div>
1.41 asau 6589: <div class="sect1">
1.1 dsieger 6590: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6591: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6592: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6593: to output a PLIST that matches any new files since the package
6594: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6595: more information on this target.</p>
1.1 dsieger 6596: </div>
1.41 asau 6597: <div class="sect1">
1.1 dsieger 6598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6599: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6600: </h2></div></div></div>
6601: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6602: of AWK patterns and actions that are used to filter the output of
6603: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6604: scripting you like to it, but be careful with quoting.</p>
6605: <p>For example, to get all files inside the
6606: <code class="filename">libdata/foo</code> directory removed from the
6607: resulting PLIST:</p>
1.1 dsieger 6608: <pre class="programlisting">
1.184 rillig 6609: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 6610: </pre>
1.185 wiz 6611: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6612: evaluated after the file list and directory list are sorted.
6613: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6614: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6615: list and directory list are sorted.</p>
1.184 rillig 6616: </div>
6617: <div class="sect1">
6618: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6619: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6620: <p>A number of variables are substituted automatically in
6621: PLISTs when a package is installed on a system. This includes the
6622: following variables:</p>
6623: <div class="variablelist"><dl class="variablelist">
6624: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6625: <dd>
6626: <p>Some packages like emacs and perl embed information
6627: about which architecture they were built on into the
6628: pathnames where they install their files. To handle this
6629: case, PLIST will be preprocessed before actually used, and
6630: the symbol
6631: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6632: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6633: same is done if the string
6634: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6635: PLIST somewhere - use this on packages that have GNU
6636: autoconf-created configure scripts.</p>
6637: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6638: <h3 class="title">Legacy note</h3>
6639: <p>There used to be a symbol
6640: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6641: was replaced by the output of <span class="command"><strong>uname
6642: -m</strong></span>, but that's no longer supported and has
6643: been removed.</p>
6644: </div>
6645: </dd>
6646: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6647: <dd>
6648: <p>Some packages want to embed the OS name and version
6649: into some paths. To do this, use these variables in the
6650: <code class="filename">PLIST</code>:
6651: </p>
6652: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6653: <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>
6654: <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>
6655: <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>
6656: </ul></div>
6657: </dd>
6658: </dl></div>
6659: <p>For a list of values which are replaced by
6660: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6661: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6662: <code class="varname">PLIST_SUBST</code> should help.</p>
6663: <p>If you want to change other variables not listed above, you
6664: can add variables and their expansions to this variable in the
6665: 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 6666: <pre class="programlisting">
1.184 rillig 6667: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 6668: </pre>
1.184 rillig 6669: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6670: in the <code class="filename">PLIST</code> with
6671: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6672: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6673: the common case of conditionally including some
6674: <code class="filename">PLIST</code> entries. It can be done by adding
6675: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6676: setting the corresponding <code class="varname">PLIST.foo</code> variable
6677: to <code class="literal">yes</code> if the entry should be included.
6678: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6679: in the <code class="filename">PLIST</code> with either
6680: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6681: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6682: For example, in <code class="filename">Makefile</code>:</p>
1.66 asau 6683: <pre class="programlisting">
1.184 rillig 6684: PLIST_VARS+= foo
6685: .if <em class="replaceable"><code>condition</code></em>
6686: PLIST.foo= yes
6687: .else
1.66 asau 6688: </pre>
1.184 rillig 6689: <p>And then in <code class="filename">PLIST</code>:</p>
1.1 dsieger 6690: <pre class="programlisting">
1.184 rillig 6691: @comment $NetBSD $
6692: bin/bar
6693: man/man1/bar.1
6694: ${PLIST.foo}bin/foo
6695: ${PLIST.foo}man/man1/foo.1
6696: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 6697: </pre>
1.184 rillig 6698: <p>An artificial space has been added between NetBSD and $, this is a
6699: workaround here to prevent CVS expanding to the filename of the guide. When
6700: adding the RCS ID the space should be ommited.</p>
1.1 dsieger 6701: </div>
1.184 rillig 6702: <div class="sect1">
6703: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6704: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6705: <p>Man pages should be installed in compressed form if
6706: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6707: and uncompressed otherwise. To handle this in the
6708: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6709: appended/removed automatically for man pages according to
6710: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6711: or not, see above for details. This modification of the
6712: <code class="filename">PLIST</code> file is done on a copy of it, not
6713: <code class="filename">PLIST</code> itself.</p>
1.1 dsieger 6714: </div>
1.41 asau 6715: <div class="sect1">
1.1 dsieger 6716: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6717: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6718: </h2></div></div></div>
6719: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6720: in generating the binary package, set the variable
6721: <code class="varname">PLIST_SRC</code> to the names of that file(s).
6722: The files are later concatenated using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
6723: important. The default for <code class="varname">PLIST_SRC</code> is
6724: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.1 dsieger 6725: </div>
1.41 asau 6726: <div class="sect1">
1.1 dsieger 6727: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6728: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6729: <p>Some packages decide to install a different set of files based on
6730: the operating system being used. These differences can be
6731: automatically handled by using the following files:</p>
6732: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6733: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6734: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6735: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6736: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6737: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6738: </ul></div>
1.1 dsieger 6739: </div>
1.41 asau 6740: <div class="sect1">
1.1 dsieger 6741: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6742: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6743: <p>Some packages decide to generate hard-to-guess file names
6744: during installation that are hard to wire down.</p>
6745: <p>In such cases, you can set the
6746: <code class="varname">GENERATE_PLIST</code> variable to shell code
6747: terminated (with a semicolon) that will output PLIST entries which
6748: will be appended to the PLIST</p>
6749: <p>You can find one example in editors/xemacs:</p>
6750: <pre class="programlisting">
6751: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6752: </pre>
6753: <p>which will append something like
6754: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6755: <code class="filename">PLIST</code>.
6756: </p>
1.1 dsieger 6757: </div>
1.41 asau 6758: <div class="sect1">
1.1 dsieger 6759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6760: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6761: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6762: multiple (and unrelated) packages install files. These
6763: directories were problematic because you had to add special
6764: tricks in the PLIST to conditionally remove them, or have some
6765: centralized package handle them.</p>
6766: <p>In pkgsrc, it is now easy: Each package should create
6767: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6768: will remove any directories left empty after uninstalling a
6769: package.</p>
6770: <p>If a package needs an empty directory to work, create
6771: the directory during installation as usual, and also add an
6772: entry to the PLIST:
6773:
6774: </p>
6775: <pre class="programlisting">
6776: @pkgdir path/to/empty/directory
6777: </pre>
6778: <p>
6779:
6780: or take a look at <code class="varname">MAKE_DIRS</code> and
6781: <code class="varname">OWN_DIRS</code>.
1.1 dsieger 6782: </p>
6783: </div>
1.184 rillig 6784: </div>
6785: <div class="chapter">
6786: <div class="titlepage"><div><div><h2 class="title">
6787: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6788: <div class="toc">
6789: <p><b>Table of Contents</b></p>
6790: <dl class="toc">
6791: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6792: <dd><dl>
6793: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6794: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6795: </dl></dd>
6796: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6797: <dd><dl>
6798: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6799: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
6800: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
6801: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
6802: </dl></dd>
6803: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6804: <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>
6805: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6806: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6807: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6808: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6809: <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>
6810: </dl>
6811: </div>
6812: <p>This chapter describes the framework known as
6813: <code class="literal">pkginstall</code>, whose key features are:</p>
6814: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6815: <li class="listitem"><p>Generic installation and manipulation of directories and files
6816: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6817: <li class="listitem"><p>Automatic handling of configuration files during installation,
6818: provided that packages are correctly designed.</p></li>
6819: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6820: <li class="listitem"><p>Registration of system users and groups.</p></li>
6821: <li class="listitem"><p>Registration of system shells.</p></li>
6822: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6823: </ul></div>
6824: <p>The following sections inspect each of the above points in detail.</p>
6825: <p>You may be thinking that many of the things described here could be
6826: easily done with simple code in the package's post-installation target
6827: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6828: as the code in them is only executed when building from source. Machines
6829: using binary packages could not benefit from it at all (as the code itself
6830: could be unavailable). Therefore, the only way to achieve any of the items
6831: described above is by means of the installation scripts, which are
6832: automatically generated by pkginstall.</p>
1.41 asau 6833: <div class="sect1">
1.1 dsieger 6834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6835: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6836: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6837: of files and directories that belong to a package. The names used in it
6838: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6839: which means that it cannot register files outside this directory (absolute
6840: path names are not allowed). Despite this restriction, some packages need
6841: to install files outside this location; e.g., under
6842: <code class="filename">${VARBASE}</code> or
6843: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6844: is to create such files during installation time by using
6845: installation scripts.</p>
6846: <p>The generic installation scripts are shell scripts that can
6847: contain arbitrary code. The list of scripts to execute is taken from
6848: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6849: <code class="filename">INSTALL</code>. A similar variable exists for package
6850: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6851: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6852: commands, so they have the potential to create and manage files
6853: anywhere in the file system.</p>
6854: <p>Using these general installation files is not recommended, but
6855: may be needed in some special cases. One reason for avoiding them is
6856: that the user has to trust the packager that there is no unwanted or
6857: simply erroneous code included in the installation script. Also,
6858: previously there were many similar scripts for the same functionality,
6859: and fixing a common error involved finding and changing all of
6860: them.</p>
6861: <p>The pkginstall framework offers another, standardized way. It
6862: provides generic scripts to abstract the manipulation of such files
6863: and directories based on variables set in the package's
6864: <code class="filename">Makefile</code>. The rest of this section describes
6865: these variables.</p>
6866: <div class="sect2">
6867: <div class="titlepage"><div><div><h3 class="title">
6868: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
6869: <p>The following variables can be set to request the creation of
6870: directories anywhere in the file system:</p>
6871: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6872: <li class="listitem">
6873: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
6874: contain a list of directories that should be created and should attempt
6875: to be destroyed by the installation scripts. The difference between
6876: the two is that the latter prompts the administrator to remove any
6877: directories that may be left after deinstallation (because they were
6878: not empty), while the former does not. Example:</p>
6879: <pre class="programlisting">
6880: MAKE_DIRS+= ${VARBASE}/foo/private
6881: </pre>
6882: </li>
6883: <li class="listitem">
6884: <p><code class="varname">MAKE_DIRS_PERMS</code> and
6885: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
6886: which directories should be created and should attempt to be destroyed
6887: by the installation scripts. Each tuple holds the following values,
6888: separated by spaces: the directory name, its owner, its group and its
6889: numerical mode. For example:</p>
6890: <pre class="programlisting">
6891: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
6892: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
6893: </pre>
6894: <p>The difference between the two is exactly the same as their
6895: non-<code class="varname">PERMS</code> counterparts.</p>
6896: </li>
6897: </ul></div>
1.1 dsieger 6898: </div>
1.184 rillig 6899: <div class="sect2">
6900: <div class="titlepage"><div><div><h3 class="title">
6901: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
6902: <p>Creating non-empty files outside the installation prefix is tricky
6903: because the <code class="filename">PLIST</code> forces all files to be inside it.
6904: To overcome this problem, the only solution is to extract the file in the
6905: known place (i.e., inside the installation prefix) and copy it to the
6906: appropriate location during installation (done by the installation scripts
6907: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
6908: file</em></span> in the following paragraphs, which describe the variables
6909: that can be used to automatically and consistently handle files outside the
6910: installation prefix:</p>
6911: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6912: <li class="listitem">
6913: <p><code class="varname">CONF_FILES</code> and
6914: <code class="varname">REQD_FILES</code> are pairs of master and target files.
6915: During installation time, the master file is copied to the target one
6916: if and only if the latter does not exist. Upon deinstallation, the
6917: target file is removed provided that it was not modified by the
6918: installation.</p>
6919: <p>The difference between the two is that the latter prompts the
6920: administrator to remove any files that may be left after
6921: deinstallation (because they were not empty), while the former does
6922: not.</p>
6923: </li>
6924: <li class="listitem">
6925: <p><code class="varname">CONF_FILES_PERMS</code> and
6926: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
6927: files as well as their target locations. For each of them, it also
6928: specifies their owner, their group and their numeric permissions, in
6929: this order. For example:</p>
1.1 dsieger 6930: <pre class="programlisting">
1.184 rillig 6931: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
6932: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 6933: </pre>
1.184 rillig 6934: <p>The difference between the two is exactly the same as their
6935: non-<code class="varname">PERMS</code> counterparts.</p>
6936: </li>
6937: </ul></div>
6938: </div>
1.1 dsieger 6939: </div>
1.41 asau 6940: <div class="sect1">
1.1 dsieger 6941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6942: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
6943: <p>Configuration files are special in the sense that they are installed
6944: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
6945: need special treatment during installation (most of which is automated by
6946: pkginstall). The main concept you must bear in mind is that files marked
6947: as configuration files are automatically copied to the right place (somewhere
6948: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
6949: and only if</em></span> they didn't exist before. Similarly, they will not
6950: be removed if they have local modifications. This ensures that
6951: administrators never lose any custom changes they may have made.</p>
6952: <div class="sect2">
6953: <div class="titlepage"><div><div><h3 class="title">
6954: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
6955: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
6956: specifies where configuration files shall be installed. Its contents are
6957: set based upon the following variables:</p>
6958: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6959: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
6960: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
6961: be overridden by the user to point to his preferred location (e.g.,
6962: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
6963: Packages must not use it directly.</p></li>
6964: <li class="listitem">
6965: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
6966: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
6967: for the package being built shall be installed. The definition of this
6968: variable only makes sense in the package's
6969: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
6970: <p>As an example, consider the Apache package,
6971: <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
6972: configuration files under the
6973: <code class="filename">httpd/</code> subdirectory of
6974: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
6975: Makefile.</p>
6976: </li>
6977: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
6978: variable that holds this package's configuration directory (if
6979: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
6980: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
6981: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
6982: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
6983: directory where the configuration files for the package identified by
6984: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
6985: </ul></div>
6986: <p>Based on the above variables, pkginstall determines the value of
6987: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
6988: variable that can be used within a package to refer to its configuration
6989: directory. The algorithm used to set its value is basically the
6990: following:</p>
6991: <div class="orderedlist"><ol class="orderedlist" type="1">
6992: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
6993: its value is used.</p></li>
6994: <li class="listitem"><p>If the previous variable is not defined but
6995: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
6996: <code class="filename">Makefile</code>, the resulting value is
6997: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
6998: <li class="listitem"><p>Otherwise, it is set to
6999: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7000: </ol></div>
7001: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
7002: 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
7003: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
7004: be created with OWN_DIRS or MAKE_DIRS.</p>
7005: </div>
7006: <div class="sect2">
7007: <div class="titlepage"><div><div><h3 class="title">
7008: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7009: <p>Given that pkgsrc (and users!) expect configuration files to be in a
7010: known place, you need to teach each package where it shall install its
7011: files. In some cases you will have to patch the package Makefiles to
7012: achieve it. If you are lucky, though, it may be as easy as passing an
7013: extra flag to the configuration script; this is the case of GNU Autoconf-
7014: generated files:</p>
1.1 dsieger 7015: <pre class="programlisting">
1.184 rillig 7016: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 7017: </pre>
1.184 rillig 7018: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
7019: for</em></span> its configuration files, not where they will be originally
7020: installed (although the difference is never explicit,
7021: unfortunately).</p>
1.1 dsieger 7022: </div>
1.184 rillig 7023: <div class="sect2">
7024: <div class="titlepage"><div><div><h3 class="title">
7025: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
7026: <p>As said before, pkginstall automatically handles configuration files.
7027: This means that <span class="strong"><strong>the packages themselves must not
7028: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7029: directly</strong></span>. Bad news is that many software installation scripts
7030: will, out of the box, mess with the contents of that directory. So what is
7031: the correct procedure to fix this issue?</p>
7032: <p>You must teach the package (usually by manually patching it) to
7033: install any configuration files under the examples hierarchy,
7034: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7035: <code class="filename">PLIST</code> registers them and the administrator always
7036: has the original copies available.</p>
7037: <p>Once the required configuration files are in place (i.e., under the
7038: examples hierarchy), the pkginstall framework can use them as master copies
7039: during the package installation to update what is in
7040: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7041: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
7042: 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
7043: about their syntax and their purpose. Here is an example, taken from the
7044: <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 7045: <pre class="programlisting">
1.184 rillig 7046: EGDIR= ${PREFIX}/share/doc/mutt/samples
7047: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 dsieger 7048: </pre>
1.184 rillig 7049: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
7050: package and has no meaning outside it.</p>
1.1 dsieger 7051: </div>
1.184 rillig 7052: <div class="sect2">
7053: <div class="titlepage"><div><div><h3 class="title">
7054: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
7055: <p>The automatic copying of config files can be toggled by setting the
7056: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7057: installation.</p>
1.1 dsieger 7058: </div>
7059: </div>
1.41 asau 7060: <div class="sect1">
1.1 dsieger 7061: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7062: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7063: <p>System startup scripts are special files because they must be
7064: installed in a place known by the underlying OS, usually outside the
7065: 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
7066: can be used. However, pkginstall provides a special mechanism to handle
7067: these files.</p>
7068: <p>In order to provide system startup scripts, the package has
7069: to:</p>
7070: <div class="orderedlist"><ol class="orderedlist" type="1">
7071: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7072: the <code class="literal">.sh</code> suffix appended. Considering the
7073: <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
7074: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
7075: <li class="listitem">
7076: <p>Tell pkginstall to handle it, appending the name of the script,
7077: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7078: Continuing the previous example:</p>
7079: <pre class="programlisting">
7080: RCD_SCRIPTS+= cupsd
7081: </pre>
7082: </li>
7083: </ol></div>
7084: <p>Once this is done, pkginstall will do the following steps for each
7085: script in an automated fashion:</p>
7086: <div class="orderedlist"><ol class="orderedlist" type="1">
7087: <li class="listitem"><p>Process the file found in the files directory applying all the
7088: substitutions described in the <code class="filename">FILES_SUBST</code>
7089: variable.</p></li>
7090: <li class="listitem"><p>Copy the script from the files directory to the examples
7091: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
7092: that this master file must be explicitly registered in the
7093: <code class="filename">PLIST</code>.</p></li>
7094: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7095: from the examples hierarchy into the system-wide startup scripts
7096: directory.</p></li>
7097: </ol></div>
7098: <div class="sect2">
7099: <div class="titlepage"><div><div><h3 class="title">
7100: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7101: <p>The automatic copying of config files can be toggled by setting the
7102: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7103: installation. Note that the scripts will be always copied inside the
7104: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7105: matter what the value of this variable is.</p>
1.1 dsieger 7106: </div>
7107: </div>
1.184 rillig 7108: <div class="sect1">
7109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7110: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7111: <p>If a package needs to create special users and/or groups during
7112: installation, it can do so by using the pkginstall framework.</p>
7113: <p>Users can be created by adding entries to the
7114: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7115: syntax:</p>
7116: <pre class="programlisting">
7117: user:group
7118: </pre>
7119: <p>Further specification of user details may be done by setting
7120: per-user variables.
7121: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7122: numeric UID for the user.
7123: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7124: user's description or comment.
7125: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7126: user's home directory, and defaults to
7127: <code class="filename">/nonexistent</code> if not specified.
7128: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7129: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7130: not specified.</p>
7131: <p>Similarly, groups can be created by adding entries to the
7132: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7133: <pre class="programlisting">
7134: group
7135: </pre>
7136: <p>The numeric GID of the group may be set by defining
7137: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7138: <p>If a package needs to create the users and groups at an earlier
7139: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7140: <code class="literal">configure</code>,<code class="literal">build</code>, or
7141: <code class="literal">pre-install</code> to indicate the phase before which the
7142: users and groups are created. In this case, the numeric UIDs and GIDs
7143: of the created users and groups are automatically hardcoded into the
7144: final installation scripts.</p>
1.1 dsieger 7145: </div>
1.41 asau 7146: <div class="sect1">
1.1 dsieger 7147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7148: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7149: <p>Packages that install system shells should register them in the shell
7150: database, <code class="filename">/etc/shells</code>, to make things easier to the
7151: administrator. This must be done from the installation scripts to keep
7152: binary packages working on any system. pkginstall provides an easy way to
7153: accomplish this task.</p>
7154: <p>When a package provides a shell interpreter, it has to set the
7155: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7156: add some hooks to the installation scripts to handle it. Consider the
7157: 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>
7158: <pre class="programlisting">
7159: PKG_SHELL= ${PREFIX}/bin/zsh
7160: </pre>
7161: <div class="sect2">
7162: <div class="titlepage"><div><div><h3 class="title">
7163: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7164: <p>The automatic registration of shell interpreters can be disabled by
7165: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7166: environment variable to <code class="literal">NO</code>.</p>
7167: </div>
1.1 dsieger 7168: </div>
1.41 asau 7169: <div class="sect1">
1.1 dsieger 7170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7171: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7172: <p>Packages that install X11 fonts should update the database files
7173: that index the fonts within each fonts directory. This can easily be
7174: accomplished within the pkginstall framework.</p>
7175: <p>When a package installs X11 fonts, it must list the directories in
7176: which fonts are installed in the
7177: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7178: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7179: <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
7180: installation scripts to run the appropriate commands to update the fonts
7181: database files within each of those directories. For convenience, if the
7182: directory path is relative, it is taken to be relative to the package's
7183: 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 7184: <pre class="programlisting">
1.184 rillig 7185: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 7186: </pre>
1.184 rillig 7187: <div class="sect2">
7188: <div class="titlepage"><div><div><h3 class="title">
7189: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7190: <p>The automatic update of fonts databases can be disabled by
7191: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7192: environment variable to <code class="literal">NO</code>.</p>
1.1 dsieger 7193: </div>
7194: </div>
7195: </div>
1.41 asau 7196: <div class="chapter">
1.1 dsieger 7197: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 7198: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 7199: <div class="toc">
7200: <p><b>Table of Contents</b></p>
1.100 leot 7201: <dl class="toc">
1.154 rillig 7202: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 7203: <dd><dl>
1.154 rillig 7204: <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>
7205: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7206: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7207: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7208: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7209: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7210: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7211: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7212: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7213: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7214: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7215: </dl></dd>
7216: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7217: <dd><dl>
7218: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7219: <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>
7220: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7221: </dl></dd>
7222: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7223: <dd><dl>
7224: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7225: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7226: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
7227: </dl></dd>
7228: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7229: <dd><dl>
7230: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7231: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
7232: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
7233: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
7234: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
7235: </dl></dd>
7236: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7237: <dd><dl>
7238: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7239: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 7240: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7241: <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>
7242: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 7243: </dl></dd>
7244: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7245: <dd><dl>
7246: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7247: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7248: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7249: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7250: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7251: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
7252: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
7253: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
7254: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
7255: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
7256: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
7257: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
7258: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
7259: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
7260: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
7261: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
7262: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
7263: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 7264: emulation</a></span></dt>
1.154 rillig 7265: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
7266: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7267: </dl></dd>
1.154 rillig 7268: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7269: </dl>
7270: </div>
1.41 asau 7271: <div class="sect1">
1.1 dsieger 7272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7273: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 7274: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 7275: different platforms. As a result, it is important to ensure,
7276: where possible, that packages in pkgsrc are portable. This
7277: chapter mentions some particular details you should pay
7278: attention to while working on pkgsrc.</p>
1.41 asau 7279: <div class="sect2">
1.1 dsieger 7280: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7281: <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 7282: </h3></div></div></div>
7283: <p>The pkgsrc user can configure pkgsrc by overriding several
7284: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7285: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7286: want to use those variables in the preprocessor directives of
1.174 leot 7287: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1 dsieger 7288: <code class="literal">.for</code>), you need to include the file
7289: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7290: loads the user preferences.</p>
7291: <p>But note that some variables may not be completely defined
7292: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7293: included, as they may contain references to variables that are
1.108 rillig 7294: not yet defined. In shell commands (the lines in
7295: <code class="filename">Makefile</code> that are indented with a tab) this
7296: is no problem, since variables are only expanded when they are
7297: used. But in the preprocessor directives mentioned above and in
7298: dependency lines (of the form <code class="literal">target:
1.1 dsieger 7299: dependencies</code>) the variables are expanded at load
7300: time.</p>
1.41 asau 7301: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7302: <h3 class="title">Note</h3>
1.108 rillig 7303: <p>To check whether a variable can be used at load time,
7304: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 7305: </div>
7306: </div>
1.41 asau 7307: <div class="sect2">
1.1 dsieger 7308: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7309: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 7310: <p>Occasionally, packages require interaction from the user,
7311: and this can be in a number of ways:</p>
1.41 asau 7312: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7313: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7314: interaction such as entering username/password or accepting a
7315: license on a web page.</p></li>
1.23 wiz 7316: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7317: passwords.</p></li>
1.23 wiz 7318: <li class="listitem"><p>help to configure the package before it is built</p></li>
7319: <li class="listitem"><p>help during the build process</p></li>
7320: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7321: </ul></div>
1.108 rillig 7322: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7323: variable to define which stages need interaction. This should be
7324: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 7325: <pre class="programlisting">
7326: INTERACTIVE_STAGE= configure install
1.111 sevan 7327: </pre>
1.1 dsieger 7328: <p>The user can then decide to skip this package by setting the
1.108 rillig 7329: <code class="varname">BATCH</code> variable. Packages that require interaction
7330: are also excluded from bulk builds.</p>
1.1 dsieger 7331: </div>
1.41 asau 7332: <div class="sect2">
1.1 dsieger 7333: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7334: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 7335: <p>Authors of software can choose the licence under which software
7336: can be copied. The Free Software Foundation has declared some
7337: licenses "Free", and the Open Source Initiative has a definition of
7338: "Open Source".</p>
7339: <p>By default, pkgsrc allows packages with Free or Open Source
7340: licenses to be built. To allow packages with other licenses to be
7341: built as well, the pkgsrc user needs to add these licenses to the
7342: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7343: that this variable only affects which packages may be
7344: <span class="emphasis"><em>built</em></span>, while the license terms often also
7345: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 7346: <p>One might want to only install packages with a BSD license,
1.108 rillig 7347: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 7348: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 7349: user can override the default by setting the
7350: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 7351: of "+=". The licenses accepted by default are defined in the
7352: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7353: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7354: <p>The license tag mechanism is intended to address
7355: copyright-related issues surrounding building, installing and
7356: using a package, and not to address redistribution issues (see
7357: <code class="varname">RESTRICTED</code> and
1.111 sevan 7358: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7359: Packages with redistribution restrictions should set these
7360: tags.</p>
1.1 dsieger 7361: <p>Denoting that a package may be copied according to a
7362: particular license is done by placing the license in
7363: <code class="filename">pkgsrc/licenses</code> and setting the
7364: <code class="varname">LICENSE</code> variable to a string identifying the
1.137 leot 7365: 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 7366: <pre class="programlisting">
7367: LICENSE= xv-license
1.111 sevan 7368: </pre>
1.1 dsieger 7369: <p>When trying to build, the user will get a notice that the
7370: package is covered by a license which has not been placed in the
7371: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7372: <pre class="programlisting">
7373: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7374: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7375: ===> To view the license, enter "/usr/bin/make show-license".
7376: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7377: ===> ACCEPTABLE_LICENSES+=xv-license
7378: *** Error code 1
1.111 sevan 7379: </pre>
1.10 hubertf 7380: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7381: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7382: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7383: convey to pkgsrc that it should not in the future fail because of
7384: that license:</p>
7385: <pre class="programlisting">
7386: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7387: </pre>
7388: <p>The use of <code class="varname">LICENSE=shareware</code>,
7389: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7390: is deprecated because it does not crisply refer to a particular
7391: license text. Another problem with such usage is that it does not
7392: enable a user to tell pkgsrc to proceed for a single package
7393: without also telling pkgsrc to proceed for all packages with that
7394: tag.</p>
7395: <div class="sect3">
7396: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7397: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7398: <p>When adding a package with a new license, the following steps
7399: are required:</p>
7400: <div class="orderedlist"><ol class="orderedlist" type="1">
7401: <li class="listitem">
1.169 rillig 7402: <p>Check whether the license qualifies as Free or Open Source by
7403: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7404: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111 sevan 7405: Open Source Initiative</a>. If this is the case, the filename in
7406: <code class="filename">pkgsrc/licenses/</code> does not need the
7407: <code class="filename">-license</code> suffix, and the license name should be
7408: added to:</p>
1.48 rodent 7409: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7410: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7411: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7412: <li class="listitem"><p>default_acceptable_licenses in
7413: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48 rodent 7414: </ul></div>
7415: </li>
1.169 rillig 7416: <li class="listitem"><p>The license text should be added to
7417: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7418: licenses can be seen in this directory.</p></li>
1.48 rodent 7419: </ol></div>
1.111 sevan 7420: </div>
7421: <div class="sect3">
7422: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7423: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7424: <p>When the license changes (in a way other than formatting),
1.111 sevan 7425: make sure that the new license has a different name (e.g.,
1.1 dsieger 7426: append the version number if it exists, or the date). Just
7427: because a user told pkgsrc to build programs under a previous
7428: version of a license does not mean that pkgsrc should build
7429: programs under the new licenses. The higher-level point is that
7430: pkgsrc does not evaluate licenses for reasonableness; the only
7431: test is a mechanistic test of whether a particular text has been
1.111 sevan 7432: approved by either of two bodies (FSF or OSI).</p>
7433: </div>
1.1 dsieger 7434: </div>
1.41 asau 7435: <div class="sect2">
1.1 dsieger 7436: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7437: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7438: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7439: By declaring the restrictions, package tools can
1.1 dsieger 7440: automatically refrain from e.g. placing binary packages on FTP
7441: sites.</p>
1.111 sevan 7442: <p>There are four possible restrictions, which are
1.1 dsieger 7443: the cross product of sources (distfiles) and binaries not being
7444: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7445: language in any license, and because non-Free licenses tend to be
7446: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7447: CD-ROM.
7448:
7449: "FTP" means making the source or binary file available over the
7450: Internet at no charge.
7451:
7452: "CD-ROM" means making the source or binary available on some kind of
7453: media, together with other source and binary packages, which is sold
7454: for a distribution charge.
1.1 dsieger 7455: </p>
7456: <p>In order to encode these restrictions, the package system
7457: defines five make variables that can be set to note these
7458: restrictions:</p>
1.41 asau 7459: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7460: <li class="listitem">
1.1 dsieger 7461: <p><code class="varname">RESTRICTED</code></p>
7462: <p>This variable should be set whenever a restriction
7463: exists (regardless of its kind). Set this variable to a
7464: string containing the reason for the restriction. It should
7465: be understood that those wanting to understand the restriction
7466: will have to read the license, and perhaps seek advice of
7467: counsel.</p>
7468: </li>
1.23 wiz 7469: <li class="listitem">
1.1 dsieger 7470: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7471: <p>Binaries may not be placed on CD-ROM containing other
7472: binary packages, for which a distribution charge may be made.
7473: In this case, set this variable to
7474: <code class="varname">${RESTRICTED}</code>.</p>
7475: </li>
1.23 wiz 7476: <li class="listitem">
1.1 dsieger 7477: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7478: <p>Binaries may not made available on the Internet without
7479: charge. In this case, set this variable to
7480: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7481: binary packages will not be included on ftp.NetBSD.org.</p>
7482: </li>
1.23 wiz 7483: <li class="listitem">
1.1 dsieger 7484: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7485: <p>Distfiles may not be placed on CD-ROM, together with
7486: other distfiles, for which a fee may be charged. In this
7487: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7488: </p>
7489: </li>
1.23 wiz 7490: <li class="listitem">
1.1 dsieger 7491: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7492: <p>Distfiles may not made available via FTP at no charge.
7493: In this case, set this variable to
7494: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7495: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7496: </li>
7497: </ul></div>
1.111 sevan 7498: <p>Please note that packages will be removed from pkgsrc when the
7499: distfiles are not distributable and cannot be obtained for a period
7500: of one full quarter branch. Packages with manual/interactive fetch
7501: must have a maintainer and it is his/her responsibility to ensure
7502: this.</p>
1.1 dsieger 7503: </div>
1.41 asau 7504: <div class="sect2">
1.1 dsieger 7505: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7506: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.175 gutterid 7507: <p>Your package may depend on some other package being present,
7508: and there are various ways of expressing this dependency.
7509: pkgsrc supports the <code class="varname">DEPENDS</code>,
7510: <code class="varname">BUILD_DEPENDS</code>,
7511: <code class="varname">TOOL_DEPENDS</code>, and
7512: <code class="varname">TEST_DEPENDS</code> definitions, the
1.1 dsieger 7513: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7514: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7515: to handle dependencies, and which uses the variables named above.
1.184 rillig 7516: 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 7517: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7518: definition registers that pre-requisite in the binary package so it
7519: will be pulled in when the binary package is later installed, whilst
7520: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7521: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7522: dependency that is only needed for building or testing the resulting
1.184 rillig 7523: 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 7524: <p>This means that if you only need a package present whilst
1.175 gutterid 7525: you are building or testing, it should be noted as a
7526: <code class="varname">TOOL_DEPENDS</code>,
7527: <code class="varname">BUILD_DEPENDS</code>, or
7528: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.156 leot 7529: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7530: packages, i.e. packages for the architecture where the package
7531: is built;
7532: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.175 gutterid 7533: packages, i.e., packages for the architecture for which the package
1.156 leot 7534: is built.</p>
1.175 gutterid 7535: <p>The format for a <code class="varname">DEPENDS</code>,
7536: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7537: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.1 dsieger 7538: <pre class="programlisting">
7539: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7540: </pre>
1.23 wiz 7541: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7542: may include any of the wildcard version numbers recognized by
1.174 leot 7543: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23 wiz 7544: <div class="orderedlist"><ol class="orderedlist" type="1">
7545: <li class="listitem">
1.1 dsieger 7546: <p>If your package needs another package's binaries or
1.54 wiz 7547: libraries to build and run, and if that package has a
1.1 dsieger 7548: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7549: <pre class="programlisting">
7550: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7551: </pre>
1.1 dsieger 7552: </li>
1.23 wiz 7553: <li class="listitem">
1.54 wiz 7554: <p>If your package needs another package's binaries or
7555: libraries only for building, and if that package has a
7556: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7557: <pre class="programlisting">
7558: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7559: </pre>
1.54 wiz 7560: <p>but set
7561: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7562: to make it a build dependency only. This case is rather
7563: rare.</p>
7564: </li>
7565: <li class="listitem">
1.25 spz 7566: <p>If your package needs binaries from another package to build,
1.156 leot 7567: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7568: <pre class="programlisting">
1.156 leot 7569: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7570: </pre>
1.1 dsieger 7571: </li>
1.156 leot 7572: <li class="listitem"><p>If your package needs static libraries to link against, header
7573: files to include, etc. from another package to build,
7574: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7575: <li class="listitem"><p>If your package needs a library with which to link and
7576: there is no <code class="filename">buildlink3.mk</code> file
7577: available, create one. Using
7578: <code class="varname">DEPENDS</code> won't be sufficient because the
7579: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7580: <li class="listitem">
1.25 spz 7581: <p>If your package needs some executable to be able to run
7582: correctly and if there's no
7583: <code class="filename">buildlink3.mk</code> file, this is specified
7584: using the <code class="varname">DEPENDS</code> variable. The
1.137 leot 7585: <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 7586: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7587: when it runs, and that is specified:</p>
1.1 dsieger 7588: <pre class="programlisting">
1.129 wiz 7589: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7590: </pre>
1.25 spz 7591: </li>
1.175 gutterid 7592: <li class="listitem"><p>If your package includes a test suite that has extra
7593: dependencies only required for this purpose (frequently this
7594: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7595: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.25 spz 7596: <li class="listitem">
7597: <p>You can use wildcards in package dependencies. Note that
7598: such wildcard dependencies are retained when creating binary
7599: packages. The dependency is checked when installing the binary
7600: package and any package which matches the pattern will be
7601: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7602: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7603: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7604: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7605: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7606: <p>Wildcards can also be used to specify that a package
7607: will only build against a certain minimum version of a
7608: pre-requisite:</p>
7609: <pre class="programlisting">
1.25 spz 7610: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7611: </pre>
1.25 spz 7612: <p>This means that the package will build using version 6.0
7613: of ImageMagick or newer. Such a dependency may be warranted
7614: if, for example, the command line options of an executable
7615: have changed.</p>
7616: <p>If you need to depend on minimum versions of libraries,
1.183 wiz 7617: set
7618: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7619: to the appropriate pattern before including its
7620: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7621: <pre class="programlisting">
7622: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7623: .include "../../graphics/jpeg/buildlink3.mk"
7624: </pre>
1.1 dsieger 7625: <p>For security fixes, please update the package
1.154 rillig 7626: 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 7627: information.</p>
7628: </li>
7629: </ol></div>
7630: <p>If your package needs files from another package to build,
7631: add the relevant distribution files to
7632: <code class="varname">DISTFILES</code>, so they will be extracted
1.137 leot 7633: 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 7634: (It relies on the jpeg sources being present in source form
7635: during the build.)</p>
7636: </div>
1.41 asau 7637: <div class="sect2">
1.1 dsieger 7638: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7639: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7640: <p>Your package may conflict with other packages a user might
7641: already have installed on his system, e.g. if your package
7642: installs the same set of files as another package in the pkgsrc
1.80 wiz 7643: tree or has the same <code class="varname">PKGNAME</code>.</p>
1.142 leot 7644: <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>
7645: 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>
7646: install the same shared library, thus you set in
7647: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7648: <pre class="programlisting">
7649: CONFLICTS= Xaw-Xpm-[0-9]*
7650: </pre>
7651: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7652: <pre class="programlisting">
7653: CONFLICTS= libXaw3d-[0-9]*
7654: </pre>
1.174 leot 7655: <p><a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.142 leot 7656: that conflict with existing packages and abort. However, in many
7657: situations this is too late in the process. Binary package managers
7658: will not know about the conflict until they attempt to install the
7659: package after already downloading it and all its dependencies.
7660: Users may also waste time building a package and its dependencies
7661: only to find out at the end that it conflicts with another package
7662: they have installed.</p>
7663: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7664: should be added in all cases where it is known that packages conflict
7665: with each other. These <code class="varname">CONFLICTS</code> entries are
1.174 leot 7666: exported in <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.142 leot 7667: managers to inform users that packages cannot be installed onto
7668: the target system.</p>
1.1 dsieger 7669: </div>
1.41 asau 7670: <div class="sect2">
1.1 dsieger 7671: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7672: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7673: <p>There are several reasons why a package might be
7674: instructed to not build under certain circumstances. If the
7675: package builds and runs on most platforms, the exceptions
1.83 dholland 7676: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7677: the package builds and runs on a small handful of platforms,
7678: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7679: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7680: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7681: (OS-version-platform) that can use glob-style
7682: wildcards.</p>
7683: <p>If a package is not appropriate for some platforms (as
1.114 maya 7684: opposed to merely broken), a different set of variables should be
1.83 dholland 7685: used as this affects failure reporting and statistics.
7686: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7687: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7688: the package is appropriate for only a small handful of platforms
7689: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7690: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7691: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7692: (OS-version-platform) that can use glob-style
7693: wildcards.</p>
7694: <p>Some packages are tightly bound to a specific version of an
1.137 leot 7695: 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 7696: backwards compatible with other versions of the OS, and should be
7697: uploaded to a version specific directory on the FTP server. Mark
7698: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7699: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7700: the package system internals, but may be used in the
7701: future.</p>
7702: <p>If the package should be skipped (for example, because it
7703: provides functionality already provided by the system), set
7704: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7705: the package should fail because some preconditions are not met,
7706: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7707: message.</p>
7708: </div>
1.41 asau 7709: <div class="sect2">
1.1 dsieger 7710: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7711: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7712: <p>To ensure that a package may not be deleted, once it has been
7713: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7714: be set in the package Makefile. This will be carried into any
7715: binary package that is made from this pkgsrc entry. A
1.23 wiz 7716: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.174 leot 7717: not be deleted using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23 wiz 7718: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7719: </div>
1.41 asau 7720: <div class="sect2">
1.1 dsieger 7721: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7722: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7723: <p>When a vulnerability is found, this should be noted in
7724: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7725: and after committing that file, ask pkgsrc-security@NetBSD.org to
7726: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7727: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7728: <code class="varname">PKGREVISION</code> should be increased (this is of
7729: course not necessary if the problem is fixed by using a newer
7730: release of the software), and the pattern in the
7731: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7732: <p>Also, if the fix should be applied to the stable pkgsrc
7733: branch, be sure to submit a pullup request!</p>
7734: <p>Binary packages already on ftp.NetBSD.org will be handled
7735: semi-automatically by a weekly cron job.</p>
7736: </div>
1.41 asau 7737: <div class="sect2">
1.1 dsieger 7738: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7739: <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 7740: <p>When making fixes to an existing package it can be useful
7741: to change the version number in <code class="varname">PKGNAME</code>. To
7742: avoid conflicting with future versions by the original author, a
1.23 wiz 7743: <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 7744: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7745: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7746: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7747: <pre class="programlisting">
7748: DISTNAME= foo-17.42
7749: PKGREVISION= 9
1.111 sevan 7750: </pre>
1.1 dsieger 7751: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7752: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7753: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7754: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7755: <code class="varname">PKGNAME_NOREV</code>.</p>
7756: <p>When a new release of the package is released, the
7757: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7758: minor release of the above package, things should be like:</p>
7759: <pre class="programlisting">
7760: DISTNAME= foo-17.43
1.111 sevan 7761: </pre>
1.1 dsieger 7762: <p><code class="varname">PKGREVISION</code> should be incremented for any
7763: non-trivial change in the resulting binary package. Without a
7764: <code class="varname">PKGREVISION</code> bump, someone with the previous
7765: version installed has no way of knowing that their package is out
7766: of date. Thus, changes without increasing
7767: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7768: trivial that no reasonable person would want to upgrade", and this
7769: is the rough test for when increasing
7770: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7771: changes that do not merit increasing
7772: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7773: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7774: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169 rillig 7775: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7776: comments in Makefile.</p></li>
7777: <li class="listitem"><p>Changing build variables if the resulting binary
7778: package is the same.</p></li>
7779: <li class="listitem"><p>Changing
7780: <code class="filename">DESCR</code>.</p></li>
7781: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7782: default options don't change.</p></li>
1.1 dsieger 7783: </ul></div>
7784: <p>Examples of changes that do merit an increase to
7785: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7786: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7787: <li class="listitem"><p>Security fixes</p></li>
7788: <li class="listitem"><p>Changes or additions to a patch
7789: file</p></li>
7790: <li class="listitem"><p>Changes to the
7791: <code class="filename">PLIST</code></p></li>
7792: <li class="listitem"><p>A dependency is changed or
7793: renamed.</p></li>
1.1 dsieger 7794: </ul></div>
7795: <p>PKGREVISION must also be incremented when dependencies have ABI
7796: changes.</p>
7797: </div>
1.41 asau 7798: <div class="sect2">
1.1 dsieger 7799: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7800: <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 7801: <p>When you want to replace the same text in multiple files, or
7802: multiple times in the same file, it is cumbersome to maintain a patch
7803: file for this. This is where the SUBST framework steps in. It provides an
7804: easy-to-use interface for replacing text in files. It just needs the
7805: following information:</p>
7806: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7807: <li class="listitem"><p>In which phase of the package build cycle should the
7808: replacement happen?</p></li>
7809: <li class="listitem"><p>In which files should the replacement
1.172 rillig 7810: happen?</p></li>
1.180 rillig 7811: <li class="listitem"><p>Which text should be replaced with
7812: what?</p></li>
1.172 rillig 7813: </ul></div>
7814: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.180 rillig 7815: variables. A minimal example is:</p>
7816: <pre class="programlisting">
7817: SUBST_CLASSES+= paths
7818: SUBST_STAGE.paths= pre-configure
7819: SUBST_FILES.paths= src/*.c
7820: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
7821: </pre>
7822: <p>Translated into English, it means: In the pre-configure stage (that
7823: is, after applying the patches from the patches/ directory and before
7824: running the configure script and the portability check), replace the text
7825: <code class="literal">/usr/local</code> with the content of the variable
7826: <code class="varname">PREFIX</code>.</p>
7827: <p>Each SUBST block starts by appending an identifier to
7828: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
7829: identifier can be chosen freely by the package. If there should ever be
7830: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
7831: early, so don't worry about name collisions.</p>
7832: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
7833: SUBST block are parameterized using this identifier. In the remainder of
7834: this section, these parameterized variables are written as
7835: <code class="varname">SUBST_STAGE.*</code>.</p>
7836: <pre class="programlisting">
7837: SUBST_CLASSES+= paths
7838: SUBST_STAGE.paths= pre-configure
7839: SUBST_MESSAGE.paths= Fixing absolute paths.
7840: SUBST_FILES.paths= src/*.c
7841: SUBST_FILES.paths+= scripts/*.sh
7842: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
7843: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
7844: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
7845: </pre>
7846: <p>To get a complete picture about the SUBST substitutions, run
7847: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
7848: expected, run pkglint on the package, which detects several typical
7849: mistakes surrounding the SUBST blocks. For any questions that might
7850: remain after this, have a look at
7851: <code class="filename">mk/subst.mk</code>.</p>
7852: <div class="sect3">
7853: <div class="titlepage"><div><div><h4 class="title">
7854: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
7855: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
7856: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
7857: <code class="literal">pre-configure</code> is used most often, by far. The most
7858: popular stages are, in chronological order:</p>
7859: <div class="variablelist"><dl class="variablelist">
7860: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
7861: <dd>
7862: <p>The substitutions are applied immediately after the
7863: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
7864: package will leave no traces of the original files.</p>
7865: <p>When the substitution applies to files for which there is also a
7866: patch in the <code class="filename">patches/</code> directory, this means that the
7867: patches will be computed based on the result of the substitution. When
7868: these patches are sent to the upstream maintainer later, to be fixed in
7869: the upstream package, these patches may no longer match what the upstream
7870: author is used to. Because of this, <code class="literal">pre-configure</code> is
7871: often a better choice.</p>
7872: </dd>
7873: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
7874: <dd>
7875: <p>The substitutions are applied after the patches from the
7876: <code class="filename">patches/</code> directory. This makes it possible to run
7877: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
7878: 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>
7879: <p>When updating the patches, it is helpful to explicitly separate the
7880: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
7881: configure</strong></span>, and to only edit the patches between these commands.
7882: Otherwise the substitutions from the SUBST block will end up in the patch
7883: file. When this happens in really obvious ways, pkglint will complain
7884: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
7885: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
7886: can only detect these really obvious
7887: cases.</p>
7888: </dd>
7889: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
7890: <dd><p>This stage should only be used if the package defines a
7891: <code class="literal">pre-configure</code> action itself, and the substitution must
7892: happen after that. Typical examples are packages that use the
7893: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
7894: script from
7895: <code class="filename">configure.ac</code>.</p></dd>
7896: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
7897: <dd><p>This stage is used to fix up any mistakes by the
7898: configure stage.</p></dd>
7899: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
7900: <dd><p>This stage should only be used for substitutions that are
7901: clearly related to building the package, not for fixing the
7902: configuration. Substitutions for pathnames (such as replacing
7903: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
7904: user names (such as replacing <code class="literal">@MY_USER@</code> with the
7905: actual username) belong in pre-configure or post-configure
7906: instead.</p></dd>
7907: <dt><span class="term"><code class="literal">post-build</code></span></dt>
7908: <dd>
7909: <p>Just as with pre-build, this stage should only be used
7910: for substitutions that are clearly related to building the package, not
7911: for fixing the configuration. Substitutions for pathnames (such as
7912: replacing <code class="filename">/usr/local</code> with
7913: <code class="literal">${PREFIX}</code>) or user names (such as replacing
7914: <code class="literal">@MY_USER@</code> with the actual username) belong in
7915: pre-configure or post-configure instead.</p>
7916: <p>A typical use is to update pkg-config files to include the rpath
7917: compiler options.</p>
7918: </dd>
7919: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
7920: <dd><p>In general, the install phase should be as simple as
7921: possible. As with the pre-build and post-build stages, it should not be
7922: used to fix pathnames or user names, these belong in pre-configure
7923: instead. There are only few legitimate use cases for applying
7924: substitutions in this stage.</p></dd>
7925: </dl></div>
7926: </div>
7927: <div class="sect3">
7928: <div class="titlepage"><div><div><h4 class="title">
1.181 rillig 7929: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.180 rillig 7930: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
7931: filename patterns. These patterns are relative to
7932: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
7933: A typical example is:</p>
7934: <pre class="programlisting">
7935: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
7936: </pre>
7937: <p>The above patterns, especially the last, are quite broad. The SUBST
7938: implementation checks that each filename pattern that is mentioned here
7939: has an effect. For example, if none of the
7940: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
7941: and substituted, that filename pattern is redundant and should be left
1.181 rillig 7942: out. By default, the SUBST framework will complain with an error message.
7943: If the text to be substituted occurs in some of the files from a single
7944: pattern, but not in all of them, that is totally ok, and the SUBST
1.180 rillig 7945: framework will only print an INFO message for those files.</p>
7946: <p>If there is a good reason for having redundant filename patterns,
1.181 rillig 7947: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.180 rillig 7948: <p>Another popular way of choosing the files for the substitutions is
7949: via a shell command, like this:</p>
7950: <pre class="programlisting">
1.181 rillig 7951: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 7952: SUBST_FILES.path= ${C_FILES_CMD:sh}
7953: </pre>
7954: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
7955: freely chosen and independent of the SUBST framework.</p>
7956: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
7957: lists each file individually. Thereby chances are higher that there are
7958: filename patterns in which no substitution happens. Since the SUBST
7959: framework cannot know whether the filename patterns in
7960: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
7961: Makefile (where any redundant filename pattern would be suspicious) or
7962: been generated by a shell command (in which redundant filename patterns
7963: are more likely and to be expected), it will complain about these
7964: redundant filename patterns. Therefore, SUBST blocks that use a shell
7965: command to generate the list of filename patterns often need to set
7966: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
7967: </div>
7968: <div class="sect3">
7969: <div class="titlepage"><div><div><h4 class="title">
7970: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
7971: <p>In most cases, the substitutions are given using one or more
7972: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
7973: <pre class="programlisting">
7974: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
7975: </pre>
7976: <p>Each of the sed commands needs to be preceded by the
7977: <code class="literal">-e</code> option and should be specified on a line of its
7978: own, to avoid hiding short sed commands at the end of a line.</p>
7979: <p>Since the sed commands often contain shell metacharacters as the
7980: separator (the <code class="literal">|</code> in the above example), it is common
7981: to enclose them in single quotes.</p>
7982: <p>A common substitution is to replace placeholders of the form
7983: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
7984: <code class="literal">${VARNAME}</code>. A typical example is:</p>
7985: <pre class="programlisting">
7986: SUBST_VARS.path= PREFIX
7987: </pre>
7988: <p>This type of substitutions is typically done by the GNU configure
1.181 rillig 7989: scripts during the do-configure stage, but in some cases these need to be
7990: overridden. The same pattern is also used when a package defines patches
7991: that replace previously hard-coded paths like
7992: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
7993: placeholder first, which then gets substituted by the actual
7994: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
7995: cases, it works equally well to just use the SUBST framework to directly
7996: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
7997: thereby omitting the intermediate patch file.</p>
1.180 rillig 7998: <p>If the above is not flexible enough, it is possible to not use sed
7999: at all for the substitution but to specify an entirely different command,
8000: like this:</p>
1.1 dsieger 8001: <pre class="programlisting">
1.180 rillig 8002: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8003: </pre>
8004: <p>This is used for the few remaining packages in which the
8005: distributed files use Windows-style line endings that need to be
8006: converted to UNIX-style line endings.</p>
8007: </div>
8008: <div class="sect3">
8009: <div class="titlepage"><div><div><h4 class="title">
8010: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8011: <p>When a SUBST block is applied during a package build, a message is
8012: logged. The default message is fine for most purposes but can be
8013: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8014: message.</p>
8015: </div>
1.1 dsieger 8016: </div>
8017: </div>
1.41 asau 8018: <div class="sect1">
1.1 dsieger 8019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8020: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 8021: <div class="sect2">
1.1 dsieger 8022: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8023: <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 8024: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8025: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8026: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8027: with the name of each file to download as an argument, expecting
8028: it to output the URL of the directory from which to download
1.137 leot 8029: 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 8030: example of this usage.</p>
8031: <p>If the download can't be automated, because the user must
8032: submit personal information to apply for a password, or must pay
8033: for the source, or whatever, you can set
8034: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8035: displayed to the user before aborting the build. Example:</p>
8036: <pre class="programlisting">
8037: FETCH_MESSAGE= "Please download the files"
8038: FETCH_MESSAGE+= " "${DISTFILES:Q}
8039: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 8040: </pre>
1.1 dsieger 8041: </div>
1.41 asau 8042: <div class="sect2">
1.1 dsieger 8043: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8044: <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 8045: <p>Sometimes authors of a software package make some
8046: modifications after the software was released, and they put up a
8047: new distfile without changing the package's version number. If a
8048: package is already in pkgsrc at that time, the checksum will
8049: no longer match. The contents of the new distfile should be
8050: compared against the old one before changing anything, to make
8051: sure the distfile was really updated on purpose, and that
8052: no trojan horse or so crept in.
8053: Please mention that the distfiles were compared and what was found
1.53 rodent 8054: in your commit message.</p>
1.109 wiz 8055: <p>Then, the correct way to work around this is to set
8056: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8057: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8058: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8059: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 8060: <code class="varname">PATCHFILES</code> for this package will be put in that
1.154 rillig 8061: 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 8062: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 8063: including the <code class="filename">nbX</code> suffix) or a date stamp can
8064: be appended, like
8065: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169 rillig 8066: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8067: name does not contain a version and the distfile is apt to change. In
8068: cases where the likelihood of this is very small,
8069: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8070: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8071: distfile name changes, even if a package is being moved or
8072: renamed.</p>
1.53 rodent 8073: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8074: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8075: path in the filenames.
1.53 rodent 8076: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8077: Furthermore, a mail to the package's authors seems appropriate
8078: telling them that changing distfiles after releases without
8079: changing the file names is not good practice.</p>
8080: </div>
1.88 tnn 8081: <div class="sect2">
8082: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8083: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169 rillig 8084: <p>Helper methods exist for packages hosted on github.com which
8085: will often have distfile names that clash with other packages, for
8086: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8087: from below:</p>
1.88 tnn 8088: <div class="sect3">
8089: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8090: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169 rillig 8091: <p>If your distfile URL looks similar to
1.189 ! bacon 8092: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.169 rillig 8093: then you are packaging a tagged release.</p>
1.88 tnn 8094: <pre class="programlisting">
1.189 ! bacon 8095: DISTNAME= example-1.0
1.90 tnn 8096: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 ! bacon 8097: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8098: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 8099: EXTRACT_SUFX= .zip
8100: </pre>
8101: </div>
8102: <div class="sect3">
8103: <div class="titlepage"><div><div><h4 class="title">
1.189 ! bacon 8104: <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>
! 8105: <p>If your distfile looks similar to
! 8106: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
! 8107: release, then set the package version to 0.0.0.N, where N is the number
! 8108: of commits to the repository, and set GITHUB_TAG to the commit hash.
! 8109: This will (almost) ensure that the first tagged release will have a
! 8110: version greater than this one so that package upgrades will function
! 8111: properly.</p>
! 8112: <pre class="programlisting">
! 8113: DISTNAME= example-0.0.0.347
! 8114: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
! 8115: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
! 8116: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
! 8117: </pre>
! 8118: </div>
! 8119: <div class="sect3">
! 8120: <div class="titlepage"><div><div><h4 class="title">
! 8121: <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>
! 8122: <p>If your distfile looks similar to
! 8123: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
! 8124: then include the last release version and the commit count since that
! 8125: release in the package version and set GITHUB_TAG to the commit hash.
! 8126: The latest release and commit count are shown in the output of
! 8127: "git describe --tags":
! 8128: </p>
! 8129: <pre class="screen">
! 8130: # git clone https://github.com/username/example
! 8131: # cd example
! 8132: # git describe --tags
! 8133: 1.2.3-5-g988881a
! 8134: </pre>
1.88 tnn 8135: <pre class="programlisting">
1.189 ! bacon 8136: DISTNAME= example-1.2.3.5
! 8137: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
! 8138: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8139: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 8140: </pre>
1.88 tnn 8141: </div>
8142: <div class="sect3">
8143: <div class="titlepage"><div><div><h4 class="title">
1.189 ! bacon 8144: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.169 rillig 8145: <p>If your distfile URL looks similar to
1.189 ! bacon 8146: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.169 rillig 8147: then you are packaging a release.</p>
1.88 tnn 8148: <pre class="programlisting">
8149: DISTNAME= offensive-1.6
1.90 tnn 8150: PKGNAME= ${DISTNAME:S/offensive/proper/}
8151: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 ! bacon 8152: GITHUB_PROJECT= example
1.90 tnn 8153: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8154: EXTRACT_SUFX= .zip
1.111 sevan 8155: </pre>
1.88 tnn 8156: </div>
8157: </div>
1.1 dsieger 8158: </div>
1.41 asau 8159: <div class="sect1">
1.1 dsieger 8160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8161: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8162: <div class="sect2">
1.1 dsieger 8163: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8164: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8165: <p>pkgsrc supports many different machines, with different
8166: object formats like a.out and ELF, and varying abilities to do
8167: shared library and dynamic loading at all. To accompany this,
8168: varying commands and options have to be passed to the
8169: compiler, linker, etc. to get the Right Thing, which can be
8170: pretty annoying especially if you don't have all the machines
8171: at your hand to test things. The
1.137 leot 8172: <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 8173: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8174: both static and dynamic libraries from a set of source files,
8175: thus being platform-independent.</p>
8176: <p>Here's how to use libtool in a package in seven simple
8177: steps:</p>
1.23 wiz 8178: <div class="orderedlist"><ol class="orderedlist" type="1">
8179: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8180: Makefile.</p></li>
1.23 wiz 8181: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8182: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8183: add it to the definition of <code class="varname">CC</code>, if only
8184: libraries are being built in a given Makefile. This one command
8185: will build both PIC and non-PIC library objects, so you need not
8186: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8187: <li class="listitem">
1.1 dsieger 8188: <p>For the linking of the library, remove any
1.23 wiz 8189: <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
8190: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8191: <pre class="programlisting">
8192: ${LIBTOOL} --mode=link \
8193: ${CC} -o ${.TARGET:.a=.la} \
8194: ${OBJS:.o=.lo} \
8195: -rpath ${PREFIX}/lib \
8196: -version-info major:minor
1.111 sevan 8197: </pre>
1.1 dsieger 8198: <p>Note that the library is changed to have a
8199: <code class="filename">.la</code> extension, and the objects are
8200: changed to have a <code class="filename">.lo</code>
8201: extension. Change <code class="varname">OBJS</code> as
8202: necessary. This automatically creates all of the
8203: <code class="filename">.a</code>,
8204: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8205: necessary) in the build directory. Be sure to include
1.23 wiz 8206: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8207: minor are zero, as libtool will otherwise strip off the
8208: shared library version.</p>
8209: <p>From the libtool manual:</p>
8210: <pre class="programlisting">
8211: So, libtool library versions are described by three integers:
8212:
8213: CURRENT
8214: The most recent interface number that this library implements.
8215:
8216: REVISION
8217: The implementation number of the CURRENT interface.
8218:
8219: AGE
8220: The difference between the newest and oldest interfaces that
8221: this library implements. In other words, the library implements
8222: all the interface numbers in the range from number `CURRENT -
8223: AGE' to `CURRENT'.
8224:
8225: If two libraries have identical CURRENT and AGE numbers, then the
8226: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 8227: </pre>
1.23 wiz 8228: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8229: different results for a.out and ELF (excluding symlinks)
8230: in only one case. An ELF library of the form
1.23 wiz 8231: <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 8232: will have a symlink of
1.23 wiz 8233: <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 8234: on an a.out platform. This is handled
8235: automatically.</p>
1.23 wiz 8236: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8237: directory of the library being built.</p>
8238: <p>In the <code class="filename">PLIST</code>, include only the
8239: <code class="filename">.la</code> file, the other files will be
8240: added automatically.</p>
8241: </li>
1.23 wiz 8242: <li class="listitem">
1.1 dsieger 8243: <p>When linking shared object (<code class="filename">.so</code>)
1.174 leot 8244: files, i.e. files that are loaded via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23 wiz 8245: shared libraries, use <span class="quote">“<span class="quote">-module
8246: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8247: tacked on.</p>
8248: <p>The <code class="filename">PLIST</code> file gets the
8249: <code class="filename">foo.so</code> entry.</p>
8250: </li>
1.23 wiz 8251: <li class="listitem">
1.1 dsieger 8252: <p>When linking programs that depend on these libraries
8253: <span class="emphasis"><em>before</em></span> they are installed, preface
1.174 leot 8254: the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ld+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 8255: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8256: libraries (static or shared), but please be aware that
8257: libtool will not allow you to specify a relative path in
1.23 wiz 8258: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8259: expects you to change that argument to be the
8260: <code class="filename">.la</code> file. e.g.</p>
8261: <pre class="programlisting">
8262: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 8263: </pre>
1.1 dsieger 8264: <p>should be changed to:</p>
8265: <pre class="programlisting">
8266: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 8267: </pre>
1.1 dsieger 8268: <p>and it will do the right thing with the libraries.</p>
8269: </li>
1.23 wiz 8270: <li class="listitem">
1.174 leot 8271: <p>When installing libraries, preface the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8272: or <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 8273: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8274: <code class="filename">.la</code>. e.g.</p>
8275: <pre class="programlisting">
1.22 jakllsch 8276: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 8277: </pre>
1.1 dsieger 8278: <p>This will install the static <code class="filename">.a</code>,
8279: shared library, any needed symlinks, and run
1.174 leot 8280: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 8281: </li>
1.23 wiz 8282: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8283: the <code class="filename">.la</code>
8284: file (this is a change from previous behaviour).</p></li>
8285: </ol></div>
8286: </div>
1.41 asau 8287: <div class="sect2">
1.1 dsieger 8288: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8289: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8290: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8291: package Makefile. This will override the package's own libtool
8292: in most cases. For older libtool using packages, libtool is
8293: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8294: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8295: configure; find work*/ -name libtool</strong></span>.</p>
8296: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8297: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8298: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8299: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8300: package's libtool script(s), set it as appropriate.</p>
8301: <p>If you do not need <code class="filename">*.a</code> static
8302: libraries built and installed, then use
8303: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8304: <p>If your package makes use of the platform-independent library
8305: for loading dynamic shared objects, that comes with libtool
8306: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8307: <p>Some packages use libtool incorrectly so that the package
8308: may not work or build in some circumstances. Some of the more
8309: common errors are:</p>
1.41 asau 8310: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8311: <li class="listitem">
1.1 dsieger 8312: <p>The inclusion of a shared object (-module) as a dependent library in an
8313: executable or library. This in itself isn't a problem if one of two things
8314: has been done:</p>
1.23 wiz 8315: <div class="orderedlist"><ol class="orderedlist" type="1">
8316: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8317: <code class="filename">libfoo.la</code>, not
8318: <code class="filename">foo.la</code></p></li>
1.23 wiz 8319: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8320: </ol></div>
8321: </li>
1.23 wiz 8322: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8323: The function lt_dlinit() should be called and the macro
8324: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8325: executables.</p></li>
8326: </ul></div>
8327: </div>
1.41 asau 8328: <div class="sect2">
1.1 dsieger 8329: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8330: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8331: <p>If a package needs GNU autoconf or automake to be executed
8332: to regenerate the configure script and Makefile.in makefile
8333: templates, then they should be executed in a pre-configure
8334: target.</p>
8335: <p>For packages that need only autoconf:</p>
8336: <pre class="programlisting">
8337: AUTOCONF_REQD= 2.50 # if default version is not good enough
8338: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8339: ...
8340:
8341: pre-configure:
8342: cd ${WRKSRC} && autoconf
8343:
8344: ...
1.111 sevan 8345: </pre>
1.1 dsieger 8346: <p>and for packages that need automake and autoconf:</p>
8347: <pre class="programlisting">
8348: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8349: USE_TOOLS+= automake # use "automake14" for automake-1.4
8350: ...
8351:
8352: pre-configure:
8353: set -e; cd ${WRKSRC}; \
8354: aclocal; autoheader; automake -a --foreign -i; autoconf
8355:
8356: ...
1.111 sevan 8357: </pre>
1.1 dsieger 8358: <p>Packages which use GNU Automake will almost certainly
8359: require GNU Make.</p>
8360: <p>There are times when the configure process makes
8361: additional changes to the generated files, which then causes
8362: the build process to try to re-execute the automake sequence.
8363: This is prevented by touching various files in the configure
8364: stage. If this causes problems with your package you can set
8365: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8366: Makefile.</p>
8367: </div>
8368: </div>
1.41 asau 8369: <div class="sect1">
1.1 dsieger 8370: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8371: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></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="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8375: <p>Compilers for the C, C++, and Fortran languages comes with
8376: the NetBSD base system. By default, pkgsrc assumes that a package
8377: is written in C and will hide all other compilers (via the wrapper
1.184 rillig 8378: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8379: <p>To declare which language's compiler a package needs, set
8380: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 8381: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8382: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8383: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8384: written in C++, usually need a C compiler for the configure
8385: phase.</p>
8386: </div>
1.41 asau 8387: <div class="sect2">
1.1 dsieger 8388: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8389: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 8390: <p>If a program is written in Java, use the Java framework in
8391: pkgsrc. The package must include
8392: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8393: provides the following variables:</p>
1.41 asau 8394: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8395: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8396: dependency on the JDK is added. If
1.23 wiz 8397: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8398: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8399: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8400: JDK.</p></li>
1.23 wiz 8401: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8402: a package needs a Java2 implementation. The supported values
1.23 wiz 8403: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8404: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8405: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8406: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8407: above. This variable is not set by default.</p></li>
1.24 wiz 8408: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8409: automatically set to the runtime location of the used Java
8410: implementation dependency. It may be used to set
8411: <code class="varname">JAVA_HOME</code> to a good value if the program
8412: needs this variable to be defined.
8413: </p></li>
1.1 dsieger 8414: </ul></div>
8415: </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="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8419: <p>If your package contains interpreted perl scripts, add
1.23 wiz 8420: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8421: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8422: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8423: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8424: that you want adjusted. Every occurrence of
8425: <code class="filename">*/bin/perl</code> in a she-bang line will be
8426: replaced with the full path to the perl executable.</p>
1.1 dsieger 8427: <p>If a particular version of perl is needed, set the
8428: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8429: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.154 rillig 8430: <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 8431: about handling perl modules.</p>
8432: </div>
1.41 asau 8433: <div class="sect2">
1.1 dsieger 8434: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8435: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 8436: <p><code class="varname">REPLACE_SH</code>,
8437: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8438: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8439: hash bangs in files. Please use the appropriate one, prefering
8440: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 8441: Each should contain a list of scripts, relative to
8442: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8443: occurrence of the matching shell in a she-bang line will be
8444: replaced with the full path to the shell executable.
1.40 wiz 8445: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8446: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8447: </div>
1.41 asau 8448: <div class="sect2">
1.40 wiz 8449: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8450: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 8451: <p>Currently, there is no special handling for other languages
8452: in pkgsrc. If a compiler package provides a
8453: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8454: just add a (build) dependency on the appropriate compiler
8455: package.</p>
8456: </div>
8457: </div>
1.41 asau 8458: <div class="sect1">
1.1 dsieger 8459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8460: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8461: <p>The most common failures when building a package are that
8462: some platforms do not provide certain header files, functions or
8463: libraries, or they provide the functions in a library that the
8464: original package author didn't know. To work around this, you
8465: can rewrite the source code in most cases so that it does not
8466: use the missing functions or provides a replacement function.</p>
1.41 asau 8467: <div class="sect2">
1.1 dsieger 8468: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8469: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8470: <p>If a package already comes with a GNU configure script, the
8471: preferred way to fix the build failure is to change the
8472: configure script, not the code. In the other cases, you can
8473: utilize the C preprocessor, which defines certain macros
8474: depending on the operating system and hardware architecture it
8475: compiles for. These macros can be queried using for example
8476: <code class="varname">#if defined(__i386)</code>. Almost every operating
8477: system, hardware architecture and compiler has its own macro.
8478: For example, if the macros <code class="varname">__GNUC__</code>,
8479: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8480: are all defined, you know that you are using NetBSD on an i386
8481: compatible CPU, and your compiler is GCC.</p>
8482: <p>The list of the following macros for hardware and
8483: operating system depends on the compiler that is used. For
8484: example, if you want to conditionally compile code on Solaris,
8485: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8486: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8487: <div class="sect3">
1.1 dsieger 8488: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8489: <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 8490: <p>To distinguish between 4.4 BSD-derived systems and the
8491: rest of the world, you should use the following code.</p>
8492: <pre class="programlisting">
8493: #include <sys/param.h>
8494: #if (defined(BSD) && BSD >= 199306)
8495: /* BSD-specific code goes here */
8496: #else
8497: /* non-BSD-specific code goes here */
8498: #endif
8499: </pre>
8500: <p>If this distinction is not fine enough, you can also test
8501: for the following macros.</p>
8502: <pre class="programlisting">
1.45 obache 8503: Cygwin __CYGWIN__
8504: DragonFly __DragonFly__
1.1 dsieger 8505: FreeBSD __FreeBSD__
1.45 obache 8506: Haiku __HAIKU__
1.1 dsieger 8507: Interix __INTERIX
8508: IRIX __sgi (TODO: get a definite source for this)
8509: Linux linux, __linux, __linux__
1.83 dholland 8510: Mac OS X __APPLE__
1.45 obache 8511: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8512: Minix3 __minix
1.1 dsieger 8513: NetBSD __NetBSD__
8514: OpenBSD __OpenBSD__
8515: Solaris sun, __sun
8516: </pre>
8517: </div>
1.41 asau 8518: <div class="sect3">
1.1 dsieger 8519: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8520: <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 8521: <pre class="programlisting">
8522: i386 i386, __i386, __i386__
8523: MIPS __mips
8524: SPARC sparc, __sparc
8525: </pre>
8526: </div>
1.41 asau 8527: <div class="sect3">
1.1 dsieger 8528: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8529: <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 8530: <pre class="programlisting">
8531: GCC __GNUC__ (major version), __GNUC_MINOR__
8532: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8533: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8534: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8535: </pre>
8536: </div>
8537: </div>
1.41 asau 8538: <div class="sect2">
1.1 dsieger 8539: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8540: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8541: <p>Some source files trigger bugs in the compiler, based on
8542: combinations of compiler version and architecture and almost
8543: always relation to optimisation being enabled. Common symptoms
8544: are gcc internal errors or never finishing compiling a
8545: file.</p>
8546: <p>Typically, a workaround involves testing the
8547: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8548: optimisation for that combination of file,
1.87 tnn 8549: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8550: <p>This used to be a big problem in the past, but is rarely
8551: needed now as compiler technology has matured. If you still need
8552: to add a compiler specific workaround, please do so in the file
8553: <code class="filename">hacks.mk</code> and describe the symptom and
8554: compiler version as detailed as possible.</p>
1.1 dsieger 8555: </div>
1.41 asau 8556: <div class="sect2">
1.1 dsieger 8557: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8558: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8559: <p>Compilation sometimes fails with an error message like this:</p>
8560: <pre class="programlisting">
8561: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8562: fatal error: pango/pango.h: No such file or directory
8563: </pre>
8564: <p>The proper way to fix this problem depends on the type of the
8565: header, which is described in the following sections.</p>
8566: <div class="sect3">
8567: <div class="titlepage"><div><div><h4 class="title">
8568: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8569: <p>If the header name looks like it comes from a different package,
8570: that other package should be included via the buildlink3
8571: framework.</p>
8572: <p>First, look whether the header is somewhere in the buildlink3
8573: directory below <code class="varname">WRKDIR</code>. In the above case of
8574: the missing Pango header:</p>
8575: <pre class="programlisting">
8576: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8577: </pre>
8578: <p>In the case of Pango, the output is:</p>
8579: <pre class="programlisting">
8580: work/.buildlink/include/pango-1.0/pango/pango.h
8581: </pre>
8582: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8583: in the <code class="filename">.buildlink</code> directory, it would have been
8584: found automatically. There is an extra <code class="filename">pango-1.0</code>
8585: path component though, which means that the compiler command line must
8586: contain an option of the form
8587: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8588: most cases this option is generated by the configure script, which can be examined using:</p>
8589: <pre class="programlisting">
8590: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8591: -I/usr/pkg/include/pango-1.0
8592: -I/usr/pkg/include/pango-1.0
8593: -I/usr/pkg/include/pango-1.0
8594: -I/usr/pkg/include/pango-1.0
8595: -I/usr/pkg/include/pango-1.0
8596: </pre>
8597: <p>This looks good. These options are transformed by the buildlink
8598: wrapper to refer to the correct path inside
8599: <code class="filename">work/.buildlink</code>.</p>
8600: <p>Since the compilation fails though, examine the compiler command
8601: lines in <code class="filename">work/.work.log</code> to see whether the
8602: <code class="literal">-I</code> option is included in the particular command
8603: line.</p>
8604: <p>To further analyze the situation, run <span class="command"><strong>bmake
8605: build-env</strong></span>, which sets up an interactive, realistic environment
8606: including all the pkgsrc wrapper commands and environment variables. From
8607: there, try to compile some simple example programs that use the
8608: header.</p>
8609: </div>
8610: <div class="sect3">
8611: <div class="titlepage"><div><div><h4 class="title">
8612: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8613: <p>If the name of the header seems to come from the package itself,
8614: and if the build is run with parallel jobs, the package may have some
8615: undeclared dependencies between the <code class="filename">.c</code> and the
8616: <code class="filename">.h</code> files, and a C file is compiled before its
8617: required header is generated.</p>
8618: <p>To see whether the build runs with parallel jobs, run
8619: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8620: like this:</p>
8621: <pre class="programlisting">
8622: usr MAKE_JOBS= 7
8623: pkg MAKE_JOBS_SAFE # undefined
8624: def _MAKE_JOBS_N= 7
8625: </pre>
8626: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8627: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8628: package could have disabled parallel builds by setting
8629: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8630: in this case it hasn't.</p>
8631: <p>To see whether the build failure is caused by parallel builds,
8632: first save the exact error message and a bit of context, maybe you need
8633: it later for reporting a bug. Next, run:</p>
8634: <pre class="programlisting">
8635: MAKE_JOBS_SAFE=no bmake clean build
8636: </pre>
8637: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8638: report</a> against the pkgsrc package, including the exact error
8639: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8640: </div>
1.173 rillig 8641: <div class="sect3">
8642: <div class="titlepage"><div><div><h4 class="title">
8643: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
8644: <p>Pkgsrc does not work reliably if any of
8645: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
8646: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
8647: bootstrap program prevents installing pkgsrc in symlink-based
8648: directories. Existing pkgsrc installations are not checked for symlinks
8649: though.</p>
8650: <p>The "No such file or directory" error messages are a typical
8651: symptom of symlinks, and it's quite difficult to find out that this is
8652: the actual cause.</p>
8653: </div>
8654: <div class="sect3">
8655: <div class="titlepage"><div><div><h4 class="title">
8656: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
8657: <p>When building a hierarchy of packages, it may happen that one
8658: package is built and then pkgsrc is updated. This situation can provoke
8659: various hard to diagnose build errors. To clean up the situation:</p>
8660: <pre class="programlisting">
8661: <code class="prompt">$</code> (cd ../../ && test -f mk/bsd.pkg.mk && rm -rf */*/work)
8662: </pre>
8663: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
8664: this command in the wrong directory.)</p>
8665: <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
8666: that directory as well.</p>
8667: </div>
8668: <div class="sect3">
8669: <div class="titlepage"><div><div><h4 class="title">
8670: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
8671: <p>On platforms other than BSD, third-party packages are installed in
8672: <code class="filename">/usr/include</code>, together with the base system. This
8673: means that pkgsrc cannot distinguish between headers provided by the base
8674: system (which it needs) and headers from third-party packages (which are
8675: often included in pkgsrc as well). This can lead to subtle version
8676: mismatches.</p>
8677: <p>In pkgsrc installations that have been active for several years, it
8678: may happen that some files are manually deleted. To exclude this unlikely
8679: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
8680: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
8681: check/fix dependencies.</p>
8682: <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>
8683: for contact information. Be prepared to describe what you have tried so
8684: far and what any error messages were.</p>
8685: </div>
1.172 rillig 8686: </div>
8687: <div class="sect2">
8688: <div class="titlepage"><div><div><h3 class="title">
8689: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 8690: </h3></div></div></div>
1.1 dsieger 8691: <p>This error message often means that a package did not
8692: link to a shared library it needs. The following functions are
8693: known to cause this error message over and over.</p>
8694: <div class="informaltable">
1.106 tnn 8695: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 8696: <colgroup>
8697: <col>
8698: <col>
8699: <col>
8700: </colgroup>
8701: <thead><tr>
8702: <th>Function</th>
8703: <th>Library</th>
8704: <th>Affected platforms</th>
8705: </tr></thead>
8706: <tbody>
8707: <tr>
8708: <td>accept, bind, connect</td>
8709: <td>-lsocket</td>
8710: <td>Solaris</td>
8711: </tr>
8712: <tr>
8713: <td>crypt</td>
8714: <td>-lcrypt</td>
8715: <td>DragonFly, NetBSD</td>
8716: </tr>
8717: <tr>
8718: <td>dlopen, dlsym</td>
8719: <td>-ldl</td>
8720: <td>Linux</td>
8721: </tr>
8722: <tr>
8723: <td>gethost*</td>
8724: <td>-lnsl</td>
8725: <td>Solaris</td>
8726: </tr>
8727: <tr>
8728: <td>inet_aton</td>
8729: <td>-lresolv</td>
8730: <td>Solaris</td>
8731: </tr>
8732: <tr>
8733: <td>nanosleep, sem_*, timer_*</td>
8734: <td>-lrt</td>
8735: <td>Solaris</td>
8736: </tr>
8737: <tr>
8738: <td>openpty</td>
8739: <td>-lutil</td>
8740: <td>Linux</td>
8741: </tr>
8742: </tbody>
8743: </table>
8744: </div>
8745: <p>To fix these linker errors, it is often sufficient to say
8746: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8747: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8748: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8749: bmake</strong></span>.</p>
1.41 asau 8750: <div class="sect3">
1.1 dsieger 8751: <div class="titlepage"><div><div><h4 class="title">
1.172 rillig 8752: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8753: <p>When you are using the SunPro compiler, there is another
8754: possibility. That compiler cannot handle the following code:</p>
8755: <pre class="programlisting">
8756: extern int extern_func(int);
8757:
8758: static inline int
8759: inline_func(int x)
8760: {
8761: return extern_func(x);
8762: }
8763:
8764: int main(void)
8765: {
8766: return 0;
8767: }
8768: </pre>
8769: <p>It generates the code for <code class="function">inline_func</code> even if
8770: that function is never used. This code then refers to
8771: <code class="function">extern_func</code>, which can usually not be resolved. To
8772: solve this problem you can try to tell the package to disable inlining
8773: of functions.</p>
8774: </div>
8775: </div>
1.41 asau 8776: <div class="sect2">
1.1 dsieger 8777: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8778: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1 dsieger 8779: <p>Sometimes packages fail to build because the compiler runs
8780: into an operating system specific soft limit. With the
8781: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 8782: to unlimit the resources. Currently, the allowed values are any combination of
8783: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8784: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 8785: Setting this variable is similar to running the shell builtin
1.10 hubertf 8786: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8787: segment size or maximum stack size of a process, respectively, to
8788: their hard limits.</p>
8789: </div>
8790: </div>
1.41 asau 8791: <div class="sect1">
1.1 dsieger 8792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8793: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 8794: <div class="sect2">
1.1 dsieger 8795: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8796: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8797: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8798: with some operating systems cannot create more than one
8799: directory at a time. As such, you should call
8800: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8801: <pre class="programlisting">
8802: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8803: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 8804: </pre>
1.23 wiz 8805: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8806: dir2</code></span>”</span> to the
1.1 dsieger 8807: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8808: automatically do the right thing.</p>
8809: </div>
1.41 asau 8810: <div class="sect2">
1.1 dsieger 8811: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8812: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8813: <p>In general, documentation should be installed into
8814: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8815: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8816: includes the version number of the package).</p>
8817: <p>Many modern packages using GNU autoconf allow to set the
8818: directory where HTML documentation is installed with the
1.23 wiz 8819: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8820: is needed because otherwise the documentation ends up in
8821: <code class="filename">${PREFIX}/share/doc/html</code> or other
8822: places.</p>
8823: <p>An exception to the above is that library API documentation
1.137 leot 8824: 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 8825: browsers (devhelp) should be left at their default location, which
8826: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8827: documentation can be recognized from files ending in
8828: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8829: (It is also acceptable to install such files in
8830: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8831: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8832: <code class="filename">.devhelp*</code> file must be directly in that
8833: directory then, no additional subdirectory level is allowed in
8834: this case. This is usually achieved by using
1.23 wiz 8835: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8836: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8837: though.)</p>
8838: </div>
1.41 asau 8839: <div class="sect2">
1.1 dsieger 8840: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8841: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8842: <p>Certain packages, most of them in the games category, install
8843: a score file that allows all users on the system to record their
8844: highscores. In order for this to work, the binaries need to be
8845: installed setgid and the score files owned by the appropriate
1.35 wiz 8846: group and/or owner (traditionally the "games" user/group). Set
8847: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8848: following variables, documented in more detail in
8849: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8850: behaviour: <code class="varname">GAMEDATAMODE</code>,
8851: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8852: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8853: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8854: <code class="varname">GAMEDATA_PERMS</code> and
8855: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8856: <p>An example that illustrates some of the variables described above is
8857: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8858: used to properly set directory permissions of the directory where the
8859: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8860: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8861: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8862: binary:</p>
8863: <pre class="programlisting">
1.112 rillig 8864: USE_GAMESGROUP= yes
1.100 leot 8865:
1.112 rillig 8866: BUILD_DEFS+= VARBASE
1.100 leot 8867:
1.112 rillig 8868: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8869: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8870: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 8871: </pre>
1.100 leot 8872: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8873: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8874: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8875: needed to be accessed by setgid games and
8876: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8877: <p>A package should therefore never hard code file ownership or
1.100 leot 8878: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8879: or alternatively on <code class="varname">INSTALL_GAME</code>,
8880: <code class="varname">INSTALL_GAME_DATA</code> and
8881: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 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="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8886: <p><code class="varname">DESTDIR</code> support means that a package
8887: installs into a staging directory, not the final location of the
8888: files. Then a binary package is created which can be used for
8889: installation as usual. There are two ways: Either the package must
1.23 wiz 8890: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8891: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8892: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8893: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 8894: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8895: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 8896: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8897: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8898: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8899: the inclusion.</p></li>
1.23 wiz 8900: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8901: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8902: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8903: automatically. Many manual rules and pre/post-install often are
8904: incorrect; fix them.</p></li>
1.23 wiz 8905: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8906: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8907: <li class="listitem"><p>In general, packages should support
1.4 rillig 8908: <code class="varname">UNPRIVILEGED</code> to be able to use
8909: DESTDIR.</p></li>
8910: </ul></div>
8911: </div>
1.41 asau 8912: <div class="sect2">
1.4 rillig 8913: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8914: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8915: <p>Your package may also contain scripts with hardcoded paths to
8916: other interpreters besides (or as well as) perl. To correct the
8917: full pathname to the script interpreter, you need to set the
8918: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8919: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8920: <pre class="programlisting">
8921: REPLACE_INTERPRETER+= tcl
8922: REPLACE.tcl.old= .*/bin/tclsh
8923: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8924: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8925: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 8926: </pre>
1.41 asau 8927: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8928: <h3 class="title">Note</h3>
8929: <p>Before March 2006, these variables were called
8930: <code class="varname">_REPLACE.*</code> and
8931: <code class="varname">_REPLACE_FILES.*</code>.</p>
8932: </div>
8933: </div>
1.41 asau 8934: <div class="sect2">
1.1 dsieger 8935: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8936: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8937: <p>Makefiles of packages providing perl5 modules should include
8938: the Makefile fragment
8939: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8940: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8941: configuration for such modules as well as various hooks to tune
8942: this configuration. See comments in this file for
8943: details.</p>
8944: <p>Perl5 modules will install into different places depending
8945: on the version of perl used during the build process. To
8946: address this, pkgsrc will append lines to the
8947: <code class="filename">PLIST</code> corresponding to the files listed in
8948: the installed <code class="filename">.packlist</code> file generated by
8949: most perl5 modules. This is invoked by defining
8950: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8951: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8952: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8953: e.g.:</p>
1.1 dsieger 8954: <pre class="programlisting">
1.47 wiz 8955: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 8956: </pre>
1.47 wiz 8957: <p>The perl5 config variables
8958: <code class="varname">installarchlib</code>,
8959: <code class="varname">installscript</code>,
8960: <code class="varname">installvendorbin</code>,
8961: <code class="varname">installvendorscript</code>,
8962: <code class="varname">installvendorarch</code>,
8963: <code class="varname">installvendorlib</code>,
8964: <code class="varname">installvendorman1dir</code>, and
8965: <code class="varname">installvendorman3dir</code> represent those
8966: locations in which components of perl5 modules may be installed,
8967: provided as variable with uppercase and prefixed with
8968: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8969: and may be used by perl5 packages that don't have a packlist.
8970: These variables are also substituted for in the
8971: <code class="filename">PLIST</code> as uppercase prefixed with
8972: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8973: </div>
1.41 asau 8974: <div class="sect2">
1.1 dsieger 8975: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8976: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8977: <p>Some packages install info files or use the
1.23 wiz 8978: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8979: commands. <code class="varname">INFO_FILES</code> should be defined in
8980: the package Makefile so that <code class="filename">INSTALL</code> and
8981: <code class="filename">DEINSTALL</code> scripts will be generated to
8982: handle registration of the info files in the Info directory
1.23 wiz 8983: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8984: files registration is either provided by the system, or by a
8985: special purpose package automatically added as dependency if
8986: needed.</p>
8987: <p><code class="varname">PKGINFODIR</code> is the directory under
8988: <code class="filename">${PREFIX}</code> where info files are primarily
8989: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8990: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8991: <p>The info files for the package should be listed in the
8992: package <code class="filename">PLIST</code>; however any split info files
8993: need not be listed.</p>
1.23 wiz 8994: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8995: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8996: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8997: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8998: should be noted with the <code class="varname">TEXINFO_REQD</code>
8999: variable in the package <code class="filename">Makefile</code>. By
9000: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 9001: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 9002: does not match the required minimum, a build dependency on the
1.137 leot 9003: <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 9004: be added automatically.</p>
9005: <p>The build and installation process of the software provided
9006: by the package should not use the
1.10 hubertf 9007: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 9008: info files is the task of the package
9009: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 9010: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 9011: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 9012: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9013: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 9014: in <code class="varname">PATH</code>.</p>
1.10 hubertf 9015: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 9016: no effect except the logging of a message. The script overriding
1.10 hubertf 9017: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 9018: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 9019: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 9020: </div>
1.41 asau 9021: <div class="sect2">
1.1 dsieger 9022: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9023: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9024: <p>All packages that install manual pages should install them
9025: into the same directory, so that there is one common place to look
9026: for them. In pkgsrc, this place is
9027: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9028: should be used in packages. The default for
9029: <code class="varname">PKGMANDIR</code> is
1.23 wiz 9030: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9031: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 9032: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9033: <h3 class="title">Note</h3>
9034: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9035: is far from complete.</p>
9036: </div>
9037: <p>The <code class="filename">PLIST</code> files can just use
9038: <code class="filename">man/</code> as the top level directory for the man
9039: page file entries, and the pkgsrc framework will convert as
9040: needed. In all other places, the correct
9041: <code class="varname">PKGMANDIR</code> must be used.</p>
9042: <p>Packages that are
9043: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 9044: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 9045: <code class="filename">./configure</code>
9046: --mandir switch to set where the man pages should be installed.
9047: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9048: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9049: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9050: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 9051: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 9052: Or if the <code class="filename">./configure</code> script uses
9053: a non-standard use of --mandir, you can set
9054: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.184 rillig 9055: <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 9056: information on installation of compressed manual pages.</p>
9057: </div>
1.41 asau 9058: <div class="sect2">
1.1 dsieger 9059: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9060: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 9061: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 9062: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 9063: you need to take some extra steps to make sure they get registered
9064: in the database:</p>
1.23 wiz 9065: <div class="orderedlist"><ol class="orderedlist" type="1">
9066: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 9067: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 9068: takes care of rebuilding the GConf database at installation and
1.1 dsieger 9069: deinstallation time, and tells the package where to install
1.7 rillig 9070: GConf data files using some standard configure arguments. It
1.1 dsieger 9071: also disallows any access to the database directly from the
9072: package.</p></li>
1.23 wiz 9073: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 9074: <code class="filename">.schemas</code> files under
9075: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
9076: installed under <code class="filename">${PREFIX}/etc</code>, you will
9077: need to manually patch the package.</p></li>
1.23 wiz 9078: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 9079: directory, as they will be handled automatically. See
1.154 rillig 9080: <a class="xref" href="#faq.conf" title="10.13. How do I change the location of configuration files?">Section 10.13, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.23 wiz 9081: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 9082: your <code class="filename">Makefile</code> with a list of all
9083: <code class="filename">.schemas</code> files installed by the package, if
9084: any. Names must not contain any directories in them.</p></li>
1.23 wiz 9085: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 9086: your <code class="filename">Makefile</code> with a
9087: list of all <code class="filename">.entries</code> files installed by the
9088: package, if any. Names must not contain any directories in
9089: them.</p></li>
9090: </ol></div>
9091: </div>
1.41 asau 9092: <div class="sect2">
1.1 dsieger 9093: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9094: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 9095: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 9096: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 9097: get registered in the database:</p>
1.23 wiz 9098: <div class="orderedlist"><ol class="orderedlist" type="1">
9099: <li class="listitem"><p>Include
1.18 snj 9100: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9101: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 9102: takes care of rebuilding the scrollkeeper database at
9103: installation and deinstallation time, and disallows any access
9104: to it directly from the package.</p></li>
1.23 wiz 9105: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9106: <code class="filename">libdata/scrollkeeper</code> directory, as they
9107: will be handled automatically.</p></li>
1.23 wiz 9108: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 9109: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9110: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 9111: </ol></div>
9112: </div>
1.41 asau 9113: <div class="sect2">
1.1 dsieger 9114: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9115: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9116: <p>If a package installs font files, you will need to rebuild
9117: the fonts database in the directory where they get installed at
9118: installation and deinstallation time. This can be automatically
9119: done by using the pkginstall framework.</p>
9120: <p>You can list the directories where fonts are installed in the
9121: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9122: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 9123: <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 9124: Also make sure that the database file
9125: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9126: <p>Note that you should not create new directories for fonts;
9127: instead use the standard ones to avoid that the user needs to
9128: manually configure his X server to find them.</p>
9129: </div>
1.41 asau 9130: <div class="sect2">
1.1 dsieger 9131: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9132: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 9133: <p>If a package installs GTK2 immodules or loaders, you need to
9134: take some extra steps to get them registered in the GTK2 database
9135: properly:</p>
1.23 wiz 9136: <div class="orderedlist"><ol class="orderedlist" type="1">
9137: <li class="listitem"><p>Include
1.1 dsieger 9138: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9139: <code class="filename">buildlink3.mk</code> file. This takes care of
9140: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 9141: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 9142: your package installs GTK2 immodules.</p></li>
1.23 wiz 9143: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 9144: GTK2 loaders.</p></li>
1.23 wiz 9145: <li class="listitem">
1.1 dsieger 9146: <p>Patch the package to not touch any of the GTK2
9147: databases directly. These are:</p>
1.41 asau 9148: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9149: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9150: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 9151: </ul></div>
9152: </li>
1.23 wiz 9153: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 9154: any entries under the <code class="filename">libdata/gtk-2.0</code>
9155: directory, as they will be handled automatically.</p></li>
9156: </ol></div>
9157: </div>
1.41 asau 9158: <div class="sect2">
1.1 dsieger 9159: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9160: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9161: <p>If a package installs SGML or XML data files that need to be
9162: registered in system-wide catalogs (like DTDs, sub-catalogs,
9163: etc.), you need to take some extra steps:</p>
1.23 wiz 9164: <div class="orderedlist"><ol class="orderedlist" type="1">
9165: <li class="listitem"><p>Include
1.1 dsieger 9166: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9167: your <code class="filename">Makefile</code>, which takes care of
9168: registering those files in system-wide catalogs at
9169: installation and deinstallation time.</p></li>
1.23 wiz 9170: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9171: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9172: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9173: any XML catalogs installed by the package.</p></li>
1.23 wiz 9174: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9175: to be added to the SGML catalog. These come in groups of
9176: three strings; see xmlcatmgr(1) for more information
9177: (specifically, arguments recognized by the 'add' action).
9178: Note that you will normally not use this variable.</p></li>
1.23 wiz 9179: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9180: to be added to the XML catalog. These come in groups of three
9181: strings; see xmlcatmgr(1) for more information (specifically,
9182: arguments recognized by the 'add' action). Note that you will
9183: normally not use this variable.</p></li>
9184: </ol></div>
9185: </div>
1.41 asau 9186: <div class="sect2">
1.1 dsieger 9187: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9188: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9189: <p>If a package provides extensions to the MIME database by
9190: installing <code class="filename">.xml</code> files inside
9191: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9192: need to take some extra steps to ensure that the database is kept
9193: consistent with respect to these new files:</p>
1.23 wiz 9194: <div class="orderedlist"><ol class="orderedlist" type="1">
9195: <li class="listitem"><p>Include
1.1 dsieger 9196: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9197: (avoid using the <code class="filename">buildlink3.mk</code> file from
9198: this same directory, which is reserved for inclusion from
9199: other <code class="filename">buildlink3.mk</code> files). It takes
9200: care of rebuilding the MIME database at installation and
9201: deinstallation time, and disallows any access to it directly
9202: from the package.</p></li>
1.23 wiz 9203: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9204: <code class="filename">share/mime</code> directory,
9205: <span class="emphasis"><em>except</em></span> for files saved under
9206: <code class="filename">share/mime/packages</code>. The former are
9207: handled automatically by
9208: the update-mime-database program, but the latter are
9209: package-dependent and must be removed by the package that
9210: installed them in the first place.</p></li>
1.23 wiz 9211: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9212: from the PLIST. They will be handled by the shared-mime-info
9213: package.</p></li>
9214: </ol></div>
9215: </div>
1.41 asau 9216: <div class="sect2">
1.1 dsieger 9217: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9218: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 9219: <p>If a package uses intltool during its build, add
9220: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9221: which forces it to use the intltool package provided by pkgsrc,
9222: instead of the one bundled with the distribution file.</p>
9223: <p>This tracks intltool's build-time dependencies and uses the
9224: latest available version; this way, the package benefits of any
9225: bug fixes that may have appeared since it was released.</p>
9226: </div>
1.41 asau 9227: <div class="sect2">
1.1 dsieger 9228: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9229: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9230: <p>If a package contains a rc.d script, it won't be copied into
9231: the startup directory by default, but you can enable it, by adding
9232: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9233: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9234: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9235: it will automatically remove the scripts when the package is
9236: deinstalled.</p>
9237: </div>
1.41 asau 9238: <div class="sect2">
1.1 dsieger 9239: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9240: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9241: <p>If a package installs TeX packages into the texmf tree,
9242: the <code class="filename">ls-R</code> database of the tree needs to be
9243: updated.</p>
1.41 asau 9244: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9245: <h3 class="title">Note</h3>
1.22 jakllsch 9246: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9247: packages should install files
1.22 jakllsch 9248: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9249: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9250: </div>
1.23 wiz 9251: <div class="orderedlist"><ol class="orderedlist" type="1">
9252: <li class="listitem"><p>Include
1.22 jakllsch 9253: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9254: takes care of rebuilding the <code class="filename">ls-R</code>
9255: database at installation and deinstallation time.</p></li>
1.23 wiz 9256: <li class="listitem">
1.1 dsieger 9257: <p>If your package installs files into a texmf
9258: tree other than the one
1.22 jakllsch 9259: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9260: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9261: trees that need database update.</p>
9262: <p>If your package also installs font map files that need
1.10 hubertf 9263: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9264: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9265: set <code class="varname">TEX_MAP_FILES</code> and/or
9266: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9267: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9268: be run automatically at installation/deinstallation to
9269: enable/disable font map files for TeX output
9270: drivers.</p>
9271: </li>
1.23 wiz 9272: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9273: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9274: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9275: </ol></div>
9276: </div>
1.41 asau 9277: <div class="sect2">
1.1 dsieger 9278: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9279: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.1 dsieger 9280: emulation</h3></div></div></div>
9281: <p>There are some packages that provide libraries and
9282: executables for running binaries from a one operating system
9283: on a different one (if the latter supports it). One example
9284: is running Linux binaries on NetBSD.</p>
1.137 leot 9285: <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 9286: helps in extracting and packaging Linux rpm packages.</p>
9287: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9288: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9289: if all libraries for each installed executable can be found by
9290: the dynamic linker. Since the standard dynamic linker is run,
9291: this fails for emulation packages, because the libraries used
9292: by the emulation are not in the standard directories.</p>
9293: </div>
1.184 rillig 9294: <div class="sect2">
9295: <div class="titlepage"><div><div><h3 class="title">
9296: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
9297: <p>If a package installs images under the
9298: <code class="filename">share/icons/hicolor</code> and/or updates the
9299: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9300: database, you need to take some extra steps to make sure that the
9301: shared theme directory is handled appropriately and that the cache
9302: database is rebuilt:</p>
9303: <div class="orderedlist"><ol class="orderedlist" type="1">
9304: <li class="listitem"><p>Include
9305: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9306: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9307: entry that refers to the theme cache.</p></li>
9308: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9309: directories from the <code class="filename">share/icons/hicolor</code>
9310: hierarchy because they will be handled automatically.</p></li>
9311: </ol></div>
9312: <p>The best way to verify that the PLIST is correct with
9313: respect to the last two points is to regenerate it using
9314: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9315: </div>
9316: <div class="sect2">
9317: <div class="titlepage"><div><div><h3 class="title">
9318: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
9319: <p>If a package installs <code class="filename">.desktop</code> files
9320: under <code class="filename">share/applications</code> and these include
9321: MIME information (MimeType key), you need to take extra steps to
9322: ensure that they are registered into the MIME database:</p>
9323: <div class="orderedlist"><ol class="orderedlist" type="1">
9324: <li class="listitem"><p>Include
9325: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9326: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9327: <code class="filename">share/applications/mimeinfo.cache</code> file.
9328: It will be handled automatically.</p></li>
9329: </ol></div>
9330: <p>The best way to verify that the PLIST is correct with
9331: respect to the last point is to regenerate it using <span class="command"><strong>make
9332: print-PLIST</strong></span>.</p>
9333: </div>
9334: </div>
9335: <div class="sect1">
9336: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9337: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9338: <p>In some cases one does not have the time to solve a problem
9339: immediately. In this case, one can plainly mark a package as broken. For
9340: this, one just sets the variable <code class="varname">BROKEN</code> to the
9341: reason why the package is broken (similar to the
9342: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9343: the package will immediately be shown this message, and the build
9344: will not be even tried.</p>
9345: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9346: intervals.</p>
9347: </div>
9348: </div>
9349: <div class="chapter">
9350: <div class="titlepage"><div><div><h2 class="title">
9351: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9352: <div class="toc">
9353: <p><b>Table of Contents</b></p>
9354: <dl class="toc">
9355: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9356: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9357: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9358: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9359: </dl>
9360: </div>
9361: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9362: site</a>:</p>
9363: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9364: environment, an intuitive and attractive desktop for users, and the
9365: GNOME development platform, an extensive framework for building
9366: applications that integrate into the rest of the desktop.</p></blockquote></div>
9367: <p>pkgsrc provides a seamless way to automatically build and install
9368: a complete GNOME environment <span class="emphasis"><em>under many different
9369: platforms</em></span>. We can say with confidence that pkgsrc is one of
9370: the most advanced build and packaging systems for GNOME due to its
9371: included technologies buildlink3, the wrappers and tools framework and
9372: automatic configuration file management. Lots of efforts are put into
9373: achieving a completely clean deinstallation of installed software
9374: components.</p>
9375: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9376: the above also means that great efforts are put into making GNOME work
9377: under this operating system. Recently, <a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9378: pkgsrc as its preferred packaging system, contributing lots of
9379: portability fixes to make GNOME build and install under it.</p>
9380: <p>This chapter is aimed at pkgsrc developers and other people
9381: interested in helping our GNOME porting and packaging efforts. It
9382: provides instructions on how to manage the existing packages and some
9383: important information regarding their internals.</p>
9384: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9385: <h3 class="title">We need your help!</h3>
9386: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9387: and GNOME and are willing to learn new exciting stuff, please jump
9388: straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9389: work</a> list! There is still a long way to go to get a
9390: fully-functional GNOME desktop under NetBSD and we need your help to
9391: achieve it!</p>
9392: </div>
9393: <div class="sect1">
9394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9395: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9396: <p>pkgsrc includes three GNOME-related meta packages:</p>
9397: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9398: <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
9399: the core GNOME desktop environment. It only includes the necessary
9400: bits to get it to boot correctly, although it may lack important
9401: functionality for daily operation. The idea behind this package is
9402: to let end users build their own configurations on top of this one,
9403: first installing this meta package to achieve a functional setup and
9404: then adding individual applications.</p></li>
9405: <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
9406: complete installation of the GNOME platform and desktop as defined
9407: by the GNOME project; this is based on the components distributed in
9408: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9409: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9410: official FTP server. Developer-only tools found in those
9411: directories are not installed unless required by some other
9412: component to work properly. Similarly, packages from the bindings
9413: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9414: in unless required as a dependency for an end-user component. This
9415: 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>
9416: <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>:
9417: Installs all the tools required to build a GNOME component when
9418: fetched from the CVS repository. These are required to let the
9419: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9420: </ul></div>
9421: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9422: sorted in a way that eases updates: a package may depend on other
9423: packages listed before it but not on any listed after it. It is very
9424: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9425: change it to alphabetical sorting!</em></span></p>
9426: </div>
9427: <div class="sect1">
9428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9429: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9430: <p>Almost all GNOME applications are written in C and use a common
9431: set of tools as their build system. Things get different with the new
9432: bindings to other languages (such as Python), but the following will
9433: give you a general idea on the minimum required tools:</p>
9434: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9435: <li class="listitem">
9436: <p>Almost all GNOME applications use the GNU Autotools as their
9437: build system. As a general rule you will need to tell this to your
9438: package:</p>
9439: <pre class="programlisting">
9440: GNU_CONFIGURE=yes
9441: USE_LIBTOOL=yes
9442: USE_TOOLS+=gmake
9443: </pre>
9444: </li>
9445: <li class="listitem">
9446: <p>If the package uses pkg-config to detect dependencies, add this
9447: tool to the list of required utilities:</p>
9448: <pre class="programlisting">
9449: USE_TOOLS+=pkg-config
9450: </pre>
9451: <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
9452: the end of the build process to ensure that you did not miss to
9453: specify any dependency in your package and that the version
9454: requirements are all correct.</p>
9455: </li>
9456: <li class="listitem"><p>If the package uses intltool, be sure to add
9457: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9458: to handle dependencies and to force the package to use the latest
9459: available version.</p></li>
9460: <li class="listitem">
9461: <p>If the package uses gtk-doc (a documentation generation
9462: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9463: tool is rather big and the distfile should come with pregenerated
9464: documentation anyway; if it does not, it is a bug that you ought to
9465: report. For such packages you should disable gtk-doc (unless it is
9466: the default):</p>
9467: <pre class="programlisting">
9468: CONFIGURE_ARGS+=--disable-gtk-doc
9469: </pre>
9470: <p>The default location of installed HTML files
9471: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9472: and should not be changed unless the package insists on installing
9473: them somewhere else. Otherwise programs as
9474: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9475: do that with an entry similar to:</p>
9476: <pre class="programlisting">
9477: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9478: </pre>
9479: </li>
9480: </ul></div>
9481: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9482: files under the installation prefix to maintain databases. In this
9483: context, shared means that those exact same directories and files are
9484: used among several different packages, leading to conflicts in the
9485: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9486: handle the most common cases, so you have to forget about using
9487: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9488: omitting shared files from them. If you find yourself doing those,
9489: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9490: <p>The following table lists the common situations that result in
9491: using shared directories or files. For each of them, the appropriate
9492: solution is given. After applying the solution be sure to
9493: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9494: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9495: <div class="table">
9496: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9497: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9498: <colgroup>
9499: <col>
9500: <col>
9501: </colgroup>
9502: <thead><tr>
9503: <th>If the package...</th>
9504: <th>Then...</th>
9505: </tr></thead>
9506: <tbody>
9507: <tr>
9508: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
9509: <td>See <a class="xref" href="#scrollkeeper-data-files" title="21.6.10. Packages installing scrollkeeper/rarian data files">Section 21.6.10, “Packages installing scrollkeeper/rarian data files”</a>.</td>
9510: </tr>
9511: <tr>
9512: <td>Installs icons under the
9513: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9514: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
9515: <td>See <a class="xref" href="#hicolor-theme" title="21.6.19. Packages installing hicolor theme icons">Section 21.6.19, “Packages installing hicolor theme icons”</a>.</td>
9516: </tr>
9517: <tr>
9518: <td>Installs files under
9519: <code class="filename">share/mime/packages</code>.</td>
9520: <td>See <a class="xref" href="#mime-database" title="21.6.14. Packages installing extensions to the MIME database">Section 21.6.14, “Packages installing extensions to the MIME database”</a>.</td>
9521: </tr>
9522: <tr>
9523: <td>Installs <code class="filename">.desktop</code> files under
9524: <code class="filename">share/applications</code> and these include MIME
9525: information.</td>
9526: <td>See <a class="xref" href="#desktop-files" title="21.6.20. Packages installing desktop files">Section 21.6.20, “Packages installing desktop files”</a>.</td>
9527: </tr>
9528: </tbody>
9529: </table></div>
1.1 dsieger 9530: </div>
1.184 rillig 9531: <br class="table-break">
1.1 dsieger 9532: </div>
1.41 asau 9533: <div class="sect1">
1.1 dsieger 9534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 9535: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9536: <p>When seeing GNOME as a whole, there are two kinds of
9537: updates:</p>
9538: <div class="variablelist"><dl class="variablelist">
9539: <dt><span class="term">Major update</span></dt>
9540: <dd>
9541: <p>Given that there is still a very long way for GNOME 3 (if it
9542: ever appears), we consider a major update one that goes from a
9543: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9544: where <code class="literal">Y</code> is even and greater than
9545: <code class="literal">X</code>. These are hard to achieve because they
9546: introduce lots of changes in the components' code and almost all
9547: GNOME distfiles are updated to newer versions. Some of them can
9548: even break API and ABI compatibility with the previous major
9549: version series. As a result, the update needs to be done all at
9550: once to minimize breakage.</p>
9551: <p>A major update typically consists of around 80 package
9552: updates and the addition of some new ones.</p>
9553: </dd>
9554: <dt><span class="term">Minor update</span></dt>
9555: <dd>
9556: <p>We consider a minor update one that goes from a
9557: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9558: one where <code class="literal">Y</code> is greater than
9559: <code class="literal">X</code>. These are easy to achieve because they do
9560: not update all GNOME components, can be done in an incremental way
9561: and do not break API nor ABI compatibility.</p>
9562: <p>A minor update typically consists of around 50 package
9563: updates, although the numbers here may vary a lot.</p>
9564: </dd>
9565: </dl></div>
9566: <p>In order to update the GNOME components in pkgsrc to a new stable
9567: release (either major or minor), the following steps should be
9568: followed:</p>
9569: <div class="orderedlist"><ol class="orderedlist" type="1">
1.23 wiz 9570: <li class="listitem">
1.184 rillig 9571: <p>Get a list of all the tarballs that form the new release by
9572: using the following commands. These will leave the full list of the
9573: components' distfiles into the <code class="filename">list.txt</code>
9574: file:</p>
9575: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9576: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9577: awk '{ print $9 }' >list.txt</code></strong>
9578: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9579: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9580: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.1 dsieger 9581: </li>
1.184 rillig 9582: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9583: bump their version to the release you are updating them to. The
9584: three meta packages should be always consistent with versioning.
9585: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9586: in them.</p></li>
1.23 wiz 9587: <li class="listitem">
1.184 rillig 9588: <p>For each meta package, update all its
9589: <code class="varname">DEPENDS</code> lines to match the latest versions as
9590: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9591: newer version (even if found in the FTP) because the meta packages
9592: are supposed to list the exact versions that form a specific GNOME
9593: release. Exceptions are permitted here if a newer version solves a
9594: serious issue in the overall desktop experience; these typically
9595: come in the form of a revision bump in pkgsrc, not in newer versions
9596: from the developers.</p>
9597: <p>Packages not listed in the <code class="filename">list.txt</code> file
9598: should be updated to the latest version available (if found in
9599: pkgsrc). This is the case, for example, of the dependencies on the
9600: 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 9601: </li>
1.23 wiz 9602: <li class="listitem">
1.184 rillig 9603: <p>Generate a patch from the modified meta packages and extract the
9604: list of "new" lines. This will provide you an outline on what
9605: packages need to be updated in pkgsrc and in what order:</p>
9606: <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 9607: </li>
1.184 rillig 9608: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9609: installed packages and start over from scratch at this point.</p></li>
9610: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9611: of <code class="filename">todo.txt</code> and update the packages listed in
9612: it in order. For major desktop updates none of these should be
9613: committed until the entire set is completed because there are chances
9614: of breaking not-yet-updated packages.</p></li>
9615: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9616: the tree one by one with appropriate log messages. At the end,
9617: commit the three meta package updates and all the corresponding
9618: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9619: <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>
9620: </ol></div>
9621: </div>
9622: <div class="sect1">
9623: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9624: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9625: <p>GNOME is a very big component in pkgsrc which approaches 100
9626: packages. Please, it is very important that you always, always,
9627: <span class="strong"><strong>always</strong></span> feed back any portability
9628: 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
9629: their attention on portability issues and to ensure that future versions
9630: can be built out-of-the box on NetBSD. The less custom patches in
9631: pkgsrc, the easier further updates are. Those developers in charge of
9632: issuing major GNOME updates will be grateful if you do that.</p>
9633: <p>The most common places to report bugs are the <a class="ulink" href="https://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="https://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
9634: Bugzilla</a>. Not all components use these to track bugs, but most
9635: of them do. Do not be short on your reports: always provide detailed
9636: explanations of the current failure, how it can be improved to achieve
9637: maximum portability and, if at all possible, provide a patch against CVS
9638: head. The more verbose you are, the higher chances of your patch being
9639: accepted.</p>
9640: <p>Also, please avoid using preprocessor magic to fix portability
9641: issues. While the FreeBSD GNOME people are doing a great job in porting
9642: GNOME to their operating system, the official GNOME sources are now
9643: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9644: and similar macros. This hurts portability. Please see our patching
9645: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9646: details.</p>
9647: </div>
1.1 dsieger 9648: </div>
1.41 asau 9649: <div class="chapter">
1.1 dsieger 9650: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9651: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9652: <div class="toc">
9653: <p><b>Table of Contents</b></p>
1.100 leot 9654: <dl class="toc">
1.154 rillig 9655: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9656: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9657: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9658: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9659: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9660: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9661: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9662: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9663: </dl>
9664: </div>
1.41 asau 9665: <div class="sect1">
1.1 dsieger 9666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9667: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9668: <p>Our policy is that we accept binaries only from pkgsrc
9669: developers to guarantee that the packages don't contain any
9670: trojan horses etc. This is not to annoy anyone but rather to
9671: protect our users! You're still free to put up your home-made
9672: binary packages and tell the world where to get them. NetBSD
9673: developers doing bulk builds and wanting to upload them please
1.154 rillig 9674: 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 9675: builds)</i></a>.</p>
1.1 dsieger 9676: </div>
1.41 asau 9677: <div class="sect1">
1.1 dsieger 9678: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9679: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9680: <p>First, check that your package is complete, compiles and
1.184 rillig 9681: 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.174 leot 9682: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1 dsieger 9683: archive that contains all files that make up the package.
9684: Finally, send this package to the pkgsrc bug tracking system,
1.174 leot 9685: either with the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1 dsieger 9686: that, go to the web page
1.174 leot 9687: <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 9688: which contains some instructions and a link to a form where you
9689: can submit packages. The
1.137 leot 9690: <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 9691: also available as a substitute for either of the above two tools.
9692: </p>
1.1 dsieger 9693: <p>In the form of the problem report, the category should be
1.23 wiz 9694: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9695: and version number, and the description field should contain a
9696: short description of your package (contents of the COMMENT
9697: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 9698: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 9699: <p>If you want to submit several packages, please send a
9700: separate PR for each one, it's easier for us to track things
9701: that way.</p>
9702: <p>Alternatively, you can also import new packages into
1.23 wiz 9703: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.174 leot 9704: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
1.1 dsieger 9705: for details.</p>
9706: </div>
1.41 asau 9707: <div class="sect1">
1.1 dsieger 9708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9709: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9710: <p>Please note all package additions, updates, moves, and
9711: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9712: important to keep this file up to date and conforming to the
9713: existing format, because it will be used by scripts to
1.174 leot 9714: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9715: sites. Additionally, check the
9716: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9717: for the package you updated or removed, in case it was mentioned
9718: there.</p>
9719: <p>When the <code class="varname">PKGREVISION</code> of a package is
9720: bumped, the change should appear in
9721: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9722: related or otherwise relevant. Mass bumps that result from a
9723: dependency being updated should not be mentioned. In all other
9724: cases it's the developer's decision.</p>
9725: <p>There is a make target that helps in creating proper
1.10 hubertf 9726: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9727: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9728: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9729: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9730: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9731: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9732: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9733: For new packages, or package moves or removals, set the
9734: <code class="varname">CTYPE</code> variable on the command line to "Added",
9735: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9736: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9737: not the same as your NetBSD login name. The target also automatically
9738: removes possibly existing entries for the package in the
9739: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 9740: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 9741: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9742: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9743: makes the cvs commands use the main repository.
9744: </p>
1.1 dsieger 9745: </div>
1.41 asau 9746: <div class="sect1">
1.1 dsieger 9747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9748: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 9749: <p>For several years, there have been mirrors of pkgsrc in
9750: fossil, git, and hg. Standard practise when using these tools is to
9751: make the first line of a commit message function as a summary that
9752: can be read without the rest, such as is commonly done with "git log
9753: --oneline". For this reason, we have the following guidelines for
9754: pkgsrc commit messages:</p>
9755: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9756: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 9757: big picture in 65 characters or less. When a commit is for one
1.130 wiz 9758: package, include the name of the package. For updates, include the
9759: version to which it is updated.</p></li>
9760: <li class="listitem"><p>Leave the next line empty.</p></li>
9761: <li class="listitem"><p>Then come the details for the commit (changes in that
9762: package, reason for a change) and any relevant PRs. Wrap this
9763: section.</p></li>
9764: </ul></div>
9765: <p>Here is an example:
9766: </p>
9767: <pre class="programlisting">
9768: libxslt: update to 1.0.30
9769:
9770: Changes since 1.0.29:
9771: ...
9772: </pre>
9773: <p>
9774: </p>
9775: <p>Here is another example:
9776: </p>
9777: <pre class="programlisting">
9778: mk/bsd.pkg.mk: enable SSP by default on NetBSD
9779:
9780: (rationale)
9781: </pre>
9782: <p>
9783: </p>
9784: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
9785: allowed on the pkgsrc repository to change commit messages.</p>
9786: </div>
9787: <div class="sect1">
9788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9789: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 9790: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 9791: access to the pkgsrc repository.</p>
9792: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9793: Start by adding the directory and then files in the directory. Don't
9794: forget to add the new package to the category's
9795: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9796: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9797: <pre class="programlisting">
9798: <code class="prompt">$</code> cd .../pkgsrc/category
9799: <code class="prompt">$</code> cvs add pkgname
9800: <code class="prompt">$</code> cd pkgname
9801: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9802: <code class="prompt">$</code> cvs add patches/p*
9803: <code class="prompt">$</code> cvs status | less
1.34 wiz 9804: <code class="prompt">$</code> cvs commit
1.33 wiz 9805: <code class="prompt">$</code> cd ..
9806: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 9807: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 9808: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 9809: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 9810: </pre>
1.1 dsieger 9811: <p>The commit message of the initial import should include part of the
9812: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9813: what the package is/does.</p>
1.33 wiz 9814: <p>Also mention the new package in
9815: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9816: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9817: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 9818: </div>
1.41 asau 9819: <div class="sect1">
1.1 dsieger 9820: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9821: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9822: <p>Please always put a concise, appropriate and relevant summary of the
9823: changes between old and new versions into the commit log when updating
9824: a package. There are various reasons for this:</p>
1.41 asau 9825: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9826: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 9827: or its information may be overwritten by newer information.</p></li>
1.23 wiz 9828: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9829: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 9830: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9831: repository is very useful for people who read the pkgsrc-changes mailing
9832: list, so that they can make tactical decisions about when to upgrade
9833: the package.</p></li>
9834: </ul></div>
9835: <p>Please also recognize that, just because a new version of a package
9836: has been released, it should not automatically be upgraded in the CVS
9837: repository. We prefer to be conservative in the packages that are
9838: included in pkgsrc - development or beta packages are not really the
9839: best thing for most places in which pkgsrc is used. Please use your
9840: judgement about what should go into pkgsrc, and bear in mind that
9841: stability is to be preferred above new and possibly untested features.</p>
9842: </div>
1.41 asau 9843: <div class="sect1">
1.1 dsieger 9844: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9845: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 9846: <p>Renaming packages is not recommended.</p>
1.175 gutterid 9847: <p>When renaming packages, be sure to fix any references to the old name
1.20 snj 9848: in other Makefiles, options, buildlink files, etc.</p>
1.167 leot 9849: <p>
1.175 gutterid 9850: Also, when renaming a package, please add
1.167 leot 9851: the package name and version pattern(s) of the previous package
9852: to <code class="varname">SUPERSEDES</code>.
1.20 snj 9853: This may be repeated for multiple renames.
9854: The new package would be an exact replacement.
1.167 leot 9855: Example:
1.20 snj 9856: </p>
1.167 leot 9857: <pre class="programlisting">
9858: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
9859: SUPERSEDES+= optcomp-[0-9]*
9860: </pre>
1.23 wiz 9861: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 9862: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9863: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9864: not be an exact replacement but is a suggestion for the replaced
9865: functionality.</p>
9866: </div>
1.41 asau 9867: <div class="sect1">
1.20 snj 9868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9869: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 9870: <p>It is preferred that packages are not renamed or moved, but if needed
9871: please follow these steps.
9872: </p>
1.23 wiz 9873: <div class="orderedlist"><ol class="orderedlist" type="1">
9874: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9875: <li class="listitem">
1.1 dsieger 9876: <p>Remove all CVS dirs.</p>
9877: <p>Alternatively to the first two steps you can also do:</p>
9878: <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>
9879: <p>and use that for further work.</p>
9880: </li>
1.23 wiz 9881: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9882: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9883: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9884: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 9885: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9886: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9887: for doing an update using pkgsrc building; for example, it can
1.174 leot 9888: search the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20 snj 9889: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9890: new <code class="varname">PKGPATH</code> for that moved package. Note that
9891: it may have multiple matches, so the tool should also check on the
9892: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9893: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9894: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 9895: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9896: place.</p></li>
1.23 wiz 9897: <li class="listitem">
1.1 dsieger 9898: <p>Check if any package depends on it:
9899: </p>
9900: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9901: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9902: </li>
1.23 wiz 9903: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9904: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9905: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9906: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9907: <li class="listitem">
1.1 dsieger 9908: <p>Commit the changed and removed files:</p>
9909: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9910: <p>(and any packages from step 5, of course).</p>
9911: </li>
9912: </ol></div>
9913: </div>
9914: </div>
1.41 asau 9915: <div class="chapter">
1.1 dsieger 9916: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9917: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9918: <p>This section contains the answers to questions that may
9919: arise when you are writing a package. If you don't find your
9920: question answered here, first have a look in the other chapters,
9921: and if you still don't have the answer, ask on the
9922: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9923: <div class="qandaset">
1.174 leot 9924: <a name="devfaq.qandaset"></a><dl>
1.154 rillig 9925: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9926: MAKEFLAGS, .MAKEFLAGS and
9927: MAKE_FLAGS?</a>
9928: </dt>
1.154 rillig 9929: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9930: MAKE, GMAKE and
9931: MAKE_PROGRAM?</a>
9932: </dt>
1.154 rillig 9933: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9934: CC, PKG_CC and
9935: PKGSRC_COMPILER?</a>
9936: </dt>
1.154 rillig 9937: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9938: BUILDLINK_LDFLAGS,
9939: BUILDLINK_LDADD and
9940: BUILDLINK_LIBS?</a>
9941: </dt>
1.154 rillig 9942: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9943: VARNAME=BUILDLINK_PREFIX.foo
9944: say it's empty?</a>
9945: </dt>
1.154 rillig 9946: <dt>24.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9947: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9948: don't understand the := inside
9949: it.</a>
9950: </dt>
1.154 rillig 9951: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9952: developers?</a>
9953: </dt>
1.154 rillig 9954: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9955: documentation?</a>
9956: </dt>
1.174 leot 9957: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill.
9958: What shall I do?</a>
1.1 dsieger 9959: </dt>
9960: </dl>
1.41 asau 9961: <table border="0" style="width: 100%;">
9962: <colgroup>
1.1 dsieger 9963: <col align="left" width="1%">
1.23 wiz 9964: <col>
1.41 asau 9965: </colgroup>
1.1 dsieger 9966: <tbody>
1.41 asau 9967: <tr class="question">
1.1 dsieger 9968: <td align="left" valign="top">
1.174 leot 9969: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.1 dsieger 9970: </td>
9971: <td align="left" valign="top"><p>What is the difference between
9972: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9973: <code class="varname">MAKE_FLAGS</code>?</p></td>
9974: </tr>
9975: <tr class="answer">
9976: <td align="left" valign="top"></td>
9977: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.174 leot 9978: to the pkgsrc-internal invocations of <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1 dsieger 9979: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9980: the <code class="varname">MAKE_PROGRAM</code> when building the
9981: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9982: </tr>
1.41 asau 9983: <tr class="question">
1.1 dsieger 9984: <td align="left" valign="top">
1.174 leot 9985: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.1 dsieger 9986: </td>
9987: <td align="left" valign="top"><p>What is the difference between
9988: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9989: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9990: </tr>
9991: <tr class="answer">
9992: <td align="left" valign="top"></td>
9993: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.174 leot 9994: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1 dsieger 9995: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9996: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9997: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9998: Make program that is used for building the
9999: package.</p></td>
10000: </tr>
1.41 asau 10001: <tr class="question">
1.1 dsieger 10002: <td align="left" valign="top">
1.174 leot 10003: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.1 dsieger 10004: </td>
10005: <td align="left" valign="top"><p>What is the difference between
10006: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10007: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10008: </tr>
10009: <tr class="answer">
10010: <td align="left" valign="top"></td>
10011: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
10012: compiler, which can be configured by the pkgsrc user.
10013: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
10014: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
10015: path to a compiler, but the type of compiler that should be
10016: used. See <code class="filename">mk/compiler.mk</code> for more
10017: information about the latter variable.</p></td>
10018: </tr>
1.41 asau 10019: <tr class="question">
1.1 dsieger 10020: <td align="left" valign="top">
1.174 leot 10021: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.1 dsieger 10022: </td>
10023: <td align="left" valign="top"><p>What is the difference between
10024: <code class="varname">BUILDLINK_LDFLAGS</code>,
10025: <code class="varname">BUILDLINK_LDADD</code> and
10026: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
10027: </tr>
10028: <tr class="answer">
10029: <td align="left" valign="top"></td>
10030: <td align="left" valign="top"><p>[FIXME]</p></td>
10031: </tr>
1.41 asau 10032: <tr class="question">
1.1 dsieger 10033: <td align="left" valign="top">
1.174 leot 10034: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.1 dsieger 10035: </td>
1.10 hubertf 10036: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 10037: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10038: say it's empty?</p></td>
10039: </tr>
10040: <tr class="answer">
10041: <td align="left" valign="top"></td>
10042: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 10043: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10044: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 10045: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 10046: command.</p></td>
10047: </tr>
1.41 asau 10048: <tr class="question">
1.1 dsieger 10049: <td align="left" valign="top">
1.174 leot 10050: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.1 dsieger 10051: </td>
10052: <td align="left" valign="top"><p>What does
1.108 rillig 10053: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10054: don't understand the <code class="code">:=</code> inside
1.1 dsieger 10055: it.</p></td>
10056: </tr>
10057: <tr class="answer">
10058: <td align="left" valign="top"></td>
1.108 rillig 10059: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
10060: assignment operator, although it looks like it.
1.1 dsieger 10061: Instead, it is a degenerate form of
1.108 rillig 10062: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.174 leot 10063: which is documented in the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.108 rillig 10064: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 10065: case of <code class="varname">MASTER_SITE_*</code>,
10066: <em class="replaceable"><code>old_string</code></em> is the empty string and
10067: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 10068: <code class="code">package/</code>. That's where the
10069: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 10070: together.</p></td>
10071: </tr>
1.41 asau 10072: <tr class="question">
1.1 dsieger 10073: <td align="left" valign="top">
1.174 leot 10074: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.1 dsieger 10075: </td>
10076: <td align="left" valign="top"><p>Which mailing lists are there for package
10077: developers?</p></td>
10078: </tr>
10079: <tr class="answer">
10080: <td align="left" valign="top"></td>
1.41 asau 10081: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.174 leot 10082: <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 10083: <dd><p>This is a list for technical discussions related
10084: to pkgsrc development, e.g. soliciting feedback for changes to
10085: pkgsrc infrastructure, proposed new features, questions related
10086: to porting pkgsrc to a new platform, advice for maintaining a
10087: package, patches that affect many packages, help requests moved
10088: from pkgsrc-users when an infrastructure bug is found,
10089: etc.</p></dd>
1.174 leot 10090: <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 10091: <dd><p>All bug reports in category "pkg" sent with
1.174 leot 10092: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1 dsieger 10093: directly; use one of the other mailing
10094: lists.</p></dd>
10095: </dl></div></td>
10096: </tr>
1.41 asau 10097: <tr class="question">
1.1 dsieger 10098: <td align="left" valign="top">
1.174 leot 10099: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.1 dsieger 10100: </td>
10101: <td align="left" valign="top"><p>Where is the pkgsrc
10102: documentation?</p></td>
10103: </tr>
10104: <tr class="answer">
10105: <td align="left" valign="top"></td>
10106: <td align="left" valign="top">
10107: <p>There are many places where you can find
10108: documentation about pkgsrc:</p>
1.41 asau 10109: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10110: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 10111: of chapters that explain large parts of pkgsrc, but some
10112: chapters tend to be outdated. Which ones they are is hard to
10113: say.</p></li>
1.174 leot 10114: <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 10115: about certain features, announcements of new parts of the pkgsrc
10116: infrastructure and sometimes even announcements that a certain
10117: feature has been marked as obsolete. The benefit here is that
10118: each message has a date appended to it.</p></li>
1.23 wiz 10119: <li class="listitem"><p>Many of the files in the
1.1 dsieger 10120: <code class="filename">mk/</code> directory start with a comment that
10121: describes the purpose of the file and how it can be used by the
10122: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 10123: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 10124: help</strong></span>.</p></li>
1.23 wiz 10125: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 10126: information, but they tend to be highly abbreviated, especially
10127: for actions that occur often. Some contain a detailed
10128: description of what has changed, but they are geared towards the
10129: other pkgsrc developers, not towards an average pkgsrc user.
10130: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10131: don't know what has been before, these messages may not be worth
10132: too much to you.</p></li>
1.23 wiz 10133: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10134: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 10135: mind of the developer who wrote the code. To get this
1.10 hubertf 10136: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 10137: to see who has written it and ask on the
10138: <code class="literal">tech-pkg</code> mailing list, so that others can
10139: find your questions later (see above). To be sure that the
10140: developer in charge reads the mail, you may CC him or
10141: her.</p></li>
10142: </ul></div>
1.184 rillig 10143: </td>
10144: </tr>
10145: <tr class="question">
10146: <td align="left" valign="top">
10147: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
10148: </td>
10149: <td align="left" valign="top"><p>I have a little time to kill.
10150: What shall I do?</p></td>
10151: </tr>
10152: <tr class="answer">
10153: <td align="left" valign="top"></td>
10154: <td align="left" valign="top">
10155: <p>This is not really an FAQ yet, but here's the answer
10156: anyway.</p>
1.41 asau 10157: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 10158: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
10159: <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
10160: will tell you about newer versions of installed packages that are
10161: available, but not yet updated in pkgsrc.</p></li>
10162: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10163: — it contains a list of suggested new packages and a list of
10164: cleanups and enhancements for pkgsrc that would be nice to
10165: have.</p></li>
10166: <li class="listitem"><p>Review packages for which review was requested on
10167: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10168: mailing list.</p></li>
1.1 dsieger 10169: </ul></div>
1.184 rillig 10170: </td>
1.1 dsieger 10171: </tr>
10172: </tbody>
1.184 rillig 10173: </table>
1.1 dsieger 10174: </div>
10175: </div>
10176: </div>
1.41 asau 10177: <div class="part">
1.1 dsieger 10178: <div class="titlepage"><div><div><h1 class="title">
10179: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10180: <div class="partintro">
1.1 dsieger 10181: <div></div>
10182: <p>This part of the guide deals with everything
10183: from the infrastructure that is behind the interfaces described
10184: in the developer's guide. A casual package maintainer should not
10185: need anything from this part.</p>
10186: <div class="toc">
10187: <p><b>Table of Contents</b></p>
1.100 leot 10188: <dl class="toc">
1.184 rillig 10189: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10190: <dd><dl>
1.184 rillig 10191: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10192: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10193: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10194: <dd><dl>
1.184 rillig 10195: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10196: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10197: </dl></dd>
1.184 rillig 10198: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10199: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10200: <dd><dl>
1.184 rillig 10201: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10202: <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 10203: </dl></dd>
1.184 rillig 10204: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10205: <dd><dl>
1.184 rillig 10206: <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>
10207: <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 10208: </dl></dd>
10209: </dl></dd>
1.184 rillig 10210: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 10211: <dd><dl>
1.184 rillig 10212: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10213: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10214: <dd><dl>
1.184 rillig 10215: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10216: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10217: </dl></dd>
10218: </dl></dd>
1.184 rillig 10219: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10220: <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 10221: </dl>
10222: </div>
10223: </div>
1.41 asau 10224: <div class="chapter">
1.1 dsieger 10225: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10226: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10227: <div class="toc">
10228: <p><b>Table of Contents</b></p>
1.100 leot 10229: <dl class="toc">
1.184 rillig 10230: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10231: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10232: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10233: <dd><dl>
1.184 rillig 10234: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10235: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10236: </dl></dd>
1.184 rillig 10237: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10238: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10239: <dd><dl>
1.184 rillig 10240: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10241: <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 10242: </dl></dd>
1.184 rillig 10243: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10244: <dd><dl>
1.184 rillig 10245: <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>
10246: <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 10247: </dl></dd>
10248: </dl>
10249: </div>
10250: <p>The pkgsrc infrastructure consists of many small Makefile
10251: fragments. Each such fragment needs a properly specified
10252: interface. This chapter explains how such an interface looks
10253: like.</p>
1.41 asau 10254: <div class="sect1">
1.1 dsieger 10255: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10256: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10257: <p>Whenever a variable is defined in the pkgsrc
10258: infrastructure, the location and the way of definition provide
10259: much information about the intended use of that variable.
10260: Additionally, more documentation may be found in a header
10261: comment or in this pkgsrc guide.</p>
10262: <p>A special file is
10263: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10264: variables that are intended to be user-defined. They are either
10265: defined using the <code class="literal">?=</code> operator or they are
10266: left undefined because defining them to anything would
1.23 wiz 10267: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10268: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10269: file.</p>
10270: <p>Outside this file, the following conventions apply:
10271: Variables that are defined using the <code class="literal">?=</code>
10272: operator may be overridden by a package.</p>
10273: <p>Variables that are defined using the <code class="literal">=</code>
10274: operator may be used read-only at run-time.</p>
10275: <p>Variables whose name starts with an underscore must not be
10276: accessed outside the pkgsrc infrastructure at all. They may
10277: change without further notice.</p>
1.41 asau 10278: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10279: <h3 class="title">Note</h3>
10280: <p>These conventions are currently not applied
10281: consistently to the complete pkgsrc
10282: infrastructure.</p>
10283: </div>
10284: </div>
1.41 asau 10285: <div class="sect1">
1.1 dsieger 10286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10287: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10288: <p>All variables that contain lists of things should default
10289: to being empty. Two examples that do not follow this rule are
10290: <code class="varname">USE_LANGUAGES</code> and
10291: <code class="varname">DISTFILES</code>. These variables cannot simply be
10292: modified using the <code class="literal">+=</code> operator in package
10293: <code class="filename">Makefile</code>s (or other files included by
10294: them), since there is no guarantee whether the variable is
10295: already set or not, and what its value is. In the case of
1.23 wiz 10296: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10297: the default value and just define it as in the following
10298: example.</p>
10299: <pre class="programlisting">
10300: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10301: </pre>
10302: <p>Because of the selection of this default value, the same
10303: value appears in many package Makefiles. Similarly for
10304: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10305: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10306: doesn't stand out. Nevertheless it is mentioned in many
10307: files.</p>
10308: </div>
1.41 asau 10309: <div class="sect1">
1.1 dsieger 10310: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10311: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.41 asau 10312: <div class="sect2">
1.1 dsieger 10313: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10314: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.1 dsieger 10315: <p>Variable evaluation takes place either at load time or at
10316: runtime, depending on the context in which they occur. The
10317: contexts where variables are evaluated at load time are:</p>
1.41 asau 10318: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10319: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10320: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10321: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10322: <code class="literal">.for</code>,</p></li>
1.23 wiz 10323: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10324: </ul></div>
10325: <p>A special exception are references to the iteration
10326: variables of <code class="literal">.for</code> loops, which are expanded
10327: inline, no matter in which context they appear.</p>
10328: <p>As the values of variables may change during load time,
10329: care must be taken not to evaluate them by accident. Typical
10330: examples for variables that should not be evaluated at load time
10331: are <code class="varname">DEPENDS</code> and
10332: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10333: clear, here is an example:</p>
10334: <pre class="programlisting">
10335: CONFIGURE_ARGS= # none
10336: CFLAGS= -O
10337: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10338:
10339: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10340:
10341: CFLAGS+= -Wall
1.111 sevan 10342: </pre>
1.1 dsieger 10343: <p>This code shows how the use of the <code class="literal">:=</code>
10344: operator can quickly lead to unexpected results. The first
10345: paragraph is fairly common code. The second paragraph evaluates
10346: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10347: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10348: <code class="literal">-Wall</code> is appended to the
10349: <code class="varname">CFLAGS</code>, but this addition will not appear in
10350: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10351: paragraphs from above typically occur in completely unrelated
10352: files.</p>
10353: </div>
1.41 asau 10354: <div class="sect2">
1.1 dsieger 10355: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10356: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10357: <p>After all the files have been loaded, the values of the
10358: variables cannot be changed anymore. Variables that are used in
10359: the shell commands are expanded at this point.</p>
10360: </div>
10361: </div>
1.41 asau 10362: <div class="sect1">
1.1 dsieger 10363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10364: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10365: <p>There are many ways in which the definition and use of a
1.108 rillig 10366: variable can be restricted in order to detect bugs and violations
10367: of the (mostly unwritten) policies. A package can be checked with
10368: <code class="literal">pkglint -Wall</code> to see whether it meets these
10369: rules.</p>
1.1 dsieger 10370: </div>
1.41 asau 10371: <div class="sect1">
1.1 dsieger 10372: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10373: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10374: <p>Most of the <code class="filename">.mk</code> files fall into one
10375: of the following classes. Cases where a file falls into more
10376: than one class should be avoided as it often leads to subtle
10377: bugs.</p>
1.41 asau 10378: <div class="sect2">
1.1 dsieger 10379: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10380: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10381: <p>In a traditional imperative programming language some of
10382: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10383: procedures. They take some input parameters and—after
10384: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10385: variables in <code class="filename">Makefile</code>s have global scope
10386: care must be taken not to use parameter names that have already
10387: another meaning. For example, <code class="varname">PKGNAME</code> is a
10388: bad choice for a parameter name.</p>
10389: <p>Procedures are completely evaluated at preprocessing time.
10390: That is, when calling a procedure all input parameters must be
10391: completely resolvable. For example,
10392: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10393: parameter since it is very likely that further text will be
10394: added after calling the procedure, which would effectively apply
10395: the procedure to only a part of the variable. Also, references
1.108 rillig 10396: to other variables will be modified after calling the
1.1 dsieger 10397: procedure.</p>
10398: <p>A procedure can declare its output parameters either as
10399: suitable for use in preprocessing directives or as only
10400: available at runtime. The latter alternative is for variables
10401: that contain references to other runtime variables.</p>
10402: <p>Procedures shall be written such that it is possible to
10403: call the procedure more than once. That is, the file must not
10404: contain multiple-inclusion guards.</p>
10405: <p>Examples for procedures are
10406: <code class="filename">mk/bsd.options.mk</code> and
10407: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10408: that the parameters are evaluated at load time, they should be
10409: assigned using the <code class="literal">:=</code> operator, which should
10410: be used only for this purpose.</p>
10411: </div>
1.41 asau 10412: <div class="sect2">
1.1 dsieger 10413: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10414: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10415: <p>Action files take some input parameters and may define
10416: runtime variables. They shall not define loadtime variables.
10417: There are action files that are included implicitly by the
10418: pkgsrc infrastructure, while other must be included
10419: explicitly.</p>
10420: <p>An example for action files is
10421: <code class="filename">mk/subst.mk</code>.</p>
10422: </div>
10423: </div>
1.41 asau 10424: <div class="sect1">
1.1 dsieger 10425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10426: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10427: <p>Package <code class="filename">Makefile</code>s usually consist of
10428: a set of variable definitions, and include the file
10429: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10430: Before that, they may also include various other
10431: <code class="filename">*.mk</code> files if they need to query the
10432: availability of certain features like the type of compiler or
10433: the X11 implementation. Due to the heavy use of preprocessor
10434: directives like <code class="literal">.if</code> and
10435: <code class="literal">.for</code>, the order in which the files are loaded
10436: matters.</p>
10437: <p>This section describes at which point the various files
10438: are loaded and gives reasons for that order.</p>
1.41 asau 10439: <div class="sect2">
1.1 dsieger 10440: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10441: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10442: </h3></div></div></div>
10443: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10444: is to define some essential variables like
10445: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10446: <code class="varname">MACHINE_ARCH</code>.</p>
10447: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10448: 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 10449: After that, those variables
1.1 dsieger 10450: that have not been overridden by the user are loaded from
10451: <code class="filename">mk/defaults/mk.conf</code>.</p>
10452: <p>After the user settings, the system settings and platform
10453: settings are loaded, which may override the user
10454: settings.</p>
10455: <p>Then, the tool definitions are loaded. The tool wrappers
10456: are not yet in effect. This only happens when building a
10457: package, so the proper variables must be used instead of the
10458: direct tool names.</p>
10459: <p>As the last steps, some essential variables from the
10460: wrapper and the package system flavor are loaded, as well as the
10461: variables that have been cached in earlier phases of a package
10462: build.</p>
10463: </div>
1.41 asau 10464: <div class="sect2">
1.1 dsieger 10465: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10466: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10467: </h3></div></div></div>
10468: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10469: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10470: loaded, which fill default values for those variables that have
10471: not been defined by the package. These variables may later
10472: be used even in unrelated files.</p>
10473: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10474: provides the target <code class="literal">error-check</code> that is added
10475: as a special dependency to all other targets that use
10476: <code class="varname">DELAYED_ERROR_MSG</code> or
10477: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10478: <p>Then, the package-specific hacks from
10479: <code class="filename">hacks.mk</code> are included.</p>
10480: <p>Then, various other files follow. Most of them don't have
10481: any dependencies on what they need to have included before or
10482: after them, though some do.</p>
10483: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10484: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10485: restricts the use of these variables to all the files that have
10486: been included before. Appearances in later files will be
10487: silently ignored.</p>
10488: <p>Then, the files for the main targets are included, in the
10489: order of later execution, though the actual order should not
10490: matter.</p>
10491: <p>At last, some more files are included that don't set any
10492: interesting variables but rather just define make targets to be
10493: executed.</p>
10494: </div>
10495: </div>
10496: </div>
1.41 asau 10497: <div class="chapter">
1.1 dsieger 10498: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10499: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.1 dsieger 10500: <div class="toc">
10501: <p><b>Table of Contents</b></p>
1.100 leot 10502: <dl class="toc">
1.184 rillig 10503: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10504: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10505: <dd><dl>
1.184 rillig 10506: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10507: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10508: </dl></dd>
10509: </dl>
10510: </div>
10511: <p>The pkgsrc infrastructure consists of a large codebase,
10512: and there are many corners where every little bit of a file is
10513: well thought out, making pkgsrc likely to fail as soon as
10514: anything is changed near those parts. To prevent most changes
10515: from breaking anything, a suite of regression tests should go
10516: along with every important part of the pkgsrc infrastructure.
10517: This chapter describes how regression tests work in pkgsrc and
10518: how you can add new tests.</p>
1.41 asau 10519: <div class="sect1">
1.1 dsieger 10520: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10521: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.137 leot 10522: <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 10523: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10524: can simply run that command, which will run all tests in the
1.168 rillig 10525: <code class="filename">regress/</code> directory.</p>
1.1 dsieger 10526: </div>
1.41 asau 10527: <div class="sect1">
1.1 dsieger 10528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10529: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.168 rillig 10530: <p>Every directory in the <code class="filename">regress/</code>
10531: directory that contains a file called <code class="filename">spec</code>
1.1 dsieger 10532: is considered a regression test. This file is a shell program
1.10 hubertf 10533: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10534: The following functions can be overridden to suit your
10535: needs.</p>
1.41 asau 10536: <div class="sect2">
1.1 dsieger 10537: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10538: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 10539: <p>These functions do not take any parameters. Although they
10540: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.174 leot 10541: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108 rillig 10542: question</a> for details.</p>
1.41 asau 10543: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10544: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 10545: <dd><p>This function prepares the environment for the
10546: test. By default it does nothing.</p></dd>
1.108 rillig 10547: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10548: <dd>
10549: <p>This function runs the actual test. By default,
1.1 dsieger 10550: it calls <code class="varname">TEST_MAKE</code> with the arguments
10551: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10552: error messages into the file
1.108 rillig 10553: <code class="varname">TEST_OUTFILE</code>.</p>
10554: <p>When defining this function, make sure that all output that
10555: needs to be checked is written to the correct output file.
10556: Example:</p>
10557: <pre class="programlisting">
10558: do_test() {
1.112 rillig 10559: echo "Example output"
1.108 rillig 10560: } 1>$TEST_OUTFILE 2>&1
10561: </pre>
10562: </dd>
10563: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10564: <dd>
10565: <p>This function is run after the test and is
1.1 dsieger 10566: typically used to compare the actual output from the one that is
10567: expected. It can make use of the various helper functions from
1.108 rillig 10568: the next section. Example:</p>
10569: <pre class="programlisting">
10570: check_result() {
1.112 rillig 10571: exit_status 0
10572: output_require "Example"
10573: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10574: output_prohibit "no such file or directory"
1.168 rillig 10575: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 10576: }
10577: </pre>
10578: </dd>
10579: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 10580: <dd><p>This function cleans everything up after the
10581: test has been run. By default it does nothing.</p></dd>
10582: </dl></div>
10583: </div>
1.41 asau 10584: <div class="sect2">
1.1 dsieger 10585: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10586: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.41 asau 10587: <div class="variablelist"><dl class="variablelist">
1.168 rillig 10588: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10589: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108 rillig 10590: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 10591: <dd><p>This function compares the exitcode of the
1.108 rillig 10592: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 10593: If they differ, the test will fail.</p></dd>
1.108 rillig 10594: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10595: <dd>
10596: <p>This function checks for each of its parameters
10597: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 10598: extended regular expression. If it does not, the test will
1.108 rillig 10599: fail. Example:</p>
10600: <pre class="programlisting">
10601: output_require "looks fine"
10602: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10603: </pre>
10604: </dd>
1.177 leot 10605: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.1 dsieger 10606: <dd><p>This function checks for each of its parameters
1.10 hubertf 10607: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10608: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10609: If any of the regular expressions matches, the test will
10610: fail.</p></dd>
10611: </dl></div>
10612: </div>
10613: </div>
10614: </div>
1.41 asau 10615: <div class="chapter">
1.1 dsieger 10616: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10617: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10618: <div class="toc">
10619: <p><b>Table of Contents</b></p>
1.184 rillig 10620: <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 10621: </div>
10622: <p>The pkgsrc system has already been ported to many
10623: operating systems, hardware architectures and compilers. This
10624: chapter explains the necessary steps to make pkgsrc even more
10625: portable.</p>
1.41 asau 10626: <div class="sect1">
1.1 dsieger 10627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10628: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10629: <p>To port pkgsrc to a new operating system (called
10630: <code class="literal">MyOS</code> in this example), you need to touch the
10631: following files:</p>
1.41 asau 10632: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10633: <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>
10634: <dd><p>This file contains some basic definitions, for
10635: example the name of the C
10636: compiler.</p></dd>
10637: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10638: <dd><p>Insert code that defines the variables
10639: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10640: <code class="varname">LOWER_OS_VERSION</code>,
10641: <code class="varname">LOWER_VENDOR</code>,
10642: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10643: <code class="varname">APPEND_ELF</code>, and the other variables that
10644: appear in this file.</p></dd>
10645: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10646: <dd><p>This file contains the platform-specific
10647: definitions that are used by pkgsrc. Start by copying one of the
10648: other files and edit it to your
10649: needs.</p></dd>
10650: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10651: <dd><p>This file defines the paths to all the tools
10652: that are needed by one or the other package in pkgsrc, as well
10653: as by pkgsrc itself. Find out where these tools are on your
10654: platform and add them.</p></dd>
10655: </dl></div>
10656: <p>Now, you should be able to build some basic packages, like
1.137 leot 10657: <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 10658: </div>
10659: </div>
10660: </div>
1.41 asau 10661: <div class="appendix">
10662: <div class="titlepage"><div><div><h1 class="title">
10663: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10664: <div class="toc">
10665: <p><b>Table of Contents</b></p>
1.100 leot 10666: <dl class="toc">
1.1 dsieger 10667: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10668: <dd><dl>
10669: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10670: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10671: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 10672: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 10673: </dl></dd>
10674: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10675: </dl>
10676: </div>
10677: <p>We checked to find a piece of software that wasn't in the packages
10678: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10679: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10680: present in the tree is beyond us, but it's useful for the purposes of
10681: this exercise.</p>
1.41 asau 10682: <div class="sect1">
1.1 dsieger 10683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10684: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10685: <div class="sect2">
1.1 dsieger 10686: <div class="titlepage"><div><div><h3 class="title">
10687: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10688: <pre class="programlisting">
10689: # $NetBSD$
10690: #
10691:
10692: DISTNAME= bison-1.25
10693: CATEGORIES= devel
1.171 rillig 10694: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 10695:
1.29 dholland 10696: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 10697: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 10698: COMMENT= GNU yacc clone
10699:
10700: GNU_CONFIGURE= yes
1.46 wiz 10701: INFO_FILES= yes
1.1 dsieger 10702:
10703: .include "../../mk/bsd.pkg.mk"
10704: </pre>
10705: </div>
1.41 asau 10706: <div class="sect2">
1.1 dsieger 10707: <div class="titlepage"><div><div><h3 class="title">
10708: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10709: <pre class="programlisting">
10710: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.174 leot 10711: improvements. Why you would want this when Berkeley <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?yacc+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 10712: of the NetBSD source tree is beyond me.
10713: </pre>
10714: </div>
1.41 asau 10715: <div class="sect2">
1.1 dsieger 10716: <div class="titlepage"><div><div><h3 class="title">
10717: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10718: <pre class="programlisting">
10719: @comment $NetBSD$
10720: bin/bison
10721: man/man1/bison.1.gz
10722: share/bison.simple
10723: share/bison.hairy
10724: </pre>
10725: </div>
1.41 asau 10726: <div class="sect2">
1.1 dsieger 10727: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 10728: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1 dsieger 10729: <p>The NetBSD package system comes with
1.137 leot 10730: <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 10731: which helps to check the contents of these
10732: files. After installation it is quite easy to use, just change to the
1.171 rillig 10733: directory of the package you wish to examine and run
1.10 hubertf 10734: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10735: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171 rillig 10736: ERROR: Makefile: Each package must define its LICENSE.
10737: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10738: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10739: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10740: 1 error, 2 warnings and 1 note found.
10741: (Run "pkglint -e" to show explanations.)
10742: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 10743: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1 dsieger 10744: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170 rillig 10745: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1 dsieger 10746: -Wall</strong></span> for a very thorough check.</p>
10747: </div>
10748: </div>
1.41 asau 10749: <div class="sect1">
1.1 dsieger 10750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10751: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10752: <p>Create the directory where the package lives,
10753: plus any auxiliary directories:</p>
10754: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10755: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10756: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10757: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10758: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.184 rillig 10759: <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 10760: then continue with fetching the distfile:</p>
10761: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10762: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10763: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10764: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10765: ftp: Error retrieving file: 500 Internal error
10766:
10767: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10768: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10769: ftp: Error retrieving file: 500 Internal error
10770:
10771: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10772: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10773: Successfully retrieved file.</pre>
10774: <p>Generate the checksum of the distfile into
10775: <code class="filename">distinfo</code>:</p>
10776: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10777: <p>Now compile:</p>
10778: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10779: >> Checksum OK for bison-1.25.tar.gz.
10780: ===> Extracting for bison-1.25
10781: ===> Patching for bison-1.25
10782: ===> Ignoring empty patch directory
10783: ===> Configuring for bison-1.25
10784: creating cache ./config.cache
10785: checking for gcc... cc
10786: checking whether we are using GNU C... yes
10787: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10788: checking how to run the C preprocessor... cc -E
10789: checking for minix/config.h... no
10790: checking for POSIXized ISC... no
10791: checking whether cross-compiling... no
10792: checking for ANSI C header files... yes
10793: checking for string.h... yes
10794: checking for stdlib.h... yes
10795: checking for memory.h... yes
10796: checking for working const... yes
10797: checking for working alloca.h... no
10798: checking for alloca... yes
10799: checking for strerror... yes
10800: updating cache ./config.cache
10801: creating ./config.status
10802: creating Makefile
10803: ===> Building for bison-1.25
10804: 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
10805: 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
10806: 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
10807: 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
10808: 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
10809: 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
10810: 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
10811: 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
10812: 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
10813: 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
10814: 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
10815: 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
10816: 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
10817: 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
10818: 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
10819: 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
10820: 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
10821: 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
10822: 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
10823: 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
10824: 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
10825: 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
10826: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10827: rm -f bison.s1
10828: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10829: <p>Everything seems OK, so install the files:</p>
10830: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10831: >> Checksum OK for bison-1.25.tar.gz.
10832: ===> Installing for bison-1.25
10833: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10834: rm -f /usr/pkg/bin/bison
10835: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10836: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10837: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10838: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10839: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10840: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10841: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10842: ===> Registering installation for bison-1.25</pre>
10843: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10844: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10845: binary package, do this now:</p>
10846: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10847: >> Checksum OK for bison-1.25.tar.gz.
10848: ===> Building package for bison-1.25
10849: Creating package bison-1.25.tgz
10850: Registering depends:.
10851: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10852: <p>Now that you don't need the source and object files
10853: any more, clean up:</p>
10854: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10855: ===> Cleaning for bison-1.25</pre>
10856: </div>
10857: </div>
1.41 asau 10858: <div class="appendix">
10859: <div class="titlepage"><div><div><h1 class="title">
10860: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10861: <div class="toc">
10862: <p><b>Table of Contents</b></p>
1.100 leot 10863: <dl class="toc">
1.1 dsieger 10864: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10865: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10866: </dl>
10867: </div>
1.41 asau 10868: <div class="sect1">
1.1 dsieger 10869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10870: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10871: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10872: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10873: => figlet221.tar.gz doesn't seem to exist on this system.
10874: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10875: => [172219 bytes]
10876: Connected to ftp.plig.net.
10877: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10878: 331 Guest login ok, send your complete e-mail address as password.
10879: 230-You are user #5 of 500 simultaneous users allowed.
10880: 230-
10881: 230- ___ _ _ _
10882: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10883: 230- | _| _| . |_| . | | | . |_| . | _| . |
10884: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10885: 230- |_| |_| |___| |___|
10886: 230-
10887: 230-** Welcome to ftp.plig.org **
10888: 230-
10889: 230-Please note that all transfers from this FTP site are logged. If you
10890: 230-do not like this, please disconnect now.
10891: 230-
1.18 snj 10892: 230-This archive is available via
1.1 dsieger 10893: 230-
10894: 230-HTTP: http://ftp.plig.org/
10895: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10896: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10897: 230-
10898: 230-Please email comments, bug reports and requests for packages to be
10899: 230-mirrored to ftp-admin@plig.org.
10900: 230-
10901: 230-
10902: 230 Logged in anonymously.
10903: Remote system type is UNIX.
10904: Using binary mode to transfer files.
10905: 200 Type okay.
10906: 250 "/pub" is new cwd.
10907: 250-"/pub/figlet" is new cwd.
10908: 250-
10909: 250-Welcome to the figlet archive at ftp.figlet.org
10910: 250-
10911: 250- ftp://ftp.figlet.org/pub/figlet/
10912: 250-
10913: 250-The official FIGlet web page is:
10914: 250- http://www.figlet.org/
10915: 250-
10916: 250-If you have questions, please mailto:info@figlet.org. If you want to
10917: 250-contribute a font or something else, you can email us.
10918: 250
10919: 250 "/pub/figlet/program" is new cwd.
10920: 250 "/pub/figlet/program/unix" is new cwd.
10921: local: figlet221.tar.gz remote: figlet221.tar.gz
10922: 502 Unimplemented command.
10923: 227 Entering Passive Mode (195,40,6,41,246,104)
10924: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10925: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10926: 226 Transfer completed.
10927: 172219 bytes received in 00:02 (75.99 KB/s)
10928: 221 Goodbye.
10929: => Checksum OK for figlet221.tar.gz.
10930: ===> Extracting for figlet-2.2.1nb2
10931: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10932: ===> Patching for figlet-2.2.1nb2
10933: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10934: ===> Overriding tools for figlet-2.2.1nb2
10935: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10936: ===> Configuring for figlet-2.2.1nb2
10937: ===> Building for figlet-2.2.1nb2
10938: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10939: chmod a+x figlet
10940: gcc -O2 -o chkfont chkfont.c
10941: => Unwrapping files-to-be-installed.
10942: <code class="prompt">#</code>
10943: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10944: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10945: ===> Installing for figlet-2.2.1nb2
10946: install -d -o root -g wheel -m 755 /usr/pkg/bin
10947: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10948: mkdir -p /usr/pkg/share/figlet
10949: cp figlet /usr/pkg/bin
10950: cp chkfont /usr/pkg/bin
10951: chmod 555 figlist showfigfonts
10952: cp figlist /usr/pkg/bin
10953: cp showfigfonts /usr/pkg/bin
10954: cp fonts/*.flf /usr/pkg/share/figlet
10955: cp fonts/*.flc /usr/pkg/share/figlet
10956: cp figlet.6 /usr/pkg/man/man6
10957: ===> Registering installation for figlet-2.2.1nb2
10958: <code class="prompt">#</code></pre>
10959: </div>
1.41 asau 10960: <div class="sect1">
1.1 dsieger 10961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10962: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10963: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10964: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10965: ===> Packaging figlet-2.2.1nb2
10966: ===> Building binary package for figlet-2.2.1nb2
10967: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10968: Using SrcDir value of /usr/pkg
10969: Registering depends:.
10970: <code class="prompt">#</code></pre>
10971: </div>
10972: </div>
1.41 asau 10973: <div class="appendix">
10974: <div class="titlepage"><div><div><h1 class="title">
10975: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10976: <div class="toc">
10977: <p><b>Table of Contents</b></p>
1.100 leot 10978: <dl class="toc">
1.23 wiz 10979: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10980: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10981: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10982: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10983: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148 leot 10984: <code class="filename">stable</code>,
1.23 wiz 10985: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10986: source packages</a></span></dt>
10987: </dl>
10988: </div>
10989: <p>As in other big projects, the directory layout of pkgsrc
10990: is quite complex for newbies. This chapter explains where you
10991: find things on the FTP server. The base directory on
1.10 hubertf 10992: <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 10993: On other servers it may be different, but inside this directory,
10994: everything should look the same, no matter on which server you
10995: are. This directory contains some subdirectories, which are
10996: explained below.</p>
1.41 asau 10997: <div class="sect1">
1.1 dsieger 10998: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10999: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 11000: <p>The directory <code class="filename">distfiles</code> contains lots
11001: of archive files from all pkgsrc packages, which are mirrored
11002: here. The subdirectories are called after their package names
11003: and are used when the distributed files have names that don't
11004: explicitly contain a version number or are otherwise too generic
11005: (for example <code class="filename">release.tar.gz</code>).</p>
11006: </div>
1.41 asau 11007: <div class="sect1">
1.1 dsieger 11008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11009: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 11010: <p>This directory contains things that individual pkgsrc
11011: developers find worth publishing.</p>
11012: </div>
1.41 asau 11013: <div class="sect1">
1.1 dsieger 11014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11015: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 11016: <p>This directory contains binary packages for the various
11017: platforms that are supported by pkgsrc.
11018: 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 11019: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 11020: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 11021: operating system for which the packages have been built. The
1.10 hubertf 11022: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 11023: command, so it may differ from the one you are used to
11024: hear.</p></li>
1.23 wiz 11025: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 11026: architecture of the platform for which the packages have been
1.10 hubertf 11027: built. It also includes the <code class="varname">ABI</code> (Application
11028: Binary Interface) for platforms that have several of
11029: them.</p></li>
1.23 wiz 11030: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 11031: the operating system. For version numbers that change often (for
11032: example NetBSD-current), the often-changing part should be
11033: replaced with an <code class="literal">x</code>, for example
11034: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 11035: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 11036: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 11037: for a stable branch, or <code class="literal">head</code> for packages
11038: built from the HEAD branch. The latter should only be used when
11039: the packages are updated on a regular basis. Otherwise the date
11040: from checking out pkgsrc should be appended, for example
11041: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 11042: </ul></div>
11043: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11044: can quickly click through the directories on the
11045: server and find the best binary packages for their machines. Since they
11046: usually know the operating system and the hardware architecture, OPSYS
11047: and ARCH are placed first. After these choices, they can select the
11048: best combination of OSVERSION and TAG together, since it is usually the
11049: case that packages stay compatible between different version of the
11050: operating system.</p>
11051: <p>In each of these directories, there is a
11052: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 11053: <code class="filename">All</code> which contains all binary packages.
11054: Besides that, there are various category directories that
11055: contain symbolic links to the real binary packages.</p>
11056: </div>
1.41 asau 11057: <div class="sect1">
1.1 dsieger 11058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11059: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 11060: <p>Here are the reports from bulk builds, for those who want
11061: to fix packages that didn't build on some of the platforms. The
1.23 wiz 11062: 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 11063: </div>
1.41 asau 11064: <div class="sect1">
1.8 rillig 11065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11066: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.148 leot 11067: <code class="filename">stable</code>,
1.22 jakllsch 11068: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 11069: source packages</h2></div></div></div>
1.23 wiz 11070: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 11071: that is the files that define how to create binary packages from
11072: source archives.</p>
1.149 leot 11073: <p>Each of the <code class="filename">current</code>,
11074: <code class="filename">stable</code> and
11075: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11076: directories share the same structure. They each contain a
11077: <code class="filename">pkgsrc</code> directory and
11078: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 11079: <p>The directory <code class="filename">pkgsrc</code> contains a
11080: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 11081: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11082: as the directory, ready to be downloaded as a whole.</p>
11083: <p>The <code class="filename">current</code> directory contains files
11084: related to the HEAD branch of the CVS repository.
11085: In this directory there is an additional file called
11086: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11087: all pkgsrc <code class="filename">README</code>s with information about
11088: categories and packages.
11089: </p>
11090: <p>The <code class="filename">stable</code> directory is a symlink to
11091: the latest
11092: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11093: </p>
11094: <p>The
11095: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11096: directories contain files related to the
11097: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11098: stable branch of the CVS repository. In these directories there is
11099: an additional file called
11100: <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 11101: which contains the state of pkgsrc when it was branched.</p>
11102: </div>
11103: </div>
1.41 asau 11104: <div class="appendix">
11105: <div class="titlepage"><div><div><h1 class="title">
1.154 rillig 11106: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
11107: <p>
11108: The following list contains all help topics that are available
11109: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11110: </p>
1.156 leot 11111: <table border="0" summary="Simple list" class="simplelist">
11112: <tr>
11113: <td>#!</td>
11114: <td>-lintl</td>
11115: </tr>
11116: <tr>
11117: <td>64bit</td>
11118: <td>ABI</td>
11119: </tr>
11120: <tr>
11121: <td>ACCEPTABLE_LICENSES</td>
11122: <td>ACROREAD_FONTPATH</td>
11123: </tr>
11124: <tr>
11125: <td>ADDITIONAL</td>
11126: <td>AFAIK</td>
11127: </tr>
11128: <tr>
11129: <td>AIX</td>
11130: <td>ALLOW_VULNERABLE_PACKAGES</td>
11131: </tr>
11132: <tr>
11133: <td>ALL_ENV</td>
1.177 leot 11134: <td>ALSA_PC</td>
11135: </tr>
11136: <tr>
1.175 gutterid 11137: <td>ALTERNATIVES_SRC</td>
1.177 leot 11138: <td>AMANDA_TMP</td>
1.161 leot 11139: </tr>
11140: <tr>
1.175 gutterid 11141: <td>AMANDA_USER</td>
1.177 leot 11142: <td>AMANDA_VAR</td>
1.159 rillig 11143: </tr>
11144: <tr>
1.175 gutterid 11145: <td>APACHE_GROUP</td>
1.177 leot 11146: <td>APACHE_MODULE_NAME</td>
1.156 leot 11147: </tr>
11148: <tr>
1.175 gutterid 11149: <td>APACHE_MODULE_SRC</td>
1.177 leot 11150: <td>APACHE_MODULE_SRCDIR</td>
1.156 leot 11151: </tr>
11152: <tr>
1.175 gutterid 11153: <td>APACHE_PKG_PREFIX</td>
1.177 leot 11154: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.156 leot 11155: </tr>
11156: <tr>
1.175 gutterid 11157: <td>APACHE_SUEXEC_DOCROOT</td>
1.177 leot 11158: <td>APACHE_USER</td>
1.156 leot 11159: </tr>
11160: <tr>
1.175 gutterid 11161: <td>APPEND_ABI</td>
1.177 leot 11162: <td>APPEND_ELF</td>
1.156 leot 11163: </tr>
11164: <tr>
1.175 gutterid 11165: <td>ARLA_CACHE</td>
1.177 leot 11166: <td>AUDIT_PACKAGES_FLAGS</td>
1.156 leot 11167: </tr>
11168: <tr>
1.175 gutterid 11169: <td>AUTOCONF_REQD</td>
1.177 leot 11170: <td>AUTOMAKE_OVERRIDE</td>
1.156 leot 11171: </tr>
11172: <tr>
1.175 gutterid 11173: <td>AUTOMAKE_REQD</td>
1.177 leot 11174: <td>AUTO_MKDIRS</td>
1.156 leot 11175: </tr>
11176: <tr>
1.175 gutterid 11177: <td>BDB185_DEFAULT</td>
1.177 leot 11178: <td>BDBBASE</td>
1.156 leot 11179: </tr>
11180: <tr>
1.175 gutterid 11181: <td>BDB_ACCEPTED</td>
1.177 leot 11182: <td>BDB_DEFAULT</td>
1.156 leot 11183: </tr>
11184: <tr>
1.175 gutterid 11185: <td>BDB_LIBS</td>
1.177 leot 11186: <td>BDB_TYPE</td>
1.156 leot 11187: </tr>
11188: <tr>
1.175 gutterid 11189: <td>BIND_DIR</td>
1.177 leot 11190: <td>BIND_GROUP</td>
1.156 leot 11191: </tr>
11192: <tr>
1.175 gutterid 11193: <td>BIND_USER</td>
1.189 ! bacon 11194: <td>BINOWN</td>
! 11195: </tr>
! 11196: <tr>
1.177 leot 11197: <td>BINPKG_SITES</td>
1.189 ! bacon 11198: <td>BIN_INSTALL_FLAGS</td>
1.156 leot 11199: </tr>
11200: <tr>
1.177 leot 11201: <td>BISON_PKGDATADIR</td>
1.189 ! bacon 11202: <td>BLAS_ACCEPTED</td>
1.177 leot 11203: </tr>
11204: <tr>
11205: <td>BLAS_LIBS</td>
1.189 ! bacon 11206: <td>BLAS_TYPE</td>
1.156 leot 11207: </tr>
11208: <tr>
11209: <td>BOOTSTRAP_DEPENDS</td>
1.189 ! bacon 11210: <td>BOOTSTRAP_SETUPTOOLS</td>
1.156 leot 11211: </tr>
11212: <tr>
11213: <td>BROKEN</td>
1.189 ! bacon 11214: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.156 leot 11215: </tr>
11216: <tr>
11217: <td>BROKEN_ON_PLATFORM</td>
1.189 ! bacon 11218: <td>BSDSRCDIR</td>
1.156 leot 11219: </tr>
11220: <tr>
11221: <td>BSDXSRCDIR</td>
1.189 ! bacon 11222: <td>BSD_MAKE_ENV</td>
1.156 leot 11223: </tr>
11224: <tr>
11225: <td>BUILDLINK_AUTO_DIRS</td>
1.189 ! bacon 11226: <td>BUILDLINK_AUTO_VARS</td>
1.156 leot 11227: </tr>
11228: <tr>
11229: <td>BUILDLINK_CFLAGS</td>
1.189 ! bacon 11230: <td>BUILDLINK_CONTENTS_FILTER</td>
1.156 leot 11231: </tr>
11232: <tr>
11233: <td>BUILDLINK_CPPFLAGS</td>
1.189 ! bacon 11234: <td>BUILDLINK_DEPMETHOD</td>
1.156 leot 11235: </tr>
11236: <tr>
11237: <td>BUILDLINK_FILES</td>
1.189 ! bacon 11238: <td>BUILDLINK_FILES_CMD</td>
1.156 leot 11239: </tr>
11240: <tr>
11241: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.189 ! bacon 11242: <td>BUILDLINK_LDFLAGS</td>
1.156 leot 11243: </tr>
11244: <tr>
11245: <td>BUILDLINK_LIBS</td>
1.189 ! bacon 11246: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.156 leot 11247: </tr>
11248: <tr>
11249: <td>BUILDLINK_PKGNAME</td>
1.189 ! bacon 11250: <td>BUILDLINK_PREFIX</td>
1.156 leot 11251: </tr>
11252: <tr>
11253: <td>BUILDLINK_RPATHDIRS</td>
1.189 ! bacon 11254: <td>BUILDLINK_TREE</td>
1.156 leot 11255: </tr>
11256: <tr>
11257: <td>BUILD_DEFS</td>
1.189 ! bacon 11258: <td>BUILD_DEFS_EFFECTS</td>
1.156 leot 11259: </tr>
11260: <tr>
11261: <td>BUILD_DEPENDS</td>
1.189 ! bacon 11262: <td>BUILD_DIRS</td>
1.156 leot 11263: </tr>
11264: <tr>
11265: <td>BUILD_ENV_SHELL</td>
1.189 ! bacon 11266: <td>BUILD_MAKE_CMD</td>
1.156 leot 11267: </tr>
11268: <tr>
11269: <td>BUILD_MAKE_FLAGS</td>
1.189 ! bacon 11270: <td>BUILD_TARGET</td>
1.156 leot 11271: </tr>
11272: <tr>
11273: <td>BUILTIN_FIND_FILES</td>
1.189 ! bacon 11274: <td>BUILTIN_FIND_FILES_VAR</td>
1.156 leot 11275: </tr>
11276: <tr>
11277: <td>BUILTIN_FIND_GREP</td>
1.189 ! bacon 11278: <td>BUILTIN_FIND_HEADERS</td>
1.156 leot 11279: </tr>
11280: <tr>
11281: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.189 ! bacon 11282: <td>BUILTIN_PKG</td>
1.156 leot 11283: </tr>
11284: <tr>
11285: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.189 ! bacon 11286: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.156 leot 11287: </tr>
11288: <tr>
11289: <td>BUILTIN_VERSION_SCRIPT</td>
1.189 ! bacon 11290: <td>BUILTIN_X11_TYPE</td>
1.156 leot 11291: </tr>
11292: <tr>
11293: <td>BUILTIN_X11_VERSION</td>
1.189 ! bacon 11294: <td>CACTI_GROUP</td>
1.156 leot 11295: </tr>
11296: <tr>
11297: <td>CACTI_USER</td>
1.189 ! bacon 11298: <td>CANNA_GROUP</td>
1.156 leot 11299: </tr>
11300: <tr>
11301: <td>CANNA_USER</td>
1.189 ! bacon 11302: <td>CAT</td>
1.156 leot 11303: </tr>
11304: <tr>
11305: <td>CCACHE_BASE</td>
1.189 ! bacon 11306: <td>CCACHE_DIR</td>
1.156 leot 11307: </tr>
11308: <tr>
11309: <td>CCACHE_LOGFILE</td>
1.189 ! bacon 11310: <td>CC_VERSION</td>
1.156 leot 11311: </tr>
11312: <tr>
11313: <td>CC_VERSION_STRING</td>
1.189 ! bacon 11314: <td>CDRECORD_CONF</td>
1.156 leot 11315: </tr>
11316: <tr>
11317: <td>CDROM_PKG_URL_DIR</td>
1.189 ! bacon 11318: <td>CDROM_PKG_URL_HOST</td>
1.156 leot 11319: </tr>
11320: <tr>
1.177 leot 11321: <td>CHECKOUT_DATE</td>
1.189 ! bacon 11322: <td>CHECK_COMPILER</td>
1.177 leot 11323: </tr>
11324: <tr>
1.175 gutterid 11325: <td>CHECK_FAKEHOME</td>
1.189 ! bacon 11326: <td>CHECK_FILES</td>
1.161 leot 11327: </tr>
11328: <tr>
1.175 gutterid 11329: <td>CHECK_FILES_SKIP</td>
1.189 ! bacon 11330: <td>CHECK_FILES_STRICT</td>
1.159 rillig 11331: </tr>
11332: <tr>
1.175 gutterid 11333: <td>CHECK_HEADERS</td>
1.189 ! bacon 11334: <td>CHECK_HEADERS_SKIP</td>
1.156 leot 11335: </tr>
11336: <tr>
1.175 gutterid 11337: <td>CHECK_INTERPRETER</td>
1.189 ! bacon 11338: <td>CHECK_INTERPRETER_SKIP</td>
1.156 leot 11339: </tr>
11340: <tr>
1.175 gutterid 11341: <td>CHECK_PERMS</td>
1.189 ! bacon 11342: <td>CHECK_PERMS_AUTOFIX</td>
1.156 leot 11343: </tr>
11344: <tr>
1.175 gutterid 11345: <td>CHECK_PERMS_SKIP</td>
1.189 ! bacon 11346: <td>CHECK_PORTABILITY</td>
1.156 leot 11347: </tr>
11348: <tr>
1.177 leot 11349: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.189 ! bacon 11350: <td>CHECK_PORTABILITY_SKIP</td>
1.156 leot 11351: </tr>
11352: <tr>
1.161 leot 11353: <td>CHECK_RELRO</td>
1.189 ! bacon 11354: <td>CHECK_RELRO_SKIP</td>
1.156 leot 11355: </tr>
11356: <tr>
1.161 leot 11357: <td>CHECK_RELRO_SUPPORTED</td>
1.189 ! bacon 11358: <td>CHECK_SHLIBS</td>
1.156 leot 11359: </tr>
11360: <tr>
1.161 leot 11361: <td>CHECK_SHLIBS_BLACKLIST</td>
1.189 ! bacon 11362: <td>CHECK_SHLIBS_SKIP</td>
1.156 leot 11363: </tr>
11364: <tr>
1.161 leot 11365: <td>CHECK_SHLIBS_SUPPORTED</td>
1.189 ! bacon 11366: <td>CHECK_SSP</td>
1.156 leot 11367: </tr>
11368: <tr>
1.161 leot 11369: <td>CHECK_SSP_SKIP</td>
1.189 ! bacon 11370: <td>CHECK_SSP_SUPPORTED</td>
1.156 leot 11371: </tr>
11372: <tr>
1.161 leot 11373: <td>CHECK_STRIPPED</td>
1.189 ! bacon 11374: <td>CHECK_STRIPPED_SKIP</td>
1.156 leot 11375: </tr>
11376: <tr>
1.161 leot 11377: <td>CHECK_WRKREF</td>
1.189 ! bacon 11378: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.156 leot 11379: </tr>
11380: <tr>
1.161 leot 11381: <td>CHECK_WRKREF_SKIP</td>
1.189 ! bacon 11382: <td>CLAMAV_DBDIR</td>
1.156 leot 11383: </tr>
11384: <tr>
1.161 leot 11385: <td>CLAMAV_GROUP</td>
1.189 ! bacon 11386: <td>CLAMAV_USER</td>
1.156 leot 11387: </tr>
11388: <tr>
1.161 leot 11389: <td>CLANGBASE</td>
1.189 ! bacon 11390: <td>CLEANDEPENDS</td>
1.156 leot 11391: </tr>
11392: <tr>
1.161 leot 11393: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.189 ! bacon 11394: <td>CMAKE_INSTALL_PREFIX</td>
1.156 leot 11395: </tr>
11396: <tr>
1.161 leot 11397: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.189 ! bacon 11398: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.156 leot 11399: </tr>
11400: <tr>
1.161 leot 11401: <td>CMAKE_PREFIX_PATH</td>
1.189 ! bacon 11402: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.156 leot 11403: </tr>
11404: <tr>
1.177 leot 11405: <td>COMMON_LISP_DOCFILES</td>
1.189 ! bacon 11406: <td>COMMON_LISP_EXAMPLES</td>
1.177 leot 11407: </tr>
11408: <tr>
11409: <td>COMMON_LISP_EXTRAFILES</td>
1.189 ! bacon 11410: <td>COMMON_LISP_PACKAGES</td>
1.177 leot 11411: </tr>
11412: <tr>
11413: <td>COMMON_LISP_SYSTEM</td>
1.189 ! bacon 11414: <td>COMPILER_RPATH_FLAG</td>
1.177 leot 11415: </tr>
11416: <tr>
1.156 leot 11417: <td>COMPILER_USE_SYMLINKS</td>
1.189 ! bacon 11418: <td>CONFIGURE_ARGS</td>
1.156 leot 11419: </tr>
11420: <tr>
11421: <td>CONFIGURE_DIRS</td>
1.189 ! bacon 11422: <td>CONFIGURE_ENV</td>
1.156 leot 11423: </tr>
11424: <tr>
1.172 rillig 11425: <td>CONFIGURE_ENV_SHELL</td>
1.189 ! bacon 11426: <td>CONFIGURE_HAS_INFODIR</td>
1.156 leot 11427: </tr>
11428: <tr>
11429: <td>CONFIGURE_HAS_MANDIR</td>
1.189 ! bacon 11430: <td>CONFIGURE_SCRIPT</td>
1.156 leot 11431: </tr>
11432: <tr>
11433: <td>CONFIG_SHELL</td>
1.189 ! bacon 11434: <td>CONFIG_SHELL_FLAGS</td>
1.156 leot 11435: </tr>
11436: <tr>
11437: <td>CONF_FILES</td>
1.189 ! bacon 11438: <td>CONF_FILES_MODE</td>
1.156 leot 11439: </tr>
11440: <tr>
11441: <td>CONF_FILES_PERMS</td>
1.189 ! bacon 11442: <td>CONSERVER_DEFAULTHOST</td>
1.156 leot 11443: </tr>
11444: <tr>
11445: <td>CONSERVER_DEFAULTPORT</td>
1.189 ! bacon 11446: <td>CP</td>
1.156 leot 11447: </tr>
11448: <tr>
11449: <td>CPP</td>
1.189 ! bacon 11450: <td>CPP_PRECOMP_FLAGS</td>
1.156 leot 11451: </tr>
11452: <tr>
11453: <td>CREATE_WRKDIR_SYMLINK</td>
1.189 ! bacon 11454: <td>CROSSBASE</td>
1.156 leot 11455: </tr>
11456: <tr>
11457: <td>CTFCONVERT</td>
1.189 ! bacon 11458: <td>CTF_FILES_SKIP</td>
1.156 leot 11459: </tr>
11460: <tr>
11461: <td>CTF_SUPPORTED</td>
1.189 ! bacon 11462: <td>CTYPE</td>
1.156 leot 11463: </tr>
11464: <tr>
11465: <td>CUPS_GROUP</td>
1.189 ! bacon 11466: <td>CUPS_SYSTEM_GROUPS</td>
1.156 leot 11467: </tr>
11468: <tr>
11469: <td>CUPS_USER</td>
1.189 ! bacon 11470: <td>CURSES_DEFAULT</td>
1.156 leot 11471: </tr>
11472: <tr>
11473: <td>CURSES_TYPE</td>
1.189 ! bacon 11474: <td>CVS_EXTRACTDIR</td>
1.177 leot 11475: </tr>
11476: <tr>
11477: <td>CVS_MODULE</td>
1.189 ! bacon 11478: <td>CVS_PROJECT</td>
1.177 leot 11479: </tr>
11480: <tr>
11481: <td>CVS_REPOSITORIES</td>
1.189 ! bacon 11482: <td>CVS_ROOT</td>
1.177 leot 11483: </tr>
11484: <tr>
11485: <td>CVS_ROOT_GNU</td>
1.189 ! bacon 11486: <td>CVS_ROOT_NONGNU</td>
1.177 leot 11487: </tr>
11488: <tr>
11489: <td>CVS_ROOT_SOURCEFORGE</td>
1.189 ! bacon 11490: <td>CVS_TAG</td>
1.161 leot 11491: </tr>
11492: <tr>
1.160 brook 11493: <td>CXX</td>
1.189 ! bacon 11494: <td>CYRUS_GROUP</td>
1.159 rillig 11495: </tr>
11496: <tr>
1.160 brook 11497: <td>CYRUS_IDLE</td>
1.189 ! bacon 11498: <td>CYRUS_USER</td>
1.156 leot 11499: </tr>
11500: <tr>
1.160 brook 11501: <td>DAEMONTOOLS_GROUP</td>
1.189 ! bacon 11502: <td>DAEMONTOOLS_LOG_USER</td>
1.156 leot 11503: </tr>
11504: <tr>
1.160 brook 11505: <td>DBUS_GROUP</td>
1.189 ! bacon 11506: <td>DBUS_USER</td>
1.156 leot 11507: </tr>
11508: <tr>
1.160 brook 11509: <td>DEFANG_GROUP</td>
1.189 ! bacon 11510: <td>DEFANG_USER</td>
1.156 leot 11511: </tr>
11512: <tr>
1.160 brook 11513: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.189 ! bacon 11514: <td>DEFAULT_DISTFILES</td>
1.156 leot 11515: </tr>
11516: <tr>
1.160 brook 11517: <td>DEFAULT_IRC_SERVER</td>
1.189 ! bacon 11518: <td>DEFAULT_SERIAL_DEVICE</td>
1.156 leot 11519: </tr>
11520: <tr>
1.160 brook 11521: <td>DEF_UMASK</td>
1.189 ! bacon 11522: <td>DEINSTALLDEPENDS</td>
1.156 leot 11523: </tr>
11524: <tr>
1.160 brook 11525: <td>DEINSTALL_SRC</td>
1.189 ! bacon 11526: <td>DEINSTALL_TEMPLATES</td>
1.156 leot 11527: </tr>
11528: <tr>
1.160 brook 11529: <td>DELAYED_ERROR_MSG</td>
1.189 ! bacon 11530: <td>DELAYED_WARNING_MSG</td>
1.156 leot 11531: </tr>
11532: <tr>
1.160 brook 11533: <td>DEPENDS</td>
1.189 ! bacon 11534: <td>DEPENDS_TARGET</td>
1.156 leot 11535: </tr>
11536: <tr>
1.160 brook 11537: <td>DEPENDS_TYPE</td>
1.189 ! bacon 11538: <td>DESTDIR</td>
1.156 leot 11539: </tr>
11540: <tr>
1.160 brook 11541: <td>DESTDIR_VARNAME</td>
1.189 ! bacon 11542: <td>DIALER_GROUP</td>
1.156 leot 11543: </tr>
11544: <tr>
1.160 brook 11545: <td>DIGEST_REQD</td>
1.189 ! bacon 11546: <td>DISTDIR</td>
1.156 leot 11547: </tr>
11548: <tr>
1.160 brook 11549: <td>DISTFILES</td>
1.189 ! bacon 11550: <td>DISTINFO_FILE</td>
1.156 leot 11551: </tr>
11552: <tr>
1.160 brook 11553: <td>DISTNAME</td>
1.189 ! bacon 11554: <td>DIST_PATH</td>
1.156 leot 11555: </tr>
11556: <tr>
1.160 brook 11557: <td>DIST_SUBDIR</td>
1.189 ! bacon 11558: <td>DJBDNS_AXFR_USER</td>
1.156 leot 11559: </tr>
11560: <tr>
1.160 brook 11561: <td>DJBDNS_CACHE_USER</td>
1.189 ! bacon 11562: <td>DJBDNS_DJBDNS_GROUP</td>
1.156 leot 11563: </tr>
11564: <tr>
1.160 brook 11565: <td>DJBDNS_LOG_USER</td>
1.189 ! bacon 11566: <td>DJBDNS_RBL_USER</td>
1.156 leot 11567: </tr>
11568: <tr>
1.160 brook 11569: <td>DJBDNS_TINY_USER</td>
1.189 ! bacon 11570: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.156 leot 11571: </tr>
11572: <tr>
1.160 brook 11573: <td>DL_AUTO_VARS</td>
1.189 ! bacon 11574: <td>DL_CFLAGS</td>
1.156 leot 11575: </tr>
11576: <tr>
1.160 brook 11577: <td>DL_LDFLAGS</td>
1.189 ! bacon 11578: <td>DL_LIBS</td>
1.156 leot 11579: </tr>
11580: <tr>
1.160 brook 11581: <td>DNS</td>
1.189 ! bacon 11582: <td>DOCOWN</td>
1.156 leot 11583: </tr>
11584: <tr>
1.180 rillig 11585: <td>DOWNLOADED_DISTFILE</td>
1.160 brook 11586: <td>DT_LAYOUT</td>
1.156 leot 11587: </tr>
11588: <tr>
1.180 rillig 11589: <td>DYNAMIC_SITES_CMD</td>
1.160 brook 11590: <td>DYNAMIC_SITES_SCRIPT</td>
1.156 leot 11591: </tr>
11592: <tr>
1.180 rillig 11593: <td>ECHO</td>
1.160 brook 11594: <td>ECHO_N</td>
1.156 leot 11595: </tr>
11596: <tr>
1.180 rillig 11597: <td>ELK_GUI</td>
1.160 brook 11598: <td>EMACS_TYPE</td>
1.156 leot 11599: </tr>
11600: <tr>
1.180 rillig 11601: <td>EMULDIR</td>
1.160 brook 11602: <td>EMULSUBDIR</td>
1.156 leot 11603: </tr>
11604: <tr>
1.180 rillig 11605: <td>EMULSUBDIRSLASH</td>
1.160 brook 11606: <td>EMUL_ARCH</td>
1.156 leot 11607: </tr>
11608: <tr>
1.180 rillig 11609: <td>EMUL_DISTRO</td>
1.160 brook 11610: <td>EMUL_EXEC_FMT</td>
1.156 leot 11611: </tr>
11612: <tr>
1.180 rillig 11613: <td>EMUL_IS_NATIVE</td>
1.160 brook 11614: <td>EMUL_MODULES</td>
1.156 leot 11615: </tr>
11616: <tr>
1.180 rillig 11617: <td>EMUL_OPSYS</td>
1.160 brook 11618: <td>EMUL_PKG_FMT</td>
1.156 leot 11619: </tr>
11620: <tr>
1.180 rillig 11621: <td>EMUL_PLATFORM</td>
1.160 brook 11622: <td>EMUL_PLATFORMS</td>
1.156 leot 11623: </tr>
11624: <tr>
1.180 rillig 11625: <td>EMUL_PREFER</td>
1.160 brook 11626: <td>EMUL_REQD</td>
1.156 leot 11627: </tr>
11628: <tr>
1.180 rillig 11629: <td>EMUL_TYPE</td>
1.160 brook 11630: <td>ERROR_MSG</td>
1.156 leot 11631: </tr>
11632: <tr>
1.180 rillig 11633: <td>EXIM_GROUP</td>
1.160 brook 11634: <td>EXIM_USER</td>
1.156 leot 11635: </tr>
11636: <tr>
1.180 rillig 11637: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.160 brook 11638: <td>EXTRACTOR</td>
1.156 leot 11639: </tr>
11640: <tr>
1.180 rillig 11641: <td>EXTRACT_CMD</td>
1.160 brook 11642: <td>EXTRACT_CMD_DEFAULT</td>
1.156 leot 11643: </tr>
11644: <tr>
1.180 rillig 11645: <td>EXTRACT_DIR</td>
1.160 brook 11646: <td>EXTRACT_ELEMENTS</td>
1.156 leot 11647: </tr>
11648: <tr>
1.180 rillig 11649: <td>EXTRACT_ENV</td>
1.160 brook 11650: <td>EXTRACT_ONLY</td>
1.156 leot 11651: </tr>
11652: <tr>
1.180 rillig 11653: <td>EXTRACT_OPTS</td>
1.160 brook 11654: <td>EXTRACT_SUFX</td>
1.156 leot 11655: </tr>
11656: <tr>
1.180 rillig 11657: <td>EXTRACT_USING</td>
1.177 leot 11658: <td>FAIL</td>
11659: </tr>
11660: <tr>
1.180 rillig 11661: <td>FAILOVER_FETCH</td>
1.175 gutterid 11662: <td>FAIL_MSG</td>
1.156 leot 11663: </tr>
11664: <tr>
1.180 rillig 11665: <td>FAKE_NCURSES</td>
1.175 gutterid 11666: <td>FAM</td>
1.156 leot 11667: </tr>
11668: <tr>
1.180 rillig 11669: <td>FAM_ACCEPTED</td>
1.175 gutterid 11670: <td>FAM_DEFAULT</td>
1.156 leot 11671: </tr>
11672: <tr>
1.180 rillig 11673: <td>FAM_SERVER</td>
1.175 gutterid 11674: <td>FCPATH</td>
1.156 leot 11675: </tr>
11676: <tr>
1.180 rillig 11677: <td>FEATURE_CPPFLAGS</td>
1.175 gutterid 11678: <td>FEATURE_LDFLAGS</td>
1.156 leot 11679: </tr>
11680: <tr>
1.180 rillig 11681: <td>FEATURE_LIBS</td>
1.175 gutterid 11682: <td>FETCH_AFTER_ARGS</td>
1.156 leot 11683: </tr>
11684: <tr>
1.180 rillig 11685: <td>FETCH_BEFORE_ARGS</td>
1.175 gutterid 11686: <td>FETCH_CMD</td>
1.156 leot 11687: </tr>
11688: <tr>
1.180 rillig 11689: <td>FETCH_OUTPUT_ARGS</td>
1.175 gutterid 11690: <td>FETCH_PROXY</td>
1.156 leot 11691: </tr>
11692: <tr>
1.180 rillig 11693: <td>FETCH_RESUME_ARGS</td>
1.189 ! bacon 11694: <td>FETCH_TIMEOUT</td>
! 11695: </tr>
! 11696: <tr>
! 11697: <td>FETCH_USE_IPV4_ONLY</td>
1.175 gutterid 11698: <td>FETCH_USING</td>
1.156 leot 11699: </tr>
11700: <tr>
1.180 rillig 11701: <td>FILES_SUBST</td>
1.175 gutterid 11702: <td>FILES_SUBST_SED</td>
1.156 leot 11703: </tr>
11704: <tr>
1.180 rillig 11705: <td>FIX_SYSTEM_HEADERS</td>
1.175 gutterid 11706: <td>FLUXBOX_USE_GNOME</td>
1.156 leot 11707: </tr>
11708: <tr>
1.180 rillig 11709: <td>FLUXBOX_USE_KDE</td>
1.175 gutterid 11710: <td>FLUXBOX_USE_XFT</td>
1.156 leot 11711: </tr>
11712: <tr>
1.180 rillig 11713: <td>FLUXBOX_USE_XINERAMA</td>
1.177 leot 11714: <td>FONTDIR</td>
1.156 leot 11715: </tr>
11716: <tr>
1.180 rillig 11717: <td>FONTS_DIRS</td>
1.172 rillig 11718: <td>FONTS_VERBOSE</td>
1.161 leot 11719: </tr>
11720: <tr>
1.180 rillig 11721: <td>FOO_HACKS_MK</td>
1.177 leot 11722: <td>FOSSIL_EXTRACTDIR</td>
11723: </tr>
11724: <tr>
1.180 rillig 11725: <td>FOSSIL_REPO</td>
1.177 leot 11726: <td>FOSSIL_REPOSITORIES</td>
11727: </tr>
11728: <tr>
1.180 rillig 11729: <td>FOSSIL_VERSION</td>
1.172 rillig 11730: <td>FOX_USE_XUNICODE</td>
1.156 leot 11731: </tr>
11732: <tr>
1.180 rillig 11733: <td>FREEWNN_GROUP</td>
1.172 rillig 11734: <td>FREEWNN_USER</td>
1.156 leot 11735: </tr>
11736: <tr>
1.180 rillig 11737: <td>FTP_PKG_URL_DIR</td>
1.172 rillig 11738: <td>FTP_PKG_URL_HOST</td>
1.156 leot 11739: </tr>
11740: <tr>
1.180 rillig 11741: <td>GAMEDATAMODE</td>
1.172 rillig 11742: <td>GAMEDATA_PERMS</td>
1.156 leot 11743: </tr>
11744: <tr>
1.180 rillig 11745: <td>GAMEDIRMODE</td>
1.172 rillig 11746: <td>GAMEDIR_PERMS</td>
1.156 leot 11747: </tr>
11748: <tr>
1.180 rillig 11749: <td>GAMEGRP</td>
1.172 rillig 11750: <td>GAMEMODE</td>
1.156 leot 11751: </tr>
11752: <tr>
1.180 rillig 11753: <td>GAMEOWN</td>
1.172 rillig 11754: <td>GAMES_GROUP</td>
1.156 leot 11755: </tr>
11756: <tr>
1.180 rillig 11757: <td>GAMES_USER</td>
1.172 rillig 11758: <td>GCC</td>
1.156 leot 11759: </tr>
11760: <tr>
1.180 rillig 11761: <td>GCCBASE</td>
1.172 rillig 11762: <td>GCC_REQD</td>
1.156 leot 11763: </tr>
11764: <tr>
1.180 rillig 11765: <td>GCC_VERSION_SUFFIX</td>
1.172 rillig 11766: <td>GEM_BUILD</td>
1.156 leot 11767: </tr>
11768: <tr>
1.180 rillig 11769: <td>GEM_CLEANBUILD</td>
1.172 rillig 11770: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.156 leot 11771: </tr>
11772: <tr>
1.180 rillig 11773: <td>GEM_DOCDIR</td>
1.172 rillig 11774: <td>GEM_EXTSDIR</td>
1.156 leot 11775: </tr>
11776: <tr>
1.180 rillig 11777: <td>GEM_HOME</td>
1.177 leot 11778: <td>GEM_KEEPBUILD</td>
11779: </tr>
11780: <tr>
1.180 rillig 11781: <td>GEM_LIBDIR</td>
1.156 leot 11782: <td>GEM_NAME</td>
11783: </tr>
11784: <tr>
1.180 rillig 11785: <td>GEM_PATH</td>
1.156 leot 11786: <td>GEM_SPECFILE</td>
11787: </tr>
11788: <tr>
1.180 rillig 11789: <td>GENERATE_PLIST</td>
1.156 leot 11790: <td>GHOSTSCRIPT_REQD</td>
11791: </tr>
11792: <tr>
1.180 rillig 11793: <td>GITHUB_PROJECT</td>
1.156 leot 11794: <td>GITHUB_RELEASE</td>
11795: </tr>
11796: <tr>
1.180 rillig 11797: <td>GITHUB_TAG</td>
1.156 leot 11798: <td>GITHUB_TYPE</td>
1.177 leot 11799: </tr>
11800: <tr>
1.180 rillig 11801: <td>GITLAB_PROJECT</td>
1.177 leot 11802: <td>GITLAB_TAG</td>
11803: </tr>
11804: <tr>
1.180 rillig 11805: <td>GITLAB_TYPE</td>
1.177 leot 11806: <td>GIT_BRANCH</td>
1.161 leot 11807: </tr>
11808: <tr>
1.180 rillig 11809: <td>GIT_ENV</td>
1.177 leot 11810: <td>GIT_EXTRACTDIR</td>
11811: </tr>
11812: <tr>
1.180 rillig 11813: <td>GIT_REPO</td>
1.177 leot 11814: <td>GIT_REPOSITORIES</td>
11815: </tr>
11816: <tr>
1.180 rillig 11817: <td>GIT_REVISION</td>
1.177 leot 11818: <td>GIT_TAG</td>
11819: </tr>
11820: <tr>
1.180 rillig 11821: <td>GNU</td>
1.175 gutterid 11822: <td>GNU_CONFIGURE</td>
1.159 rillig 11823: </tr>
11824: <tr>
1.180 rillig 11825: <td>GNU_CONFIGURE_INFODIR</td>
1.175 gutterid 11826: <td>GNU_CONFIGURE_MANDIR</td>
1.156 leot 11827: </tr>
11828: <tr>
1.180 rillig 11829: <td>GNU_CONFIGURE_QUIET</td>
1.178 rillig 11830: <td>GNU_CONFIGURE_STRICT</td>
1.156 leot 11831: </tr>
11832: <tr>
1.180 rillig 11833: <td>GODEP_REDIRECTS</td>
1.178 rillig 11834: <td>GO_BUILD_PATTERN</td>
1.156 leot 11835: </tr>
11836: <tr>
1.180 rillig 11837: <td>GO_DEPS</td>
1.178 rillig 11838: <td>GO_DIST_BASE</td>
1.156 leot 11839: </tr>
11840: <tr>
1.180 rillig 11841: <td>GO_MODULE_FILES</td>
1.178 rillig 11842: <td>GO_SRCPATH</td>
1.156 leot 11843: </tr>
11844: <tr>
1.180 rillig 11845: <td>GO_VERSION_DEFAULT</td>
1.178 rillig 11846: <td>GROUP_SPECIFIC_PKGS</td>
1.156 leot 11847: </tr>
11848: <tr>
1.180 rillig 11849: <td>GRUB_NETWORK_CARDS</td>
1.178 rillig 11850: <td>GRUB_PRESET_COMMAND</td>
1.156 leot 11851: </tr>
11852: <tr>
1.180 rillig 11853: <td>GRUB_SCAN_ARGS</td>
1.178 rillig 11854: <td>GZIP</td>
1.156 leot 11855: </tr>
11856: <tr>
1.180 rillig 11857: <td>HASKELL_COMPILER</td>
1.178 rillig 11858: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.156 leot 11859: </tr>
11860: <tr>
1.180 rillig 11861: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.178 rillig 11862: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.156 leot 11863: </tr>
11864: <tr>
1.180 rillig 11865: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.178 rillig 11866: <td>HAS_CONFIGURE</td>
1.177 leot 11867: </tr>
11868: <tr>
1.180 rillig 11869: <td>HEADER_TEMPLATES</td>
1.178 rillig 11870: <td>HG_REPO</td>
1.161 leot 11871: </tr>
11872: <tr>
1.180 rillig 11873: <td>HG_REPOSITORIES</td>
1.178 rillig 11874: <td>HG_TAG</td>
1.156 leot 11875: </tr>
11876: <tr>
1.188 leot 11877: <td>HOMEPAGE</td>
1.180 rillig 11878: <td>HOST_PKGTOOLS_ARGS</td>
1.156 leot 11879: </tr>
11880: <tr>
1.188 leot 11881: <td>HOST_SPECIFIC_PKGS</td>
1.180 rillig 11882: <td>HOWL_GROUP</td>
1.156 leot 11883: </tr>
11884: <tr>
1.188 leot 11885: <td>HOWL_USER</td>
1.180 rillig 11886: <td>ICCBASE</td>
1.156 leot 11887: </tr>
11888: <tr>
1.188 leot 11889: <td>ICECAST_CHROOTDIR</td>
1.180 rillig 11890: <td>ICON_THEMES</td>
1.156 leot 11891: </tr>
11892: <tr>
1.188 leot 11893: <td>IDOBASE</td>
1.180 rillig 11894: <td>IGNORE_CCACHE</td>
1.156 leot 11895: </tr>
11896: <tr>
1.188 leot 11897: <td>IGNORE_INFO_DIRS</td>
1.180 rillig 11898: <td>IGNORE_INTERACTIVE_FETCH</td>
1.156 leot 11899: </tr>
11900: <tr>
1.188 leot 11901: <td>IMAKE</td>
1.180 rillig 11902: <td>IMAKEOPTS</td>
1.156 leot 11903: </tr>
11904: <tr>
1.188 leot 11905: <td>IMAKE_MAKE</td>
1.180 rillig 11906: <td>IMAKE_MANINSTALL</td>
1.156 leot 11907: </tr>
11908: <tr>
1.188 leot 11909: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.180 rillig 11910: <td>IMDICTDIR</td>
1.156 leot 11911: </tr>
11912: <tr>
1.188 leot 11913: <td>INCOMPAT_CURSES</td>
1.180 rillig 11914: <td>INFO_DIR</td>
1.156 leot 11915: </tr>
11916: <tr>
1.188 leot 11917: <td>INFO_FILES</td>
1.180 rillig 11918: <td>INFO_FILES_VERBOSE</td>
1.156 leot 11919: </tr>
11920: <tr>
1.188 leot 11921: <td>INFO_MSG</td>
1.180 rillig 11922: <td>INIT_SYSTEM</td>
1.156 leot 11923: </tr>
11924: <tr>
1.188 leot 11925: <td>INN_DATA_DIR</td>
1.180 rillig 11926: <td>INN_GROUP</td>
1.172 rillig 11927: </tr>
11928: <tr>
1.188 leot 11929: <td>INN_USER</td>
1.180 rillig 11930: <td>INSTALLATION_DIRS</td>
1.156 leot 11931: </tr>
11932: <tr>
1.188 leot 11933: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.180 rillig 11934: <td>INSTALL_ENV</td>
1.156 leot 11935: </tr>
11936: <tr>
1.188 leot 11937: <td>INSTALL_SH_OVERRIDE</td>
1.180 rillig 11938: <td>INSTALL_SRC</td>
1.156 leot 11939: </tr>
11940: <tr>
1.188 leot 11941: <td>INSTALL_TEMPLATES</td>
1.180 rillig 11942: <td>INSTALL_UNSTRIPPED</td>
1.156 leot 11943: </tr>
11944: <tr>
1.188 leot 11945: <td>IRCD_HYBRID_IRC_GROUP</td>
1.180 rillig 11946: <td>IRCD_HYBRID_IRC_USER</td>
1.156 leot 11947: </tr>
11948: <tr>
1.188 leot 11949: <td>IRCD_HYBRID_MAXCONN</td>
1.180 rillig 11950: <td>IRCD_HYBRID_NICLEN</td>
1.156 leot 11951: </tr>
11952: <tr>
1.188 leot 11953: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.180 rillig 11954: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.156 leot 11955: </tr>
11956: <tr>
1.188 leot 11957: <td>IRCD_HYBRID_TOPICLEN</td>
1.180 rillig 11958: <td>IRIX</td>
1.156 leot 11959: </tr>
11960: <tr>
1.188 leot 11961: <td>IRRD_USE_PGP</td>
1.180 rillig 11962: <td>JABBERD_GROUP</td>
1.156 leot 11963: </tr>
11964: <tr>
1.188 leot 11965: <td>JABBERD_LOGDIR</td>
1.180 rillig 11966: <td>JABBERD_PIDDIR</td>
1.156 leot 11967: </tr>
11968: <tr>
1.188 leot 11969: <td>JABBERD_SPOOLDIR</td>
1.180 rillig 11970: <td>JABBERD_USER</td>
1.177 leot 11971: </tr>
11972: <tr>
1.188 leot 11973: <td>JAKARTA_HOME</td>
1.180 rillig 11974: <td>JAVA_APP_PATH</td>
1.161 leot 11975: </tr>
11976: <tr>
1.188 leot 11977: <td>JAVA_APP_TARGETS</td>
1.180 rillig 11978: <td>JAVA_BINPREFIX</td>
1.156 leot 11979: </tr>
11980: <tr>
1.188 leot 11981: <td>JAVA_CLASSPATH</td>
1.180 rillig 11982: <td>JAVA_HOME</td>
1.156 leot 11983: </tr>
11984: <tr>
1.188 leot 11985: <td>JAVA_LD_LIBRARY_PATH</td>
1.180 rillig 11986: <td>JAVA_NAME</td>
1.156 leot 11987: </tr>
11988: <tr>
1.188 leot 11989: <td>JAVA_UNLIMIT</td>
1.180 rillig 11990: <td>JAVA_WRAPPERS</td>
1.156 leot 11991: </tr>
11992: <tr>
1.188 leot 11993: <td>JPEG_ACCEPTED</td>
1.180 rillig 11994: <td>JPEG_DEFAULT</td>
1.156 leot 11995: </tr>
11996: <tr>
1.188 leot 11997: <td>KERBEROS</td>
1.180 rillig 11998: <td>KERMIT_SUID_UUCP</td>
1.156 leot 11999: </tr>
12000: <tr>
1.188 leot 12001: <td>KJS_USE_PCRE</td>
1.180 rillig 12002: <td>KNEWS_DOMAIN_FILE</td>
1.156 leot 12003: </tr>
12004: <tr>
1.188 leot 12005: <td>KNEWS_DOMAIN_NAME</td>
1.180 rillig 12006: <td>KRB5_ACCEPTED</td>
1.177 leot 12007: </tr>
12008: <tr>
1.188 leot 12009: <td>KRB5_DEFAULT</td>
1.180 rillig 12010: <td>LANGUAGES</td>
1.156 leot 12011: </tr>
12012: <tr>
1.188 leot 12013: <td>LAPACK_LIBS</td>
1.180 rillig 12014: <td>LATEX2HTML_ICONPATH</td>
1.156 leot 12015: </tr>
12016: <tr>
1.188 leot 12017: <td>LDCONFIG_ADD_CMD</td>
1.180 rillig 12018: <td>LDCONFIG_REMOVE_CMD</td>
1.156 leot 12019: </tr>
12020: <tr>
1.188 leot 12021: <td>LEAFNODE_DATA_DIR</td>
1.180 rillig 12022: <td>LEAFNODE_GROUP</td>
1.156 leot 12023: </tr>
12024: <tr>
1.188 leot 12025: <td>LEAFNODE_USER</td>
1.180 rillig 12026: <td>LIBDVDCSS_HOMEPAGE</td>
1.157 leot 12027: </tr>
12028: <tr>
1.188 leot 12029: <td>LIBDVDCSS_MASTER_SITES</td>
1.180 rillig 12030: <td>LIBRSVG_TYPE</td>
1.156 leot 12031: </tr>
12032: <tr>
1.188 leot 12033: <td>LIBTOOL</td>
1.180 rillig 12034: <td>LIBTOOLIZE_PLIST</td>
1.156 leot 12035: </tr>
12036: <tr>
1.188 leot 12037: <td>LIBTOOL_M4_OVERRIDE</td>
1.180 rillig 12038: <td>LIBUSB_TYPE</td>
1.177 leot 12039: </tr>
12040: <tr>
1.188 leot 12041: <td>LICENSE</td>
1.180 rillig 12042: <td>LINKER_RPATH_FLAG</td>
1.156 leot 12043: </tr>
12044: <tr>
1.188 leot 12045: <td>LINK_RPATH_FLAG</td>
1.180 rillig 12046: <td>LINUX_BASE_NODEPS</td>
1.161 leot 12047: </tr>
12048: <tr>
1.188 leot 12049: <td>LINUX_BASE_PREFERRED</td>
1.180 rillig 12050: <td>LINUX_BASE_REQUIRED</td>
1.156 leot 12051: </tr>
12052: <tr>
1.188 leot 12053: <td>LINUX_LOCALES</td>
1.180 rillig 12054: <td>LOCALBASE</td>
1.156 leot 12055: </tr>
12056: <tr>
1.188 leot 12057: <td>LOCALBASE_LOCKTYPE</td>
1.180 rillig 12058: <td>LOCALPATCHES</td>
1.156 leot 12059: </tr>
12060: <tr>
1.188 leot 12061: <td>LOVE_DATA</td>
1.180 rillig 12062: <td>LOVE_GAME</td>
1.156 leot 12063: </tr>
12064: <tr>
1.188 leot 12065: <td>LOVE_VERSION</td>
1.180 rillig 12066: <td>LP64PLATFORMS</td>
1.156 leot 12067: </tr>
12068: <tr>
1.188 leot 12069: <td>MACHINE_PLATFORM</td>
1.180 rillig 12070: <td>MAILAGENT_DOMAIN</td>
1.156 leot 12071: </tr>
12072: <tr>
1.188 leot 12073: <td>MAILAGENT_EMAIL</td>
1.180 rillig 12074: <td>MAILAGENT_FQDN</td>
1.159 rillig 12075: </tr>
12076: <tr>
1.188 leot 12077: <td>MAILAGENT_ORGANIZATION</td>
1.180 rillig 12078: <td>MAJORDOMO_HOMEDIR</td>
1.156 leot 12079: </tr>
12080: <tr>
1.188 leot 12081: <td>MAJOR_OS_VERSION</td>
1.180 rillig 12082: <td>MAKEINFO_ARGS</td>
1.156 leot 12083: </tr>
12084: <tr>
1.188 leot 12085: <td>MAKE_DIRS</td>
1.180 rillig 12086: <td>MAKE_DIRS_PERMS</td>
1.156 leot 12087: </tr>
12088: <tr>
1.188 leot 12089: <td>MAKE_ENV</td>
1.180 rillig 12090: <td>MAKE_FILE</td>
1.156 leot 12091: </tr>
12092: <tr>
1.188 leot 12093: <td>MAKE_FLAGS</td>
1.180 rillig 12094: <td>MAKE_JOBS</td>
1.156 leot 12095: </tr>
12096: <tr>
1.188 leot 12097: <td>MAKE_JOBS_SAFE</td>
1.180 rillig 12098: <td>MAKE_PROGRAM</td>
1.156 leot 12099: </tr>
12100: <tr>
1.189 ! bacon 12101: <td>MANCOMPRESSED_IF_MANZ</td>
1.188 leot 12102: <td>MANINSTALL</td>
1.189 ! bacon 12103: </tr>
! 12104: <tr>
1.180 rillig 12105: <td>MANZ</td>
1.189 ! bacon 12106: <td>MASTER_SITES</td>
1.156 leot 12107: </tr>
12108: <tr>
1.180 rillig 12109: <td>MASTER_SITE_BACKUP</td>
1.189 ! bacon 12110: <td>MASTER_SITE_LOCAL</td>
1.156 leot 12111: </tr>
12112: <tr>
1.180 rillig 12113: <td>MASTER_SITE_MOZILLA</td>
1.189 ! bacon 12114: <td>MASTER_SITE_OVERRIDE</td>
1.156 leot 12115: </tr>
12116: <tr>
1.180 rillig 12117: <td>MASTER_SITE_PERL_CPAN</td>
1.189 ! bacon 12118: <td>MASTER_SORT</td>
1.156 leot 12119: </tr>
12120: <tr>
1.180 rillig 12121: <td>MASTER_SORT_RANDOM</td>
1.189 ! bacon 12122: <td>MASTER_SORT_REGEX</td>
1.156 leot 12123: </tr>
12124: <tr>
1.180 rillig 12125: <td>MECAB_CHARSET</td>
1.189 ! bacon 12126: <td>MEDIATOMB_GROUP</td>
1.156 leot 12127: </tr>
12128: <tr>
1.180 rillig 12129: <td>MEDIATOMB_USER</td>
1.189 ! bacon 12130: <td>MIPSPROBASE</td>
1.156 leot 12131: </tr>
12132: <tr>
1.180 rillig 12133: <td>MIREDO_GROUP</td>
1.189 ! bacon 12134: <td>MIREDO_USER</td>
1.156 leot 12135: </tr>
12136: <tr>
1.180 rillig 12137: <td>MISSING_FEATURES</td>
1.189 ! bacon 12138: <td>MKDIR</td>
1.156 leot 12139: </tr>
12140: <tr>
1.180 rillig 12141: <td>MLDONKEY_GROUP</td>
1.189 ! bacon 12142: <td>MLDONKEY_HOME</td>
1.156 leot 12143: </tr>
12144: <tr>
1.180 rillig 12145: <td>MLDONKEY_USER</td>
1.189 ! bacon 12146: <td>MONOTONE_GROUP</td>
1.156 leot 12147: </tr>
12148: <tr>
1.180 rillig 12149: <td>MONOTONE_USER</td>
1.189 ! bacon 12150: <td>MOTIFBASE</td>
1.156 leot 12151: </tr>
12152: <tr>
1.180 rillig 12153: <td>MOTIF_TYPE</td>
1.189 ! bacon 12154: <td>MOTIF_TYPE_DEFAULT</td>
1.156 leot 12155: </tr>
12156: <tr>
1.180 rillig 12157: <td>MPI_TYPE</td>
1.189 ! bacon 12158: <td>MSGFMT_STRIP_MSGCTXT</td>
1.156 leot 12159: </tr>
12160: <tr>
1.180 rillig 12161: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.189 ! bacon 12162: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.156 leot 12163: </tr>
12164: <tr>
1.180 rillig 12165: <td>MUST</td>
1.189 ! bacon 12166: <td>MV</td>
1.156 leot 12167: </tr>
12168: <tr>
1.180 rillig 12169: <td>MYSQL_CHARSET</td>
1.189 ! bacon 12170: <td>MYSQL_DATADIR</td>
1.156 leot 12171: </tr>
12172: <tr>
1.180 rillig 12173: <td>MYSQL_EXTRA_CHARSET</td>
1.189 ! bacon 12174: <td>MYSQL_GROUP</td>
1.156 leot 12175: </tr>
12176: <tr>
1.180 rillig 12177: <td>MYSQL_PKGSRCDIR</td>
1.189 ! bacon 12178: <td>MYSQL_USER</td>
1.156 leot 12179: </tr>
12180: <tr>
1.180 rillig 12181: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.189 ! bacon 12182: <td>MYSQL_VERSION_DEFAULT</td>
1.156 leot 12183: </tr>
12184: <tr>
1.180 rillig 12185: <td>NAGIOSCMD_GROUP</td>
1.189 ! bacon 12186: <td>NAGIOSDIR</td>
1.156 leot 12187: </tr>
12188: <tr>
1.180 rillig 12189: <td>NAGIOS_GROUP</td>
1.189 ! bacon 12190: <td>NAGIOS_USER</td>
1.156 leot 12191: </tr>
12192: <tr>
1.180 rillig 12193: <td>NATIVE_APPEND_ABI</td>
1.189 ! bacon 12194: <td>NATIVE_APPEND_ELF</td>
1.156 leot 12195: </tr>
12196: <tr>
1.180 rillig 12197: <td>NATIVE_EXEC_FMT</td>
1.189 ! bacon 12198: <td>NATIVE_MACHINE_PLATFORM</td>
1.156 leot 12199: </tr>
12200: <tr>
1.180 rillig 12201: <td>NATIVE_OBJECT_FMT</td>
1.189 ! bacon 12202: <td>NBPAX_PROGRAM_PREFIX</td>
1.178 rillig 12203: </tr>
12204: <tr>
1.180 rillig 12205: <td>NETBSD_LOGIN_NAME</td>
1.189 ! bacon 12206: <td>NMH_EDITOR</td>
1.156 leot 12207: </tr>
12208: <tr>
1.180 rillig 12209: <td>NMH_MTA</td>
1.189 ! bacon 12210: <td>NMH_PAGER</td>
1.156 leot 12211: </tr>
12212: <tr>
1.180 rillig 12213: <td>NOLOGIN</td>
1.189 ! bacon 12214: <td>NOTE</td>
1.156 leot 12215: </tr>
12216: <tr>
1.180 rillig 12217: <td>NOT_FOR_PLATFORM</td>
1.189 ! bacon 12218: <td>NOT_PAX_ASLR_SAFE</td>
1.156 leot 12219: </tr>
12220: <tr>
1.180 rillig 12221: <td>NOT_PAX_MPROTECT_SAFE</td>
1.189 ! bacon 12222: <td>NO_BUILD</td>
1.156 leot 12223: </tr>
12224: <tr>
1.180 rillig 12225: <td>NO_CHECKSUM</td>
1.189 ! bacon 12226: <td>NO_CONFIGURE</td>
1.156 leot 12227: </tr>
12228: <tr>
1.180 rillig 12229: <td>NO_SKIP</td>
1.189 ! bacon 12230: <td>NS_PREFERRED</td>
1.156 leot 12231: </tr>
12232: <tr>
1.180 rillig 12233: <td>NULLMAILER_GROUP</td>
1.189 ! bacon 12234: <td>NULLMAILER_USER</td>
1.156 leot 12235: </tr>
12236: <tr>
1.180 rillig 12237: <td>OASIS</td>
1.189 ! bacon 12238: <td>OASIS_BUILD_ARGS</td>
1.156 leot 12239: </tr>
12240: <tr>
1.180 rillig 12241: <td>OBJHOSTNAME</td>
1.189 ! bacon 12242: <td>OBJMACHINE</td>
1.156 leot 12243: </tr>
12244: <tr>
1.180 rillig 12245: <td>OCAML_FINDLIB_DIRS</td>
1.189 ! bacon 12246: <td>OCAML_FINDLIB_REGISTER</td>
1.156 leot 12247: </tr>
12248: <tr>
1.180 rillig 12249: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.189 ! bacon 12250: <td>OCAML_SITELIBDIR</td>
1.156 leot 12251: </tr>
12252: <tr>
1.180 rillig 12253: <td>OCAML_TOPKG_DOCDIR</td>
1.189 ! bacon 12254: <td>OCAML_USE_DUNE</td>
1.156 leot 12255: </tr>
12256: <tr>
1.180 rillig 12257: <td>OCAML_USE_FINDLIB</td>
1.189 ! bacon 12258: <td>OCAML_USE_JBUILDER</td>
1.156 leot 12259: </tr>
12260: <tr>
1.180 rillig 12261: <td>OCAML_USE_OASIS</td>
1.189 ! bacon 12262: <td>OCAML_USE_OASIS_DYNRUN</td>
1.156 leot 12263: </tr>
12264: <tr>
1.180 rillig 12265: <td>OCAML_USE_OPAM</td>
1.189 ! bacon 12266: <td>OCAML_USE_OPT_COMPILER</td>
1.156 leot 12267: </tr>
12268: <tr>
1.180 rillig 12269: <td>OCAML_USE_TOPKG</td>
1.189 ! bacon 12270: <td>OMF</td>
1.156 leot 12271: </tr>
12272: <tr>
1.180 rillig 12273: <td>ONLY_FOR_COMPILER</td>
1.189 ! bacon 12274: <td>ONLY_FOR_PLATFORM</td>
1.156 leot 12275: </tr>
12276: <tr>
1.180 rillig 12277: <td>OPENSSH_CHROOT</td>
1.189 ! bacon 12278: <td>OPENSSH_GROUP</td>
1.156 leot 12279: </tr>
12280: <tr>
1.180 rillig 12281: <td>OPENSSH_USER</td>
1.189 ! bacon 12282: <td>OPSYS</td>
1.156 leot 12283: </tr>
12284: <tr>
1.180 rillig 12285: <td>OPSYS_EMULDIR</td>
1.189 ! bacon 12286: <td>OS</td>
1.156 leot 12287: </tr>
12288: <tr>
1.188 leot 12289: <td>OSS_TYPE</td>
1.180 rillig 12290: <td>OSX</td>
1.177 leot 12291: </tr>
12292: <tr>
1.188 leot 12293: <td>OSX_TOLERATE_SDK_SKEW</td>
1.180 rillig 12294: <td>OS_HAVE_ALSA</td>
1.156 leot 12295: </tr>
12296: <tr>
1.188 leot 12297: <td>OS_HAVE_RCD</td>
1.180 rillig 12298: <td>OS_VARIANT</td>
1.159 rillig 12299: </tr>
12300: <tr>
1.188 leot 12301: <td>OS_VERSION</td>
1.180 rillig 12302: <td>OTF_FONTS_DIR</td>
1.156 leot 12303: </tr>
12304: <tr>
1.188 leot 12305: <td>OVERRIDE_DIRDEPTH</td>
1.180 rillig 12306: <td>OVERRIDE_GEMSPEC</td>
1.156 leot 12307: </tr>
12308: <tr>
1.188 leot 12309: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.180 rillig 12310: <td>OVERRIDE_ROCKSPEC</td>
1.161 leot 12311: </tr>
12312: <tr>
1.188 leot 12313: <td>OWN_DIRS</td>
1.180 rillig 12314: <td>OWN_DIRS_PERMS</td>
1.156 leot 12315: </tr>
12316: <tr>
1.188 leot 12317: <td>P4GROUP</td>
1.180 rillig 12318: <td>P4PORT</td>
1.156 leot 12319: </tr>
12320: <tr>
1.188 leot 12321: <td>P4ROOT</td>
1.180 rillig 12322: <td>P4USER</td>
1.156 leot 12323: </tr>
12324: <tr>
1.188 leot 12325: <td>PACKAGES</td>
1.180 rillig 12326: <td>PALMOS_DEFAULT_SDK</td>
1.156 leot 12327: </tr>
12328: <tr>
1.188 leot 12329: <td>PAMBASE</td>
1.180 rillig 12330: <td>PAM_DEFAULT</td>
1.156 leot 12331: </tr>
12332: <tr>
1.188 leot 12333: <td>PAPERSIZE</td>
1.180 rillig 12334: <td>PASSIVE_FETCH</td>
1.156 leot 12335: </tr>
12336: <tr>
1.188 leot 12337: <td>PATCHDIR</td>
1.180 rillig 12338: <td>PATCHFILES</td>
1.156 leot 12339: </tr>
12340: <tr>
1.188 leot 12341: <td>PATCH_ARGS</td>
1.180 rillig 12342: <td>PATCH_DEBUG</td>
1.169 rillig 12343: </tr>
12344: <tr>
1.188 leot 12345: <td>PATCH_DIST_ARGS</td>
1.180 rillig 12346: <td>PATCH_DIST_CAT</td>
1.156 leot 12347: </tr>
12348: <tr>
1.188 leot 12349: <td>PATCH_DIST_STRIP</td>
1.180 rillig 12350: <td>PATCH_FUZZ_FACTOR</td>
1.156 leot 12351: </tr>
12352: <tr>
1.188 leot 12353: <td>PATCH_STRIP</td>
1.180 rillig 12354: <td>PATH</td>
1.156 leot 12355: </tr>
12356: <tr>
1.188 leot 12357: <td>PCCBASE</td>
1.180 rillig 12358: <td>PEAR</td>
1.177 leot 12359: </tr>
12360: <tr>
1.188 leot 12361: <td>PEAR_CHANNEL</td>
1.180 rillig 12362: <td>PEAR_CHANNEL_ALIAS</td>
1.177 leot 12363: </tr>
12364: <tr>
1.188 leot 12365: <td>PEAR_CHANNEL_VERSION</td>
1.180 rillig 12366: <td>PEAR_CMD</td>
1.161 leot 12367: </tr>
12368: <tr>
1.188 leot 12369: <td>PEAR_LIB</td>
1.180 rillig 12370: <td>PEAR_PACKAGE_XML</td>
1.161 leot 12371: </tr>
12372: <tr>
1.188 leot 12373: <td>PERL5</td>
1.180 rillig 12374: <td>PERL5_CONFIGURE</td>
1.156 leot 12375: </tr>
12376: <tr>
1.188 leot 12377: <td>PERL5_CONFIGURE_DIRS</td>
1.180 rillig 12378: <td>PERL5_LDFLAGS</td>
1.156 leot 12379: </tr>
12380: <tr>
1.188 leot 12381: <td>PERL5_LICENSE</td>
1.180 rillig 12382: <td>PERL5_MODULE_TYPE</td>
1.156 leot 12383: </tr>
12384: <tr>
1.188 leot 12385: <td>PERL5_PACKLIST</td>
1.180 rillig 12386: <td>PERL5_PACKLIST_DIR</td>
1.156 leot 12387: </tr>
12388: <tr>
1.188 leot 12389: <td>PERL5_PERLBASE</td>
1.180 rillig 12390: <td>PERL5_SITEBASE</td>
1.156 leot 12391: </tr>
12392: <tr>
1.188 leot 12393: <td>PERL5_USE_PACKLIST</td>
1.180 rillig 12394: <td>PERL5_VENDORBASE</td>
1.156 leot 12395: </tr>
12396: <tr>
1.188 leot 12397: <td>PFCTL</td>
1.180 rillig 12398: <td>PFVAR_H</td>
1.156 leot 12399: </tr>
12400: <tr>
1.188 leot 12401: <td>PF_VERSION</td>
1.180 rillig 12402: <td>PGGROUP</td>
1.156 leot 12403: </tr>
12404: <tr>
1.188 leot 12405: <td>PGHOME</td>
1.180 rillig 12406: <td>PGPKGSRCDIR</td>
1.156 leot 12407: </tr>
12408: <tr>
1.188 leot 12409: <td>PGSQL_TYPE</td>
1.180 rillig 12410: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.156 leot 12411: </tr>
12412: <tr>
1.188 leot 12413: <td>PGSQL_VERSION_DEFAULT</td>
1.180 rillig 12414: <td>PGUSER</td>
1.156 leot 12415: </tr>
12416: <tr>
1.188 leot 12417: <td>PG_LIB_EXT</td>
1.180 rillig 12418: <td>PHP</td>
1.156 leot 12419: </tr>
12420: <tr>
1.188 leot 12421: <td>PHPCOMMON_MK</td>
1.180 rillig 12422: <td>PHPPKGSRCDIR</td>
1.156 leot 12423: </tr>
12424: <tr>
1.188 leot 12425: <td>PHP_BASE_VERS</td>
1.180 rillig 12426: <td>PHP_CHECK_INSTALLED</td>
1.156 leot 12427: </tr>
12428: <tr>
1.188 leot 12429: <td>PHP_EXTENSION_DIR</td>
1.180 rillig 12430: <td>PHP_INITIAL_TEENY</td>
1.156 leot 12431: </tr>
12432: <tr>
1.188 leot 12433: <td>PHP_PKG_PREFIX</td>
1.180 rillig 12434: <td>PHP_VERSION</td>
1.156 leot 12435: </tr>
12436: <tr>
1.188 leot 12437: <td>PHP_VERSIONS_ACCEPTED</td>
1.180 rillig 12438: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.156 leot 12439: </tr>
12440: <tr>
1.188 leot 12441: <td>PHP_VERSION_DEFAULT</td>
1.180 rillig 12442: <td>PHP_VERSION_REQD</td>
1.156 leot 12443: </tr>
12444: <tr>
1.188 leot 12445: <td>PILRC_USE_GTK</td>
1.180 rillig 12446: <td>PKGCONFIG_BASE</td>
1.156 leot 12447: </tr>
12448: <tr>
1.188 leot 12449: <td>PKGCONFIG_FILE</td>
1.180 rillig 12450: <td>PKGCONFIG_OVERRIDE</td>
1.156 leot 12451: </tr>
12452: <tr>
1.188 leot 12453: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.180 rillig 12454: <td>PKGDIR</td>
1.156 leot 12455: </tr>
12456: <tr>
1.188 leot 12457: <td>PKGGNUDIR</td>
1.180 rillig 12458: <td>PKGINFODIR</td>
1.156 leot 12459: </tr>
12460: <tr>
1.188 leot 12461: <td>PKGLOCALEDIR</td>
1.180 rillig 12462: <td>PKGMANDIR</td>
1.156 leot 12463: </tr>
12464: <tr>
1.188 leot 12465: <td>PKGNAME</td>
1.180 rillig 12466: <td>PKGNAME_REQD</td>
1.156 leot 12467: </tr>
12468: <tr>
1.188 leot 12469: <td>PKGPATH</td>
1.180 rillig 12470: <td>PKGREVISION</td>
1.177 leot 12471: </tr>
12472: <tr>
1.188 leot 12473: <td>PKGSRC_BLAS_TYPES</td>
1.180 rillig 12474: <td>PKGSRC_CHANGES</td>
1.156 leot 12475: </tr>
12476: <tr>
1.188 leot 12477: <td>PKGSRC_COMPILER</td>
1.180 rillig 12478: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.159 rillig 12479: </tr>
12480: <tr>
1.188 leot 12481: <td>PKGSRC_LOCKTYPE</td>
1.180 rillig 12482: <td>PKGSRC_MAKE_ENV</td>
1.156 leot 12483: </tr>
12484: <tr>
1.188 leot 12485: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.180 rillig 12486: <td>PKGSRC_MKPIE</td>
1.156 leot 12487: </tr>
12488: <tr>
1.188 leot 12489: <td>PKGSRC_MKREPRO</td>
1.180 rillig 12490: <td>PKGSRC_RUN_TEST</td>
1.156 leot 12491: </tr>
12492: <tr>
1.188 leot 12493: <td>PKGSRC_SETENV</td>
1.180 rillig 12494: <td>PKGSRC_SLEEPSECS</td>
1.156 leot 12495: </tr>
12496: <tr>
1.188 leot 12497: <td>PKGSRC_TODO</td>
1.180 rillig 12498: <td>PKGSRC_USE_CTF</td>
1.156 leot 12499: </tr>
12500: <tr>
1.188 leot 12501: <td>PKGSRC_USE_FORTIFY</td>
1.180 rillig 12502: <td>PKGSRC_USE_RELRO</td>
1.156 leot 12503: </tr>
12504: <tr>
1.188 leot 12505: <td>PKGSRC_USE_SSP</td>
1.180 rillig 12506: <td>PKGSRC_USE_STACK_CHECK</td>
1.156 leot 12507: </tr>
12508: <tr>
1.188 leot 12509: <td>PKGTASKS_DATAFILE</td>
1.180 rillig 12510: <td>PKGTOOLS_ARGS</td>
1.156 leot 12511: </tr>
12512: <tr>
1.188 leot 12513: <td>PKGTOOLS_ENV</td>
1.180 rillig 12514: <td>PKG_ALTERNATIVES</td>
1.156 leot 12515: </tr>
12516: <tr>
1.188 leot 12517: <td>PKG_APACHE</td>
1.180 rillig 12518: <td>PKG_APACHE_ACCEPTED</td>
1.156 leot 12519: </tr>
12520: <tr>
1.188 leot 12521: <td>PKG_APACHE_DEFAULT</td>
1.180 rillig 12522: <td>PKG_BEST_EXISTS</td>
1.156 leot 12523: </tr>
12524: <tr>
1.188 leot 12525: <td>PKG_BUILD_OPTIONS</td>
1.180 rillig 12526: <td>PKG_COMPRESSION</td>
1.156 leot 12527: </tr>
12528: <tr>
1.188 leot 12529: <td>PKG_CONFIG</td>
1.180 rillig 12530: <td>PKG_CONFIG_PERMS</td>
1.156 leot 12531: </tr>
12532: <tr>
1.188 leot 12533: <td>PKG_CREATE_USERGROUP</td>
1.180 rillig 12534: <td>PKG_DB_TMPDIR</td>
1.156 leot 12535: </tr>
12536: <tr>
1.188 leot 12537: <td>PKG_DEBUG_LEVEL</td>
1.180 rillig 12538: <td>PKG_DEFAULT_OPTIONS</td>
1.156 leot 12539: </tr>
12540: <tr>
1.188 leot 12541: <td>PKG_DESTDIR_SUPPORT</td>
1.180 rillig 12542: <td>PKG_DEVELOPER</td>
1.156 leot 12543: </tr>
12544: <tr>
1.188 leot 12545: <td>PKG_DISABLED_OPTIONS</td>
1.180 rillig 12546: <td>PKG_FATAL_ERRORS</td>
1.156 leot 12547: </tr>
12548: <tr>
1.188 leot 12549: <td>PKG_FC</td>
1.180 rillig 12550: <td>PKG_FILELIST_CMD</td>
1.156 leot 12551: </tr>
12552: <tr>
1.188 leot 12553: <td>PKG_GECOS</td>
1.180 rillig 12554: <td>PKG_GID</td>
1.156 leot 12555: </tr>
12556: <tr>
1.188 leot 12557: <td>PKG_GROUPS</td>
1.180 rillig 12558: <td>PKG_GROUPS_VARS</td>
1.156 leot 12559: </tr>
12560: <tr>
1.188 leot 12561: <td>PKG_HOME</td>
1.180 rillig 12562: <td>PKG_INIT_SCRIPTS</td>
1.156 leot 12563: </tr>
12564: <tr>
1.188 leot 12565: <td>PKG_JAVA_HOME</td>
1.180 rillig 12566: <td>PKG_JVM</td>
1.156 leot 12567: </tr>
12568: <tr>
1.188 leot 12569: <td>PKG_JVMS_ACCEPTED</td>
1.180 rillig 12570: <td>PKG_JVM_DEFAULT</td>
1.156 leot 12571: </tr>
12572: <tr>
1.188 leot 12573: <td>PKG_LEGACY_OPTIONS</td>
1.180 rillig 12574: <td>PKG_LIBTOOL</td>
1.156 leot 12575: </tr>
12576: <tr>
1.188 leot 12577: <td>PKG_OPTIONS</td>
1.180 rillig 12578: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.156 leot 12579: </tr>
12580: <tr>
1.188 leot 12581: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.180 rillig 12582: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.156 leot 12583: </tr>
12584: <tr>
1.188 leot 12585: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.180 rillig 12586: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.156 leot 12587: </tr>
12588: <tr>
1.188 leot 12589: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.180 rillig 12590: <td>PKG_OPTIONS_VAR</td>
1.156 leot 12591: </tr>
12592: <tr>
1.188 leot 12593: <td>PKG_PHP</td>
1.180 rillig 12594: <td>PKG_PHP_MAJOR_VERS</td>
1.156 leot 12595: </tr>
12596: <tr>
1.188 leot 12597: <td>PKG_PHP_VERSION</td>
1.180 rillig 12598: <td>PKG_RCD_SCRIPTS</td>
1.156 leot 12599: </tr>
12600: <tr>
1.188 leot 12601: <td>PKG_REFCOUNT_DBDIR</td>
1.180 rillig 12602: <td>PKG_REGISTER_SHELLS</td>
1.156 leot 12603: </tr>
12604: <tr>
1.188 leot 12605: <td>PKG_RESUME_TRANSFERS</td>
1.180 rillig 12606: <td>PKG_SHELL</td>
1.156 leot 12607: </tr>
12608: <tr>
1.188 leot 12609: <td>PKG_SUGGESTED_OPTIONS</td>
1.180 rillig 12610: <td>PKG_SUPPORTED_OPTIONS</td>
1.156 leot 12611: </tr>
12612: <tr>
1.188 leot 12613: <td>PKG_SYSCONFBASE</td>
1.180 rillig 12614: <td>PKG_SYSCONFBASEDIR</td>
1.156 leot 12615: </tr>
12616: <tr>
1.188 leot 12617: <td>PKG_SYSCONFDIR</td>
1.180 rillig 12618: <td>PKG_SYSCONFDIR_PERMS</td>
1.156 leot 12619: </tr>
12620: <tr>
1.188 leot 12621: <td>PKG_SYSCONFSUBDIR</td>
1.180 rillig 12622: <td>PKG_SYSCONFVAR</td>
1.156 leot 12623: </tr>
12624: <tr>
1.188 leot 12625: <td>PKG_TOOLS_BIN</td>
1.180 rillig 12626: <td>PKG_UID</td>
1.156 leot 12627: </tr>
12628: <tr>
1.188 leot 12629: <td>PKG_UPDATE_FONTS_DB</td>
1.180 rillig 12630: <td>PKG_USERS</td>
1.156 leot 12631: </tr>
12632: <tr>
1.188 leot 12633: <td>PKG_USERS_VARS</td>
1.180 rillig 12634: <td>PKG_VERBOSE</td>
1.156 leot 12635: </tr>
12636: <tr>
1.188 leot 12637: <td>PLIST</td>
1.180 rillig 12638: <td>PLIST_AWK</td>
1.156 leot 12639: </tr>
12640: <tr>
1.188 leot 12641: <td>PLIST_AWK_ENV</td>
1.180 rillig 12642: <td>PLIST_SRC</td>
1.156 leot 12643: </tr>
12644: <tr>
1.188 leot 12645: <td>PLIST_SUBST</td>
1.180 rillig 12646: <td>PLIST_TYPE</td>
1.156 leot 12647: </tr>
12648: <tr>
1.188 leot 12649: <td>PLIST_VARS</td>
1.180 rillig 12650: <td>POPTOP_USE_MPPE</td>
1.156 leot 12651: </tr>
12652: <tr>
1.188 leot 12653: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.180 rillig 12654: <td>POST_FETCH_HOOK</td>
1.156 leot 12655: </tr>
12656: <tr>
1.188 leot 12657: <td>PREFER</td>
1.180 rillig 12658: <td>PREFER_NATIVE</td>
1.156 leot 12659: </tr>
12660: <tr>
1.188 leot 12661: <td>PREFER_NATIVE_PTHREADS</td>
1.180 rillig 12662: <td>PREFER_PKGSRC</td>
1.156 leot 12663: </tr>
12664: <tr>
1.188 leot 12665: <td>PREFIX</td>
1.180 rillig 12666: <td>PREPEND_PATH</td>
1.156 leot 12667: </tr>
12668: <tr>
1.188 leot 12669: <td>PRE_ROOT_CMD</td>
1.180 rillig 12670: <td>PRIVILEGED_STAGES</td>
1.156 leot 12671: </tr>
12672: <tr>
1.188 leot 12673: <td>PS</td>
1.180 rillig 12674: <td>PTHREAD_AUTO_VARS</td>
1.156 leot 12675: </tr>
12676: <tr>
1.188 leot 12677: <td>PTHREAD_CFLAGS</td>
1.180 rillig 12678: <td>PTHREAD_LDFLAGS</td>
1.156 leot 12679: </tr>
12680: <tr>
1.188 leot 12681: <td>PTHREAD_LIBS</td>
1.180 rillig 12682: <td>PTHREAD_OPTS</td>
1.156 leot 12683: </tr>
12684: <tr>
1.188 leot 12685: <td>PTHREAD_TYPE</td>
1.180 rillig 12686: <td>PVM_SSH</td>
1.156 leot 12687: </tr>
12688: <tr>
1.188 leot 12689: <td>PYPKGPREFIX</td>
1.180 rillig 12690: <td>PYTHON_FOR_BUILD_ONLY</td>
1.156 leot 12691: </tr>
12692: <tr>
1.188 leot 12693: <td>PYTHON_SELF_CONFLICT</td>
1.180 rillig 12694: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.156 leot 12695: </tr>
12696: <tr>
1.188 leot 12697: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.180 rillig 12698: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.156 leot 12699: </tr>
12700: <tr>
1.188 leot 12701: <td>PYTHON_VERSION_DEFAULT</td>
1.180 rillig 12702: <td>PYTHON_VERSION_REQD</td>
1.156 leot 12703: </tr>
12704: <tr>
1.188 leot 12705: <td>PYVERSSUFFIX</td>
1.180 rillig 12706: <td>PY_NO_EGG</td>
1.156 leot 12707: </tr>
12708: <tr>
1.188 leot 12709: <td>QMAILDIR</td>
1.180 rillig 12710: <td>QMAIL_ALIAS_USER</td>
1.156 leot 12711: </tr>
12712: <tr>
1.188 leot 12713: <td>QMAIL_DAEMON_USER</td>
1.180 rillig 12714: <td>QMAIL_LOG_USER</td>
1.156 leot 12715: </tr>
12716: <tr>
1.188 leot 12717: <td>QMAIL_NOFILES_GROUP</td>
1.180 rillig 12718: <td>QMAIL_PASSWD_USER</td>
1.156 leot 12719: </tr>
12720: <tr>
1.188 leot 12721: <td>QMAIL_QMAIL_GROUP</td>
1.180 rillig 12722: <td>QMAIL_QUEUE_DIR</td>
1.156 leot 12723: </tr>
12724: <tr>
1.188 leot 12725: <td>QMAIL_QUEUE_EXTRA</td>
1.180 rillig 12726: <td>QMAIL_QUEUE_USER</td>
1.156 leot 12727: </tr>
12728: <tr>
1.188 leot 12729: <td>QMAIL_REMOTE_USER</td>
1.180 rillig 12730: <td>QMAIL_ROOT_USER</td>
1.156 leot 12731: </tr>
12732: <tr>
1.188 leot 12733: <td>QMAIL_SEND_USER</td>
1.180 rillig 12734: <td>QPOPPER_FAC</td>
1.156 leot 12735: </tr>
12736: <tr>
1.188 leot 12737: <td>QPOPPER_SPOOL_DIR</td>
1.180 rillig 12738: <td>QPOPPER_USER</td>
1.156 leot 12739: </tr>
12740: <tr>
1.188 leot 12741: <td>RAKE_NAME</td>
1.180 rillig 12742: <td>RASMOL_DEPTH</td>
1.156 leot 12743: </tr>
12744: <tr>
1.188 leot 12745: <td>RCD_DIR</td>
1.180 rillig 12746: <td>RCD_ORDER</td>
1.177 leot 12747: </tr>
12748: <tr>
1.188 leot 12749: <td>RCD_SCRIPTS</td>
1.180 rillig 12750: <td>RCD_SCRIPTS_DIR</td>
1.159 rillig 12751: </tr>
12752: <tr>
1.188 leot 12753: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.180 rillig 12754: <td>RCD_SCRIPTS_MODE</td>
1.156 leot 12755: </tr>
12756: <tr>
1.188 leot 12757: <td>RCD_SCRIPTS_SHELL</td>
1.180 rillig 12758: <td>RCD_SCRIPT_SRC</td>
1.156 leot 12759: </tr>
12760: <tr>
1.188 leot 12761: <td>RCD_SUBR</td>
1.180 rillig 12762: <td>RDOC</td>
1.161 leot 12763: </tr>
12764: <tr>
1.188 leot 12765: <td>READLINE_DEFAULT</td>
1.180 rillig 12766: <td>READLINE_TYPE</td>
1.156 leot 12767: </tr>
12768: <tr>
1.188 leot 12769: <td>REAL_ROOT_GROUP</td>
1.180 rillig 12770: <td>REAL_ROOT_USER</td>
1.156 leot 12771: </tr>
12772: <tr>
1.188 leot 12773: <td>RECURSIVE_MAKE</td>
1.180 rillig 12774: <td>RELAY_CTRL_DIR</td>
1.156 leot 12775: </tr>
12776: <tr>
1.188 leot 12777: <td>REPLACE_AWK</td>
1.180 rillig 12778: <td>REPLACE_BASH</td>
1.156 leot 12779: </tr>
12780: <tr>
1.188 leot 12781: <td>REPLACE_CSH</td>
1.180 rillig 12782: <td>REPLACE_KSH</td>
1.156 leot 12783: </tr>
12784: <tr>
1.188 leot 12785: <td>REPLACE_PERL</td>
1.180 rillig 12786: <td>REPLACE_PERL6</td>
1.156 leot 12787: </tr>
12788: <tr>
1.188 leot 12789: <td>REPLACE_PHP</td>
1.180 rillig 12790: <td>REPLACE_PYTHON</td>
1.166 leot 12791: </tr>
12792: <tr>
1.188 leot 12793: <td>REPLACE_RUBY</td>
1.180 rillig 12794: <td>REPLACE_RUBY_DIRS</td>
1.156 leot 12795: </tr>
12796: <tr>
1.188 leot 12797: <td>REPLACE_RUBY_PAT</td>
1.180 rillig 12798: <td>REPLACE_SH</td>
1.156 leot 12799: </tr>
12800: <tr>
1.188 leot 12801: <td>REPLACE_TEXLUA</td>
1.180 rillig 12802: <td>REQD_DIRS</td>
1.156 leot 12803: </tr>
12804: <tr>
1.188 leot 12805: <td>REQD_DIRS_PERMS</td>
1.180 rillig 12806: <td>REQD_FILES</td>
1.156 leot 12807: </tr>
12808: <tr>
1.188 leot 12809: <td>REQD_FILES_MODE</td>
1.180 rillig 12810: <td>REQD_FILES_PERMS</td>
1.156 leot 12811: </tr>
12812: <tr>
1.188 leot 12813: <td>RESOLV_AUTO_VARS</td>
1.180 rillig 12814: <td>RESOLV_LDFLAGS</td>
1.156 leot 12815: </tr>
12816: <tr>
1.188 leot 12817: <td>RESOLV_LIBS</td>
1.180 rillig 12818: <td>RM</td>
1.177 leot 12819: </tr>
12820: <tr>
1.188 leot 12821: <td>ROCKSPEC_NAME</td>
1.180 rillig 12822: <td>ROCKSPEC_SPECFILE</td>
1.156 leot 12823: </tr>
12824: <tr>
1.188 leot 12825: <td>ROOT_CMD</td>
1.180 rillig 12826: <td>ROOT_GROUP</td>
1.156 leot 12827: </tr>
12828: <tr>
1.188 leot 12829: <td>ROOT_USER</td>
1.180 rillig 12830: <td>RPCGEN</td>
1.156 leot 12831: </tr>
12832: <tr>
1.188 leot 12833: <td>RPM</td>
1.180 rillig 12834: <td>RPM2PKG_PLIST</td>
1.156 leot 12835: </tr>
12836: <tr>
1.188 leot 12837: <td>RPM2PKG_PREFIX</td>
1.180 rillig 12838: <td>RPM2PKG_STAGE</td>
1.156 leot 12839: </tr>
12840: <tr>
1.188 leot 12841: <td>RPM2PKG_STRIP</td>
1.180 rillig 12842: <td>RPM2PKG_SUBPREFIX</td>
1.156 leot 12843: </tr>
12844: <tr>
1.188 leot 12845: <td>RPMFILES</td>
1.180 rillig 12846: <td>RPMIGNOREPATH</td>
1.156 leot 12847: </tr>
12848: <tr>
1.188 leot 12849: <td>RPM_DB_PREFIX</td>
1.180 rillig 12850: <td>RSSH_CVS_PATH</td>
1.156 leot 12851: </tr>
12852: <tr>
1.188 leot 12853: <td>RSSH_RDIST_PATH</td>
1.180 rillig 12854: <td>RSSH_RSYNC_PATH</td>
1.156 leot 12855: </tr>
12856: <tr>
1.188 leot 12857: <td>RSSH_SCP_PATH</td>
1.180 rillig 12858: <td>RSSH_SFTP_SERVER_PATH</td>
1.156 leot 12859: </tr>
12860: <tr>
1.188 leot 12861: <td>RUBY</td>
1.180 rillig 12862: <td>RUBYGEM</td>
1.156 leot 12863: </tr>
12864: <tr>
1.188 leot 12865: <td>RUBYGEM_NAME</td>
1.180 rillig 12866: <td>RUBYGEM_OPTIONS</td>
1.156 leot 12867: </tr>
12868: <tr>
1.188 leot 12869: <td>RUBY_ABI_VERSION</td>
1.180 rillig 12870: <td>RUBY_ARCH</td>
1.156 leot 12871: </tr>
12872: <tr>
1.188 leot 12873: <td>RUBY_ARCHINC</td>
1.180 rillig 12874: <td>RUBY_ARCHLIB</td>
1.156 leot 12875: </tr>
12876: <tr>
1.188 leot 12877: <td>RUBY_BASE</td>
1.180 rillig 12878: <td>RUBY_BASERIDIR</td>
1.156 leot 12879: </tr>
12880: <tr>
1.188 leot 12881: <td>RUBY_BUILD_DOCUMENT</td>
1.180 rillig 12882: <td>RUBY_DLEXT</td>
1.156 leot 12883: </tr>
12884: <tr>
1.188 leot 12885: <td>RUBY_DOC</td>
1.180 rillig 12886: <td>RUBY_DYNAMIC_DIRS</td>
1.156 leot 12887: </tr>
12888: <tr>
1.188 leot 12889: <td>RUBY_EG</td>
1.180 rillig 12890: <td>RUBY_ENCODING_ARG</td>
1.156 leot 12891: </tr>
12892: <tr>
1.188 leot 12893: <td>RUBY_EXTCONF</td>
1.180 rillig 12894: <td>RUBY_EXTCONF_CHECK</td>
1.156 leot 12895: </tr>
12896: <tr>
1.188 leot 12897: <td>RUBY_EXTCONF_DEBUG</td>
1.180 rillig 12898: <td>RUBY_EXTCONF_MAKEFILE</td>
1.156 leot 12899: </tr>
12900: <tr>
1.188 leot 12901: <td>RUBY_GEM_BASE</td>
1.180 rillig 12902: <td>RUBY_INC</td>
1.156 leot 12903: </tr>
12904: <tr>
1.188 leot 12905: <td>RUBY_LIB</td>
1.180 rillig 12906: <td>RUBY_LIB_BASE</td>
1.156 leot 12907: </tr>
12908: <tr>
1.188 leot 12909: <td>RUBY_NAME</td>
1.180 rillig 12910: <td>RUBY_NOVERSION</td>
1.156 leot 12911: </tr>
12912: <tr>
1.188 leot 12913: <td>RUBY_PKGPREFIX</td>
1.180 rillig 12914: <td>RUBY_RAILS</td>
1.156 leot 12915: </tr>
12916: <tr>
1.188 leot 12917: <td>RUBY_RAILS51_VERSION</td>
1.180 rillig 12918: <td>RUBY_RAILS52_VERSION</td>
1.156 leot 12919: </tr>
12920: <tr>
1.188 leot 12921: <td>RUBY_RAILS60_VERSION</td>
1.180 rillig 12922: <td>RUBY_RAILS_ACCEPTED</td>
1.174 leot 12923: </tr>
12924: <tr>
1.188 leot 12925: <td>RUBY_RAILS_DEFAULT</td>
1.180 rillig 12926: <td>RUBY_RAILS_REQD</td>
1.156 leot 12927: </tr>
12928: <tr>
1.188 leot 12929: <td>RUBY_RAILS_STRICT_DEP</td>
1.180 rillig 12930: <td>RUBY_RIDIR</td>
1.156 leot 12931: </tr>
12932: <tr>
1.188 leot 12933: <td>RUBY_SETUP</td>
1.180 rillig 12934: <td>RUBY_SHLIB</td>
1.156 leot 12935: </tr>
12936: <tr>
1.188 leot 12937: <td>RUBY_SHLIBALIAS</td>
1.180 rillig 12938: <td>RUBY_SHLIBVER</td>
1.156 leot 12939: </tr>
12940: <tr>
1.188 leot 12941: <td>RUBY_SIMPLE_INSTALL</td>
1.180 rillig 12942: <td>RUBY_SITEARCHLIB</td>
1.156 leot 12943: </tr>
12944: <tr>
1.188 leot 12945: <td>RUBY_SITELIB</td>
1.180 rillig 12946: <td>RUBY_SITELIB_BASE</td>
1.156 leot 12947: </tr>
12948: <tr>
1.188 leot 12949: <td>RUBY_SITERIDIR</td>
1.180 rillig 12950: <td>RUBY_SLEXT</td>
1.156 leot 12951: </tr>
12952: <tr>
1.188 leot 12953: <td>RUBY_SRCDIR</td>
1.180 rillig 12954: <td>RUBY_STATICLIB</td>
1.156 leot 12955: </tr>
12956: <tr>
1.188 leot 12957: <td>RUBY_SUFFIX</td>
1.180 rillig 12958: <td>RUBY_SYSRIDIR</td>
1.156 leot 12959: </tr>
12960: <tr>
1.188 leot 12961: <td>RUBY_USE_PTHREAD</td>
1.180 rillig 12962: <td>RUBY_VENDORARCHLIB</td>
1.156 leot 12963: </tr>
12964: <tr>
1.188 leot 12965: <td>RUBY_VENDORLIB</td>
1.180 rillig 12966: <td>RUBY_VENDORLIB_BASE</td>
1.156 leot 12967: </tr>
12968: <tr>
1.188 leot 12969: <td>RUBY_VER</td>
1.180 rillig 12970: <td>RUBY_VERSION</td>
1.156 leot 12971: </tr>
12972: <tr>
1.188 leot 12973: <td>RUBY_VERSIONS_ACCEPTED</td>
1.180 rillig 12974: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.156 leot 12975: </tr>
12976: <tr>
1.188 leot 12977: <td>RUBY_VERSION_DEFAULT</td>
1.180 rillig 12978: <td>RUBY_VERSION_REQD</td>
1.156 leot 12979: </tr>
12980: <tr>
1.188 leot 12981: <td>RUBY_VER_DIR</td>
1.180 rillig 12982: <td>RUN</td>
1.156 leot 12983: </tr>
12984: <tr>
1.188 leot 12985: <td>RUN_LDCONFIG</td>
1.180 rillig 12986: <td>SAWFISH_THEMES</td>
1.156 leot 12987: </tr>
12988: <tr>
1.188 leot 12989: <td>SCO</td>
1.180 rillig 12990: <td>SCREWS_GROUP</td>
1.156 leot 12991: </tr>
12992: <tr>
1.188 leot 12993: <td>SCREWS_USER</td>
1.180 rillig 12994: <td>SCRIPTS_ENV</td>
1.156 leot 12995: </tr>
12996: <tr>
1.188 leot 12997: <td>SCROLLKEEPER_DATADIR</td>
1.180 rillig 12998: <td>SCROLLKEEPER_REBUILDDB</td>
1.156 leot 12999: </tr>
13000: <tr>
1.188 leot 13001: <td>SCROLLKEEPER_UPDATEDB</td>
1.180 rillig 13002: <td>SDIST_PAWD</td>
1.156 leot 13003: </tr>
13004: <tr>
1.188 leot 13005: <td>SERIAL_DEVICES</td>
1.180 rillig 13006: <td>SETGIDGAME</td>
1.156 leot 13007: </tr>
13008: <tr>
1.188 leot 13009: <td>SETGID_GAMES_PERMS</td>
1.180 rillig 13010: <td>SETUID_ROOT_PERMS</td>
1.156 leot 13011: </tr>
13012: <tr>
1.188 leot 13013: <td>SH</td>
1.180 rillig 13014: <td>SHLIB</td>
1.177 leot 13015: </tr>
13016: <tr>
1.188 leot 13017: <td>SHORTNAME</td>
1.180 rillig 13018: <td>SIGN_PACKAGES</td>
1.156 leot 13019: </tr>
13020: <tr>
1.188 leot 13021: <td>SILC_CLIENT_WITH_PERL</td>
1.180 rillig 13022: <td>SITE_SPECIFIC_PKGS</td>
1.156 leot 13023: </tr>
13024: <tr>
1.188 leot 13025: <td>SKIP_DEPENDS</td>
1.180 rillig 13026: <td>SMF_INSTANCES</td>
1.159 rillig 13027: </tr>
13028: <tr>
1.188 leot 13029: <td>SMF_MANIFEST</td>
1.180 rillig 13030: <td>SMF_METHODS</td>
1.156 leot 13031: </tr>
13032: <tr>
1.188 leot 13033: <td>SMF_METHOD_SHELL</td>
1.180 rillig 13034: <td>SMF_METHOD_SRC</td>
1.156 leot 13035: </tr>
13036: <tr>
1.188 leot 13037: <td>SMF_NAME</td>
1.180 rillig 13038: <td>SMF_PREFIX</td>
1.156 leot 13039: </tr>
13040: <tr>
1.188 leot 13041: <td>SMF_SRCDIR</td>
1.180 rillig 13042: <td>SNIPROXY_GROUP</td>
1.156 leot 13043: </tr>
13044: <tr>
1.188 leot 13045: <td>SNIPROXY_USER</td>
1.180 rillig 13046: <td>SOURCE_BUFFSIZE</td>
1.156 leot 13047: </tr>
13048: <tr>
1.188 leot 13049: <td>SPECIAL_PERMS</td>
1.180 rillig 13050: <td>SPECIFIC_PKGS</td>
1.156 leot 13051: </tr>
13052: <tr>
1.188 leot 13053: <td>SSH_SUID</td>
1.180 rillig 13054: <td>SSP_SUPPORTED</td>
1.156 leot 13055: </tr>
13056: <tr>
1.188 leot 13057: <td>SSYNC_PAWD</td>
1.180 rillig 13058: <td>STEP_MSG</td>
1.156 leot 13059: </tr>
13060: <tr>
1.188 leot 13061: <td>STRIP</td>
1.180 rillig 13062: <td>STRIP_DBG</td>
1.156 leot 13063: </tr>
13064: <tr>
1.188 leot 13065: <td>STRIP_DEBUG</td>
1.180 rillig 13066: <td>STRIP_DEBUG_SUPPORTED</td>
1.156 leot 13067: </tr>
13068: <tr>
1.188 leot 13069: <td>STRIP_FILES_SKIP</td>
1.180 rillig 13070: <td>SU</td>
1.156 leot 13071: </tr>
13072: <tr>
1.188 leot 13073: <td>SUBDIR</td>
1.180 rillig 13074: <td>SUBST</td>
1.174 leot 13075: </tr>
13076: <tr>
1.188 leot 13077: <td>SUBST_CLASSES</td>
1.180 rillig 13078: <td>SUBST_FILES</td>
1.156 leot 13079: </tr>
13080: <tr>
1.188 leot 13081: <td>SUBST_FILTER_CMD</td>
1.180 rillig 13082: <td>SUBST_MESSAGE</td>
1.156 leot 13083: </tr>
13084: <tr>
1.188 leot 13085: <td>SUBST_NOOP_OK</td>
1.180 rillig 13086: <td>SUBST_SED</td>
1.156 leot 13087: </tr>
13088: <tr>
1.188 leot 13089: <td>SUBST_SHOW_DIFF</td>
1.180 rillig 13090: <td>SUBST_SKIP_TEXT_CHECK</td>
1.156 leot 13091: </tr>
13092: <tr>
1.188 leot 13093: <td>SUBST_STAGE</td>
1.180 rillig 13094: <td>SUBST_VARS</td>
1.156 leot 13095: </tr>
13096: <tr>
1.188 leot 13097: <td>SUNWSPROBASE</td>
1.180 rillig 13098: <td>SUSE_PREFER</td>
1.177 leot 13099: </tr>
13100: <tr>
1.188 leot 13101: <td>SU_CMD</td>
1.180 rillig 13102: <td>SVN_EXTRACTDIR</td>
1.177 leot 13103: </tr>
13104: <tr>
1.188 leot 13105: <td>SVN_REPO</td>
1.180 rillig 13106: <td>SVN_REPOSITORIES</td>
1.156 leot 13107: </tr>
13108: <tr>
1.188 leot 13109: <td>SVN_REVISION</td>
1.189 ! bacon 13110: <td>TBL</td>
! 13111: </tr>
! 13112: <tr>
1.180 rillig 13113: <td>TERMCAP_TYPE</td>
1.189 ! bacon 13114: <td>TERMINFO_DEFAULT</td>
1.161 leot 13115: </tr>
13116: <tr>
1.180 rillig 13117: <td>TERMINFO_TYPE</td>
1.189 ! bacon 13118: <td>TEST</td>
1.159 rillig 13119: </tr>
13120: <tr>
1.180 rillig 13121: <td>TEST_DEPENDS</td>
1.189 ! bacon 13122: <td>TEST_DIRS</td>
1.156 leot 13123: </tr>
13124: <tr>
1.180 rillig 13125: <td>TEST_ENV</td>
1.189 ! bacon 13126: <td>TEST_ENV_SHELL</td>
1.156 leot 13127: </tr>
13128: <tr>
1.180 rillig 13129: <td>TEST_MAKE_CMD</td>
1.189 ! bacon 13130: <td>TEST_MAKE_FLAGS</td>
1.156 leot 13131: </tr>
13132: <tr>
1.180 rillig 13133: <td>TEST_TARGET</td>
1.189 ! bacon 13134: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.156 leot 13135: </tr>
13136: <tr>
1.180 rillig 13137: <td>TEXLIVE_REV</td>
1.189 ! bacon 13138: <td>TEXLIVE_UNVERSIONED</td>
1.156 leot 13139: </tr>
13140: <tr>
1.180 rillig 13141: <td>TEXMFSITE</td>
1.189 ! bacon 13142: <td>TEX_FORMATS</td>
1.156 leot 13143: </tr>
13144: <tr>
1.180 rillig 13145: <td>TEX_HYPHEN_DAT</td>
1.189 ! bacon 13146: <td>TEX_HYPHEN_DEF</td>
1.156 leot 13147: </tr>
13148: <tr>
1.180 rillig 13149: <td>TEX_TEXMF_DIRS</td>
1.189 ! bacon 13150: <td>THTTPD_LOG_FACILITY</td>
1.156 leot 13151: </tr>
13152: <tr>
1.180 rillig 13153: <td>TO</td>
1.189 ! bacon 13154: <td>TOOLS_ALIASES</td>
1.156 leot 13155: </tr>
13156: <tr>
1.180 rillig 13157: <td>TOOLS_ALWAYS_WRAP</td>
1.189 ! bacon 13158: <td>TOOLS_ARGS</td>
1.156 leot 13159: </tr>
13160: <tr>
1.180 rillig 13161: <td>TOOLS_BROKEN</td>
1.189 ! bacon 13162: <td>TOOLS_CMD</td>
1.156 leot 13163: </tr>
13164: <tr>
1.189 ! bacon 13165: <td>TOOLS_CMDLINE_SED</td>
1.180 rillig 13166: <td>TOOLS_CREATE</td>
1.156 leot 13167: </tr>
13168: <tr>
1.188 leot 13169: <td>TOOLS_DIR</td>
1.180 rillig 13170: <td>TOOLS_FAIL</td>
1.156 leot 13171: </tr>
13172: <tr>
1.188 leot 13173: <td>TOOLS_GNU_MISSING</td>
1.180 rillig 13174: <td>TOOLS_LDCONFIG</td>
1.156 leot 13175: </tr>
13176: <tr>
1.188 leot 13177: <td>TOOLS_NOOP</td>
1.180 rillig 13178: <td>TOOLS_PATH</td>
1.156 leot 13179: </tr>
13180: <tr>
1.188 leot 13181: <td>TOOLS_SCRIPT</td>
1.180 rillig 13182: <td>TOOL_DEPENDS</td>
1.161 leot 13183: </tr>
13184: <tr>
1.188 leot 13185: <td>TTF_FONTDIR</td>
1.180 rillig 13186: <td>TTF_FONTS_DIR</td>
1.156 leot 13187: </tr>
13188: <tr>
1.188 leot 13189: <td>TYPE</td>
1.180 rillig 13190: <td>UAC_REQD_EXECS</td>
1.156 leot 13191: </tr>
13192: <tr>
1.188 leot 13193: <td>UCSPI_SSL_GROUP</td>
1.180 rillig 13194: <td>UCSPI_SSL_USER</td>
1.156 leot 13195: </tr>
13196: <tr>
1.188 leot 13197: <td>UNLIMIT_RESOURCES</td>
1.180 rillig 13198: <td>UNPRIVILEGED</td>
1.156 leot 13199: </tr>
13200: <tr>
1.188 leot 13201: <td>UNPRIVILEGED_GROUP</td>
1.180 rillig 13202: <td>UNPRIVILEGED_GROUPS</td>
1.156 leot 13203: </tr>
13204: <tr>
1.188 leot 13205: <td>UNPRIVILEGED_USER</td>
1.180 rillig 13206: <td>UNWRAP_FILES</td>
1.156 leot 13207: </tr>
13208: <tr>
1.188 leot 13209: <td>UNWRAP_PATTERNS</td>
1.180 rillig 13210: <td>UPDATE_GEMSPEC</td>
1.156 leot 13211: </tr>
13212: <tr>
1.188 leot 13213: <td>UPDATE_TARGET</td>
1.180 rillig 13214: <td>URI</td>
1.156 leot 13215: </tr>
13216: <tr>
1.188 leot 13217: <td>USERGROUP_PHASE</td>
1.180 rillig 13218: <td>USERPPP_GROUP</td>
1.156 leot 13219: </tr>
13220: <tr>
1.188 leot 13221: <td>USER_SPECIFIC_PKGS</td>
1.180 rillig 13222: <td>USE_ABI_DEPENDS</td>
1.156 leot 13223: </tr>
13224: <tr>
1.188 leot 13225: <td>USE_APR</td>
1.180 rillig 13226: <td>USE_BSD_MAKEFILE</td>
1.156 leot 13227: </tr>
13228: <tr>
1.188 leot 13229: <td>USE_BUILTIN</td>
1.180 rillig 13230: <td>USE_CROSS_COMPILE</td>
1.156 leot 13231: </tr>
13232: <tr>
1.188 leot 13233: <td>USE_CURSES</td>
1.180 rillig 13234: <td>USE_CWRAPPERS</td>
1.156 leot 13235: </tr>
13236: <tr>
1.188 leot 13237: <td>USE_DB185</td>
1.180 rillig 13238: <td>USE_FEATURES</td>
1.156 leot 13239: </tr>
13240: <tr>
1.188 leot 13241: <td>USE_GAMESGROUP</td>
1.180 rillig 13242: <td>USE_GCC_RUNTIME</td>
1.156 leot 13243: </tr>
13244: <tr>
1.188 leot 13245: <td>USE_IMAKE</td>
1.180 rillig 13246: <td>USE_JAVA</td>
1.156 leot 13247: </tr>
13248: <tr>
1.188 leot 13249: <td>USE_JAVA2</td>
1.180 rillig 13250: <td>USE_LANGUAGES</td>
1.156 leot 13251: </tr>
13252: <tr>
1.188 leot 13253: <td>USE_LIBTOOL</td>
1.180 rillig 13254: <td>USE_NATIVE_GCC</td>
1.156 leot 13255: </tr>
13256: <tr>
1.188 leot 13257: <td>USE_NETBSD_REPO</td>
1.180 rillig 13258: <td>USE_PKGSRC_GCC</td>
1.156 leot 13259: </tr>
13260: <tr>
1.188 leot 13261: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.180 rillig 13262: <td>USE_PKGTASKS</td>
1.156 leot 13263: </tr>
13264: <tr>
1.188 leot 13265: <td>USE_PKG_ADMIN_DIGEST</td>
1.180 rillig 13266: <td>USE_RUBY_EXTCONF</td>
1.156 leot 13267: </tr>
13268: <tr>
1.188 leot 13269: <td>USE_RUBY_INSTALL</td>
1.180 rillig 13270: <td>USE_RUBY_SETUP</td>
1.156 leot 13271: </tr>
13272: <tr>
1.188 leot 13273: <td>USE_RUBY_SETUP_PKG</td>
1.180 rillig 13274: <td>USE_TOOLS</td>
1.156 leot 13275: </tr>
13276: <tr>
1.188 leot 13277: <td>UUCP_GROUP</td>
1.180 rillig 13278: <td>UUCP_USER</td>
1.156 leot 13279: </tr>
13280: <tr>
1.188 leot 13281: <td>VARBASE</td>
1.180 rillig 13282: <td>VARNAME</td>
1.156 leot 13283: </tr>
13284: <tr>
1.188 leot 13285: <td>VIM_EXTRA_OPTS</td>
1.180 rillig 13286: <td>WARNING_MSG</td>
1.156 leot 13287: </tr>
13288: <tr>
1.188 leot 13289: <td>WCALC_CGIDIR</td>
1.180 rillig 13290: <td>WCALC_CGIPATH</td>
1.156 leot 13291: </tr>
13292: <tr>
1.188 leot 13293: <td>WCALC_HTMLDIR</td>
1.180 rillig 13294: <td>WCALC_HTMLPATH</td>
1.156 leot 13295: </tr>
13296: <tr>
1.188 leot 13297: <td>WDM_MANAGERS</td>
1.189 ! bacon 13298: <td>WRAPPER_CC</td>
! 13299: </tr>
! 13300: <tr>
1.180 rillig 13301: <td>WRAPPER_REORDER_CMDS</td>
1.189 ! bacon 13302: <td>WRKDIR</td>
1.156 leot 13303: </tr>
13304: <tr>
1.180 rillig 13305: <td>WRKDIR_BASENAME</td>
1.189 ! bacon 13306: <td>WRKDIR_LOCKTYPE</td>
1.156 leot 13307: </tr>
13308: <tr>
1.180 rillig 13309: <td>WRKLOG</td>
1.189 ! bacon 13310: <td>WRKOBJDIR</td>
1.156 leot 13311: </tr>
13312: <tr>
1.180 rillig 13313: <td>WRKSRC</td>
1.189 ! bacon 13314: <td>X10_PORT</td>
1.156 leot 13315: </tr>
13316: <tr>
1.180 rillig 13317: <td>X11</td>
1.189 ! bacon 13318: <td>X11BASE</td>
1.156 leot 13319: </tr>
13320: <tr>
1.180 rillig 13321: <td>X11_PKGSRCDIR</td>
1.189 ! bacon 13322: <td>X11_TYPE</td>
1.156 leot 13323: </tr>
13324: <tr>
1.180 rillig 13325: <td>X509_CERTIFICATE</td>
1.189 ! bacon 13326: <td>X509_KEY</td>
1.156 leot 13327: </tr>
13328: <tr>
1.180 rillig 13329: <td>XAW_TYPE</td>
1.189 ! bacon 13330: <td>XLOCK_DEFAULT_MODE</td>
1.156 leot 13331: </tr>
13332: <tr>
1.189 ! bacon 13333: <td>XMKMF</td>
1.180 rillig 13334: <td>XMKMF_FLAGS</td>
1.156 leot 13335: </tr>
13336: <tr>
1.188 leot 13337: <td>XXX</td>
1.180 rillig 13338: <td>XXXX</td>
1.159 rillig 13339: </tr>
13340: <tr>
1.188 leot 13341: <td>YES</td>
1.180 rillig 13342: <td>ZSH_STATIC</td>
1.156 leot 13343: </tr>
13344: <tr>
1.188 leot 13345: <td>__stdc__</td>
1.180 rillig 13346: <td>_vargroups</td>
1.174 leot 13347: </tr>
13348: <tr>
1.188 leot 13349: <td>accept</td>
1.180 rillig 13350: <td>acquire-localbase-lock</td>
1.156 leot 13351: </tr>
13352: <tr>
1.188 leot 13353: <td>acquire-lock</td>
1.180 rillig 13354: <td>add</td>
1.156 leot 13355: </tr>
13356: <tr>
1.188 leot 13357: <td>administrator</td>
1.180 rillig 13358: <td>alloca</td>
1.174 leot 13359: </tr>
13360: <tr>
1.188 leot 13361: <td>alternatives</td>
1.180 rillig 13362: <td>aslr</td>
1.156 leot 13363: </tr>
13364: <tr>
1.188 leot 13365: <td>asprintf</td>
1.180 rillig 13366: <td>atlas</td>
1.161 leot 13367: </tr>
13368: <tr>
1.188 leot 13369: <td>autoconf</td>
1.180 rillig 13370: <td>automake</td>
1.156 leot 13371: </tr>
13372: <tr>
1.188 leot 13373: <td>autoreconf</td>
1.180 rillig 13374: <td>awk</td>
1.156 leot 13375: </tr>
13376: <tr>
1.188 leot 13377: <td>bash</td>
1.180 rillig 13378: <td>big-endian</td>
1.156 leot 13379: </tr>
13380: <tr>
1.188 leot 13381: <td>bin-install</td>
1.180 rillig 13382: <td>bind</td>
1.177 leot 13383: </tr>
13384: <tr>
1.188 leot 13385: <td>binpkg-list</td>
1.180 rillig 13386: <td>blas</td>
1.159 rillig 13387: </tr>
13388: <tr>
1.188 leot 13389: <td>bootstrap-depends</td>
1.180 rillig 13390: <td>broken</td>
1.156 leot 13391: </tr>
13392: <tr>
1.188 leot 13393: <td>broken_on_platform</td>
1.180 rillig 13394: <td>bsd</td>
1.174 leot 13395: </tr>
13396: <tr>
1.188 leot 13397: <td>bsd.prog.mk</td>
1.180 rillig 13398: <td>build</td>
1.156 leot 13399: </tr>
13400: <tr>
1.188 leot 13401: <td>build-env</td>
1.180 rillig 13402: <td>buildlink-directories</td>
1.156 leot 13403: </tr>
13404: <tr>
1.188 leot 13405: <td>buildlink-oss-soundcard-h</td>
1.180 rillig 13406: <td>c</td>
1.156 leot 13407: </tr>
13408: <tr>
1.188 leot 13409: <td>c++</td>
1.180 rillig 13410: <td>ccache</td>
1.156 leot 13411: </tr>
13412: <tr>
1.188 leot 13413: <td>cce</td>
1.180 rillig 13414: <td>cdefs</td>
1.174 leot 13415: </tr>
13416: <tr>
1.188 leot 13417: <td>ceil</td>
1.180 rillig 13418: <td>changes</td>
1.156 leot 13419: </tr>
13420: <tr>
1.188 leot 13421: <td>changes-entry</td>
1.180 rillig 13422: <td>changes-entry-noupdate</td>
1.156 leot 13423: </tr>
13424: <tr>
1.188 leot 13425: <td>check</td>
1.180 rillig 13426: <td>check-clean</td>
1.156 leot 13427: </tr>
13428: <tr>
1.188 leot 13429: <td>check-files</td>
1.180 rillig 13430: <td>check-files-clean</td>
1.156 leot 13431: </tr>
13432: <tr>
1.188 leot 13433: <td>check-vulnerable</td>
1.180 rillig 13434: <td>checksum</td>
1.156 leot 13435: </tr>
13436: <tr>
1.188 leot 13437: <td>checksum-phase</td>
1.180 rillig 13438: <td>clean</td>
1.156 leot 13439: </tr>
13440: <tr>
1.188 leot 13441: <td>clean-depends</td>
1.180 rillig 13442: <td>cleandir</td>
1.156 leot 13443: </tr>
13444: <tr>
1.188 leot 13445: <td>commit</td>
1.180 rillig 13446: <td>commit-changes-entry</td>
1.156 leot 13447: </tr>
13448: <tr>
1.188 leot 13449: <td>compact</td>
1.180 rillig 13450: <td>compiler</td>
1.156 leot 13451: </tr>
13452: <tr>
1.188 leot 13453: <td>conf</td>
1.180 rillig 13454: <td>config.guess</td>
1.156 leot 13455: </tr>
13456: <tr>
1.188 leot 13457: <td>config.sub</td>
1.180 rillig 13458: <td>configuration</td>
1.156 leot 13459: </tr>
13460: <tr>
1.188 leot 13461: <td>configure</td>
1.180 rillig 13462: <td>configure-env</td>
1.156 leot 13463: </tr>
13464: <tr>
1.188 leot 13465: <td>configure-help</td>
1.180 rillig 13466: <td>configure_args</td>
1.156 leot 13467: </tr>
13468: <tr>
1.188 leot 13469: <td>connect</td>
1.180 rillig 13470: <td>cos</td>
1.174 leot 13471: </tr>
13472: <tr>
1.188 leot 13473: <td>cputime</td>
1.180 rillig 13474: <td>create-usergroup</td>
1.156 leot 13475: </tr>
13476: <tr>
1.188 leot 13477: <td>csh</td>
1.180 rillig 13478: <td>ctf</td>
1.161 leot 13479: </tr>
13480: <tr>
1.188 leot 13481: <td>cvs</td>
1.180 rillig 13482: <td>debug</td>
1.156 leot 13483: </tr>
13484: <tr>
1.188 leot 13485: <td>declaration</td>
1.180 rillig 13486: <td>declare</td>
1.156 leot 13487: </tr>
13488: <tr>
1.188 leot 13489: <td>defined</td>
1.180 rillig 13490: <td>depend</td>
1.156 leot 13491: </tr>
13492: <tr>
1.188 leot 13493: <td>dependencies</td>
1.180 rillig 13494: <td>depends</td>
1.156 leot 13495: </tr>
13496: <tr>
1.188 leot 13497: <td>depends-checksum</td>
1.180 rillig 13498: <td>depends-fetch</td>
1.156 leot 13499: </tr>
13500: <tr>
1.188 leot 13501: <td>deps</td>
1.180 rillig 13502: <td>describe</td>
1.156 leot 13503: </tr>
13504: <tr>
1.188 leot 13505: <td>destdir</td>
1.180 rillig 13506: <td>disable</td>
1.162 rillig 13507: </tr>
13508: <tr>
1.188 leot 13509: <td>distclean</td>
1.180 rillig 13510: <td>distinfo</td>
1.156 leot 13511: </tr>
13512: <tr>
1.188 leot 13513: <td>dl</td>
1.180 rillig 13514: <td>dlopen</td>
1.156 leot 13515: </tr>
13516: <tr>
1.188 leot 13517: <td>do-build</td>
1.180 rillig 13518: <td>do-buildlink</td>
1.156 leot 13519: </tr>
13520: <tr>
1.188 leot 13521: <td>do-clean</td>
1.180 rillig 13522: <td>do-configure</td>
1.170 rillig 13523: </tr>
13524: <tr>
1.188 leot 13525: <td>do-configure-post-hook</td>
1.180 rillig 13526: <td>do-extract</td>
1.177 leot 13527: </tr>
13528: <tr>
1.188 leot 13529: <td>do-fetch</td>
1.180 rillig 13530: <td>do-install</td>
1.174 leot 13531: </tr>
13532: <tr>
1.188 leot 13533: <td>emul</td>
1.180 rillig 13534: <td>emul-distinfo</td>
1.156 leot 13535: </tr>
13536: <tr>
1.188 leot 13537: <td>emul-fetch</td>
1.180 rillig 13538: <td>emulation</td>
1.159 rillig 13539: </tr>
13540: <tr>
1.188 leot 13541: <td>emulator</td>
1.180 rillig 13542: <td>enable</td>
1.156 leot 13543: </tr>
13544: <tr>
1.188 leot 13545: <td>endian</td>
1.180 rillig 13546: <td>endif</td>
1.156 leot 13547: </tr>
13548: <tr>
1.188 leot 13549: <td>enomem</td>
1.180 rillig 13550: <td>err</td>
1.156 leot 13551: </tr>
13552: <tr>
1.188 leot 13553: <td>errx</td>
1.180 rillig 13554: <td>etc</td>
1.174 leot 13555: </tr>
13556: <tr>
1.188 leot 13557: <td>exp</td>
1.180 rillig 13558: <td>extract-rpm</td>
1.156 leot 13559: </tr>
13560: <tr>
1.188 leot 13561: <td>fabs</td>
1.180 rillig 13562: <td>feature</td>
1.156 leot 13563: </tr>
13564: <tr>
1.188 leot 13565: <td>features</td>
1.180 rillig 13566: <td>fetch</td>
1.156 leot 13567: </tr>
13568: <tr>
1.188 leot 13569: <td>fetch-list</td>
1.180 rillig 13570: <td>follows</td>
1.156 leot 13571: </tr>
13572: <tr>
1.188 leot 13573: <td>forbids</td>
1.180 rillig 13574: <td>form</td>
1.156 leot 13575: </tr>
13576: <tr>
1.188 leot 13577: <td>format</td>
1.180 rillig 13578: <td>fortify</td>
1.177 leot 13579: </tr>
13580: <tr>
1.188 leot 13581: <td>fortify_source</td>
1.180 rillig 13582: <td>fossil</td>
1.156 leot 13583: </tr>
13584: <tr>
1.188 leot 13585: <td>friend</td>
1.180 rillig 13586: <td>fts</td>
1.156 leot 13587: </tr>
13588: <tr>
1.188 leot 13589: <td>fts_close</td>
1.180 rillig 13590: <td>fts_open</td>
1.156 leot 13591: </tr>
13592: <tr>
1.188 leot 13593: <td>fts_read</td>
1.180 rillig 13594: <td>fts_set</td>
1.174 leot 13595: </tr>
13596: <tr>
1.188 leot 13597: <td>gcc</td>
1.180 rillig 13598: <td>gethostbyaddr</td>
1.156 leot 13599: </tr>
13600: <tr>
1.188 leot 13601: <td>gethostbyname</td>
1.180 rillig 13602: <td>gethostbyname2</td>
1.156 leot 13603: </tr>
13604: <tr>
1.188 leot 13605: <td>getopt_long</td>
1.180 rillig 13606: <td>getprogname</td>
1.174 leot 13607: </tr>
13608: <tr>
1.188 leot 13609: <td>getservbyname</td>
1.180 rillig 13610: <td>getservbyport</td>
1.174 leot 13611: </tr>
13612: <tr>
1.188 leot 13613: <td>getservent</td>
1.180 rillig 13614: <td>gettext</td>
1.156 leot 13615: </tr>
13616: <tr>
1.188 leot 13617: <td>git</td>
1.180 rillig 13618: <td>github</td>
1.177 leot 13619: </tr>
13620: <tr>
1.188 leot 13621: <td>gitlab</td>
1.180 rillig 13622: <td>glob</td>
1.159 rillig 13623: </tr>
13624: <tr>
1.188 leot 13625: <td>gnu</td>
1.180 rillig 13626: <td>gnu_configure_strict</td>
1.156 leot 13627: </tr>
13628: <tr>
1.188 leot 13629: <td>go</td>
1.180 rillig 13630: <td>go-deps</td>
1.156 leot 13631: </tr>
13632: <tr>
1.188 leot 13633: <td>golang</td>
1.180 rillig 13634: <td>guess-license</td>
1.156 leot 13635: </tr>
13636: <tr>
1.188 leot 13637: <td>hashbang</td>
1.180 rillig 13638: <td>heimdal</td>
1.156 leot 13639: </tr>
13640: <tr>
1.188 leot 13641: <td>help</td>
1.180 rillig 13642: <td>hg</td>
1.161 leot 13643: </tr>
13644: <tr>
1.188 leot 13645: <td>imake</td>
1.180 rillig 13646: <td>increment</td>
1.156 leot 13647: </tr>
13648: <tr>
1.188 leot 13649: <td>inet_aton</td>
1.180 rillig 13650: <td>interp</td>
1.156 leot 13651: </tr>
13652: <tr>
1.188 leot 13653: <td>interpreter</td>
1.180 rillig 13654: <td>intl</td>
1.156 leot 13655: </tr>
13656: <tr>
1.189 ! bacon 13657: <td>ip4</td>
! 13658: <td>ip6</td>
! 13659: </tr>
! 13660: <tr>
! 13661: <td>ipv4</td>
! 13662: <td>ipv6</td>
! 13663: </tr>
! 13664: <tr>
1.188 leot 13665: <td>iso</td>
1.180 rillig 13666: <td>kerberos</td>
1.156 leot 13667: </tr>
13668: <tr>
1.188 leot 13669: <td>krb</td>
1.180 rillig 13670: <td>krb5</td>
1.177 leot 13671: </tr>
13672: <tr>
1.188 leot 13673: <td>ksh</td>
1.180 rillig 13674: <td>lapack</td>
1.156 leot 13675: </tr>
13676: <tr>
1.188 leot 13677: <td>latex</td>
1.180 rillig 13678: <td>libintl_bindtextdomain</td>
1.174 leot 13679: </tr>
13680: <tr>
1.188 leot 13681: <td>libintl_gettext</td>
1.180 rillig 13682: <td>libintl_textdomain</td>
1.159 rillig 13683: </tr>
13684: <tr>
1.188 leot 13685: <td>libnbcompat</td>
1.180 rillig 13686: <td>libs</td>
1.156 leot 13687: </tr>
13688: <tr>
1.188 leot 13689: <td>libtool</td>
1.180 rillig 13690: <td>licence</td>
1.156 leot 13691: </tr>
13692: <tr>
1.188 leot 13693: <td>license</td>
1.180 rillig 13694: <td>lintl</td>
1.156 leot 13695: </tr>
13696: <tr>
1.188 leot 13697: <td>little-endian</td>
1.180 rillig 13698: <td>lock</td>
1.156 leot 13699: </tr>
13700: <tr>
1.188 leot 13701: <td>locking</td>
1.180 rillig 13702: <td>lvalue</td>
1.156 leot 13703: </tr>
13704: <tr>
1.188 leot 13705: <td>make</td>
1.180 rillig 13706: <td>makesum</td>
1.161 leot 13707: </tr>
13708: <tr>
1.188 leot 13709: <td>memory</td>
1.180 rillig 13710: <td>mercurial</td>
1.156 leot 13711: </tr>
13712: <tr>
1.188 leot 13713: <td>meta</td>
1.180 rillig 13714: <td>meta-package</td>
1.156 leot 13715: </tr>
13716: <tr>
1.188 leot 13717: <td>meta_package</td>
1.180 rillig 13718: <td>mit-krb5</td>
1.177 leot 13719: </tr>
13720: <tr>
1.188 leot 13721: <td>mk.conf</td>
1.180 rillig 13722: <td>mkl</td>
1.159 rillig 13723: </tr>
13724: <tr>
1.188 leot 13725: <td>mount</td>
1.180 rillig 13726: <td>mprotect</td>
1.156 leot 13727: </tr>
13728: <tr>
1.188 leot 13729: <td>mremap</td>
1.180 rillig 13730: <td>nb</td>
1.156 leot 13731: </tr>
13732: <tr>
1.188 leot 13733: <td>nbcompat</td>
1.180 rillig 13734: <td>obstack</td>
1.156 leot 13735: </tr>
13736: <tr>
1.188 leot 13737: <td>obstack_ptr_grow</td>
1.180 rillig 13738: <td>occurs</td>
1.161 leot 13739: </tr>
13740: <tr>
1.188 leot 13741: <td>only</td>
1.180 rillig 13742: <td>openblas</td>
1.156 leot 13743: </tr>
13744: <tr>
1.188 leot 13745: <td>options</td>
1.180 rillig 13746: <td>options.mk</td>
1.156 leot 13747: </tr>
13748: <tr>
1.188 leot 13749: <td>order</td>
1.180 rillig 13750: <td>override</td>
1.156 leot 13751: </tr>
13752: <tr>
1.188 leot 13753: <td>override-intltool</td>
1.180 rillig 13754: <td>override-message-intltool</td>
1.156 leot 13755: </tr>
13756: <tr>
1.188 leot 13757: <td>package</td>
1.180 rillig 13758: <td>parallel</td>
1.156 leot 13759: </tr>
13760: <tr>
1.188 leot 13761: <td>path</td>
1.180 rillig 13762: <td>pax</td>
1.156 leot 13763: </tr>
13764: <tr>
1.188 leot 13765: <td>paxctl</td>
1.180 rillig 13766: <td>pbulk-index</td>
1.156 leot 13767: </tr>
13768: <tr>
1.188 leot 13769: <td>pc</td>
1.180 rillig 13770: <td>perl</td>
1.156 leot 13771: </tr>
13772: <tr>
1.188 leot 13773: <td>perl5</td>
1.180 rillig 13774: <td>perms</td>
1.156 leot 13775: </tr>
13776: <tr>
1.188 leot 13777: <td>php</td>
1.180 rillig 13778: <td>pkg-build-options</td>
1.156 leot 13779: </tr>
13780: <tr>
1.188 leot 13781: <td>pkg-config</td>
1.180 rillig 13782: <td>pkg_build_options</td>
1.156 leot 13783: </tr>
13784: <tr>
1.188 leot 13785: <td>platform</td>
1.180 rillig 13786: <td>plist</td>
1.156 leot 13787: </tr>
13788: <tr>
1.188 leot 13789: <td>post-extract</td>
1.180 rillig 13790: <td>post-fetch</td>
1.156 leot 13791: </tr>
13792: <tr>
1.188 leot 13793: <td>post-wrapper</td>
1.180 rillig 13794: <td>pre-build-checks-hook</td>
1.174 leot 13795: </tr>
13796: <tr>
1.188 leot 13797: <td>pre-configure</td>
1.180 rillig 13798: <td>pre-configure-checks-hook</td>
1.156 leot 13799: </tr>
13800: <tr>
1.188 leot 13801: <td>pre-extract</td>
1.180 rillig 13802: <td>pre-fetch</td>
1.156 leot 13803: </tr>
13804: <tr>
1.188 leot 13805: <td>print-go-deps</td>
1.180 rillig 13806: <td>print-plist</td>
1.156 leot 13807: </tr>
13808: <tr>
1.188 leot 13809: <td>print-summary-data</td>
1.180 rillig 13810: <td>privileged-install-hook</td>
1.156 leot 13811: </tr>
13812: <tr>
1.188 leot 13813: <td>pypi</td>
1.180 rillig 13814: <td>python</td>
1.156 leot 13815: </tr>
13816: <tr>
1.188 leot 13817: <td>readme-all</td>
1.180 rillig 13818: <td>recv</td>
1.174 leot 13819: </tr>
13820: <tr>
1.188 leot 13821: <td>recvfrom</td>
1.180 rillig 13822: <td>regcomp</td>
1.174 leot 13823: </tr>
13824: <tr>
1.188 leot 13825: <td>release-localbase-lock</td>
1.180 rillig 13826: <td>release-lock</td>
1.156 leot 13827: </tr>
13828: <tr>
1.188 leot 13829: <td>relro</td>
1.180 rillig 13830: <td>rename</td>
1.156 leot 13831: </tr>
13832: <tr>
1.188 leot 13833: <td>reorder</td>
1.180 rillig 13834: <td>replace</td>
1.156 leot 13835: </tr>
13836: <tr>
1.188 leot 13837: <td>replace_interpreter</td>
1.180 rillig 13838: <td>reproducible</td>
1.156 leot 13839: </tr>
13840: <tr>
1.188 leot 13841: <td>resolv</td>
1.180 rillig 13842: <td>root</td>
1.174 leot 13843: </tr>
13844: <tr>
1.188 leot 13845: <td>ruby</td>
1.180 rillig 13846: <td>send</td>
1.156 leot 13847: </tr>
13848: <tr>
1.188 leot 13849: <td>sendfile</td>
1.180 rillig 13850: <td>sendto</td>
1.156 leot 13851: </tr>
13852: <tr>
1.188 leot 13853: <td>setenv</td>
1.180 rillig 13854: <td>setgid</td>
1.156 leot 13855: </tr>
13856: <tr>
1.188 leot 13857: <td>setprogname</td>
1.180 rillig 13858: <td>setuid</td>
1.156 leot 13859: </tr>
13860: <tr>
1.188 leot 13861: <td>sh</td>
1.181 rillig 13862: <td>shebang</td>
13863: </tr>
13864: <tr>
1.188 leot 13865: <td>show</td>
1.158 brook 13866: <td>show-all</td>
1.156 leot 13867: </tr>
13868: <tr>
1.188 leot 13869: <td>show-build-defs</td>
1.158 brook 13870: <td>show-depends</td>
1.156 leot 13871: </tr>
13872: <tr>
1.188 leot 13873: <td>show-deps</td>
1.158 brook 13874: <td>show-distfiles</td>
1.156 leot 13875: </tr>
13876: <tr>
1.188 leot 13877: <td>show-downlevel</td>
1.158 brook 13878: <td>show-subdir-var</td>
1.156 leot 13879: </tr>
13880: <tr>
1.188 leot 13881: <td>show-tools</td>
1.158 brook 13882: <td>show-var</td>
1.156 leot 13883: </tr>
13884: <tr>
1.188 leot 13885: <td>show-vars</td>
1.158 brook 13886: <td>snprintf</td>
1.174 leot 13887: </tr>
13888: <tr>
1.188 leot 13889: <td>socket</td>
1.170 rillig 13890: <td>ssp</td>
1.156 leot 13891: </tr>
13892: <tr>
1.188 leot 13893: <td>st_mode</td>
1.170 rillig 13894: <td>stage-install</td>
1.156 leot 13895: </tr>
13896: <tr>
1.188 leot 13897: <td>strcasestr</td>
1.162 rillig 13898: <td>strict</td>
13899: </tr>
13900: <tr>
1.188 leot 13901: <td>strip</td>
1.174 leot 13902: <td>strndup</td>
1.156 leot 13903: </tr>
13904: <tr>
1.188 leot 13905: <td>strnlen</td>
1.174 leot 13906: <td>strsep</td>
13907: </tr>
13908: <tr>
1.188 leot 13909: <td>subst</td>
1.174 leot 13910: <td>substitutions</td>
1.177 leot 13911: </tr>
13912: <tr>
1.188 leot 13913: <td>subversion</td>
1.175 gutterid 13914: <td>sun</td>
1.156 leot 13915: </tr>
13916: <tr>
1.188 leot 13917: <td>sunpro</td>
1.156 leot 13918: <td>sunwspro</td>
13919: </tr>
13920: <tr>
1.188 leot 13921: <td>svn</td>
1.161 leot 13922: <td>symlink</td>
13923: </tr>
13924: <tr>
1.188 leot 13925: <td>test</td>
1.174 leot 13926: <td>test-env</td>
1.156 leot 13927: </tr>
13928: <tr>
1.188 leot 13929: <td>tex</td>
1.174 leot 13930: <td>texlive</td>
1.156 leot 13931: </tr>
13932: <tr>
1.188 leot 13933: <td>tmp</td>
1.174 leot 13934: <td>tool</td>
1.156 leot 13935: </tr>
13936: <tr>
1.188 leot 13937: <td>tools</td>
1.174 leot 13938: <td>tools-libtool-m4-override</td>
1.156 leot 13939: </tr>
13940: <tr>
1.188 leot 13941: <td>type</td>
1.174 leot 13942: <td>ulimit</td>
1.156 leot 13943: </tr>
13944: <tr>
1.188 leot 13945: <td>undefined</td>
1.174 leot 13946: <td>undo-replace</td>
1.156 leot 13947: </tr>
13948: <tr>
1.188 leot 13949: <td>unlimit</td>
1.174 leot 13950: <td>unprivileged</td>
1.156 leot 13951: </tr>
13952: <tr>
1.188 leot 13953: <td>unprivileged-install-hook</td>
1.174 leot 13954: <td>unstripped</td>
1.156 leot 13955: </tr>
13956: <tr>
1.188 leot 13957: <td>update</td>
1.174 leot 13958: <td>upload</td>
1.156 leot 13959: </tr>
13960: <tr>
1.188 leot 13961: <td>upload-distfiles</td>
1.157 leot 13962: <td>use_tools</td>
1.156 leot 13963: </tr>
13964: <tr>
1.188 leot 13965: <td>user</td>
1.157 leot 13966: <td>utimes</td>
1.156 leot 13967: </tr>
13968: <tr>
1.188 leot 13969: <td>vasprintf</td>
1.157 leot 13970: <td>verbose</td>
1.156 leot 13971: </tr>
13972: <tr>
1.188 leot 13973: <td>vsnprintf</td>
1.157 leot 13974: <td>warn</td>
1.156 leot 13975: </tr>
13976: <tr>
1.188 leot 13977: <td>warning</td>
1.157 leot 13978: <td>warnings</td>
1.156 leot 13979: </tr>
13980: <tr>
1.188 leot 13981: <td>warnx</td>
1.174 leot 13982: <td>wattr_off</td>
1.156 leot 13983: </tr>
13984: <tr>
1.188 leot 13985: <td>wattr_on</td>
1.174 leot 13986: <td>work</td>
1.156 leot 13987: </tr>
13988: <tr>
1.188 leot 13989: <td>wrapper</td>
1.174 leot 13990: <td>wrkdir</td>
1.156 leot 13991: </tr>
13992: </table>
1.154 rillig 13993: </div>
13994: <div class="appendix">
13995: <div class="titlepage"><div><div><h1 class="title">
13996: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 13997: <div class="toc">
13998: <p><b>Table of Contents</b></p>
1.100 leot 13999: <dl class="toc">
1.154 rillig 14000: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
14001: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1 dsieger 14002: </dl>
14003: </div>
14004: <p>This section contains information on editing the pkgsrc
14005: guide itself.</p>
1.41 asau 14006: <div class="sect1">
1.1 dsieger 14007: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 14008: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.1 dsieger 14009: <p>The pkgsrc guide's source code is stored in
14010: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
14011: are created from it:</p>
1.41 asau 14012: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 14013: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
14014: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.174 leot 14015: <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>
14016: <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 14017: The PDF version of the pkgsrc guide.</p></li>
1.174 leot 14018: <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 14019: PostScript version of the pkgsrc guide.</p></li>
14020: </ul></div>
14021: </div>
1.41 asau 14022: <div class="sect1">
1.1 dsieger 14023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 14024: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.1 dsieger 14025: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 14026: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 14027: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 14028: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 14029: documentation) installed. These are automatically installed when
1.137 leot 14030: 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 14031: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 14032: right directory. All further steps will take place
14033: here.</p></li>
1.41 asau 14034: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 14035: <code class="filename">files/</code>.</p></li>
1.41 asau 14036: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 14037: guide for valid XML and to build the final output files. If you
14038: get any errors at this stage, you can just edit the files, as
14039: there are only symbolic links in the working directory, pointing
14040: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 14041: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 14042: commit)</strong></span></p></li>
1.41 asau 14043: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 14044: regenerate the output files with the proper RCS
14045: Ids.</p></li>
1.41 asau 14046: <li class="step">
1.10 hubertf 14047: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 14048: commit the files in both <code class="filename">pkgsrc/doc</code> and
14049: <code class="filename">htdocs</code>.</p>
1.41 asau 14050: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 14051: <h3 class="title">Note</h3>
14052: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 14053: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
14054: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 14055: directory.</p>
14056: </div>
14057: </li>
14058: </ol></div>
14059: </div>
14060: </div>
14061: </div></body>
14062: </html>
CVSweb <webmaster@jp.NetBSD.org>