Annotation of pkgsrc/doc/pkgsrc.html, revision 1.314
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.132 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
1.148 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75 rillig 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.110 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.75 rillig 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.110 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.75 rillig 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.310 jnemeth 33: <div><p class="copyright">Copyright © 1994-2021 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.39 2021/01/02 08:32:15 jnemeth Exp $</p></div>
1.148 asau 35: <div><div class="abstract">
1.75 rillig 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.210 leot 48: <dl class="toc">
1.75 rillig 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
1.75 rillig 56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
1.267 rillig 63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75 rillig 65: <dd><dl>
1.267 rillig 66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 67: <dd><dl>
1.267 rillig 68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 70: </dl></dd>
1.267 rillig 71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 72: <dd><dl>
1.267 rillig 73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 75: </dl></dd>
76: </dl></dd>
1.267 rillig 77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75 rillig 78: <dd><dl>
1.267 rillig 79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 81: </dl></dd>
1.267 rillig 82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75 rillig 83: <dd><dl>
1.267 rillig 84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 85: <dd><dl>
1.267 rillig 86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
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.75 rillig 93: </dl></dd>
1.267 rillig 94: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75 rillig 95: <dd><dl>
1.267 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.75 rillig 99: </dl></dd>
100: </dl></dd>
1.267 rillig 101: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75 rillig 102: <dd><dl>
1.267 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.88 wiz 107: <dd><dl>
1.267 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.88 wiz 111: </dl></dd>
1.267 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.75 rillig 114: </dl></dd>
1.267 rillig 115: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75 rillig 116: <dd><dl>
1.267 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.106 rillig 119: </dl></dd>
1.267 rillig 120: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 121: builds)</a></span></dt>
1.75 rillig 122: <dd><dl>
1.267 rillig 123: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 124: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 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.293 rillig 127: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
128: <dd><dl>
1.294 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.296 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.293 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.267 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.128 wiz 160: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 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.75 rillig 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.267 rillig 172: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299 rillig 173: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91 rillig 174: <dd><dl>
1.299 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.91 rillig 178: <dd><dl>
1.299 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.91 rillig 184: </dl></dd>
1.299 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.106 rillig 194: </dl></dd>
1.299 rillig 195: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106 rillig 196: <dd><dl>
1.299 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.106 rillig 202: <dd><dl>
1.299 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.106 rillig 205: </dl></dd>
1.299 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.106 rillig 222: <dd><dl>
1.299 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.106 rillig 227: </dl></dd>
1.299 rillig 228: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
229: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106 rillig 230: </dl></dd>
1.299 rillig 231: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 232: <dd><dl>
1.299 rillig 233: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
234: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
235: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
236: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106 rillig 237: <dd><dl>
1.299 rillig 238: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
239: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
240: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
241: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106 rillig 242: </dl></dd>
243: </dl></dd>
1.299 rillig 244: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106 rillig 245: <dd><dl>
1.299 rillig 246: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
247: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
248: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
249: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 250: </dl></dd>
1.299 rillig 251: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106 rillig 252: <dd><dl>
1.299 rillig 253: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
254: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
255: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
256: </dl></dd>
257: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
258: <dd><dl>
259: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
260: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 261: <dd><dl>
1.299 rillig 262: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
263: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133 wiz 264: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
265: and
266: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
267: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 268: </dl></dd>
1.299 rillig 269: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
270: <dd><dl>
271: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
272: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
273: </dl></dd>
274: </dl></dd>
275: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106 rillig 276: <dd><dl>
1.299 rillig 277: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
278: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
279: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
280: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
281: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
282: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
283: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
284: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
285: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106 rillig 286: </dl></dd>
1.299 rillig 287: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
288: <dd><dl>
289: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
290: <dd><dl>
291: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
292: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106 rillig 293: </dl></dd>
1.299 rillig 294: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106 rillig 295: <dd><dl>
1.299 rillig 296: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
297: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
298: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
299: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
300: </dl></dd>
301: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
302: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
303: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
304: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
305: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
306: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
307: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.267 rillig 308: </dl></dd>
309: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
310: <dd><dl>
311: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
312: <dd><dl>
313: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
314: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
315: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
316: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
317: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
318: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
319: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
320: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
321: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
322: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
323: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
324: </dl></dd>
325: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
326: <dd><dl>
327: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
328: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
329: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
330: </dl></dd>
331: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
332: <dd><dl>
333: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
334: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
336: </dl></dd>
337: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
338: <dd><dl>
339: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
340: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
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.287 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.267 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.87 wiz 373: emulation</a></span></dt>
1.267 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.77 rillig 376: </dl></dd>
1.267 rillig 377: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 378: </dl></dd>
1.299 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.267 rillig 386: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 387: <dd><dl>
1.267 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.75 rillig 398: </dl></dd>
399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
400: <dd><dl>
1.299 rillig 401: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 402: <dd><dl>
1.299 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.81 rillig 406: <dd><dl>
1.299 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.81 rillig 409: </dl></dd>
1.299 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.75 rillig 412: <dd><dl>
1.299 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.75 rillig 415: </dl></dd>
1.299 rillig 416: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 417: <dd><dl>
1.299 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.75 rillig 420: </dl></dd>
421: </dl></dd>
1.299 rillig 422: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 423: <dd><dl>
1.299 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.75 rillig 426: <dd><dl>
1.299 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.75 rillig 429: </dl></dd>
430: </dl></dd>
1.299 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.75 rillig 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.287 rillig 441: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 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>
1.76 rillig 450: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
451: <dd><dl>
1.128 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.261 leot 457: <code class="filename">stable</code>,
1.128 wiz 458: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 459: source packages</a></span></dt>
460: </dl></dd>
1.267 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.75 rillig 463: <dd><dl>
1.267 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.75 rillig 466: </dl></dd>
467: </dl>
468: </div>
1.82 rillig 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.299 rillig 474: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 475: </dt>
1.299 rillig 476: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 477: </dt>
1.82 rillig 478: </dl>
479: </div>
1.148 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.75 rillig 483: <div class="toc">
484: <p><b>Table of Contents</b></p>
1.210 leot 485: <dl class="toc">
1.75 rillig 486: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 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>
1.75 rillig 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>
1.88 wiz 493: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 494: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
495: </dl>
496: </div>
1.148 asau 497: <div class="sect1">
1.75 rillig 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>
1.82 rillig 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>
1.75 rillig 507: <p>pkgsrc currently contains several thousand packages,
508: including:</p>
1.148 asau 509: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 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.75 rillig 511: web server</p></li>
1.250 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.75 rillig 513: web browser</p></li>
1.250 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.75 rillig 515: Desktop Environment</p></li>
1.250 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.75 rillig 517: Desktop Environment</p></li>
518: </ul></div>
1.219 rillig 519: <p>… just to name a few.</p>
1.75 rillig 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.148 asau 523: <div class="sect2">
1.82 rillig 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.148 asau 529: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 530: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 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.128 wiz 536: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 537: including binaries, libraries, man pages and other
538: documentation.</p></li>
1.214 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.128 wiz 543: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 544: consists of highly portable code. This allows the greatest speed of
1.132 spz 545: development when porting to a new platform. This portability also
1.82 rillig 546: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
547: platforms</em></span>.</p></li>
1.128 wiz 548: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 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.128 wiz 552: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 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>
1.91 rillig 558: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 560: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 561: — That means, if a package contains bugs, it's better to find
1.91 rillig 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.290 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.91 rillig 565: of shell scripts), and post-installation checks (installed files,
566: references to shared libraries, script interpreters).</p></li>
1.128 wiz 567: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 568: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 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>
1.82 rillig 572: </div>
1.148 asau 573: <div class="sect2">
1.82 rillig 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>
1.75 rillig 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>
1.82 rillig 583: <div class="table">
584: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216 tnn 585: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 586: <colgroup>
587: <col>
588: <col>
1.202 sevan 589: <col>
1.82 rillig 590: </colgroup>
591: <thead><tr>
592: <th>Platform</th>
593: <th>Date Support Added</th>
1.202 sevan 594: <th>Notes</th>
1.82 rillig 595: </tr></thead>
596: <tbody>
597: <tr>
1.289 leot 598: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 599: <td align="center">Aug 1997</td>
1.202 sevan 600: <td class="auto-generated"> </td>
1.82 rillig 601: </tr>
602: <tr>
1.110 hubertf 603: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 604: <td align="center">Mar 1999</td>
1.264 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.82 rillig 606: </tr>
607: <tr>
1.289 leot 608: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 609: <td align="center">Jun 1999</td>
1.264 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.82 rillig 611: </tr>
612: <tr>
613: <td>
1.230 sevan 614: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82 rillig 615: </td>
616: <td align="center">Oct 2001</td>
1.305 bacon 617: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.82 rillig 618: </tr>
619: <tr>
1.289 leot 620: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 621: <td align="center">Nov 2002</td>
1.264 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.82 rillig 623: </tr>
624: <tr>
1.289 leot 625: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 626: <td align="center">Nov 2002</td>
1.264 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.82 rillig 628: </tr>
629: <tr>
1.289 leot 630: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 631: <td align="center">Dec 2002</td>
1.202 sevan 632: <td>
1.264 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.202 sevan 635: </td>
1.82 rillig 636: </tr>
637: <tr>
638: <td>BSD/OS</td>
639: <td align="center">Dec 2003</td>
1.202 sevan 640: <td class="auto-generated"> </td>
1.82 rillig 641: </tr>
642: <tr>
1.289 leot 643: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 644: <td align="center">Dec 2003</td>
1.264 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.82 rillig 646: </tr>
647: <tr>
648: <td>
1.289 leot 649: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 650: (Microsoft Windows Services for Unix)
651: </td>
652: <td align="center">Mar 2004</td>
1.264 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.82 rillig 654: </tr>
655: <tr>
1.289 leot 656: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 657: <td align="center">Oct 2004</td>
1.202 sevan 658: <td class="auto-generated"> </td>
1.82 rillig 659: </tr>
660: <tr>
1.110 hubertf 661: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 662: <td align="center">Nov 2004</td>
1.264 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.82 rillig 664: </tr>
1.98 wiz 665: <tr>
1.289 leot 666: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 667: <td align="center">Apr 2007</td>
1.264 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.98 wiz 669: </tr>
1.128 wiz 670: <tr>
1.289 leot 671: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128 wiz 672: <td align="center">Sep 2010</td>
1.264 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.128 wiz 674: </tr>
1.151 obache 675: <tr>
1.289 leot 676: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 677: <td align="center">Jan 2011</td>
1.202 sevan 678: <td class="auto-generated"> </td>
1.151 obache 679: </tr>
680: <tr>
1.289 leot 681: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151 obache 682: <td align="center">Nov 2011</td>
1.264 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.151 obache 684: </tr>
685: <tr>
1.289 leot 686: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151 obache 687: <td align="center">Mar 2013</td>
1.264 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.151 obache 689: </tr>
1.166 jnemeth 690: <tr>
1.289 leot 691: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166 jnemeth 692: <td align="center">Jul 2013</td>
1.264 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.166 jnemeth 694: </tr>
1.214 sevan 695: <tr>
1.289 leot 696: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214 sevan 697: <td align="center">Jun 2014</td>
1.264 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.214 sevan 699: </tr>
1.82 rillig 700: </tbody>
1.91 rillig 701: </table></div>
1.82 rillig 702: </div>
1.91 rillig 703: <br class="table-break">
1.82 rillig 704: </div>
1.75 rillig 705: </div>
1.148 asau 706: <div class="sect1">
1.75 rillig 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.110 hubertf 710: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 711: describes how one can use one of the packages in the Package
712: Collection, either by installing a precompiled binary package,
1.93 rillig 713: or by building one's own copy using the NetBSD package system.
1.110 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.75 rillig 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.110 hubertf 717: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 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.110 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.75 rillig 722: </div>
1.148 asau 723: <div class="sect1">
1.75 rillig 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.128 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.75 rillig 728: terminology used within this document.</p>
1.148 asau 729: <div class="variablelist"><dl class="variablelist">
1.75 rillig 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.236 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.75 rillig 738: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 739: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 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>
1.75 rillig 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
1.76 rillig 752: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 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.128 wiz 756: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 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
1.76 rillig 761: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 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
1.76 rillig 765: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 766: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 767: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 768: especially in the context of precompiled packages.</p>
769: </dd>
770: <dt><span class="term">Program</span></dt>
1.88 wiz 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>
1.75 rillig 774: </dl></div>
1.148 asau 775: <div class="sect2">
1.75 rillig 776: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 777: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 778: <div class="variablelist"><dl class="variablelist">
1.75 rillig 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.128 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.75 rillig 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.110 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.75 rillig 790: documentation.</p>
791: </dd>
792: <dt><span class="term">package maintainers</span></dt>
793: <dd><p>A
1.110 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.75 rillig 795: <dt><span class="term">infrastructure developers</span></dt>
796: <dd><p>These people are involved in all those files
1.76 rillig 797: that live in the <code class="filename">mk/</code> directory and below.
1.110 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.75 rillig 799: too.</p></dd>
800: </dl></div>
801: </div>
802: </div>
1.148 asau 803: <div class="sect1">
1.75 rillig 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.128 wiz 808: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.226 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.75 rillig 812: </div>
813: </div>
1.148 asau 814: <div class="part">
1.75 rillig 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.210 leot 819: <dl class="toc">
1.267 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.75 rillig 822: <dd><dl>
1.267 rillig 823: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 824: <dd><dl>
1.267 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.75 rillig 827: </dl></dd>
1.267 rillig 828: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 829: <dd><dl>
1.267 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.75 rillig 832: </dl></dd>
833: </dl></dd>
1.267 rillig 834: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75 rillig 835: <dd><dl>
1.267 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.75 rillig 838: </dl></dd>
1.267 rillig 839: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75 rillig 840: <dd><dl>
1.267 rillig 841: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 842: <dd><dl>
1.267 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.75 rillig 850: </dl></dd>
1.267 rillig 851: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75 rillig 852: <dd><dl>
1.267 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.75 rillig 856: </dl></dd>
857: </dl></dd>
1.267 rillig 858: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75 rillig 859: <dd><dl>
1.267 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.88 wiz 864: <dd><dl>
1.267 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.88 wiz 868: </dl></dd>
1.267 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.75 rillig 871: </dl></dd>
1.267 rillig 872: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75 rillig 873: <dd><dl>
1.267 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.106 rillig 876: </dl></dd>
1.267 rillig 877: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 878: builds)</a></span></dt>
1.75 rillig 879: <dd><dl>
1.267 rillig 880: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 881: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 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.293 rillig 884: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
885: <dd><dl>
1.294 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.296 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.293 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.267 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.128 wiz 917: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 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.75 rillig 925: </dl></dd>
926: </dl>
927: </div>
1.148 asau 928: <div class="chapter">
1.75 rillig 929: <div class="titlepage"><div><div><h2 class="title">
1.267 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.278 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.267 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.75 rillig 974: <div class="toc">
975: <p><b>Table of Contents</b></p>
1.210 leot 976: <dl class="toc">
1.267 rillig 977: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 978: <dd><dl>
1.267 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.75 rillig 981: </dl></dd>
1.267 rillig 982: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 983: <dd><dl>
1.267 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.75 rillig 986: </dl></dd>
987: </dl>
988: </div>
1.91 rillig 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.148 asau 997: <div class="sect1">
1.75 rillig 998: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 999: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75 rillig 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.313 leot 1006: <code class="literal">2021Q1</code>.</p>
1.75 rillig 1007: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 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.157 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.148 asau 1012: <div class="sect2">
1.75 rillig 1013: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1014: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75 rillig 1015: <p>The primary download location for all pkgsrc files is
1.264 sevan 1016: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157 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.264 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.230 sevan 1023: It is autogenerated weekly.</p>
1.157 asau 1024: <p>To save download time we provide bzip2- and
1025: xz-compressed archives which are published at
1.264 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.157 asau 1027: and
1.264 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.157 asau 1029: respectively.
1030: </p>
1031: <p>You can fetch the same files using FTP.</p>
1.313 leot 1032: <p>The tar file for the stable branch 2021Q1 is in the
1033: directory <code class="filename">pkgsrc-2021Q1</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q1/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249 leot 1034: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112 weinem 1035: <pre class="screen">
1.313 leot 1036: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q1/pkgsrc.tar.gz</code></strong></pre>
1.188 snj 1037: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 1038: or your web browser.</p>
1.112 weinem 1039: <p>Then, extract it with:</p>
1.188 snj 1040: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 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.75 rillig 1046: </div>
1.148 asau 1047: <div class="sect2">
1.75 rillig 1048: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1049: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128 wiz 1050: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.313 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-2021Q1 -P pkgsrc</code></strong>
1.128 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.146 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 grant 1058: </pre>
1.289 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.128 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.146 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.128 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.101 rillig 1076: <pre class="programlisting">
1077: # recommended CVS configuration file from the pkgsrc guide
1.268 sevan 1078: cvs -q
1.101 rillig 1079: checkout -P
1.103 wiz 1080: update -dP
1081: diff -upN
1.101 rillig 1082: rdiff -u
1.128 wiz 1083: release -d
1.101 rillig 1084: </pre>
1.75 rillig 1085: </div>
1086: </div>
1.148 asau 1087: <div class="sect1">
1.75 rillig 1088: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1089: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75 rillig 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.148 asau 1094: <div class="sect2">
1.75 rillig 1095: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1096: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148 asau 1097: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1098: <h3 class="title">Warning</h3>
1.77 rillig 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>
1.75 rillig 1106: </div>
1.82 rillig 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.188 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.82 rillig 1111: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267 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.75 rillig 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.148 asau 1118: <div class="sect2">
1.75 rillig 1119: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1120: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132 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.148 asau 1127: <div class="sect3">
1.75 rillig 1128: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1129: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75 rillig 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.128 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.75 rillig 1135: back to the stable branch, add the
1.313 leot 1136: <span class="quote">“<span class="quote">-rpkgsrc-2021Q1</span>”</span> option.</p>
1.75 rillig 1137: </div>
1.148 asau 1138: <div class="sect3">
1.75 rillig 1139: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1140: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75 rillig 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.128 wiz 1147: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1148: </div>
1149: </div>
1150: </div>
1151: </div>
1.148 asau 1152: <div class="chapter">
1.75 rillig 1153: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1154: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75 rillig 1155: <div class="toc">
1156: <p><b>Table of Contents</b></p>
1.210 leot 1157: <dl class="toc">
1.267 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.75 rillig 1160: </dl>
1161: </div>
1.148 asau 1162: <div class="sect1">
1.75 rillig 1163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.82 rillig 1166: </div>
1.148 asau 1167: <div class="sect1">
1.82 rillig 1168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1169: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1170: <p>pkgsrc can be bootstrapped for use in two different modes:
1171: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1172: to privileged one all programs are installed under one particular user
1.149 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.82 rillig 1176: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1177: <pre class="screen">
1.167 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.75 rillig 1179: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1180: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1181: </pre>
1.149 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.230 sevan 1186: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149 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.230 sevan 1192: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149 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.148 asau 1198: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1199: <h3 class="title">Note</h3>
1.110 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.128 wiz 1203: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1204: </div>
1.149 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.75 rillig 1213: </div>
1214: </div>
1.148 asau 1215: <div class="chapter">
1.75 rillig 1216: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1217: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75 rillig 1218: <div class="toc">
1219: <p><b>Table of Contents</b></p>
1.210 leot 1220: <dl class="toc">
1.267 rillig 1221: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 1222: <dd><dl>
1.267 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.75 rillig 1236: </dl></dd>
1237: </dl>
1238: </div>
1239: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1240: is to only install the package tools and to use binary packages
1.128 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.88 wiz 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.148 asau 1245: <div class="sect1">
1.75 rillig 1246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1247: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.294 rillig 1248: <p>On the <a class="ulink" href="http://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264 sevan 1249: site and mirrors, there are collections of binary packages,
1.109 rillig 1250: ready to be installed. These binary packages have been built using the
1251: default settings for the directories, that is:</p>
1.148 asau 1252: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.109 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.267 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.148 asau 1260: <div class="sect2">
1.75 rillig 1261: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1262: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105 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.294 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.105 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.128 wiz 1271: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 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.230 sevan 1278: for managing binary packages and the database of installed packages).</p>
1.75 rillig 1279: </div>
1.148 asau 1280: <div class="sect2">
1.75 rillig 1281: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1282: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1283: <p>In the directory from the last section, there is a
1.196 wiz 1284: subdirectory called <code class="filename">All/</code>, which contains all the
1.109 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.128 wiz 1287: medium you are using).</p>
1.109 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.110 hubertf 1290: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1291: <pre class="screen">
1292: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.294 rillig 1293:
1294: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284 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.109 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.230 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.109 rillig 1308: </pre>
1.75 rillig 1309: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1310: package in question will be installed, too, assuming they are
1311: present where you install from.</p>
1.128 wiz 1312: <p>Adding packages might install vulnerable packages.
1313: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1314: regularly, especially after installing new packages, and verify
1315: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1316: <p>After you've installed packages, be sure to have
1.88 wiz 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>
1.75 rillig 1320: </div>
1.148 asau 1321: <div class="sect2">
1.75 rillig 1322: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1323: <a name="using.pkg_delete"></a>5.1.3. Deinstalling packages</h3></div></div></div>
1.82 rillig 1324: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1325: installed from source code or from a binary package. The
1.110 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.88 wiz 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>
1.82 rillig 1334: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1335: removes all the packages that require the package in question
1336: and then removes the package itself. For example:
1.82 rillig 1337:
1.88 wiz 1338: </p>
1.82 rillig 1339: <pre class="screen">
1.88 wiz 1340: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1341: </pre>
1.82 rillig 1342: <p>
1343:
1.88 wiz 1344: will remove jpeg and all the packages that used it; this allows
1345: upgrading the jpeg package.</p>
1.82 rillig 1346: </div>
1.148 asau 1347: <div class="sect2">
1.82 rillig 1348: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1349: <a name="using.pkg_info"></a>5.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1350: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1351: installed packages or binary package files.</p>
1.82 rillig 1352: </div>
1.148 asau 1353: <div class="sect2">
1.82 rillig 1354: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1355: <a name="vulnerabilities"></a>5.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82 rillig 1356: <p>
1.279 leot 1357: The pkgsrc Security Team and Packages Groups maintain a list of
1.88 wiz 1358: known security vulnerabilities to packages which are (or have been)
1359: included in pkgsrc. The list is available from the NetBSD
1.294 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.88 wiz 1362: </p>
1.82 rillig 1363: <p>
1.125 wiz 1364: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 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>
1.82 rillig 1369: <p>
1.125 wiz 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.88 wiz 1373: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1374: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1375: installed packages are vulnerable. If a package is vulnerable, you
1376: will see output similar to the following:
1377: </p>
1.82 rillig 1378: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289 leot 1379: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1380: <p>
1.125 wiz 1381: You may wish to have the
1.294 rillig 1382:
1383: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1384: file downloaded daily so that
1385: it remains current. This may be done by adding an appropriate entry
1.311 leot 1386: to the root users <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.125 wiz 1387: </p>
1388: <pre class="screen">
1.233 sevan 1389: # Download vulnerabilities file
1.230 sevan 1390: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.233 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.125 wiz 1394: </pre>
1395: <p>
1.230 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.125 wiz 1398:
1.230 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.235 yyamano 1408: desired (not required), by adding the following line to
1.230 sevan 1409: <code class="filename">/etc/security.conf</code>:
1.125 wiz 1410: </p>
1411: <pre class="screen">
1.230 sevan 1412: check_pkg_vulnerabilities=YES
1.125 wiz 1413: </pre>
1414: <p>
1.311 leot 1415: see <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88 wiz 1416: </p>
1.82 rillig 1417: </div>
1.148 asau 1418: <div class="sect2">
1.82 rillig 1419: <div class="titlepage"><div><div><h3 class="title">
1.267 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.82 rillig 1421: <p>
1.250 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.128 wiz 1423: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 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>
1.82 rillig 1428: ...
1.88 wiz 1429: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1430: </pre>
1.110 hubertf 1431: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1432: package on your system and rebuild any dependencies.
1433: </p>
1.82 rillig 1434: </div>
1.148 asau 1435: <div class="sect2">
1.82 rillig 1436: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1437: <a name="using.pkg_admin"></a>5.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1438: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1439: administrative functions on the package system.</p>
1.82 rillig 1440: </div>
1.75 rillig 1441: </div>
1.148 asau 1442: <div class="sect1">
1.75 rillig 1443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1444: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88 wiz 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.110 hubertf 1448: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1449: directory to build local <code class="filename">README.html</code> files for
1.250 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.88 wiz 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.110 hubertf 1454: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 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.110 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.88 wiz 1459: instructions how to create your own packages.</p>
1.148 asau 1460: <div class="sect2">
1.75 rillig 1461: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1462: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82 rillig 1463: <p>To build packages from source, you need a working C
1.88 wiz 1464: compiler. On NetBSD, you need to install the
1.128 wiz 1465: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1466: sets. If you want to build X11-related packages, the
1.128 wiz 1467: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1468: sets are required, too.</p>
1.75 rillig 1469: </div>
1.148 asau 1470: <div class="sect2">
1.75 rillig 1471: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1472: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75 rillig 1473: <p>The first step for building a package is downloading the
1.88 wiz 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>
1.82 rillig 1481: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1482: <p>
1.110 hubertf 1483: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 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>
1.88 wiz 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>
1.75 rillig 1502: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1503: if you want to keep the settings, by editing the
1.110 hubertf 1504: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1505: and adding the definitions there.</p>
1.82 rillig 1506: <p>
1.88 wiz 1507: If a package depends on many other packages (such as
1.250 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.88 wiz 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>
1.82 rillig 1513: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1514: <p>
1.88 wiz 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>
1.75 rillig 1519: </div>
1.148 asau 1520: <div class="sect2">
1.75 rillig 1521: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1522: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1523: <p>
1.88 wiz 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.148 asau 1529: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1530: <h3 class="title">Note</h3>
1531: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1532: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1533: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1534: </div>
1.87 wiz 1535: <p>For example, type</p>
1.88 wiz 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>
1.75 rillig 1540: <p>at the shell prompt to build the various components of the
1.88 wiz 1541: package.</p>
1.82 rillig 1542: <p>The next stage is to actually install the newly compiled
1.88 wiz 1543: program onto your system. Do this by entering:
1.82 rillig 1544:
1.88 wiz 1545: </p>
1.82 rillig 1546: <pre class="screen">
1.88 wiz 1547: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1548: </pre>
1.82 rillig 1549: <p>
1550:
1.88 wiz 1551: while you are still in the directory for whatever package you
1552: are installing.</p>
1.82 rillig 1553: <p>Installing the package on your system may require you to
1.88 wiz 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>
1.82 rillig 1557: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1558: You can now enter:
1.82 rillig 1559:
1.88 wiz 1560: </p>
1.82 rillig 1561: <pre class="screen">
1.88 wiz 1562: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1563: </pre>
1.82 rillig 1564: <p>
1565:
1.88 wiz 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>
1.82 rillig 1570: <pre class="screen">
1.88 wiz 1571: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1572: </pre>
1.75 rillig 1573: <p>Taking the figlet utility as an example, we can install it on our
1.110 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.88 wiz 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.110 hubertf 1592: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 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.110 hubertf 1597: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1598: set them each time you want to use pkgsrc.</p>
1.128 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.88 wiz 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.128 wiz 1604: <div class="orderedlist"><ol class="orderedlist" type="1">
1605: <li class="listitem">
1.311 leot 1606: <p>If you invoke the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88 wiz 1607: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1608: information will be displayed. For example,</p>
1.75 rillig 1609: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1610: <p>will show all the commands that are invoked, up to and
1.128 wiz 1611: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1612: </li>
1.128 wiz 1613: <li class="listitem">
1.311 leot 1614: <p>If you want to know the value of a certain <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1615: definition, then the <code class="varname">VARNAME</code> definition
1616: should be used, in conjunction with the show-var
1.311 leot 1617: target. e.g. to show the expansion of the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 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>
1.75 rillig 1621: /usr/pkg
1622: <code class="prompt">%</code>
1.88 wiz 1623: </pre>
1.75 rillig 1624: </li>
1625: </ol></div>
1626: <p>If you want to install a binary package that you've either
1.88 wiz 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.311 leot 1630: install a binary package - if available - via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110 hubertf 1631: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1632: sites searched is kept in the variable
1633: <code class="varname">BINPKG_SITES</code>, which defaults to
1.311 leot 1634: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88 wiz 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>
1.75 rillig 1648: </div>
1649: </div>
1650: </div>
1.148 asau 1651: <div class="chapter">
1.75 rillig 1652: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1653: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75 rillig 1654: <div class="toc">
1655: <p><b>Table of Contents</b></p>
1.210 leot 1656: <dl class="toc">
1.267 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.88 wiz 1665: </dl></dd>
1.267 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.75 rillig 1668: </dl>
1669: </div>
1.104 rillig 1670: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 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.311 leot 1673: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89 rillig 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.223 rillig 1681: spelling mistakes) takes place.</p>
1.148 asau 1682: <div class="sect1">
1.75 rillig 1683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1684: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223 rillig 1685: <p>The following variables apply to all
1.89 rillig 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.148 asau 1690: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1691: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 1692: packages will be installed. The default is
1.76 rillig 1693: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 1694: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 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.75 rillig 1697: installed. The default is
1.76 rillig 1698: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 1699: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 1700: X11 is installed on the system. The default is
1.194 bsiegert 1701: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 1702: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 1703: downloaded copies of the original source distributions used
1704: for building pkgsrc packages. The default is
1.76 rillig 1705: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 1706: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 1707: database about installed packages is stored. The default is
1.230 sevan 1708: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128 wiz 1709: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 1710: If set, override the packages'
1711: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 1712: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 1713: Backup location(s) for distribution files and patch files
1714: if not found locally or in
1.76 rillig 1715: <code class="filename">${MASTER_SITES}</code> or
1716: <code class="filename">${PATCH_SITES}</code> respectively.
1.230 sevan 1717: The defaults is
1718: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 1719: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 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.128 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.125 wiz 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.75 rillig 1730: </ul></div>
1731: </div>
1.148 asau 1732: <div class="sect1">
1.75 rillig 1733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1734: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219 rillig 1735: <p>
1.75 rillig 1736: </p>
1.148 asau 1737: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1738: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 1739: directory for the binary packages. The default is
1.76 rillig 1740: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 1741: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 1742: The top level directory where, if defined, the separate
1743: working directories will get created, and symbolically
1.76 rillig 1744: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 1745: This is useful for building packages on several
1.76 rillig 1746: architectures, then <code class="filename">${PKGSRCDIR}</code>
1747: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 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.126 jakllsch 1750: — it is an internal definition which refers to the
1.75 rillig 1751: root of the pkgsrc tree. It is possible to have many
1752: pkgsrc tree instances.)</p></li>
1.128 wiz 1753: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 1754: Directory for local patches that aren't part of pkgsrc.
1.299 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.93 rillig 1756: information.</p></li>
1.128 wiz 1757: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 1758: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 1759: BSD-style Makefile. If this is not set,
1760: <code class="varname">MAKECONF</code> is set to
1.76 rillig 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>
1.75 rillig 1763: </ul></div>
1764: </div>
1.148 asau 1765: <div class="sect1">
1.75 rillig 1766: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1767: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.312 gdt 1768: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
1.256 maya 1769: By default, binary packages of built packages are
1.263 leot 1770: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256 maya 1771: this variable to "no" prevents this.</p></li></ul></div>
1.217 jnemeth 1772: <p>Packages have to support installation into a
1.103 wiz 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.148 asau 1776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1777: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 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.103 wiz 1783: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1784: clean</code></strong> needs to be run as root.</p>
1.118 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.174 asau 1802: <code class="prompt">$</code> make stage-install
1.118 imil 1803: </pre>
1804: <p>
1805:
1806: Create a package without root privileges
1807:
1808: </p>
1809: <pre class="programlisting">
1.174 asau 1810: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 1811: </pre>
1812: <p>
1813:
1814: For the following command, you must be able to gain root
1.311 leot 1815: privileges using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118 imil 1816:
1817: </p>
1818: <pre class="programlisting">
1.174 asau 1819: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 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.103 wiz 1832: </div>
1.148 asau 1833: <div class="sect1">
1.103 wiz 1834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1835: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 1836: <div class="sect2">
1.78 rillig 1837: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1838: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 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.148 asau 1841: <div class="variablelist"><dl class="variablelist">
1.89 rillig 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.148 asau 1847: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 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.128 wiz 1854: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 1855: distributed C/C++ (chainable)</p></li>
1.174 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.128 wiz 1862: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 1863: GNU C/C++ Compiler</p></li>
1.174 asau 1864: <li class="listitem"><p><code class="varname">hp</code>:
1865: HP-UX C/aC++ compilers</p></li>
1.128 wiz 1866: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 1867: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 1868: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 1869: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 1870: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 1871: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 1872: <li class="listitem"><p><code class="varname">xlc</code>:
1.230 sevan 1873: IBM's XL C/C++ compiler suite</p></li>
1.89 rillig 1874: </ul></div>
1875: <p>The default is
1.128 wiz 1876: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 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.128 wiz 1880: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 1881: variable should always be terminated with a value for
1882: a real compiler. Note that only one real compiler
1.128 wiz 1883: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 1884: is not allowed).</p>
1.89 rillig 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.266 leot 1891: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225 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.291 gutterid 1895: <dd><p>Specifies the Fortran compiler to use.
1896: The default is <code class="varname">gfortran</code>.</p></dd>
1.225 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.89 rillig 1901: </dl></div>
1902: </div>
1.148 asau 1903: <div class="sect2">
1.89 rillig 1904: <div class="titlepage"><div><div><h3 class="title">
1.267 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.78 rillig 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">
1.100 rillig 1910: CFLAGS+= -your -flags
1.78 rillig 1911: </pre>
1912: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 1913: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 1914: need to add their own flags. You may want to take a look
1.250 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.128 wiz 1916: package if you're interested in optimization specifically
1917: for the current CPU. </p>
1.78 rillig 1918: </div>
1.148 asau 1919: <div class="sect2">
1.88 wiz 1920: <div class="titlepage"><div><div><h3 class="title">
1.267 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.88 wiz 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">
1.100 rillig 1933: LDFLAGS+= -your -linkerflags
1.88 wiz 1934: </pre>
1935: </div>
1.78 rillig 1936: </div>
1.148 asau 1937: <div class="sect1">
1.78 rillig 1938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1939: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 1940: <p>
1.75 rillig 1941: </p>
1.148 asau 1942: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1943: <li class="listitem">
1.75 rillig 1944: <p><code class="varname">PKG_DEVELOPER</code>:
1945: Run some sanity checks that package developers want:
1946: </p>
1.148 asau 1947: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 1948: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 1949: fuzz</p></li>
1.128 wiz 1950: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 1951: binaries will find their shared libs.</p></li>
1.75 rillig 1952: </ul></div>
1953: <p>
1.87 wiz 1954: </p>
1.75 rillig 1955: </li>
1.128 wiz 1956: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 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.223 rillig 1963: as well as their actual execution progress with <span class="command"><strong>set
1964: -x</strong></span>.</p></li>
1.75 rillig 1965: </ul></div>
1966: <p>
1967: </p>
1968: </div>
1.148 asau 1969: <div class="sect1">
1.75 rillig 1970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1971: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 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>
1.75 rillig 1975: <p>To see which options, if any, a package supports, and which
1.110 hubertf 1976: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 1977: show-options</strong></span>, for example:</p>
1.75 rillig 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.
1.1 grant 1987:
1.75 rillig 1988: These options are enabled by default: firefox
1989: These options are currently enabled: mozilla ssl
1.1 grant 1990: </pre>
1.75 rillig 1991: <p>The following variables can be defined in
1.110 hubertf 1992: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 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.128 wiz 1999: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2000: are disabled. A few examples:</p>
1.75 rillig 2001: <pre class="screen">
1.110 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.75 rillig 2003: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2004: PKG_OPTIONS.kdebase= debug -sasl
2005: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2006: <p>It is important to note that options that were specifically
1.120 snj 2007: suggested by the package maintainer must be explicitly removed if
1.111 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.88 wiz 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.128 wiz 2013: <div class="orderedlist"><ol class="orderedlist" type="1">
2014: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2015: maintainer</p></li>
1.128 wiz 2016: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2017: variables (see below)</p></li>
1.128 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.75 rillig 2020: </ol></div>
2021: <p>For groups of mutually exclusive options, the last option
1.88 wiz 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.110 hubertf 2030: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 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.110 hubertf 2035: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2036: directly. Support for the legacy variables will be removed
2037: eventually.</p>
1.75 rillig 2038: </div>
2039: </div>
1.148 asau 2040: <div class="chapter">
1.75 rillig 2041: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2042: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75 rillig 2043: <div class="toc">
2044: <p><b>Table of Contents</b></p>
1.210 leot 2045: <dl class="toc">
1.267 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.75 rillig 2048: </dl>
2049: </div>
1.148 asau 2050: <div class="sect1">
1.75 rillig 2051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2052: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87 wiz 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.311 leot 2055: another system with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87 wiz 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.110 hubertf 2060: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2061: package</strong></span>:</p>
2062: <pre class="screen">
1.223 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.87 wiz 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.110 hubertf 2068: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2069: it. Binary packages are created by default in
2070: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 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.250 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.267 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.87 wiz 2074: such a binary package.</p>
1.75 rillig 2075: </div>
1.148 asau 2076: <div class="sect1">
1.75 rillig 2077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2078: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.299 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.106 rillig 2080: </div>
2081: </div>
1.148 asau 2082: <div class="chapter">
1.106 rillig 2083: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2084: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 2085: builds)</h2></div></div></div>
2086: <div class="toc">
2087: <p><b>Table of Contents</b></p>
1.210 leot 2088: <dl class="toc">
1.267 rillig 2089: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 2090: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 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.293 rillig 2093: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2094: <dd><dl>
1.294 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.296 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.293 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.106 rillig 2108: </dl>
2109: </div>
1.290 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.180 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.290 gutterid 2115: deploying onto production systems.
1.180 wiz 2116: There is a way of getting a set of binary packages:
1.290 gutterid 2117: the bulk build system, or pbulk ("p" stands for "parallel").
1.223 rillig 2118: This chapter describes how to set it up.</p>
1.148 asau 2119: <div class="sect1">
1.106 rillig 2120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2121: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180 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.290 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.223 rillig 2129: Note that all their dependencies will be built, so you don't need to track them manually.
1.180 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.223 rillig 2134: Essentially, you should provide a fresh system, either a chroot environment
1.180 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.106 rillig 2139: certain packages tried to install files outside the
2140: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2141: <code class="filename">/etc</code>.
2142: </p>
1.106 rillig 2143: </div>
1.148 asau 2144: <div class="sect1">
1.106 rillig 2145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.295 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.148 asau 2148: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.116 rillig 2151: </ul></div>
1.148 asau 2152: <div class="sect2">
1.116 rillig 2153: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 2154: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223 rillig 2155: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178 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.223 rillig 2158: Create a user with name "pbulk".</p>
1.178 asau 2159: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2160: <pre class="screen">
1.264 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.181 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.178 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.230 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.178 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.223 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.178 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.223 rillig 2185: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178 asau 2186: <pre class="programlisting">
2187: www/firefox
2188: mail/thunderbird
2189: misc/libreoffice4
2190: </pre>
1.179 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.178 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.106 rillig 2211: </div>
2212: </div>
1.148 asau 2213: <div class="sect1">
1.106 rillig 2214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2215: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180 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.293 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.294 rillig 2238: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.293 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.294 rillig 2249: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293 rillig 2250: <p>The job of a compiler is not restricted to producing executable
1.294 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.293 rillig 2257: <pre class="programlisting">
2258: CFLAGS+= -Werror=char-subscripts
1.294 rillig 2259: CFLAGS+= -Werror=implicit-function-declaration
1.293 rillig 2260: </pre>
1.294 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.293 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.294 rillig 2270: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293 rillig 2271: </ul></div>
2272: <p>If a package produces these error messages, but the package is
1.294 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.293 rillig 2275: <pre class="programlisting">
1.294 rillig 2276: .if ${PKGPATH} == category/package
1.293 rillig 2277: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2278: # error message
2279: # code
1.294 rillig 2280: # Reason why the code does not need to be fixed.
1.293 rillig 2281: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.294 rillig 2282: .endif
1.293 rillig 2283: </pre>
2284: <p>If the error messages from the compiler are valid and the code
1.294 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.293 rillig 2292: </div>
2293: <div class="sect2">
2294: <div class="titlepage"><div><div><h3 class="title">
1.296 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.293 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.296 rillig 2390: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.293 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.294 rillig 2400: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293 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.296 rillig 2408: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293 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.296 rillig 2416: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293 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.296 rillig 2433: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.293 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.296 rillig 2446: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293 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.296 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.293 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.296 rillig 2462: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.293 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.87 wiz 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.250 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.87 wiz 2483: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2484: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2485: way that keeps all the dependencies for a given package on the same
2486: CD as that package.</p>
1.148 asau 2487: <div class="sect2">
1.75 rillig 2488: <div class="titlepage"><div><div><h3 class="title">
1.293 rillig 2489: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 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>
1.75 rillig 2498: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 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.290 gutterid 2504: directory which contains these files, e.g.:</p>
1.87 wiz 2505: <pre class="screen">
2506: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 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>
1.87 wiz 2512: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2513: </pre>
1.75 rillig 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>
1.76 rillig 2516: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2517: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2518: in their root directories.</p>
1.75 rillig 2519: </div>
2520: </div>
2521: </div>
1.148 asau 2522: <div class="chapter">
1.75 rillig 2523: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2524: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2525: <div class="toc">
2526: <p><b>Table of Contents</b></p>
1.210 leot 2527: <dl class="toc">
1.267 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.90 rillig 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>
1.91 rillig 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">
1.100 rillig 2544: LOCALBASE= /usr/pkg
2545: PKG_SYSCONFBASE= /usr/pkg/etc
2546: VARBASE= /var
1.231 sevan 2547: PKG_DBDIR= /usr/pkg/pkgdb
1.91 rillig 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">
1.100 rillig 2552: LOCALBASE= ${HOME}/pkg
2553: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2554: VARBASE= ${HOME}/pkg/var
1.231 sevan 2555: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.91 rillig 2556: </pre>
2557: <p>What these four directories are for, and what they look like is
2558: explained below.</p>
1.148 asau 2559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2560: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2561: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2562: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 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.128 wiz 2567: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 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.128 wiz 2571: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2572: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 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.90 rillig 2574: itself.</p></li>
2575: </ul></div>
1.148 asau 2576: <div class="sect1">
1.90 rillig 2577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2578: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2579: </h2></div></div></div>
1.90 rillig 2580: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2581: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2582: <div class="variablelist"><dl class="variablelist">
1.90 rillig 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.148 asau 2642: <div class="sect1">
1.90 rillig 2643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2644: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2645: </h2></div></div></div>
1.148 asau 2646: <div class="variablelist"><dl class="variablelist">
1.90 rillig 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.148 asau 2663: <div class="chapter">
1.90 rillig 2664: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2665: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2666: <div class="toc">
2667: <p><b>Table of Contents</b></p>
1.210 leot 2668: <dl class="toc">
1.267 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.128 wiz 2679: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 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.75 rillig 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.148 asau 2692: <div class="sect1">
1.75 rillig 2693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2694: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2695: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2696: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.78 rillig 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.289 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.75 rillig 2707: A list where the results of pkgsrc bulk builds are sent and
2708: discussed.</p></li>
1.289 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.75 rillig 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">
1.100 rillig 2718: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2719: </pre>
2720: <p>Archives for all these mailing lists are available from
1.289 leot 2721: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2722: </div>
1.148 asau 2723: <div class="sect1">
1.75 rillig 2724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2725: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2726: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2727: a number of useful utilities for both users and developers of pkgsrc. This
1.233 sevan 2728: section attempts only to make the reader aware of some of the utilities and when
1.75 rillig 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.250 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.75 rillig 2733: Symlinks for use by buildlink.</p></li></ul></div>
2734: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2735: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 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.233 sevan 2737: Calculates various kinds of checksums (including SHA3).</p></li>
1.250 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.75 rillig 2739: Compatibility library for pkgsrc tools.</p></li>
1.250 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.87 wiz 2741: non-BSD systems due to lack of native mtree.</p></li>
1.250 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.75 rillig 2743: Up-to-date replacement for
1.76 rillig 2744: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2745: systems where pkg_install is not present.</p></li>
2746: </ul></div>
2747: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2748: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 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.75 rillig 2750: Create a binary package from an
1.110 hubertf 2751: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2752: save the old package.</p></li>
1.250 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.75 rillig 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.250 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.117 jnemeth 2758: the best compiler flags to optimise code for your current
1.128 wiz 2759: CPU and compiler. </p></li>
1.75 rillig 2760: </ul></div>
2761: <p>Utilities for keeping track of installed packages, being up to date,
2762: etc:</p>
1.148 asau 2763: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 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.173 wiz 2765: update tool similar to apt(1). Download, install, and upgrade
2766: binary packages easily.</p></li>
1.250 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.75 rillig 2768: packages whose installed versions do not match the latest pkgsrc
2769: entries.</p></li>
1.250 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.75 rillig 2771: dependency graphs of packages, to aid in choosing a strategy for
2772: updating.</p></li>
1.250 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.112 weinem 2776: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.250 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.75 rillig 2778: does various checks on the complete pkgsrc system.</p></li>
1.250 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.75 rillig 2780: packages you have installed.</p></li>
2781: </ul></div>
2782: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2783: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 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.75 rillig 2785: making and maintaining patches for a package (includes pkgdiff,
2786: pkgvi, mkpatches, etc.).</p></li>
1.250 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.75 rillig 2788: converting to pkgsrc.</p></li>
2789: </ul></div>
2790: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2791: utilities)</p>
1.148 asau 2792: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 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.75 rillig 2794: packages in a chrooted area.</p></li>
1.250 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.75 rillig 2796: kernel version for chrooted cross builds.</p></li>
2797: </ul></div>
2798: </div>
1.148 asau 2799: <div class="sect1">
1.75 rillig 2800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2801: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219 rillig 2802: <p>To install packages from source as a non-root user, download
1.267 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.219 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.75 rillig 2810: </div>
1.148 asau 2811: <div class="sect1">
1.75 rillig 2812: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2813: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 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.110 hubertf 2817: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 2818: distfile is found, pkgsrc will try to resume it.</p>
2819: <p>You can also
1.168 wiz 2820: use a different program than the platform default program by changing the
1.117 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.75 rillig 2828: <p>For example, if you want to use
1.117 jnemeth 2829: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 2830: like:</p>
2831: <pre class="programlisting">
1.223 rillig 2832: FETCH_USING= wget
1.1 grant 2833: </pre>
1.75 rillig 2834: </div>
1.148 asau 2835: <div class="sect1">
1.75 rillig 2836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.103 wiz 2838: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 2839: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 2840: you will have to add the following line into
1.110 hubertf 2841: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 2842: <pre class="programlisting">
1.103 wiz 2843: X11_TYPE=modular
1.1 grant 2844: </pre>
1.75 rillig 2845: </div>
1.148 asau 2846: <div class="sect1">
1.75 rillig 2847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2848: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 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.128 wiz 2853: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 2854: port 80 as the proxy port number. So the proxy environment variables
2855: are:</p>
2856: <pre class="programlisting">
1.100 rillig 2857: ftp_proxy=ftp://orpheus.amdahl.com:80/
2858: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 2859: </pre>
1.75 rillig 2860: </div>
1.148 asau 2861: <div class="sect1">
1.75 rillig 2862: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2863: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 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.267 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.75 rillig 2879: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 2880: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 2881: the first available command from the following list:</p>
1.148 asau 2882: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.75 rillig 2885: </ul></div>
2886: <p>On a default NetBSD installation, this will be
1.76 rillig 2887: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 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.110 hubertf 2890: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 2891: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2892: <p>Having that option present will prevent
1.76 rillig 2893: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 2894: transfers.</p>
2895: </div>
1.148 asau 2896: <div class="sect1">
1.75 rillig 2897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2898: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 2899: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 2900: from work or university, where you can't run a <span class="command"><strong>make
1.132 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.75 rillig 2902: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 2903: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 2904: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 2905: resulting list to your machine at work/school and use it there. If you
1.311 leot 2906: don't have a NetBSD-compatible <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75 rillig 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>
1.76 rillig 2915: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 2916: home.</p>
2917: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 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.110 hubertf 2920: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 2921: directly by running:</p>
1.75 rillig 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.148 asau 2928: <div class="sect1">
1.75 rillig 2929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.128 wiz 2931: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.250 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.75 rillig 2933: package, you get the error from make that it doesn't know how to make
1.76 rillig 2934: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 2935: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 2936: the NetBSD base distribution on your machine. It is recommended to do
2937: that to format man pages.</p>
1.250 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.75 rillig 2939: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 2940: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 2941: </div>
1.148 asau 2942: <div class="sect1">
1.75 rillig 2943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.87 wiz 2945: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 2946: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 2947: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 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>
1.76 rillig 2950: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 2951: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 2952: -r</strong></span>).</p>
2953: </div>
1.148 asau 2954: <div class="sect1">
1.75 rillig 2955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2956: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 2957: <p>When installing packages as non-root user and using the just-in-time
1.311 leot 2958: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75 rillig 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.250 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.110 hubertf 2963: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 2964: <span class="emphasis"><em>after</em></span> the definition of the
2965: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 2966: <pre class="programlisting">
1.100 rillig 2967: .if exists(${LOCALBASE}/bin/sudo)
2968: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2969: .endif
1.1 grant 2970: </pre>
1.75 rillig 2971: </div>
1.148 asau 2972: <div class="sect1">
1.75 rillig 2973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2974: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 2975: <p>As the system administrator, you can choose where configuration files
2976: are installed. The default settings make all these files go into
1.76 rillig 2977: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 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.110 hubertf 2983: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 2984: directory; some common examples include <code class="filename">/etc</code> or
2985: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 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.148 asau 2994: <div class="sect1">
1.75 rillig 2995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2996: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75 rillig 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.114 jmcneill 3003: do this, refer to the following two tools (installed as part of the
1.250 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.128 wiz 3005: <div class="orderedlist"><ol class="orderedlist" type="1">
3006: <li class="listitem">
1.122 reed 3007: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3008: download a list of the security vulnerabilities information. This list
1.132 spz 3009: is kept up to date by the pkgsrc security team, and is distributed
3010: from the NetBSD ftp server:</p>
1.292 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.75 rillig 3012: </li>
1.128 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.75 rillig 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.233 sevan 3019: <p>Use of these tools is strongly recommended!
1.267 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.233 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.75 rillig 3024: </div>
1.148 asau 3025: <div class="sect1">
1.75 rillig 3026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.75 rillig 3028: <p>When you add your own preferences to the
3029: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3030: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3031: environment variables to the <code class="filename">./configure</code>
1.311 leot 3032: scripts and to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75 rillig 3033: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3034: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 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.110 hubertf 3038: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3039: directory and then inspect any <code class="filename">Makefile</code> and
3040: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3041: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3042: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 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.287 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.299 rillig 3061: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75 rillig 3062: </div>
1.148 asau 3063: <div class="sect1">
1.80 rillig 3064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3065: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3066: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3067: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 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.148 asau 3073: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 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.80 rillig 3076: files.</p></li>
1.148 asau 3077: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3078: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3079: verify this.</p></li>
1.218 rillig 3080: <li class="step"><p>If you are a package developer who wants to invest
1.267 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.148 asau 3082: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3083: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3084: </ol></div>
3085: </div>
1.148 asau 3086: <div class="sect1">
1.88 wiz 3087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.89 rillig 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.110 hubertf 3096: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3097: -dP</strong></span> in that directory to download the current version.</p>
3098: </div>
1.75 rillig 3099: </div>
3100: </div>
1.148 asau 3101: <div class="part">
1.75 rillig 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.148 asau 3104: <div class="partintro">
1.77 rillig 3105: <div></div>
3106: <p>This part of the book deals with creating and
1.128 wiz 3107: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3108: guide on creating a new package. The remaining chapters are more
3109: like a reference manual for pkgsrc.</p>
1.75 rillig 3110: <div class="toc">
3111: <p><b>Table of Contents</b></p>
1.210 leot 3112: <dl class="toc">
1.267 rillig 3113: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299 rillig 3114: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91 rillig 3115: <dd><dl>
1.299 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.91 rillig 3119: <dd><dl>
1.299 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.91 rillig 3125: </dl></dd>
1.299 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.106 rillig 3135: </dl></dd>
1.299 rillig 3136: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106 rillig 3137: <dd><dl>
1.299 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.106 rillig 3143: <dd><dl>
1.299 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.106 rillig 3146: </dl></dd>
1.299 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.106 rillig 3163: <dd><dl>
1.299 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.106 rillig 3168: </dl></dd>
1.299 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.106 rillig 3171: </dl></dd>
1.299 rillig 3172: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3173: <dd><dl>
1.299 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.106 rillig 3178: <dd><dl>
1.299 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.106 rillig 3183: </dl></dd>
3184: </dl></dd>
1.299 rillig 3185: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106 rillig 3186: <dd><dl>
1.299 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.106 rillig 3191: </dl></dd>
1.299 rillig 3192: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106 rillig 3193: <dd><dl>
1.299 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.106 rillig 3202: <dd><dl>
1.299 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.133 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.106 rillig 3209: </dl></dd>
1.299 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.106 rillig 3217: <dd><dl>
1.299 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.106 rillig 3227: </dl></dd>
1.299 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.106 rillig 3234: </dl></dd>
1.299 rillig 3235: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106 rillig 3236: <dd><dl>
1.299 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.267 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.287 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.267 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.87 wiz 3314: emulation</a></span></dt>
1.267 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.77 rillig 3317: </dl></dd>
1.267 rillig 3318: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3319: </dl></dd>
1.299 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.267 rillig 3327: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 3328: <dd><dl>
1.267 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.75 rillig 3339: </dl>
3340: </div>
1.77 rillig 3341: </div>
1.148 asau 3342: <div class="chapter">
1.77 rillig 3343: <div class="titlepage"><div><div><h2 class="title">
1.267 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.278 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.267 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.299 rillig 3387: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91 rillig 3388: <div class="toc">
3389: <p><b>Table of Contents</b></p>
1.210 leot 3390: <dl class="toc">
1.299 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.91 rillig 3407: </dl></dd>
1.299 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.91 rillig 3410: </dl>
3411: </div>
1.299 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.77 rillig 3451: <pre class="programlisting">
1.299 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.77 rillig 3460: </pre>
3461: </li>
1.299 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>:
1.311 leot 3483: an argument to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.299 rillig 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
1.311 leot 3493: this package which have been reported with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.299 rillig 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.148 asau 3559: <div class="sect1">
1.91 rillig 3560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 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.148 asau 3597: <div class="sect2">
1.91 rillig 3598: <div class="titlepage"><div><div><h3 class="title">
1.299 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.91 rillig 3624: </div>
1.148 asau 3625: <div class="sect2">
1.91 rillig 3626: <div class="titlepage"><div><div><h3 class="title">
1.299 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.118 imil 3660: </div>
1.275 brook 3661: <div class="sect2">
3662: <div class="titlepage"><div><div><h3 class="title">
1.299 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.275 brook 3687: </div>
3688: <div class="sect2">
3689: <div class="titlepage"><div><div><h3 class="title">
1.299 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.275 brook 3730: <pre class="programlisting">
1.299 rillig 3731: case ${target_os} in
3732: netbsd*) have_kvm=yes ;;
3733: *) have_kvm=no ;;
3734: esac
1.275 brook 3735: </pre>
1.299 rillig 3736: </td>
3737: <td>
1.275 brook 3738: <pre class="programlisting">
1.299 rillig 3739: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275 brook 3740: </pre>
1.299 rillig 3741: </td>
3742: </tr>
3743: <tr>
3744: <td>C source file</td>
3745: <td>
1.91 rillig 3746: <pre class="programlisting">
1.299 rillig 3747: #if defined(__NetBSD__)
3748: # include <sys/event.h>
3749: #endif
1.91 rillig 3750: </pre>
1.299 rillig 3751: </td>
3752: <td>
1.91 rillig 3753: <pre class="programlisting">
1.299 rillig 3754: #if defined(HAVE_SYS_EVENT_H)
3755: # include <sys/event.h>
3756: #endif
1.91 rillig 3757: </pre>
1.299 rillig 3758: </td>
3759: </tr>
3760: <tr>
3761: <td>C source file</td>
3762: <td>
1.91 rillig 3763: <pre class="programlisting">
1.299 rillig 3764: int
3765: monitor_file(...)
3766: {
3767: #if defined(__NetBSD__)
3768: int fd = kqueue();
3769: ...
3770: #else
3771: ...
3772: #endif
3773: }
1.91 rillig 3774: </pre>
1.299 rillig 3775: </td>
3776: <td>
1.91 rillig 3777: <pre class="programlisting">
1.299 rillig 3778: int
3779: monitor_file(...)
3780: {
3781: #if defined(HAVE_KQUEUE)
3782: int fd = kqueue();
3783: ...
3784: #else
3785: ...
3786: #endif
3787: }
1.91 rillig 3788: </pre>
1.299 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.91 rillig 3818: </div>
1.299 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>
1.311 leot 3846: <p>This shell script is invoked twice by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.299 rillig 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
1.311 leot 3851: <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
3852: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information. See also <a class="xref" href="#files-and-dirs-outside-prefix" title="20.1. Files and directories outside the installation prefix">Section 20.1, “Files and directories outside the installation prefix”</a>.
1.299 rillig 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.91 rillig 3856: <pre class="programlisting">
1.299 rillig 3857: FILES_SUBST+= SOMEVAR="somevalue"
1.91 rillig 3858: </pre>
1.299 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.
1.311 leot 3872: See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
3873: and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.299 rillig 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.
1.312 gdt 3879: While this was used often in the past, it has two
3880: problems: the display will be missed if many packages are
3881: intalled at once, and the person installing the package
3882: and the one using or configuring it may be different. It
3883: should therefore be used only in exceptional circumstances
3884: where lasting negative consequences would result from
3885: someone not reading it.</p>
3886: <p>MESSAGE should not be used for:</p>
3887: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3888: <li class="listitem"><p>exhortations to read the documentation</p></li>
3889: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
3890: <li class="listitem"><p>anything that should be explained in the
3891: installation/configuration documentation that should
3892: come with the package</p></li>
3893: </ul></div>
3894: <p>If the documentation provided by upstream needs
1.313 leot 3895: enhancing, create e.g. files/README.pkgsrc and install it
3896: in the package's documentation directory.
1.312 gdt 3897: </p>
3898: <p>Note that MESSAGE is shown for all operating
3899: systems and all init systems. If a MESSAGE is necessary,
1.313 leot 3900: it should be narrowed to only those operating systems and
1.312 gdt 3901: init systems to which it applies.</p>
3902: <p>Note that you can modify variables in it easily by using
1.299 rillig 3903: <code class="varname">MESSAGE_SUBST</code> in the package's
3904: <code class="filename">Makefile</code>:</p>
1.91 rillig 3905: <pre class="programlisting">
1.299 rillig 3906: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.91 rillig 3907: </pre>
1.299 rillig 3908: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
3909: <code class="filename">MESSAGE</code>. By default, substitution is
3910: performed for <code class="varname">PKGNAME</code>,
3911: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
3912: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3913: <code class="varname">PKG_SYSCONFDIR</code>,
3914: <code class="varname">ROOT_GROUP</code>, and
3915: <code class="varname">ROOT_USER</code>.</p>
3916: <p>You can display a different or additional files by
3917: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3918: default is <code class="filename">MESSAGE</code>, if the file
3919: exists.</p>
3920: </dd>
3921: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
3922: <dd>
3923: <p>This file is used by the alternatives framework.
3924: It creates, configures, and destroys generic wrappers used to
3925: run programs with similar interfaces.
3926: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3927: for more information.</p>
3928: <p>Each line of the file contains two filenames, first
3929: the wrapper and then the alternative provided by the package.
3930: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3931: </dd>
3932: </dl></div>
3933: </div>
3934: <div class="sect2">
3935: <div class="titlepage"><div><div><h3 class="title">
3936: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
3937: <div class="variablelist"><dl class="variablelist">
3938: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3939: <dd><p>This file contains arbitrary things that could
3940: also go into a <code class="filename">Makefile</code>, but its purpose is
3941: to be used by more than one package. This file should only be
3942: used when the packages that will use the file are known in
3943: advance. For other purposes it is often better to write a
3944: <code class="filename">*.mk</code> file and give it a good name that
3945: describes what it does.</p></dd>
3946: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3947: <dd><p>This file contains the dependency information
3948: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
3949: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3950: <dd><p>This file contains workarounds for compiler bugs
3951: and similar things. It is included automatically by the pkgsrc
3952: infrastructure, so you don't need an extra
3953: <code class="literal">.include</code> line for
3954: it.</p></dd>
3955: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3956: <dd><p>This file contains the code for the
3957: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
3958: selected by the user. If a package has only one or two options,
3959: it is equally acceptable to put the code directly into the
3960: <code class="filename">Makefile</code>.</p></dd>
3961: </dl></div>
3962: </div>
3963: <div class="sect2">
3964: <div class="titlepage"><div><div><h3 class="title">
3965: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
3966: <div class="variablelist"><dl class="variablelist">
3967: <dt><span class="term"><code class="filename">README*</code></span></dt>
3968: <dd><p>These files do not take place in the creation of
3969: a package and thus are purely informative to the package
3970: developer.</p></dd>
3971: <dt><span class="term"><code class="filename">TODO</code></span></dt>
3972: <dd><p>This file contains things that need to be done
3973: to make the package even
3974: better.</p></dd>
3975: </dl></div>
3976: </div>
3977: </div>
3978: <div class="sect1">
3979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3980: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
3981: </h2></div></div></div>
3982: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
3983: unpacked into the directory denoted by
3984: <code class="varname">WRKDIR</code>. It can be removed by running
3985: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
3986: directory is also used to keep various timestamp files.
3987: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
3988: The default is <code class="filename">${.CURDIR}/work</code>
3989: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
3990: if <code class="varname">OBJMACHINE</code> is set.</p>
1.91 rillig 3991: </div>
1.299 rillig 3992: <div class="sect1">
3993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3994: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
3995: </h2></div></div></div>
3996: <p>If you have any files that you wish to be placed in the package
3997: prior to configuration or building, you can place these files here
3998: and use a <span class="command"><strong>${CP}</strong></span> command in the
3999: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4000: <p>If you want to share files in this way with other
4001: packages, set the <code class="varname">FILESDIR</code> variable to point
4002: to the other package's <code class="filename">files</code> directory,
4003: e.g.:</p>
1.91 rillig 4004: <pre class="programlisting">
1.299 rillig 4005: FILESDIR= ../../editors/xemacs/files
1.91 rillig 4006: </pre>
4007: </div>
4008: </div>
1.148 asau 4009: <div class="chapter">
1.75 rillig 4010: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 4011: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75 rillig 4012: <div class="toc">
4013: <p><b>Table of Contents</b></p>
1.210 leot 4014: <dl class="toc">
1.299 rillig 4015: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4016: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4017: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4018: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4019: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4020: <dd><dl>
4021: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4022: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4023: </dl></dd>
4024: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4025: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4026: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4027: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4028: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4029: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4030: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4031: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4032: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4033: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4034: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4035: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75 rillig 4036: </dl>
4037: </div>
1.148 asau 4038: <div class="sect1">
1.75 rillig 4039: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4040: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4041: <p>This chapter gives a detailed description on how a package is
4042: built. Building a package is separated into different
4043: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4044: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4045: described in the following sections. Each phase is split into
4046: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4047: containing phase, prefixed by one of <code class="varname">pre-</code>,
4048: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4049: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4050: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4051: <p>Never override the regular targets (like
4052: <code class="varname">fetch</code>), if you have to, override the
4053: <code class="varname">do-*</code> ones instead.</p>
4054: <p>The basic steps for building a program are always the same. First
4055: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4056: the local system and then extracted. After any pkgsrc-specific patches
4057: to compile properly are applied, the software can be configured, then
4058: built (usually by compiling), and finally the generated binaries, etc.
4059: can be put into place on the system.</p>
4060: <p>To get more details about what is happening at each step,
4061: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4062: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4063: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4064: </div>
4065: <div class="sect1">
4066: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4067: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4068: <p>Before outlining the process performed by the NetBSD package system in
4069: the next section, here's a brief discussion on where programs are
4070: installed, and which variables influence this.</p>
4071: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4072: where all files of the final program shall be installed. It is
4073: usually set to <code class="varname">LOCALBASE</code>
4074: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4075: for pkgs in the <code class="filename">cross</code> category. The value of
4076: <code class="varname">PREFIX</code> needs to be put
4077: into the various places in the program's source where paths to
4078: 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>
4079: <p>When choosing which of these variables to use,
4080: follow the following rules:</p>
1.148 asau 4081: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 4082: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4083: where the current pkg will be installed. When referring to a
4084: pkg's own installation path, use
4085: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
4086: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
4087: are installed. If you need to construct a -I or -L argument
4088: to the compiler to find includes and libraries installed by
4089: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
4090: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4091: installed all packages in <code class="filename">/usr/local</code>. As
4092: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4093: administrator, this variable is a misnomer.</p></li>
4094: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4095: distribution (from xsrc, etc.) is installed. When looking for
4096: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4097: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4098: <li class="listitem"><p>X11-based packages using imake must set
4099: <code class="varname">USE_IMAKE</code> to be installed correctly under
4100: <code class="varname">LOCALBASE</code>.</p></li>
4101: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.311 leot 4102: install files according to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.299 rillig 4103: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4104: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4105: </ul></div>
4106: </div>
4107: <div class="sect1">
4108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4109: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4110: <p>When building a package, various directories are used to store
4111: source files, temporary files, pkgsrc-internal files, and so on. These
4112: directories are explained here.</p>
4113: <p>Some of the directory variables contain relative pathnames. There
4114: are two common base directories for these relative directories:
4115: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4116: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4117: inside the package itself.</p>
4118: <div class="variablelist"><dl class="variablelist">
4119: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4120: <dd><p>This is an absolute pathname that points to the pkgsrc
4121: root directory. Generally, you don't need
4122: it.</p></dd>
4123: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4124: <dd><p>This is an absolute pathname that points to the
4125: current package.</p></dd>
4126: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
4127: <dd><p>This is a pathname relative to
4128: <code class="varname">PKGSRCDIR</code> that points to the current
4129: package.</p></dd>
4130: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4131: <dd><p>This is an absolute pathname pointing to the directory
4132: where all work takes place. The distfiles are extracted to this
4133: directory. It also contains temporary directories and log files used by
4134: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4135: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4136: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4137: <dd><p>This is an absolute pathname pointing to the directory
4138: where the distfiles are extracted. It is usually a direct subdirectory
4139: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4140: that isn't hidden. This variable may be changed by a package
4141: <code class="filename">Makefile</code>.</p></dd>
4142: </dl></div>
4143: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4144: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4145: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4146: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4147: If users would like to have their pkgsrc trees behave in a
4148: read-only manner, then the value of
4149: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4150: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 4151: </div>
1.148 asau 4152: <div class="sect1">
1.75 rillig 4153: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4154: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4155: <p>You can run a particular phase by typing <span class="command"><strong>make
4156: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
4157: phase. This will automatically run all phases that are required for this
4158: phase. The default phase is <code class="varname">build</code>, that is, when you
4159: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
4160: the package will be built, but not installed.</p>
1.75 rillig 4161: </div>
1.148 asau 4162: <div class="sect1">
1.75 rillig 4163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4164: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4165: <p>The first step in building a package is to fetch the
4166: distribution files (distfiles) from the sites that are providing
4167: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4168: phase.</p>
1.148 asau 4169: <div class="sect2">
1.93 rillig 4170: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 4171: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4172: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4173: defines all URLs from where the distfile, whose name is
4174: derived from the <code class="varname">DISTNAME</code> variable, is
4175: fetched. The more complicated cases are described
4176: below.</p>
4177: <p>The variable <code class="varname">DISTFILES</code> specifies
4178: the list of distfiles that have to be fetched. Its value
4179: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4180: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4181: so that most packages don't need to define it at all.
4182: <code class="varname">EXTRACT_SUFX</code> is
4183: <code class="literal">.tar.gz</code> by default, but can be changed
4184: freely. Note that if your package requires additional
4185: distfiles to the default one, you cannot just append the
4186: additional filenames using the <code class="literal">+=</code>
4187: operator, but you have write for example:</p>
4188: <pre class="programlisting">
4189: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4190: </pre>
4191: <p>Each distfile is fetched from a list of sites, usually
4192: <code class="varname">MASTER_SITES</code>. If the package has multiple
4193: <code class="varname">DISTFILES</code> or multiple
4194: <code class="varname">PATCHFILES</code> from different sites, you can
4195: set
4196: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4197: to the list of URLs where the file
4198: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4199: (including the suffix) can be found.</p>
4200: <pre class="programlisting">
4201: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4202: DISTFILES+= foo-file.tar.gz
4203: SITES.foo-file.tar.gz= \
4204: https://www.somewhere.com/somehow/ \
4205: https://www.somewhereelse.com/mirror/somehow/
4206: </pre>
4207: <p>When actually fetching the distfiles, each item from
4208: <code class="varname">MASTER_SITES</code> or
4209: <code class="varname">SITES.*</code> gets the name of each distfile
4210: appended to it, without an intermediate slash. Therefore,
4211: all site values have to end with a slash or other separator
4212: character. This allows for example to set
4213: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4214: that gets the name of the distfile as a parameter. In this
4215: case, the definition would look like:</p>
4216: <pre class="programlisting">
4217: MASTER_SITES= https://www.example.com/download.cgi?file=
4218: </pre>
4219: <p> The exception to this rule are URLs starting with a dash.
4220: In that case the URL is taken as is, fetched and the result
4221: stored under the name of the distfile. You can use this style
4222: for the case when the download URL style does not match the
4223: above common case. For example, if permanent download URL is a
4224: redirector to the real download URL, or the download file name
4225: is offered by an HTTP Content-Disposition header. In the
4226: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4227: created instead of the default
4228: <code class="filename">v1.0.0.tar.gz</code>.</p>
4229: <pre class="programlisting">
4230: DISTNAME= foo-1.0.0
4231: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4232: </pre>
4233: <p>There are some predefined values for
4234: <code class="varname">MASTER_SITES</code>, which can be used in
4235: packages. The names of the variables should speak for
4236: themselves.</p>
4237: <table border="0" summary="Simple list" class="simplelist">
4238: <tr>
4239: <td>MASTER_SITE_APACHE</td>
4240: <td>MASTER_SITE_BACKUP</td>
4241: </tr>
4242: <tr>
4243: <td>MASTER_SITE_CRATESIO</td>
4244: <td>MASTER_SITE_CYGWIN</td>
4245: </tr>
4246: <tr>
4247: <td>MASTER_SITE_DEBIAN</td>
4248: <td>MASTER_SITE_FREEBSD</td>
4249: </tr>
4250: <tr>
4251: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4252: <td>MASTER_SITE_GENTOO</td>
4253: </tr>
4254: <tr>
4255: <td>MASTER_SITE_GITHUB</td>
4256: <td>MASTER_SITE_GNOME</td>
4257: </tr>
4258: <tr>
4259: <td>MASTER_SITE_GNU</td>
4260: <td>MASTER_SITE_GNUSTEP</td>
4261: </tr>
4262: <tr>
4263: <td>MASTER_SITE_HASKELL_HACKAGE</td>
4264: <td>MASTER_SITE_IFARCHIVE</td>
4265: </tr>
4266: <tr>
4267: <td>MASTER_SITE_KDE</td>
4268: <td>MASTER_SITE_MOZILLA</td>
4269: </tr>
4270: <tr>
4271: <td>MASTER_SITE_MOZILLA_ALL</td>
4272: <td>MASTER_SITE_MYSQL</td>
4273: </tr>
4274: <tr>
4275: <td>MASTER_SITE_NETLIB</td>
4276: <td>MASTER_SITE_OPENBSD</td>
4277: </tr>
4278: <tr>
4279: <td>MASTER_SITE_OPENOFFICE</td>
4280: <td>MASTER_SITE_OSDN</td>
4281: </tr>
4282: <tr>
4283: <td>MASTER_SITE_PERL_CPAN</td>
4284: <td>MASTER_SITE_PGSQL</td>
4285: </tr>
4286: <tr>
4287: <td>MASTER_SITE_PYPI</td>
4288: <td>MASTER_SITE_RUBYGEMS</td>
4289: </tr>
4290: <tr>
4291: <td>MASTER_SITE_R_CRAN</td>
4292: <td>MASTER_SITE_SOURCEFORGE</td>
4293: </tr>
1.85 jmmv 4294: <tr>
1.299 rillig 4295: <td>MASTER_SITE_SUNSITE</td>
4296: <td>MASTER_SITE_SUSE</td>
1.85 jmmv 4297: </tr>
4298: <tr>
1.299 rillig 4299: <td>MASTER_SITE_TEX_CTAN</td>
4300: <td>MASTER_SITE_XCONTRIB</td>
1.85 jmmv 4301: </tr>
4302: <tr>
1.299 rillig 4303: <td>MASTER_SITE_XEMACS</td>
4304: <td>MASTER_SITE_XORG</td>
4305: </tr>
4306: </table>
4307: <p>Some explanations for the less self-explaining ones:
4308: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
4309: 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
4310: 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>
4311: <p>If you choose one of these predefined sites, you may
4312: want to specify a subdirectory of that site. Since these
4313: macros may expand to more than one actual site, you
4314: <span class="emphasis"><em>must</em></span> use the following construct to
4315: specify a subdirectory:</p>
1.100 rillig 4316: <pre class="programlisting">
1.299 rillig 4317: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4318: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100 rillig 4319: </pre>
1.299 rillig 4320: <p>Note the trailing slash after the subdirectory
4321: name.</p>
4322: </div>
4323: <div class="sect2">
4324: <div class="titlepage"><div><div><h3 class="title">
4325: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4326: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4327: all the distfiles exist in a local directory
4328: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4329: user). If the files do not exist, they are fetched using
4330: commands of the form</p>
1.100 rillig 4331: <pre class="programlisting">
1.299 rillig 4332: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4333: </pre>
4334: <p>where <code class="literal">${site}</code> varies through
4335: several possibilities in turn: first,
4336: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4337: sites specified in either <code class="varname">SITES.file</code> if
4338: defined, else <code class="varname">MASTER_SITES</code> or
4339: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4340: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4341: all except the first and the last can be optionally sorted
4342: by the user, via setting either
4343: <code class="varname">MASTER_SORT_RANDOM</code>, and
4344: <code class="varname">MASTER_SORT_AWK</code> or
4345: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4346: <p> The specific command and arguments used depend on the
4347: <code class="varname">FETCH_USING</code> parameter. The example above is
4348: for <code class="literal">FETCH_USING=custom</code>.</p>
4349: <p>The distfiles mirror run by the NetBSD Foundation uses the
4350: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4351: distfiles, if they are freely distributable. Packages setting
4352: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4353: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4354: mirrored.</p>
1.85 jmmv 4355: </div>
4356: </div>
1.299 rillig 4357: <div class="sect1">
4358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4359: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4360: <p>After the distfile(s) are fetched, their checksum is
4361: generated and compared with the checksums stored in the
4362: distinfo file. If the checksums don't match, the build is
4363: aborted. This is to ensure the same distfile is used for
4364: building, and that the distfile wasn't changed, e.g. by some
4365: malign force, deliberately changed distfiles on the master
4366: distribution site or network lossage.</p>
1.75 rillig 4367: </div>
1.148 asau 4368: <div class="sect1">
1.75 rillig 4369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4370: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4371: <p>When the distfiles are present on the local system, they
4372: need to be extracted, as they usually come in the form of some
4373: compressed archive format.</p>
4374: <p>By default, all <code class="varname">DISTFILES</code> are
4375: extracted. If you only need some of them, you can set the
4376: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4377: files.</p>
4378: <p>Extracting the files is usually done by a little
4379: program, <code class="filename">mk/extract/extract</code>, which
4380: already knows how to extract various archive formats, so most
4381: likely you will not need to change anything here. But if you
4382: need, the following variables may help you:</p>
1.148 asau 4383: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4384: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4385: <dd><p>Use these variables to override the default
4386: options for an extract command, which are defined in
4387: <code class="filename">mk/extract/extract</code>.</p></dd>
4388: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4389: <dd><p>This variable can be set to
4390: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4391: (which is the default value), <code class="literal">pax</code>, or an
4392: absolute pathname pointing to the command with which tar
4393: archives should be extracted. It is preferred to choose bsdtar over gtar
4394: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 4395: </dl></div>
1.299 rillig 4396: <p>If the <code class="filename">extract</code> program doesn't
4397: serve your needs, you can also override the
4398: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4399: command used for extracting the files. This command is
4400: executed in the <code class="filename">${WRKSRC}</code>
4401: directory. During execution of this command, the shell
4402: variable <code class="varname">extract_file</code> holds the absolute
4403: pathname of the file that is going to be extracted.</p>
4404: <p>And if that still does not suffice, you can override the
4405: <code class="varname">do-extract</code> target in the package
4406: Makefile.</p>
1.75 rillig 4407: </div>
1.148 asau 4408: <div class="sect1">
1.75 rillig 4409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4410: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4411: <p>After extraction, all the patches named by the
4412: <code class="varname">PATCHFILES</code>, those present in the patches
4413: subdirectory of the package as well as in
4414: $LOCALPATCHES/$PKGPATH (e.g.
4415: <code class="filename">/usr/local/patches/graphics/png</code>) are
4416: applied. Patchfiles ending in <code class="filename">.Z</code> or
4417: <code class="filename">.gz</code> are uncompressed before they are
4418: applied, files ending in <code class="filename">.orig</code> or
4419: <code class="filename">.rej</code> are ignored. Any special options to
1.311 leot 4420: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.299 rillig 4421: <code class="varname">PATCH_DIST_ARGS</code>. See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> for more details.</p>
1.311 leot 4422: <p>By default <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.299 rillig 4423: fail if the expected text from the patch context is not found in the
4424: patched file. If that happens, fix the patch file by comparing it
4425: with the actual text in the file to be patched.</p>
1.78 rillig 4426: </div>
1.148 asau 4427: <div class="sect1">
1.75 rillig 4428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4429: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4430: <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>.
4431: </p>
1.75 rillig 4432: </div>
1.148 asau 4433: <div class="sect1">
1.75 rillig 4434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4435: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4436: <p>This phase creates wrapper programs for the compilers and
4437: linkers. The following variables can be used to tweak the
4438: wrappers.</p>
4439: <div class="variablelist"><dl class="variablelist">
4440: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4441: <dd><p>The command used to print progress
4442: messages. Does nothing by default. Set to
4443: <code class="literal">${ECHO}</code> to see the progress
4444: messages.</p></dd>
4445: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4446: <dd><p>This variable can be set to
4447: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4448: depending on whether you want additional information in the
4449: wrapper log file.</p></dd>
4450: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4451: <dd><p>This variable can be set to
4452: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4453: on whether the wrapper should use its cache, which will
4454: improve the speed. The default value is
4455: <code class="literal">yes</code>, but is forced to
4456: <code class="literal">no</code> if the platform does not support
4457: it.</p></dd>
4458: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4459: <dd><p>A list of reordering commands. A reordering
4460: command has the form
4461: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4462: It ensures that that
4463: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4464: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4465: </p></dd>
4466: </dl></div>
4467: </div>
4468: <div class="sect1">
4469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4470: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4471: <p>Most pieces of software need information on the header
4472: files, system calls, and library routines which are available
4473: on the platform they run on. The process of determining this
4474: information is known as configuration, and is usually
4475: automated. In most cases, a script is supplied with the
4476: distfiles, and its invocation results in generation of header
4477: files, Makefiles, etc.</p>
4478: <p>If the package contains a configure script, this can be
4479: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4480: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4481: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.301 rillig 4482: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4483: <p>In the <code class="literal">do-configure</code> stage, a rough
4484: equivalent of the following command is run. See
4485: <code class="filename">mk/configure/configure.mk</code>, target
4486: <code class="literal">do-configure-script</code> for the exact
4487: definition.</p>
4488: <pre class="programlisting">
4489: .for dir in ${CONFIGURE_DIRS}
4490: cd ${WRKSRC} && cd ${dir} \
4491: && env ${CONFIGURE_ENV} \
4492: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299 rillig 4493: .endfor
1.100 rillig 4494: </pre>
1.299 rillig 4495: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4496: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4497: <code class="varname">WRKSRC</code>. In each of these directories, the
4498: configure script is run with the environment
4499: <code class="varname">CONFIGURE_ENV</code> and arguments
4500: <code class="varname">CONFIGURE_ARGS</code>. The variables
4501: <code class="varname">CONFIGURE_ENV</code>,
4502: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4503: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4504: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4505: package.</p>
4506: <p>If the program uses the Perl way of configuration (mainly Perl
4507: modules, but not only), i.e. a file called
4508: <code class="filename">Makefile.PL</code>, it should include
4509: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4510: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4511: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4512: <p>If the program uses an <code class="filename">Imakefile</code>
4513: for configuration, the appropriate steps can be invoked by
4514: setting <code class="varname">USE_IMAKE</code> to
4515: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4516: You can add variables to xmkmf's environment by adding them to the
4517: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4518: <p>If the program uses <code class="filename">cmake</code>
4519: for configuration, the appropriate steps can be invoked by
4520: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
4521: You can add variables to cmake's environment by adding them to the
4522: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
4523: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
4524: The top directory argument is given by the
4525: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
4526: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
4527: <p>If there is no configure step at all, set
4528: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 4529: </div>
1.148 asau 4530: <div class="sect1">
1.75 rillig 4531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4532: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301 rillig 4533: <p>For building a package, a rough equivalent of the following
4534: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4535: <code class="literal">do-build</code> for the exact definition.</p>
1.97 rillig 4536: <pre class="programlisting">
1.301 rillig 4537: .for dir in ${BUILD_DIRS}
4538: cd ${WRKSRC} && cd ${dir} \
1.299 rillig 4539: && env ${MAKE_ENV} \
1.301 rillig 4540: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299 rillig 4541: -f ${MAKE_FILE} \
4542: ${BUILD_TARGET}
4543: .endfor
1.97 rillig 4544: </pre>
1.299 rillig 4545: <p><code class="varname">BUILD_DIRS</code> (default:
4546: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4547: <code class="varname">WRKSRC</code>. In each of these directories,
4548: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4549: <code class="varname">MAKE_ENV</code> and arguments
4550: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4551: <code class="varname">MAKE_ENV</code>,
4552: <code class="varname">BUILD_MAKE_FLAGS</code>,
4553: <code class="varname">MAKE_FILE</code> and
4554: <code class="varname">BUILD_TARGET</code> may all be changed by the
4555: package.</p>
4556: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4557: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4558: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4559: default value of <code class="varname">MAKE_FILE</code> is
4560: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4561: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4562: <p>If there is no build step at all, set
4563: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.97 rillig 4564: </div>
1.148 asau 4565: <div class="sect1">
1.97 rillig 4566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4567: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4568: <p>[TODO]</p>
1.75 rillig 4569: </div>
1.148 asau 4570: <div class="sect1">
1.75 rillig 4571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4572: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4573: <p>Once the build stage has completed, the final step is to
4574: install the software in public directories, so users can
4575: access the programs and files.</p>
1.301 rillig 4576: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4577: of the following code is executed; see
4578: <code class="filename">mk/install/install.mk</code>, target
4579: <code class="literal">do-install</code> for the exact definition. Additionally,
4580: before and after this code, several consistency checks are run
4581: against the files-to-be-installed, see
4582: <code class="filename">mk/check/*.mk</code> for details.</p>
4583: <pre class="programlisting">
4584: .for dir in ${INSTALL_DIRS}
4585: cd ${WRKSRC} && cd ${dir} \
4586: && env ${INSTALL_ENV} ${MAKE_ENV} \
4587: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4588: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299 rillig 4589: .endfor
1.220 wiz 4590: </pre>
1.299 rillig 4591: <p>The variable's meanings are analogous to the ones in the
4592: <span class="emphasis"><em>build</em></span> phase.
4593: <code class="varname">INSTALL_DIRS</code> defaults to
4594: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4595: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4596: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4597: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4598: defined.</p>
4599: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4600: variables are useful. They are all variations of the
1.311 leot 4601: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.299 rillig 4602: permissions preset. <code class="varname">INSTALL</code> is the plain
4603: install command. The specialized variants, together with their
4604: intended use, are:</p>
4605: <div class="variablelist"><dl class="variablelist">
4606: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4607: <dd><p>directories that contain
4608: binaries</p></dd>
4609: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4610: <dd><p>directories that contain
4611: scripts</p></dd>
4612: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4613: <dd><p>directories that contain shared and static
4614: libraries</p></dd>
4615: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4616: <dd><p>directories that contain data
4617: files</p></dd>
4618: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4619: <dd><p>directories that contain man
4620: pages</p></dd>
4621: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4622: <dd><p>directories that contain data files for games
4623: </p></dd>
4624: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4625: <dd><p>binaries that can be stripped from debugging
4626: symbols</p></dd>
4627: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4628: <dd><p>binaries that cannot be
4629: stripped</p></dd>
4630: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4631: <dd><p>game
4632: binaries</p></dd>
4633: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4634: <dd><p>shared and static
4635: libraries</p></dd>
4636: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4637: <dd><p>data files</p></dd>
4638: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4639: <dd><p>data files for
4640: games</p></dd>
4641: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4642: <dd><p>man pages</p></dd>
4643: </dl></div>
4644: <p>Some other variables are:</p>
4645: <div class="variablelist"><dl class="variablelist">
4646: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.311 leot 4647: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.299 rillig 4648: when installing binaries. Any debugging sections and symbols present in
4649: binaries will be preserved.
4650: </p></dd>
4651: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4652: <dd><p>A list of directories relative to
4653: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4654: beginning of the <span class="emphasis"><em>install</em></span> phase.
4655: The package is supposed to create all needed directories itself
4656: before installing files to it and list all other directories here.
4657: </p></dd>
4658: </dl></div>
4659: <p>In the rare cases that a package shouldn't install anything,
4660: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4661: mostly relevant for packages in the <code class="filename">regress</code>
4662: category.</p>
1.75 rillig 4663: </div>
1.148 asau 4664: <div class="sect1">
1.75 rillig 4665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4666: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4667: <p>Once the install stage has completed, a binary package of
4668: the installed files can be built. These binary packages can be
4669: used for quick installation without previous compilation, e.g. by
4670: the <span class="command"><strong>make bin-install</strong></span> or by using
4671: <span class="command"><strong>pkg_add</strong></span>.</p>
4672: <p>By default, the binary packages are created in
4673: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4674: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4675: one for each category in the <code class="varname">CATEGORIES</code>
4676: variable. <code class="varname">PACKAGES</code> defaults to
4677: <code class="filename">pkgsrc/packages</code>.</p>
1.75 rillig 4678: </div>
1.148 asau 4679: <div class="sect1">
1.75 rillig 4680: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4681: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4682: <p>Once you're finished with a package, you can clean the work
4683: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4684: to clean the work directories of all dependencies too, use
4685: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 4686: </div>
1.148 asau 4687: <div class="sect1">
1.75 rillig 4688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4689: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148 asau 4690: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4691: <dt><span class="term">pre/post-*</span></dt>
4692: <dd>
4693: <p>For any of the main targets described in the previous
4694: section (configure, build, install, etc.), two auxiliary
4695: targets exist with
4696: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4697: prefix for the main target's name. These targets are
4698: invoked before and after the main target is called,
4699: allowing extra configuration or installation steps be
4700: performed from a package's Makefile, for example, which
4701: a program's configure script or install target
4702: omitted.</p>
4703: <p>About 5% of the pkgsrc packages define their custom
4704: post-extract target, another 5% define pre-configure, and 10%
4705: define post-install. The other pre/post-* targets are defined
4706: even less often.</p>
4707: </dd>
4708: <dt><span class="term">do-*</span></dt>
1.75 rillig 4709: <dd>
1.299 rillig 4710: <p>Should one of the main targets do the wrong thing,
4711: and should there be no variable to fix this, you can
4712: redefine it with the do-* target. (Note that redefining
4713: the target itself instead of the do-* target is a bad
4714: idea, as the pre-* and post-* targets won't be called
4715: anymore, etc.)</p>
4716: <p>About 15% of the pkgsrc packages override the default
4717: do-install, the other do-* targets are overridden even less
4718: often.</p>
1.75 rillig 4719: </dd>
1.299 rillig 4720: <dt><span class="term">reinstall</span></dt>
1.75 rillig 4721: <dd>
1.299 rillig 4722: <p>If you did a <span class="command"><strong>make install</strong></span> and
4723: you noticed some file was not installed properly, you
4724: can repeat the installation with this target, which will
4725: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4726: <p>This is the default value of
4727: <code class="varname">DEPENDS_TARGET</code> except in the case of
4728: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4729: package</strong></span>, where the defaults are
4730: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4731: respectively.</p>
1.75 rillig 4732: </dd>
1.299 rillig 4733: <dt><span class="term">deinstall</span></dt>
4734: <dd>
1.311 leot 4735: <p>This target does a <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.299 rillig 4736: current directory, effectively de-installing the
4737: package. The following variables can be used to tune the
4738: behaviour:</p>
4739: <div class="variablelist"><dl class="variablelist">
4740: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.311 leot 4741: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.299 rillig 4742: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4743: <dd><p>Remove all packages that require (depend on)
4744: the given package. This can be used to remove any
4745: packages that may have been pulled in by a given
4746: package, e.g. if <span class="command"><strong>make deinstall
4747: DEINSTALLDEPENDS=1</strong></span> is done in
4748: <code class="filename">pkgsrc/x11/kde</code>, this is
4749: likely to remove whole KDE. Works by adding
1.311 leot 4750: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.299 rillig 4751: command line.</p></dd>
4752: </dl></div>
4753: </dd>
4754: <dt><span class="term">bin-install</span></dt>
4755: <dd><p>Install a binary package from local disk and via FTP
4756: from a list of sites (see the
4757: <code class="varname">BINPKG_SITES</code> variable), and do a
4758: <span class="command"><strong>make package</strong></span> if no binary package is
4759: available anywhere. The arguments given to
4760: <span class="command"><strong>pkg_add</strong></span> can be set via
4761: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4762: operation, etc.</p></dd>
4763: <dt><span class="term">install-clean</span></dt>
4764: <dd><p>This target removes the state files for the "install" and later
4765: phases so that the "install" target may be re-invoked. This can be
4766: used after editing the PLIST to install the package without
4767: rebuilding it.</p></dd>
4768: <dt><span class="term">build-clean</span></dt>
4769: <dd><p>This target removes the state files for the "build" and later
4770: phases so that the "build" target may be re-invoked.</p></dd>
4771: <dt><span class="term">update</span></dt>
4772: <dd>
4773: <p>This target causes the current package to be
4774: updated to the latest version. The package and all
4775: depending packages first get de-installed, then current
4776: versions of the corresponding packages get compiled and
4777: installed. This is similar to manually noting which
4778: packages are currently installed, then performing a
4779: series of <span class="command"><strong>make deinstall</strong></span> and
4780: <span class="command"><strong>make install</strong></span> (or whatever
4781: <code class="varname">UPDATE_TARGET</code> is set to) for these
4782: packages.</p>
4783: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4784: resume package updating in case a previous <span class="command"><strong>make
4785: update</strong></span> was interrupted for some reason.
4786: However, in this case, make sure you don't call
4787: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4788: list of dependent packages in <code class="varname">WRKDIR</code>.
4789: Otherwise, you lose the ability to automatically update
4790: the current package along with the dependent packages
4791: you have installed.</p>
4792: <p>Resuming an interrupted <span class="command"><strong>make
4793: update</strong></span> will only work as long as the package
4794: tree remains unchanged. If the source code for one of
4795: the packages to be updated has been changed, resuming
4796: <span class="command"><strong>make update</strong></span> will most certainly
4797: fail!</p>
4798: <p>The following variables can be used either on the
4799: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4800: alter the behaviour of <span class="command"><strong>make
4801: update</strong></span>:</p>
4802: <div class="variablelist"><dl class="variablelist">
4803: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4804: <dd><p>Install target to recursively use for the
4805: updated package and the dependent packages.
4806: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4807: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4808: <span class="command"><strong>make update</strong></span>. Other good
4809: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4810: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4811: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4812: endless loop!</p></dd>
4813: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4814: <dd><p>Don't clean up after updating. Useful if
4815: you want to leave the work sources of the updated
4816: packages around for inspection or other purposes.
4817: Be sure you eventually clean up the source tree
4818: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4819: or you may run into troubles with old source code
4820: still lying around on your next
4821: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4822: update</strong></span>.</p></dd>
4823: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4824: <dd><p>Deinstall each package before installing
4825: (making <code class="varname">DEPENDS_TARGET</code>). This
4826: may be necessary if the
4827: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4828: called after interrupting a running <span class="command"><strong>make
4829: update</strong></span>.</p></dd>
4830: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4831: <dd><p>Allows you to disable recursion and hardcode
4832: the target for packages. The default is
4833: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4834: facilitating a recursive update of prerequisite
4835: packages. Only set
4836: <code class="varname">DEPENDS_TARGET</code> if you want to
4837: disable recursive updates. Use
4838: <code class="varname">UPDATE_TARGET</code> instead to just
4839: set a specific target for each package to be
4840: installed during <span class="command"><strong>make update</strong></span>
4841: (see above).</p></dd>
4842: </dl></div>
4843: </dd>
4844: <dt><span class="term">clean-update</span></dt>
4845: <dd>
4846: <p>Clean the source tree for all packages that would
4847: get updated if <span class="command"><strong>make update</strong></span> was called
4848: from the current directory. This target should not be
4849: used if the current package (or any of its depending
4850: packages) have already been de-installed (e.g., after
4851: calling <span class="command"><strong>make update</strong></span>) or you may lose
4852: some packages you intended to update. As a rule of
4853: thumb: only use this target <span class="emphasis"><em>before</em></span>
4854: the first time you run <span class="command"><strong>make update</strong></span>
4855: and only if you have a dirty package tree (e.g., if you
4856: used <code class="varname">NOCLEAN</code>).</p>
4857: <p>If you are unsure about whether your tree is
4858: clean, you can either perform a <span class="command"><strong>make
4859: clean</strong></span> at the top of the tree, or use the
4860: following sequence of commands from the directory of the
4861: package you want to update (<span class="emphasis"><em>before</em></span>
4862: running <span class="command"><strong>make update</strong></span> for the first
4863: time, otherwise you lose all the packages you wanted to
4864: update!):</p>
4865: <pre class="screen">
4866: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
4867: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
4868: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
4869: </pre>
4870: <p>The following variables can be used either on the
4871: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
4872: <span class="command"><strong>make clean-update</strong></span>:</p>
4873: <div class="variablelist"><dl class="variablelist">
4874: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
4875: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
4876: reconstruct the list of directories to update for
4877: this package. Only use this if <span class="command"><strong>make
4878: update</strong></span> successfully installed all
4879: packages you wanted to update. Normally, this is
4880: done automatically on <span class="command"><strong>make
4881: update</strong></span>, but may have been suppressed by
4882: the <code class="varname">NOCLEAN</code> variable (see
4883: above).</p></dd>
4884: </dl></div>
4885: </dd>
4886: <dt><span class="term">replace</span></dt>
4887: <dd>
4888: <p>Update the installation of the current package. This
4889: differs from update in that it does not replace dependent
4890: 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
4891: target to work.</p>
4892: <p><span class="emphasis"><em>Be careful when using this
4893: target!</em></span> There are no guarantees that dependent
4894: packages will still work, in particular they will most
4895: certainly break if you <span class="command"><strong>make replace</strong></span> a
4896: library package whose shared library major version changed
4897: between your installed version and the new one. For this
4898: reason, this target is not officially supported and only
4899: recommended for advanced users.</p>
4900: </dd>
4901: <dt><span class="term">info</span></dt>
1.311 leot 4902: <dd><p>This target invokes <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.299 rillig 4903: package. You can use this to check which version of a
4904: package is installed.</p></dd>
4905: <dt><span class="term">index</span></dt>
4906: <dd>
4907: <p>This is a top-level command, i.e. it should be used in
4908: the <code class="filename">pkgsrc</code> directory. It creates a
4909: database of all packages in the local pkgsrc tree, including
4910: dependencies, comment, maintainer, and some other useful
4911: information. Individual entries are created by running
4912: <span class="command"><strong>make describe</strong></span> in the packages'
4913: directories. This index file is saved as
4914: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
4915: verbose format by running <span class="command"><strong>make
4916: print-index</strong></span>. You can search in it with
4917: <span class="command"><strong>make search
4918: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
4919: extract a list of all packages that depend on a particular
4920: one by running <span class="command"><strong>make show-deps
4921: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
4922: <p>Running this command takes a very long time, some
4923: hours even on fast machines!</p>
4924: </dd>
4925: <dt><span class="term">readme</span></dt>
4926: <dd>
4927: <p>This target generates a
1.314 ! nia 4928: <code class="filename">index.html</code> file, which can be
1.299 rillig 4929: 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
4930: contain references to any packages which are in the
4931: <code class="varname">PACKAGES</code> directory on the local
4932: host. The generated files can be made to refer to URLs
4933: based on <code class="varname">FTP_PKG_URL_HOST</code> and
4934: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314 ! nia 4935: wanted to generate <code class="filename">index.html</code>
1.299 rillig 4936: files which pointed to binary packages on the local
4937: machine, in the directory
4938: <code class="filename">/usr/packages</code>, set
4939: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
4940: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
4941: <code class="varname">${PACKAGES}</code> directory and its
4942: subdirectories will be searched for all the binary
4943: packages.</p>
4944: <p>The target can be run at the toplevel or in category
4945: directories, in which case it descends recursively.</p>
4946: </dd>
4947: <dt><span class="term">readme-all</span></dt>
4948: <dd><p>This is a top-level command, run it in
4949: <code class="filename">pkgsrc</code>. Use this target to create a
4950: file <code class="filename">README-all.html</code> which contains a
4951: list of all packages currently available in the NetBSD
4952: Packages Collection, together with the category they belong
4953: to and a short description. This file is compiled from the
1.314 ! nia 4954: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299 rillig 4955: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
4956: readme</strong></span>.</p></dd>
4957: <dt><span class="term">cdrom-readme</span></dt>
4958: <dd><p>This is very much the same as the
4959: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
4960: used when generating a pkgsrc tree to be written to a
4961: CD-ROM. This target also produces
1.314 ! nia 4962: <code class="filename">index.html</code> files, and can be made
1.299 rillig 4963: to refer to URLs based on
4964: <code class="varname">CDROM_PKG_URL_HOST</code> and
4965: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
4966: <dt><span class="term">show-distfiles</span></dt>
4967: <dd><p>This target shows which distfiles and patchfiles
4968: are needed to build the package
4969: (<code class="varname">ALLFILES</code>, which contains all
4970: <code class="varname">DISTFILES</code> and
4971: <code class="varname">PATCHFILES</code>, but not
4972: <code class="filename">patches/*</code>).</p></dd>
4973: <dt><span class="term">show-downlevel</span></dt>
4974: <dd><p>This target shows nothing if the package is not
4975: installed. If a version of this package is installed,
4976: but is not the version provided in this version of
4977: pkgsrc, then a warning message is displayed. This target
4978: can be used to show which of your installed packages are
4979: downlevel, and so the old versions can be deleted, and
4980: the current ones added.</p></dd>
4981: <dt><span class="term">show-pkgsrc-dir</span></dt>
4982: <dd><p>This target shows the directory in the pkgsrc
4983: hierarchy from which the package can be built and
4984: installed. This may not be the same directory as the one
4985: from which the package was installed. This target is
4986: intended to be used by people who may wish to upgrade
4987: many packages on a single host, and can be invoked from
4988: the top-level pkgsrc Makefile by using the
4989: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
4990: <dt><span class="term">show-installed-depends</span></dt>
4991: <dd><p>This target shows which installed packages match
4992: the current package's <code class="varname">DEPENDS</code>. Useful
4993: if out of date dependencies are causing build
4994: problems.</p></dd>
4995: <dt><span class="term">print-build-depends-list</span></dt>
4996: <dd><p>This target shows the list of packages that the current package
4997: depends on for building.</p></dd>
4998: <dt><span class="term">print-run-depends-list</span></dt>
4999: <dd><p>This target shows the list of packages that the current package
5000: depends on for running.</p></dd>
5001: <dt><span class="term">check-shlibs</span></dt>
5002: <dd><p>After a package is installed, check all its
5003: binaries and (on ELF platforms) shared libraries to see
5004: if they find the shared libs they need. Run by default
5005: 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>
5006: <dt><span class="term">print-PLIST</span></dt>
5007: <dd>
5008: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5009: upgraded pkg, this prints out an attempt to generate a
5010: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5011: -newer work/.extract_done</strong></span>. An attempt is made
5012: to care for shared libs etc., but it is
5013: <span class="emphasis"><em>strongly</em></span> recommended to review the
5014: result before putting it into
5015: <code class="filename">PLIST</code>. On upgrades, it's useful to
5016: diff the output of this command against an already
5017: existing <code class="filename">PLIST</code> file.</p>
1.311 leot 5018: <p>If the package installs files via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.299 rillig 5019: other methods that don't update file access times, be
5020: sure to add these files manually to your
5021: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5022: -newer</span>”</span> command used by this target won't catch
5023: them!</p>
5024: <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
5025: information on this target.</p>
5026: </dd>
5027: </dl></div>
5028: </div>
5029: </div>
5030: <div class="chapter">
5031: <div class="titlepage"><div><div><h2 class="title">
5032: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5033: <div class="toc">
5034: <p><b>Table of Contents</b></p>
5035: <dl class="toc">
5036: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5037: <dd><dl>
5038: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
5039: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
5040: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
5041: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
5042: </dl></dd>
5043: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5044: <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>
5045: </dl>
5046: </div>
5047: <p>When you find a package that is not yet in pkgsrc, you
5048: most likely have a URL from where you can download the source
5049: code. Starting with this URL, creating a package involves only a
5050: few steps.</p>
5051: <div class="procedure"><ol class="procedure" type="1">
5052: <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
5053: enable the basic quality checks.</p></li>
5054: <li class="step">
5055: <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
5056: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5057: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5058: <span class="command"><strong>mkpatches</strong></span>:</p>
5059: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5060: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5061: </li>
5062: <li class="step">
5063: <p>Choose one of the top-level directories as the category in
5064: which you want to place your package. You can also create a directory of
5065: your own (maybe called <code class="filename">local</code>). In that category
5066: directory, create another directory for your package and change into
5067: it:</p>
5068: <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>
5069: <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>
5070: </li>
5071: <li class="step">
5072: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
5073: you for a URL. Enter the URL of the distribution file (in most cases a
5074: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
5075: of your package are created automatically. The distribution file is
5076: extracted automatically to fill in some details in the
5077: <code class="filename">Makefile</code> that would otherwise have to be done
5078: manually:</p>
5079: <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>
5080: </li>
5081: <li class="step">
5082: <p>Examine the extracted files to determine the dependencies of
5083: your package. Ideally, this is mentioned in some
5084: <code class="filename">README</code> file, but things may differ. For each of
5085: these dependencies, look where it exists in pkgsrc, and if there is a
5086: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5087: line to your package <code class="filename">Makefile</code> which includes that
5088: file just before the last line. If the
5089: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5090: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5091: that the package's include files and libraries are provided.</p>
5092: <p>If you just need binaries from a package, add a
5093: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5094: version of the dependency and where it can be found in pkgsrc. This line
5095: should be placed in the third paragraph. If the dependency is only
5096: needed for building the package, but not when using it, use
5097: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5098: instead of <code class="varname">DEPENDS</code>.
5099: The difference between <code class="varname">TOOL_DEPENDS</code> and
5100: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5101: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
5102: packages, i.e. packages for the architecture where the package
5103: is built;
5104: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
5105: packages, i.e. packages for the architecture for which the package
5106: is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
5107: to specify a dependency used only for testing the resulting package
5108: built, using the upstream project's included test suite.
5109: Your package may then look like this:</p>
5110: <pre class="programlisting">
5111: [...]
5112:
5113: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5114: DEPENDS+= screen-[0-9]*:../../misc/screen
5115: DEPENDS+= screen>=4.0:../../misc/screen
5116:
5117: [...]
5118:
5119: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5120: .include "../../devel/glib2/buildlink3.mk"
5121: .include "../../mk/bsd.pkg.mk"
5122: </pre>
5123: </li>
5124: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5125: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5126: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5127: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5128: additional explanations.</p></li>
5129: <li class="step"><p>In many cases the package is not yet ready to build. You can
5130: 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
5131: over there, you can hopefully continue here.</p></li>
5132: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5133: directory from the extracted files. Besides these files, a lot of cache
5134: files and other system information has been saved in the working
5135: directory, which may become wrong after you edited the
5136: <code class="filename">Makefile</code>.</p></li>
5137: <li class="step">
5138: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5139: 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>
5140: <p>If the extracted files from the package need to be fixed, run multiple rounds of these commands:</p>
5141: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>make</code></strong>
5142: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5143: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
5144: <code class="prompt">$</code> <strong class="userinput"><code>make mps</code></strong>
5145: <code class="prompt">$</code> <strong class="userinput"><code>make clean</code></strong></pre>
5146: </li>
5147: <li class="step"><p>When the package builds fine, the next step is to install
5148: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5149: everything works.</p></li>
5150: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5151: contains a list of the files that are installed by the package, is
5152: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5153: >PLIST</strong></span> to generate a probably correct list. Check
5154: the file using your preferred text editor to see if the list of
5155: files looks plausible.</p></li>
5156: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5157: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5158: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5159: had been registered in the database of installed files, but with an
5160: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5161: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5162: registered with the list of files from
5163: <code class="filename">PLIST</code>.</p></li>
5164: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
5165: package from the set of installed files.</p></li>
5166: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5167: from above again in a single step, making sure that the PLIST is correct
5168: and the whole package is created as intended.</p></li>
5169: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything left to do.</p></li>
5170: <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>
5171: </ol></div>
5172: <div class="sect1">
5173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5174: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5175: <div class="sect2">
5176: <div class="titlepage"><div><div><h3 class="title">
5177: <a name="creating.perl-module"></a>14.1.1. Perl modules</h3></div></div></div>
5178: <p>Simple Perl modules are handled automatically by
5179: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
5180: </div>
5181: <div class="sect2">
5182: <div class="titlepage"><div><div><h3 class="title">
5183: <a name="creating.python-module"></a>14.1.2. Python modules and programs</h3></div></div></div>
5184: <p>Python modules and programs packages are easily created using a
5185: set of predefined variables.</p>
5186: <p>
5187: If some Python versions are not supported by the software, set the
5188: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5189: that are not supported, e.g.
5190: </p>
5191: <pre class="programlisting">
5192: PYTHON_VERSIONS_INCOMPATIBLE= 27
5193: </pre>
5194: <p>
5195: If the packaged software is a Python module, include one of
5196: <code class="filename">../../lang/python/egg.mk</code>,
5197: <code class="filename">../../lang/python/distutils.mk</code>, or
5198: <code class="filename">../../lang/python/extension.mk</code>.</p>
5199: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
5200: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
5201: If the packaged software is using setuptools, you only need
5202: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
5203: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
5204: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>,
5205: so pkgsrc will use this framework.
5206: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>;
5207: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
5208: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
5209: to the name of the script.</p>
5210: <p>Either way, the package directory should be called
5211: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5212: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5213: </p>
5214: <pre class="programlisting">
5215: DISTNAME= foopymodule-1.2.10
5216: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5217: </pre>
5218: <p>If it is an application, include
5219: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5220: In order to correctly set the path to the Python interpreter, use the
5221: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5222: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5223: For example:
5224: </p>
5225: <pre class="programlisting">
5226: REPLACE_PYTHON= *.py
5227: </pre>
5228: <p>Some Python modules have separate distributions for Python-2.x
5229: and Python-3.x support. In pkgsrc this is handled by the
5230: <code class="filename">versioned_dependencies.mk</code> file. Set
5231: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
5232: packages that should be depended upon and include
5233: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
5234: then the pkgsrc infrastructure will depend on the appropriate package
5235: version. For example:
5236: </p>
5237: <pre class="programlisting">
5238: PYTHON_VERSIONED_DEPENDENCIES=dialog
5239: </pre>
5240: <p>
5241: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
5242: of supported packages.</p>
5243: </div>
5244: <div class="sect2">
5245: <div class="titlepage"><div><div><h3 class="title">
5246: <a name="creating.R-package"></a>14.1.3. R packages</h3></div></div></div>
5247: <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>
5248: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
5249: 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>.
5250: Individual packages (and optionally their dependencies) may be created
5251: and updated. R packages generally follow the same form, and most of
5252: the relevant information needed is contained in a
5253: <code class="filename">DESCRIPTION</code> file as part of each R package on
5254: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5255: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5256: creates or updates a package in the canonical form. The resulting
5257: package should be reviewed for correctness.</p>
5258: </div>
5259: <div class="sect2">
5260: <div class="titlepage"><div><div><h3 class="title">
5261: <a name="creating.TeX-package"></a>14.1.4. TeXlive packages</h3></div></div></div>
5262: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
5263: <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>
5264: <p>If the TeXlive package name is not known, it may be useful to
5265: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5266: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5267: 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
5268: archive</a>.</p>
5269: <p>If the TeXlive package name is known, download the files from
5270: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5271: archive</a>. For package <code class="filename">foo</code>, you will need
5272: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5273: also have associated documentation packages, so download
5274: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5275: should be placed in the appropriate category directory, which is often
5276: but not always <code class="filename">print</code>. Then run the following
5277: command in the category directory.</p>
5278: <pre class="programlisting">
5279: texlive2pkg foo.tar.xz foo.doc.tar.xz
5280: </pre>
5281: <p>This will create two packages, <code class="filename">tex-foo</code> and
5282: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5283: are correct.</p>
5284: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5285: currently does not include version information in package filenames
5286: and changes their contents periodically when updates occur.
5287: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5288: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5289: main one and the corresponding documentation, upload the distfiles
5290: with the following command in each package directory.</p>
5291: <pre class="programlisting">
5292: make upload-distfiles
5293: </pre>
5294: </div>
5295: </div>
5296: <div class="sect1">
5297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5298: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5299: <div class="sect2">
5300: <div class="titlepage"><div><div><h3 class="title">
5301: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5302: <div class="sect3">
5303: <div class="titlepage"><div><div><h4 class="title">
5304: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5305: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5306: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5307: pkgsrc. As the description says it has to do with the web, the obvious
5308: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5309: <pre class="programlisting">
5310: <code class="prompt">$</code> mkdir www/nvu
5311: <code class="prompt">$</code> cd www/nvu
5312: </pre>
5313: <p>The web site says that the sources are available as a tar file, so
5314: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5315: <pre class="programlisting">
5316: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5317: </pre>
5318: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5319: below the <code class="varname">DISTNAME</code> line, as the package name should
5320: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5321: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5322: <code class="varname">COMMENT</code> fields. Then the package
5323: <code class="filename">Makefile</code> looked like that:</p>
5324: <pre class="programlisting">
5325: # $NetBSD $
5326: #
5327:
5328: DISTNAME= nvu-1.0-sources
5329: PKGNAME= nvu-1.0
5330: CATEGORIES= www
5331: MASTER_SITES= http://cvs.nvu.com/download/
5332: EXTRACT_SUFX= .tar.bz2
5333:
5334: MAINTAINER= rillig@NetBSD.org
5335: HOMEPAGE= http://cvs.nvu.com/
5336: COMMENT= Web Authoring System
5337:
5338: # url2pkg-marker (please do not remove this line.)
5339: .include "../../mk/bsd.pkg.mk"
5340: </pre>
5341: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5342: this is a workaround to prevent CVS expanding to the filename of the
5343: guide.</p>
5344: <p>Then, I quit the editor and watched pkgsrc downloading a large
5345: source archive:</p>
5346: <pre class="programlisting">
5347: url2pkg> Running "make makesum" ...
5348: => Required installed package digest>=20010302: digest-20060826 found
5349: => Fetching nvu-1.0-sources.tar.bz2
5350: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5351: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5352: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5353: url2pkg> Running "make extract" ...
5354: => Required installed package digest>=20010302: digest-20060826 found
5355: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5356: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5357: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5358: ===> Installing dependencies for nvu-1.0
5359: ===> Overriding tools for nvu-1.0
5360: ===> Extracting for nvu-1.0
5361: url2pkg> Adjusting the Makefile.
5362:
5363: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5364:
5365: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5366: </pre>
5367: </div>
5368: <div class="sect3">
5369: <div class="titlepage"><div><div><h4 class="title">
5370: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5371: <p>Now that the package has been extracted, let's see what's inside
5372: it. The package has a <code class="filename">README.txt</code>, but that only
5373: says something about mozilla, so it's probably useless for seeing what
5374: dependencies this package has. But since there is a GNU configure script
5375: in the package, let's hope that it will complain about everything it
5376: needs.</p>
5377: <pre class="programlisting">
5378: <code class="prompt">$</code> bmake
5379: => Required installed package digest>=20010302: digest-20060826 found
5380: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5381: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5382: ===> Patching for nvu-1.0
5383: ===> Creating toolchain wrappers for nvu-1.0
5384: ===> Configuring for nvu-1.0
5385: [...]
5386: configure: error: Perl 5.004 or higher is required.
5387: [...]
5388: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5389: [...]
5390: </pre>
5391: <p>That worked quite well. So I opened the package Makefile in my
5392: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5393: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5394: package have changed now, and since a perl wrapper is automatically
5395: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5396: from scratch.</p>
5397: <pre class="programlisting">
5398: <code class="prompt">$</code> bmake clean
5399: ===> Cleaning for nvu-1.0
5400: <code class="prompt">$</code> bmake
5401: [...]
5402: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5403: GNU Make. You will not be able to build Mozilla without GNU Make.
5404: [...]
5405: </pre>
5406: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5407: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5408: <pre class="programlisting">
5409: [...]
5410: checking for GTK - version >= 1.2.0... no
5411: *** Could not run GTK test program, checking why...
5412: [...]
5413: </pre>
5414: <p>Now to the other dependencies. The first question is: Where is the
5415: GTK package hidden in pkgsrc?</p>
5416: <pre class="programlisting">
5417: <code class="prompt">$</code> echo ../../*/gtk*
5418: [many packages ...]
5419: <code class="prompt">$</code> echo ../../*/gtk
5420: ../../x11/gtk
5421: <code class="prompt">$</code> echo ../../*/gtk2
5422: ../../x11/gtk2
5423: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5424: ../../x11/gtk2/buildlink3.mk
5425: </pre>
5426: <p>The first try was definitely too broad. The second one had exactly
5427: one result, which is very good. But there is one pitfall with GNOME
5428: packages. Before GNOME 2 had been released, there were already many
5429: GNOME 1 packages in pkgsrc. To be able to continue to use these
5430: packages, the GNOME 2 packages were imported as separate packages, and
5431: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5432: whether this was the case here, and indeed it was.</p>
5433: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5434: file, adding the dependency is very easy. I just inserted an
5435: <code class="literal">.include</code> line before the last line of the package
5436: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5437: <pre class="programlisting">
5438: [...]
5439: .include "../../x11/gtk2/buildlink3.mk"
5440: .include "../../mk/bsd.pkg.mk
5441: </pre>
5442: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5443: was:</p>
1.75 rillig 5444: <pre class="programlisting">
1.299 rillig 5445: [...]
5446: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5447: checking for GTK - version >= 1.2.0... no
5448: *** Could not run GTK test program, checking why...
5449: *** The test program failed to compile or link. See the file config.log for the
5450: *** exact error that occured. This usually means GTK was incorrectly installed
5451: *** or that you have moved GTK since it was installed. In the latter case, you
5452: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5453: configure: error: Test for GTK failed.
5454: [...]
1.222 sevan 5455: </pre>
1.299 rillig 5456: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5457: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5458: told me that this package really wanted to have the GNOME 1 version of
5459: GTK. If the package had looked for GTK2, it would have looked for
5460: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5461: So I changed the <code class="literal">x11/gtk2</code> to
5462: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5463: and tried again.</p>
1.119 mishka 5464: <pre class="programlisting">
1.299 rillig 5465: [...]
5466: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5467: In file included from xpidl.c:42:
5468: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5469: In file included from xpidl.c:42:
5470: xpidl.h:132: error: parse error before "IDL_ns"
5471: [...]
1.222 sevan 5472: </pre>
1.299 rillig 5473: <p>The package still does not find all of its dependencies. Now the
5474: question is: Which package provides the
5475: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119 mishka 5476: <pre class="programlisting">
1.299 rillig 5477: <code class="prompt">$</code> echo ../../*/*idl*
5478: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5479: <code class="prompt">$</code> echo ../../*/*IDL*
5480: ../../net/libIDL
1.222 sevan 5481: </pre>
1.299 rillig 5482: <p>Let's take the one from the second try. So I included the
5483: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5484: again. But the error didn't change. After digging through some of the
5485: code, I concluded that the build process of the package was broken and
5486: couldn't have ever worked, but since the Mozilla source tree is quite
5487: large, I didn't want to fix it. So I added the following to the package
5488: <code class="filename">Makefile</code> and tried again:</p>
1.197 wiz 5489: <pre class="programlisting">
1.299 rillig 5490: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5491: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.222 sevan 5492: </pre>
1.299 rillig 5493: <p>The latter line is needed because the package expects the library
5494: <code class="filename">libIDL.so</code>, but only
5495: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5496: wrapper to rewrite that on the fly.</p>
5497: <p>The next problem was related to a recent change of the FreeType
5498: 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>
5499: which patch files were relevant for this issue and copied them to the
5500: <code class="filename">patches</code> directory. Then I retried, fixed the
5501: patches so that they applied cleanly and retried again. This time,
5502: everything worked.</p>
1.197 wiz 5503: </div>
1.299 rillig 5504: <div class="sect3">
5505: <div class="titlepage"><div><div><h4 class="title">
5506: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87 wiz 5507: <pre class="programlisting">
1.299 rillig 5508: <code class="prompt">$</code> bmake CHECK_FILES=no install
5509: [...]
5510: <code class="prompt">$</code> bmake print-PLIST >PLIST
5511: <code class="prompt">$</code> bmake deinstall
5512: <code class="prompt">$</code> bmake install
1.222 sevan 5513: </pre>
1.299 rillig 5514: </div>
5515: </div>
1.75 rillig 5516: </div>
5517: </div>
1.148 asau 5518: <div class="chapter">
1.75 rillig 5519: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 5520: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 5521: <div class="toc">
5522: <p><b>Table of Contents</b></p>
1.210 leot 5523: <dl class="toc">
1.299 rillig 5524: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5525: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5526: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5527: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5528: <dd><dl>
5529: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5530: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5531: <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>
5532: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.75 rillig 5533: </dl></dd>
5534: </dl>
5535: </div>
1.299 rillig 5536: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5537: each of which forms a well-defined part of the pkgsrc system. Using
1.311 leot 5538: the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.299 rillig 5539: like pkgsrc requires some discipline to keep the code correct and
5540: understandable.</p>
5541: <p>The basic ingredients for <code class="filename">Makefile</code>
5542: programming are variables and shell
5543: commands. Among these shell commands may even be more complex ones
1.311 leot 5544: like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/awk.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.299 rillig 5545: as intended it is necessary to quote all variables correctly when they
5546: are used.</p>
5547: <p>This chapter describes some patterns that appear quite often in
5548: <code class="filename">Makefile</code>s, including the pitfalls that come along
5549: with them.</p>
1.148 asau 5550: <div class="sect1">
1.75 rillig 5551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5552: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5553: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5554: <p>When you are creating a file as a
5555: target of a rule, always write the data to a temporary file first
5556: and finally rename that file. Otherwise there might occur an error
5557: in the middle of generating the file, and when the user runs
1.311 leot 5558: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.299 rillig 5559: regenerated properly. Example:</p>
1.75 rillig 5560: <pre class="programlisting">
1.299 rillig 5561: wrong:
5562: @echo "line 1" > ${.TARGET}
5563: @echo "line 2" >> ${.TARGET}
5564: @false
5565:
5566: correct:
5567: @echo "line 1" > ${.TARGET}.tmp
5568: @echo "line 2" >> ${.TARGET}.tmp
5569: @false
5570: @mv ${.TARGET}.tmp ${.TARGET}
1.100 rillig 5571: </pre>
1.299 rillig 5572: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5573: <code class="filename">wrong</code> will exist, although there was an error
5574: message in the first run. On the other hand, running <span class="command"><strong>make
5575: correct</strong></span> gives an error message twice, as expected.</p>
1.311 leot 5576: <p>You might remember that <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.299 rillig 5577: <code class="literal">${.TARGET}</code> in case of error, but this only
5578: happens when it is interrupted, for example by pressing
5579: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.311 leot 5580: when one of the commands fails (like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.299 rillig 5581: </li></ul></div>
5582: </div>
5583: <div class="sect1">
5584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5585: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5586: <p><code class="filename">Makefile</code> variables contain strings that
5587: can be processed using the five operators <code class="code">=</code>,
5588: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.311 leot 5589: <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.299 rillig 5590: page.</p>
5591: <p>When a variable's value is parsed from a
5592: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5593: the backslash character <code class="code">\</code> are handled specially. If a
5594: backslash is the last character in a line, that backslash is removed
5595: from the line and the line continues with the next line of the file.</p>
5596: <p>The <code class="code">#</code> character starts a comment that reaches
5597: until the end of the line. To get an actual <code class="code">#</code> character,
5598: such as in a URL, write <code class="code">\#</code> instead.</p>
5599: <p>The evaluation of variables either happens immediately or lazy.
5600: It happens immediately when the variable occurs on the right-hand
5601: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5602: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5603: In the other cases, it is evaluated lazily.</p>
5604: <p>Some of the modifiers split the string into words and then
5605: operate on the words, others operate on the string as a whole. When a
5606: string is split into words, double quotes and single quotes are
1.311 leot 5607: interpreted as delimiters, just like in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.299 rillig 5608: <div class="sect2">
5609: <div class="titlepage"><div><div><h3 class="title">
5610: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5611: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5612: <li class="listitem"><p>All variable names starting with an underscore
5613: are reserved for use by the pkgsrc infrastructure. They shall
5614: not be used by packages.</p></li>
5615: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5616: lowercase variable names for the iteration
5617: variables.</p></li>
5618: <li class="listitem"><p>All list variables should have a plural name,
5619: such as <code class="varname">PKG_OPTIONS</code> or
5620: <code class="varname">DISTFILES</code>.</p></li>
5621: </ul></div>
5622: </div>
5623: </div>
5624: <div class="sect1">
5625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5626: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5627: <div class="sect2">
5628: <div class="titlepage"><div><div><h3 class="title">
5629: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5630: <p>When adding a string that possibly contains whitespace or quotes to
5631: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5632: modifier.</p>
5633: <p>When adding another list to a list (example 2), it must not be
5634: quoted, since its elements are already quoted.</p>
1.75 rillig 5635: <pre class="programlisting">
1.299 rillig 5636: STRING= foo * bar `date`
5637: LIST= # empty
5638: ANOTHER_LIST= a=b c=d
5639:
5640: LIST+= ${STRING:Q} # 1
5641: LIST+= ${ANOTHER_LIST} # 2
1.100 rillig 5642: </pre>
1.299 rillig 5643: </div>
5644: <div class="sect2">
5645: <div class="titlepage"><div><div><h3 class="title">
5646: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5647: <p>Echoing a string containing special characters needs special
5648: work.</p>
1.75 rillig 5649: <pre class="programlisting">
1.299 rillig 5650: STRING= foo bar < > * `date` $$HOME ' "
5651: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5652:
5653: all:
5654: echo ${STRING} # 1
5655: echo ${STRING:Q} # 2
5656: printf '%s\n' ${STRING:Q}'' # 3
5657: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.100 rillig 5658: </pre>
1.299 rillig 5659: <p>Example 1 leads to a syntax error in the shell, as the characters
5660: are just copied.</p>
5661: <p>Example 2 quotes the string so that the shell interprets it
5662: correctly. But the echo command may additionally interpret strings with a
5663: leading dash or those containing backslashes.</p>
1.311 leot 5664: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.299 rillig 5665: interprets the format string, but not the next argument. The trailing
5666: single quotes handle the case when the string is empty. In that case, the
5667: :Q modifier would result in an empty string too, which would then be
1.311 leot 5668: skipped by the shell. For <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.299 rillig 5669: but other programs may care.</p>
5670: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5671: need to be quoted because the quoting has already been done
5672: when adding elements to the list.</p>
1.75 rillig 5673: </div>
1.148 asau 5674: <div class="sect2">
1.75 rillig 5675: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 5676: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5677: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5678: GNU-style configure script (especially those that call other configure
5679: scripts), it must not have leading or trailing whitespace, since
5680: otherwise the configure script gets confused. To trim leading and
5681: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5682: following example:</p>
1.75 rillig 5683: <pre class="programlisting">
1.299 rillig 5684: CPPFLAGS= # empty
5685: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5686: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 grant 5687:
1.299 rillig 5688: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 grant 5689:
1.299 rillig 5690: all:
5691: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5692: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5693: </pre>
5694: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5695: trailing whitespace because the <code class="code">+=</code> operator always adds a
5696: space.</p>
5697: </div>
5698: <div class="sect2">
5699: <div class="titlepage"><div><div><h3 class="title">
5700: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5701: <p>When a possibly empty variable is used in a shell program, it may
5702: lead to a syntax error.</p>
5703: <pre class="programlisting">
5704: EGFILES= # empty
1.87 wiz 5705:
1.299 rillig 5706: install-examples: # produces a syntax error in the shell
5707: for egfile in ${EGFILES}; do \
5708: echo "Installing $$egfile"; \
5709: done
5710: </pre>
5711: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.311 leot 5712: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.299 rillig 5713: To fix this syntax error, use one of the snippets below.</p>
5714: <pre class="programlisting">
5715: EMPTY= # empty
1.87 wiz 5716:
1.299 rillig 5717: install-examples:
5718: for egfile in ${EGFILES} ""; do \
5719: [ -n "$$egfile" ] || continue; \
5720: echo "Installing $$egfile"; \
5721: done
5722: </pre>
5723: <p>In this case, an empty string is appended to the iteration list (to
5724: prevent the syntax error) and filtered out later.</p>
5725: <pre class="programlisting">
5726: EGFILES= # empty
1.87 wiz 5727:
1.299 rillig 5728: install-examples:
5729: .for egfile in ${EGFILES}
5730: echo "Installing ${egfile}"
5731: .endfor
1.100 rillig 5732: </pre>
1.299 rillig 5733: <p>If one of the filenames contains special characters, it should be
5734: enclosed in single or double quotes.</p>
5735: <p>To have a shell command test whether a make variable is empty, use
5736: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5737: </div>
5738: </div>
5739: </div>
5740: <div class="chapter">
5741: <div class="titlepage"><div><div><h2 class="title">
5742: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5743: <div class="toc">
5744: <p><b>Table of Contents</b></p>
5745: <dl class="toc">
5746: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5747: <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>
5748: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5749: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5750: </dl>
1.75 rillig 5751: </div>
1.299 rillig 5752: <p>Many packages have the ability to be built to support different
5753: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5754: in pkgsrc that provides generic handling of those options that
5755: determine different ways in which the packages can be built. It's
5756: possible for the user to specify exactly which sets of options will be
5757: built into a package or to allow a set of global default options
5758: apply.</p>
5759: <p>There are two broad classes of behaviors that one might want to
5760: control via options. One is whether some particular feature is
5761: enabled in a program that will be built anyway, often by including or
5762: not including a dependency on some other package. The other is
5763: whether or not an additional program will be built as part of the
5764: package. Generally, it is better to make a split package for such
5765: additional programs instead of using options, because it enables
5766: binary packages to be built which can then be added separately. For
5767: example, the foo package might have minimal dependencies (those
5768: packages without which foo doesn't make sense), and then the foo-gfoo
5769: package might include the GTK frontend program gfoo. This is better
5770: than including a gtk option to foo that adds gfoo, because either that
5771: option is default, in which case binary users can't get foo without
5772: gfoo, or not default, in which case they can't get gfoo. With split
5773: packages, they can install foo without having GTK, and later decide to
5774: install gfoo (pulling in GTK at that time). This is an advantage to
5775: source users too, avoiding the need for rebuilds.</p>
5776: <p>Plugins with widely varying dependencies should usually be split
5777: instead of options.</p>
5778: <p>It is often more work to maintain split packages, especially if
5779: the upstream package does not support this. The decision of split
5780: vs. option should be made based on the likelihood that users will want
5781: or object to the various pieces, the size of the dependencies that are
5782: included, and the amount of work.</p>
5783: <p>A further consideration is licensing. Non-free parts, or parts
5784: that depend on non-free dependencies (especially plugins) should
5785: almost always be split if feasible.</p>
5786: <div class="sect1">
5787: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5788: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5789: <p>Global default options are listed in
5790: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5791: that should be built into every package if that option is supported.
5792: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 5793: </div>
1.148 asau 5794: <div class="sect1">
1.75 rillig 5795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5796: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5797: </h2></div></div></div>
5798: <p>The following example shows how
5799: <code class="filename">bsd.options.mk</code> should be used
5800: by the hypothetical ``wibble'' package, either in the package
5801: <code class="filename">Makefile</code>, or in a file,
5802: e.g. <code class="filename">options.mk</code>, that is included by the
5803: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 5804: <pre class="programlisting">
1.299 rillig 5805: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5806: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5807: PKG_OPTIONS_OPTIONAL_GROUPS= database
5808: PKG_OPTIONS_GROUP.database= mysql pgsql
5809: PKG_SUGGESTED_OPTIONS= wibble-foo
5810: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5811: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5812:
5813: .include "../../mk/bsd.prefs.mk"
5814:
5815: # this package was previously named wibble2
5816: .if defined(PKG_OPTIONS.wibble2)
5817: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5818: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5819: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5820: .endif
5821:
5822: .include "../../mk/bsd.options.mk"
5823:
5824: # Package-specific option-handling
1.100 rillig 5825:
1.299 rillig 5826: ###
5827: ### FOO support
5828: ###
5829: .if !empty(PKG_OPTIONS:Mwibble-foo)
5830: CONFIGURE_ARGS+= --enable-foo
5831: .endif
1.100 rillig 5832:
1.299 rillig 5833: ###
5834: ### LDAP support
5835: ###
5836: .if !empty(PKG_OPTIONS:Mldap)
5837: . include "../../databases/openldap-client/buildlink3.mk"
5838: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5839: .endif
1.100 rillig 5840:
1.299 rillig 5841: ###
5842: ### database support
5843: ###
5844: .if !empty(PKG_OPTIONS:Mmysql)
5845: . include "../../mk/mysql.buildlink3.mk"
5846: .endif
5847: .if !empty(PKG_OPTIONS:Mpgsql)
5848: . include "../../mk/pgsql.buildlink3.mk"
5849: .endif
5850: </pre>
5851: <p>The first section contains the information about which build
5852: options are supported by the package, and any default options settings
5853: if needed.</p>
5854: <div class="orderedlist"><ol class="orderedlist" type="1">
5855: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.311 leot 5856: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.299 rillig 5857: options. It should be set to
5858: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5859: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5860: at the point where the options are processed.</p></li>
5861: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
5862: build options supported by the package.</p></li>
5863: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
5864: list of names of groups of mutually exclusive options. The options in
5865: each group are listed in
5866: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5867: The most specific setting of any option from the group takes
5868: precedence over all other options in the group. Options from the
5869: groups will be automatically added to
5870: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
5871: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
5872: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5873: packages will fail if no option from the group is
5874: selected.</p></li>
5875: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
5876: of names of sets of options. At least one option from each set must
5877: be selected. The options in each set are listed in
5878: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5879: Options from the sets will be automatically added to
5880: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5881: fail if no option from the set is selected.</p></li>
5882: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
5883: build options which are enabled by default.</p></li>
5884: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
5885: of
5886: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
5887: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
5888: their option counterparts. Pairs should be added with
5889: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
5890: warning will be issued if the user uses a legacy
5891: variable.</p></li>
5892: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
5893: of
5894: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
5895: pairs that map options that have been renamed to their new
5896: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
5897: the listing of global legacy options. A warning will be issued if
5898: the user uses a legacy option.</p></li>
5899: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
5900: options implied by deprecated variables used. This can be used for
5901: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5902: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5903: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
5904: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
5905: a list of warnings about deprecated variables or options used, and
5906: what to use instead.</p></li>
5907: </ol></div>
5908: <p>A package should never modify
5909: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5910: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5911: To suggest a default set of options, use
5912: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5913: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5914: including <code class="filename">bsd.options.mk</code>. If none of
5915: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5916: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5917: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5918: happen with platform-specific options if none of them is supported on
5919: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5920: empty list and the package is otherwise treated as not using the
5921: options framework.</p>
5922: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5923: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5924: build options, properly filtered to remove unsupported and duplicate
5925: options.</p>
5926: <p>The remaining sections contain the logic that is specific to
5927: each option. The correct way to check for an option is to check
5928: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5929: <pre class="programlisting">
5930: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100 rillig 5931: </pre>
1.75 rillig 5932: </div>
1.299 rillig 5933: <div class="sect1">
5934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5935: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
5936: <p>Options that enable similar features in different packages (like
5937: optional support for a library) should use a common name in all
5938: packages that support it (like the name of the library). If another
5939: package already has an option with the same meaning, use the same
5940: name.</p>
5941: <p>Options that enable features specific to one package, where it's
5942: unlikely that another (unrelated) package has the same (or a similar)
5943: optional feature, should use a name prefixed with
5944: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5945: <p>If a group of related packages share an optional feature
5946: specific to that group, prefix it with the name of the
5947: <span class="quote">“<span class="quote">main</span>”</span> package
5948: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5949: <p>For new options, add a line to
5950: <code class="filename">mk/defaults/options.description</code>. Lines have two
5951: fields, separated by tab. The first field is the option name, the
5952: second its description. The description should be a whole sentence
5953: (starting with an uppercase letter and ending with a period) that
5954: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5955: support.</span>”</span> The file is sorted by option names.</p>
5956: </div>
5957: <div class="sect1">
5958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5959: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
5960: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
5961: different dependencies based on the options with which the package was
5962: built. For querying these options, the file
5963: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5964: typical example looks like this:</p>
1.87 wiz 5965: <pre class="programlisting">
1.299 rillig 5966: pkgbase := libpurple
5967: .include "../../mk/pkg-build-options.mk"
5968:
5969: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5970: ...
5971: .endif
1.229 sevan 5972: </pre>
1.299 rillig 5973: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5974: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5975: options of the libpurple package, which can then be queried like
5976: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5977: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5978: details.</p>
1.75 rillig 5979: </div>
5980: </div>
1.148 asau 5981: <div class="chapter">
1.75 rillig 5982: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 5983: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 5984: <div class="toc">
5985: <p><b>Table of Contents</b></p>
1.210 leot 5986: <dl class="toc">
1.299 rillig 5987: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
5988: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
5989: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75 rillig 5990: </dl>
5991: </div>
1.299 rillig 5992: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
5993: by pkgsrc and also for individual packages to define what commands
5994: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
5995: or for later run-time of an installed packaged (such as
5996: <code class="varname">DEPENDS</code>).
5997: If the native system provides an adequate tool, then in many cases, a pkgsrc
5998: package will not be used.</p>
5999: <p>When building a package, the replacement tools are
6000: made available in a directory (as symlinks or wrapper scripts)
6001: that is early in the executable search path. Just like the buildlink
6002: system, this helps with consistent builds.</p>
6003: <p>A tool may be needed to help build a specific package. For example,
6004: perl, GNU make (gmake) or yacc may be needed.</p>
6005: <p>Also a tool may be needed, for example, because the native system's supplied
6006: tool may be inefficient for building a package with pkgsrc.
6007: For example, a package may need GNU awk, bison (instead of
6008: yacc) or a better sed.</p>
6009: <p>The tools used by a package can be listed by running
6010: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 6011: <div class="sect1">
1.75 rillig 6012: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6013: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6014: <p>The default set of tools used by pkgsrc is defined in
6015: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6016: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6017: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6018: These can be seen by running:
6019: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6020: <p>If a package needs a specific program to build
6021: then the <code class="varname">USE_TOOLS</code> variable can be used
6022: to define the tools needed.</p>
1.75 rillig 6023: </div>
1.299 rillig 6024: <div class="sect1">
6025: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6026: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6027: <p>In the following examples, the :run means that it is needed at
6028: run-time (and becomes a DEPENDS).
6029: The default is a build dependency which can be set with
6030: :build. (So in this example, it is the same as gmake:build
6031: and pkg-config:build.)</p>
1.75 rillig 6032: <pre class="programlisting">
1.299 rillig 6033: USE_TOOLS+= gmake perl:run pkg-config
1.1 grant 6034: </pre>
1.299 rillig 6035: <p>When using the tools framework, a
6036: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6037: which contains the full path to the appropriate tool. For example,
6038: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6039: on Linux systems.</p>
6040: <p>If you always need a pkgsrc version of the
6041: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6042: </p>
1.75 rillig 6043: </div>
1.299 rillig 6044: <div class="sect1">
6045: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6046: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6047: <p>When improving or porting pkgsrc to a new platform, have a look
6048: at (or create) the corresponding platform specific make file fragment under
6049: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6050: the name of the common tools. For example:</p>
1.75 rillig 6051: <pre class="programlisting">
1.299 rillig 6052: .if exists(/usr/bin/bzcat)
6053: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6054: .elif exists(/usr/bin/bzip2)
6055: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6056: .endif
6057:
6058: TOOLS_PLATFORM.true?= true # shell builtin
1.1 grant 6059: </pre>
1.75 rillig 6060: </div>
6061: </div>
1.299 rillig 6062: <div class="chapter">
6063: <div class="titlepage"><div><div><h2 class="title">
6064: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6065: <div class="toc">
6066: <p><b>Table of Contents</b></p>
6067: <dl class="toc">
6068: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6069: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6070: <dd><dl>
6071: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6072: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6073: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6074: and
6075: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6076: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6077: </dl></dd>
6078: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
6079: <dd><dl>
6080: <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>
6081: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
6082: </dl></dd>
6083: </dl>
1.75 rillig 6084: </div>
1.299 rillig 6085: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6086: are seen by a package's configure and build processes. This is implemented
6087: in a two step process:</p>
6088: <div class="orderedlist"><ol class="orderedlist" type="1">
6089: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6090: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6091: of <code class="varname">WRKDIR</code>.</p></li>
6092: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6093: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6094: <code class="option">-L${LOCALBASE}/lib</code> into references to
6095: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6096: native compiler on some operating systems look like GCC, so that
6097: packages that expect GCC won't require modifications to build with
6098: those native compilers.</p></li>
6099: </ol></div>
6100: <p>This normalizes the environment in which a package is built so that the
6101: package may be built consistently despite what other software may be
6102: installed. Please note that the normal system header and library paths,
6103: e.g. <code class="filename">/usr/include</code>,
6104: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6105: designed to insulate the package build from non-system-supplied
6106: software.</p>
1.148 asau 6107: <div class="sect1">
1.75 rillig 6108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6109: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6110: <p>The process of converting packages to use the buildlink3
6111: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6112: The things to keep in mind are:</p>
1.128 wiz 6113: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299 rillig 6114: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6115: instead of the actual toolchain. Some packages are tricky,
6116: and the only way to know for sure is the check
6117: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6118: wrappers are being invoked.</p></li>
6119: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6120: the package Makefile, e.g. Java VMs, standalone shells,
6121: etc., because the code to symlink files into
6122: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6123: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6124: </p></li>
6125: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6126: <code class="filename">buildlink3.mk</code> files that you list in a
6127: package's Makefile are added as dependencies for that package.
6128: </p></li>
6129: </ol></div>
6130: <p>If a dependency on a particular package is required for its libraries and
6131: headers, then we replace:</p>
6132: <pre class="programlisting">
6133: DEPENDS+= foo>=1.1.0:../../category/foo
6134: </pre>
6135: <p>with</p>
6136: <pre class="programlisting">
6137: .include "../../category/foo/buildlink3.mk"
6138: </pre>
6139: <p>The buildlink3.mk files usually define the required dependencies.
6140: If you need a newer version of the dependency when using buildlink3.mk
6141: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 6142: <pre class="programlisting">
1.299 rillig 6143: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6144: .include "../../category/foo/buildlink3.mk"
1.1 grant 6145: </pre>
1.299 rillig 6146: <p>There are several <code class="filename">buildlink3.mk</code>
6147: files in <code class="filename">pkgsrc/mk</code>
6148: that handle special package issues:</p>
6149: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6150: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6151: the native or a pkgsrc Berkeley DB implementation based on
6152: the values of <code class="varname">BDB_ACCEPTED</code> and
6153: <code class="varname">BDB_DEFAULT</code>.</p></li>
6154: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6155: comes with neither Curses nor NCurses, this will take care
6156: 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>
6157: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6158: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6159: adding a dependency on Heimdal or MIT-krb5 for packages that
6160: require a Kerberos 5 implementation.</p></li>
6161: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6162: system-provided Motif installation or adds a dependency on
6163: <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
6164: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6165: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6166: to choose which Motif version will be used.</p></li>
6167: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6168: system-provided GNU readline or editline (libedit) installation,
6169: 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>,
6170: <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
6171: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6172: If your package really needs GNU readline library, its Makefile
6173: should include <code class="filename">devel/readline/buildlink3.mk</code>
6174: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6175: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6176: variables that may be used by packages that use the
6177: Open Sound System (OSS) API.</p></li>
6178: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6179: any of the Postgres versions in the variable
6180: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6181: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6182: the file for more information.</p></li>
6183: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6184: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
6185: 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>
6186: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6187: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6188: library.</p></li>
6189: </ul></div>
6190: <p>The comments in those <code class="filename">buildlink3.mk</code>
6191: files provide a more complete
6192: description of how to use them properly.</p>
1.75 rillig 6193: </div>
1.148 asau 6194: <div class="sect1">
1.75 rillig 6195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6196: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6197: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6198: included by Makefiles to indicate the need to compile and link
6199: against header files and libraries provided by the package. A
6200: <code class="filename">buildlink3.mk</code> file should always provide
6201: enough information to add the correct type of dependency
6202: relationship and include any other
6203: <code class="filename">buildlink3.mk</code> files that it needs to find
6204: headers and libraries that it needs in turn.</p>
6205: <p>To generate an initial <code class="filename">buildlink3.mk</code>
6206: 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>
6207: package is highly recommended. For most packages, the following
6208: command will generate a good starting point for
6209: <code class="filename">buildlink3.mk</code> files:</p>
6210: <pre class="screen">
6211: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6212: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6213: </pre>
1.148 asau 6214: <div class="sect2">
1.75 rillig 6215: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6216: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6217: <p>The following real-life example
6218: <code class="filename">buildlink3.mk</code> is taken
6219: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 6220: <pre class="programlisting">
1.299 rillig 6221: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
6222:
6223: BUILDLINK_TREE+= tiff
6224:
6225: .if !defined(TIFF_BUILDLINK3_MK)
6226: TIFF_BUILDLINK3_MK:=
6227:
6228: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6229: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6230: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6231:
6232: .include "../../devel/zlib/buildlink3.mk"
6233: .include "../../graphics/jpeg/buildlink3.mk"
6234: .endif # TIFF_BUILDLINK3_MK
6235:
6236: BUILDLINK_TREE+= -tiff
1.1 grant 6237: </pre>
1.299 rillig 6238: <p>The header and footer manipulate
6239: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6240: <code class="filename">buildlink3.mk</code> files and is used to track
6241: the dependency tree.</p>
6242: <p>The main section is protected from multiple inclusion
6243: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6244: added. Several important variables are set in the section:</p>
6245: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6246: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6247: is the dependency version recorded in the installed
1.299 rillig 6248: package; this should always be set using
6249: <span class="command"><strong>+=</strong></span> to ensure that
6250: we're appending to any pre-existing list of values. This
1.300 wiz 6251: variable should be set to the last version of the
1.299 rillig 6252: package that had an backwards-incompatible API change.
6253: </p></li>
6254: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6255: is the location of the <em class="replaceable"><code>pkg</code></em>
6256: pkgsrc directory.</p></li>
6257: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6258: (not shown above) controls whether we use
6259: <code class="varname">BUILD_DEPENDS</code> or
6260: <code class="varname">DEPENDS</code> to add the dependency on
6261: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6262: selected by setting
6263: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6264: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
6265: used.</p></li>
6266: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6267: and
6268: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6269: (not shown above) are lists of subdirectories of
6270: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6271: to add to the header and library search paths. These
6272: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6273: respectively.</p></li>
6274: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6275: (not shown above) is the list of preprocessor flags to add
6276: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6277: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6278: should be avoided and instead be handled using
6279: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6280: above.</p></li>
6281: </ul></div>
6282: <p>The following variables are all optionally defined within
6283: this second section (protected against multiple inclusion) and
6284: control which package files are symlinked into
6285: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6286: transformed during the symlinking:</p>
6287: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6288: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6289: (not shown above) is a shell glob pattern relative to
6290: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6291: to be symlinked into
6292: <code class="filename">${BUILDLINK_DIR}</code>,
6293: e.g. <code class="filename">include/*.h</code>.</p></li>
6294: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6295: (not shown above) is a shell pipeline that
6296: outputs to stdout a list of files relative to
6297: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6298: The resulting files are to be symlinked
6299: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6300: this takes the <code class="filename">+CONTENTS</code> of a
6301: <em class="replaceable"><code>pkg</code></em> and filters it through
6302: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6303: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6304: (not shown above) is a filter command that filters
6305: <code class="filename">+CONTENTS</code> input into a list of files
6306: relative to
6307: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6308: on stdout. By default,
6309: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6310: outputs the contents of the <code class="filename">include</code>
6311: and <code class="filename">lib</code> directories in the package
6312: <code class="filename">+CONTENTS</code>.</p></li>
6313: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6314: (not shown above) is a list of sed arguments used to
6315: transform the name of the source filename into a
6316: destination filename, e.g. <span class="command"><strong>-e
6317: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6318: </ul></div>
6319: <p>This section can additionally include any
6320: <code class="filename">buildlink3.mk</code> needed for
6321: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6322: Including these <code class="filename">buildlink3.mk</code> files
6323: means that the headers and libraries for these
6324: dependencies are also symlinked into
6325: <code class="filename">${BUILDLINK_DIR}</code>
6326: whenever the <em class="replaceable"><code>pkg</code></em>
6327: <code class="filename">buildlink3.mk</code>
6328: file is included. Dependencies are only added for directly
6329: include <code class="filename">buildlink3.mk</code> files.</p>
6330: <p>When providing a <code class="filename">buildlink3.mk</code> and
6331: including other <code class="filename">buildlink3.mk</code> files in it,
6332: please only add necessary ones, i.e., those whose libraries or
6333: header files are automatically exposed when the package is
6334: use.</p>
6335: <p>In particular, if only an executable
6336: (<code class="filename">bin/foo</code>) is linked against a library, that
6337: library does not need to be propagated in the
6338: <code class="filename">buildlink3.mk</code> file.</p>
6339: <p>The following steps should help you decide if a
6340: <code class="filename">buildlink3.mk</code> file needs to be included:
6341: </p>
6342: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6343: <li class="listitem"><p>Look at the installed header files: What
6344: headers do they include? The packages providing these files
6345: must be buildlinked.</p></li>
6346: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6347: libraries and look against what other libraries they link.
6348: Some of the packages providing these probably need to be
6349: buildlinked; however, it's not automatic, since e.g. GTK on
6350: some systems pulls in the X libraries, so they will show up in
6351: the <code class="filename">ldd</code> output, while on others (like OS
6352: X) it won't. <code class="filename">ldd</code> output can thus only be
6353: used as a hint.</p></li>
6354: </ul></div>
6355: <p>
6356: </p>
6357: </div>
1.148 asau 6358: <div class="sect2">
1.75 rillig 6359: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6360: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6361: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6362: and
6363: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6364: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300 wiz 6365: <p>Both variables set lower bounds for a version of this package.
6366: The two variables differ in that one describes source
1.299 rillig 6367: compatibility (API) and the other binary compatibility (ABI).
6368: The difference is that a change in the API breaks compilation of
6369: programs while changes in the ABI stop compiled programs from
6370: running.</p>
1.300 wiz 6371: <p>The
6372: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6373: variable in a <code class="filename">buildlink3.mk</code> should be
6374: changed very rarely. (One possible scenario: If all packages
6375: using this package need a higher version than defined in the
6376: <code class="filename">buildlink3.mk</code>,
1.299 rillig 6377: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6378: could be updated to that higher version.)</p>
6379: <p>On the other hand, changes to
1.299 rillig 6380: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6381: are more common. The variable will need to be updated every
6382: time the major version of one of its shared libraries is changed,
6383: or any other change where a binary built against the previous
6384: version of the package will not run against the new version any
6385: longer.</p>
6386: <p>In such a case, the package's
1.299 rillig 6387: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6388: must be increased to require the new package version. Then the
6389: <code class="varname">PKGREVISION</code> of all packages
6390: <em class="replaceable"><code>foo</code></em> that depend on this package need
6391: to be increased, and if they have
6392: <code class="filename">buildlink3.mk</code> files,
6393: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6394: in their <code class="filename">buildlink3.mk</code> files must be
6395: increased to the new version as well. This is required so that a
6396: package will pull in the versions of the packages that use the
6397: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6398: uniquely identify the packages built against the new ABI. The
6399: <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
6400: help with these updates.</p>
6401: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6402: about dependencies on other packages, including the
6403: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299 rillig 6404: <p>Please take careful consideration before adjusting
6405: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6406: or
6407: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6408: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6409: cause unneeded package deletions and rebuilds. In many cases,
6410: new versions of packages work just fine with older
6411: dependencies.</p>
1.299 rillig 6412: <p>Also it is not needed to set
6413: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6414: when it is identical to
6415: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 6416: </div>
6417: </div>
1.148 asau 6418: <div class="sect1">
1.75 rillig 6419: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6420: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6421: <p>Some packages in pkgsrc install headers and libraries that
6422: coincide with headers and libraries present in the base system.
6423: Aside from a <code class="filename">buildlink3.mk</code> file, these
6424: packages should also include a <code class="filename">builtin.mk</code>
6425: file that includes the necessary checks to decide whether using
6426: the built-in software or the pkgsrc software is
6427: appropriate.</p>
6428: <p>The only requirements of a builtin.mk file for
6429: <em class="replaceable"><code>pkg</code></em> are:</p>
6430: <div class="orderedlist"><ol class="orderedlist" type="1">
6431: <li class="listitem"><p>It should set
6432: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6433: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6434: after it is included.</p></li>
6435: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6436: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6437: which is already set before the
6438: <code class="filename">builtin.mk</code> file is included.</p></li>
6439: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6440: is <span class="emphasis"><em>very</em></span> important and takes careful
6441: attention to <code class="filename">Makefile</code> coding.</p></li>
6442: </ol></div>
6443: <div class="sect2">
6444: <div class="titlepage"><div><div><h3 class="title">
6445: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6446: <p>The following is the recommended template for builtin.mk
6447: files:</p>
1.75 rillig 6448: <pre class="programlisting">
1.299 rillig 6449: .if !defined(IS_BUILTIN.foo)
6450: #
6451: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6452: # genuinely exists in the system or not.
6453: #
6454: IS_BUILTIN.foo?= no
1.100 rillig 6455:
1.299 rillig 6456: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6457: # version can be determined.
6458: #
6459: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6460: BUILTIN_PKG.foo?= foo-1.0
6461: . endif
6462: .endif # IS_BUILTIN.foo
1.100 rillig 6463:
1.299 rillig 6464: .if !defined(USE_BUILTIN.foo)
6465: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6466: . if defined(BUILTIN_PKG.foo)
6467: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6468: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6469: USE_BUILTIN.foo!= \
6470: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6471: && ${ECHO} "yes" || ${ECHO} "no"
6472: . endif
6473: . endfor
6474: . endif
6475: .endif # USE_BUILTIN.foo
1.100 rillig 6476:
1.299 rillig 6477: CHECK_BUILTIN.foo?= no
6478: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6479: #
6480: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6481: # "yes" or "no".
6482: #
6483: .endif # CHECK_BUILTIN.foo
1.75 rillig 6484: </pre>
1.299 rillig 6485: <p>The first section sets
6486: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6487: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6488: in the base system. This should not be a base system software
6489: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6490: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6491: included as part of the base system. This variable is only
6492: used internally within the <code class="filename">builtin.mk</code>
6493: file.</p>
6494: <p>The second section sets
6495: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6496: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6497: system if it exists (if
6498: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6499: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6500: within the <code class="filename">builtin.mk</code> file.</p>
6501: <p>The third section sets
6502: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6503: and is <span class="emphasis"><em>required</em></span> in all
6504: <code class="filename">builtin.mk</code> files. The code in this
6505: section must make the determination whether the built-in
6506: software is adequate to satisfy the dependencies listed in
6507: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6508: This is typically done by comparing
6509: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6510: against each of the dependencies in
6511: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6512: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6513: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6514: end of the <code class="filename">builtin.mk</code> file. Note that
6515: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6516: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6517: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6518: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6519: that the built-in version of the software is similar enough to
6520: be used as a replacement.</p>
6521: <p>The last section is guarded by
6522: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6523: and includes code that uses the value of
6524: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6525: set in the previous section. This typically includes, e.g.,
6526: adding additional dependency restrictions and listing additional
6527: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6528: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6529: </div>
6530: <div class="sect2">
6531: <div class="titlepage"><div><div><h3 class="title">
6532: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
6533: <p>When building packages, it's possible to choose whether to set
6534: a global preference for using either the built-in (native)
6535: version or the pkgsrc version of software to satisfy a
6536: dependency. This is controlled by setting
6537: <code class="varname">PREFER_PKGSRC</code> and
6538: <code class="varname">PREFER_NATIVE</code>. These variables take values
6539: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
6540: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
6541: use the pkgsrc versions of software, while
6542: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
6543: built-in versions. Preferences are determined by the most
6544: specific instance of the package in either
6545: <code class="varname">PREFER_PKGSRC</code> or
6546: <code class="varname">PREFER_NATIVE</code>. If a package is specified
6547: in neither or in both variables, then
6548: <code class="varname">PREFER_PKGSRC</code> has precedence over
6549: <code class="varname">PREFER_NATIVE</code>. For example, to require
6550: using pkgsrc versions of software for all but the most basic
6551: bits on a NetBSD system, you can set:</p>
1.75 rillig 6552: <pre class="programlisting">
1.299 rillig 6553: PREFER_PKGSRC= yes
6554: PREFER_NATIVE= getopt skey tcp_wrappers
6555: </pre>
6556: <p>A package <span class="emphasis"><em>must</em></span> have a
6557: <code class="filename">builtin.mk</code>
6558: file to be listed in <code class="varname">PREFER_NATIVE</code>,
6559: otherwise it is simply ignored in that list.</p>
1.305 bacon 6560: <p><code class="varname">PREFER_PKGSRC</code> and
6561: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
6562: to ensure that the bootstrap process does not use inapropriate
6563: native tools as dependencies for core packages.
6564:
6565: </p>
6566: <pre class="screen">
6567: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
6568: </pre>
6569: <p>
6570:
1.299 rillig 6571: Switching between settings globally at a later date can introduce
6572: complications with dependency resolution. This is caused by packages
1.305 bacon 6573: built with the opposite preference being installed alongside each
6574: other. Hence, any changes to these variables after bootstrap will
6575: necessitate rebuilding all packages depending on one whose preference
6576: has been changed. This is not trivial and should be avoided.</p>
6577: <p>When using pkgsrc on Linux systems, there is high risk of
6578: "leakage", where programs installed by pkgsrc may inadvertently use a
6579: command or library not installed by pkgsrc, e.g. those installed by
6580: yum or apt. Such foreign dependencies may be installed, removed, or
6581: upgraded to a version incompatible with the pkgsrc package at any
6582: time, causing pkgsrc packages to subsequently malfunction. Pkgsrc
6583: cannot prevent this, as it has no control over other package managers.
6584: Another potential problem is that under Redhat Enterprise and related
6585: Linux systems, yum packages are only patched and never upgraded, so
6586: eventually they may become too outdated for use by pkgsrc. Even
6587: intentionally using foreign dependencies, not considered leakage, can
6588: lead to these problems, so it is generally discouraged. In order to
6589: minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
6590: This ensures that pkgsrc is aware of any changes to dependency packages
6591: and can rebuild or upgrade the entire dependency tree as needed. This
6592: default can be overridden by setting --prefer-pkgsrc to "no" or a list of
6593: packages, or by setting --prefer-native to "yes".</p>
1.75 rillig 6594: </div>
1.107 rillig 6595: </div>
1.75 rillig 6596: </div>
1.148 asau 6597: <div class="chapter">
1.75 rillig 6598: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 6599: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75 rillig 6600: <div class="toc">
6601: <p><b>Table of Contents</b></p>
1.210 leot 6602: <dl class="toc">
1.299 rillig 6603: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6604: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6605: <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>
6606: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6607: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6608: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6609: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6610: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6611: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75 rillig 6612: </dl>
6613: </div>
1.299 rillig 6614: <p>The <code class="filename">PLIST</code> file contains a package's
6615: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6616: the package (relative to the <code class="filename">${PREFIX}</code>
6617: directory it's been installed in) plus some additional statements
1.311 leot 6618: - see the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.299 rillig 6619: This chapter addresses some issues that need attention when
6620: dealing with the <code class="filename">PLIST</code> file (or files, see
6621: below!).</p>
1.148 asau 6622: <div class="sect1">
1.75 rillig 6623: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6624: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6625: <p>Be sure to add a RCS ID line as the first thing in any
6626: <code class="filename">PLIST</code> file you write:</p>
6627: <pre class="programlisting">
6628: @comment $NetBSD $
6629: </pre>
6630: <p>An artificial space has been added between NetBSD and $, this is a
6631: workaround here to prevent CVS expanding to the filename of the guide. When
6632: adding the RCS ID the space should be omitted.</p>
1.75 rillig 6633: </div>
1.148 asau 6634: <div class="sect1">
1.75 rillig 6635: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6636: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6637: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6638: to output a PLIST that matches any new files since the package
6639: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6640: more information on this target.</p>
1.75 rillig 6641: </div>
1.148 asau 6642: <div class="sect1">
1.75 rillig 6643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6644: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6645: </h2></div></div></div>
6646: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6647: of AWK patterns and actions that are used to filter the output of
6648: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6649: scripting you like to it, but be careful with quoting.</p>
6650: <p>For example, to get all files inside the
6651: <code class="filename">libdata/foo</code> directory removed from the
6652: resulting PLIST:</p>
1.88 wiz 6653: <pre class="programlisting">
1.299 rillig 6654: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.100 rillig 6655: </pre>
1.300 wiz 6656: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6657: evaluated after the file list and directory list are sorted.
6658: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6659: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6660: list and directory list are sorted.</p>
1.299 rillig 6661: </div>
6662: <div class="sect1">
6663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6664: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6665: <p>A number of variables are substituted automatically in
6666: PLISTs when a package is installed on a system. This includes the
6667: following variables:</p>
6668: <div class="variablelist"><dl class="variablelist">
6669: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6670: <dd>
6671: <p>Some packages like emacs and perl embed information
6672: about which architecture they were built on into the
6673: pathnames where they install their files. To handle this
6674: case, PLIST will be preprocessed before actually used, and
6675: the symbol
6676: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6677: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6678: same is done if the string
6679: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6680: PLIST somewhere - use this on packages that have GNU
6681: autoconf-created configure scripts.</p>
6682: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6683: <h3 class="title">Legacy note</h3>
6684: <p>There used to be a symbol
6685: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6686: was replaced by the output of <span class="command"><strong>uname
6687: -m</strong></span>, but that's no longer supported and has
6688: been removed.</p>
6689: </div>
6690: </dd>
6691: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6692: <dd>
6693: <p>Some packages want to embed the OS name and version
6694: into some paths. To do this, use these variables in the
6695: <code class="filename">PLIST</code>:
6696: </p>
6697: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6698: <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>
6699: <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>
6700: <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>
6701: </ul></div>
6702: </dd>
6703: </dl></div>
6704: <p>For a list of values which are replaced by
6705: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6706: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6707: <code class="varname">PLIST_SUBST</code> should help.</p>
6708: <p>If you want to change other variables not listed above, you
6709: can add variables and their expansions to this variable in the
6710: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="12.5. Optional files">Section 12.5, “Optional files”</a>):</p>
1.81 rillig 6711: <pre class="programlisting">
1.299 rillig 6712: PLIST_SUBST+= SOMEVAR="somevalue"
1.100 rillig 6713: </pre>
1.299 rillig 6714: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6715: in the <code class="filename">PLIST</code> with
6716: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6717: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6718: the common case of conditionally including some
6719: <code class="filename">PLIST</code> entries. It can be done by adding
6720: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6721: setting the corresponding <code class="varname">PLIST.foo</code> variable
6722: to <code class="literal">yes</code> if the entry should be included.
6723: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6724: in the <code class="filename">PLIST</code> with either
6725: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6726: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6727: For example, in <code class="filename">Makefile</code>:</p>
1.174 asau 6728: <pre class="programlisting">
1.299 rillig 6729: PLIST_VARS+= foo
6730: .if <em class="replaceable"><code>condition</code></em>
6731: PLIST.foo= yes
6732: .else
1.174 asau 6733: </pre>
1.299 rillig 6734: <p>And then in <code class="filename">PLIST</code>:</p>
1.81 rillig 6735: <pre class="programlisting">
1.299 rillig 6736: @comment $NetBSD $
6737: bin/bar
6738: man/man1/bar.1
6739: ${PLIST.foo}bin/foo
6740: ${PLIST.foo}man/man1/foo.1
6741: ${PLIST.foo}share/bar/foo.data
1.100 rillig 6742: </pre>
1.299 rillig 6743: <p>An artificial space has been added between NetBSD and $, this is a
6744: workaround here to prevent CVS expanding to the filename of the guide. When
1.309 gutterid 6745: adding the RCS ID the space should be omitted.</p>
1.81 rillig 6746: </div>
1.299 rillig 6747: <div class="sect1">
6748: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6749: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6750: <p>Man pages should be installed in compressed form if
6751: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6752: and uncompressed otherwise. To handle this in the
6753: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6754: appended/removed automatically for man pages according to
6755: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6756: or not, see above for details. This modification of the
6757: <code class="filename">PLIST</code> file is done on a copy of it, not
6758: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 6759: </div>
1.148 asau 6760: <div class="sect1">
1.75 rillig 6761: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6762: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6763: </h2></div></div></div>
6764: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6765: in generating the binary package, set the variable
6766: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.311 leot 6767: The files are later concatenated using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.299 rillig 6768: important. The default for <code class="varname">PLIST_SRC</code> is
6769: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 6770: </div>
1.148 asau 6771: <div class="sect1">
1.75 rillig 6772: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6773: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6774: <p>Some packages decide to install a different set of files based on
6775: the operating system being used. These differences can be
6776: automatically handled by using the following files:</p>
6777: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6778: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6779: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6780: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6781: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6782: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6783: </ul></div>
1.75 rillig 6784: </div>
1.148 asau 6785: <div class="sect1">
1.75 rillig 6786: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6787: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6788: <p>Some packages decide to generate hard-to-guess file names
6789: during installation that are hard to wire down.</p>
6790: <p>In such cases, you can set the
6791: <code class="varname">GENERATE_PLIST</code> variable to shell code
6792: terminated (with a semicolon) that will output PLIST entries which
6793: will be appended to the PLIST</p>
6794: <p>You can find one example in editors/xemacs:</p>
6795: <pre class="programlisting">
6796: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6797: </pre>
6798: <p>which will append something like
6799: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6800: <code class="filename">PLIST</code>.
6801: </p>
1.75 rillig 6802: </div>
1.148 asau 6803: <div class="sect1">
1.75 rillig 6804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6805: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6806: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6807: multiple (and unrelated) packages install files. These
6808: directories were problematic because you had to add special
6809: tricks in the PLIST to conditionally remove them, or have some
6810: centralized package handle them.</p>
6811: <p>In pkgsrc, it is now easy: Each package should create
6812: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6813: will remove any directories left empty after uninstalling a
6814: package.</p>
6815: <p>If a package needs an empty directory to work, create
6816: the directory during installation as usual, and also add an
6817: entry to the PLIST:
6818:
6819: </p>
6820: <pre class="programlisting">
6821: @pkgdir path/to/empty/directory
6822: </pre>
6823: <p>
6824:
6825: or take a look at <code class="varname">MAKE_DIRS</code> and
6826: <code class="varname">OWN_DIRS</code>.
1.88 wiz 6827: </p>
1.75 rillig 6828: </div>
1.299 rillig 6829: </div>
6830: <div class="chapter">
6831: <div class="titlepage"><div><div><h2 class="title">
6832: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6833: <div class="toc">
6834: <p><b>Table of Contents</b></p>
6835: <dl class="toc">
6836: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6837: <dd><dl>
6838: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6839: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6840: </dl></dd>
6841: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6842: <dd><dl>
6843: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6844: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
6845: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
6846: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
6847: </dl></dd>
6848: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6849: <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>
6850: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6851: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6852: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6853: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6854: <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>
6855: </dl>
6856: </div>
6857: <p>This chapter describes the framework known as
6858: <code class="literal">pkginstall</code>, whose key features are:</p>
6859: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6860: <li class="listitem"><p>Generic installation and manipulation of directories and files
6861: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6862: <li class="listitem"><p>Automatic handling of configuration files during installation,
6863: provided that packages are correctly designed.</p></li>
6864: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6865: <li class="listitem"><p>Registration of system users and groups.</p></li>
6866: <li class="listitem"><p>Registration of system shells.</p></li>
6867: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6868: </ul></div>
6869: <p>The following sections inspect each of the above points in detail.</p>
6870: <p>You may be thinking that many of the things described here could be
6871: easily done with simple code in the package's post-installation target
6872: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6873: as the code in them is only executed when building from source. Machines
6874: using binary packages could not benefit from it at all (as the code itself
6875: could be unavailable). Therefore, the only way to achieve any of the items
6876: described above is by means of the installation scripts, which are
6877: automatically generated by pkginstall.</p>
1.148 asau 6878: <div class="sect1">
1.75 rillig 6879: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6880: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6881: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6882: of files and directories that belong to a package. The names used in it
6883: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6884: which means that it cannot register files outside this directory (absolute
6885: path names are not allowed). Despite this restriction, some packages need
6886: to install files outside this location; e.g., under
6887: <code class="filename">${VARBASE}</code> or
6888: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6889: is to create such files during installation time by using
6890: installation scripts.</p>
6891: <p>The generic installation scripts are shell scripts that can
6892: contain arbitrary code. The list of scripts to execute is taken from
6893: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6894: <code class="filename">INSTALL</code>. A similar variable exists for package
6895: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6896: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6897: commands, so they have the potential to create and manage files
6898: anywhere in the file system.</p>
6899: <p>Using these general installation files is not recommended, but
6900: may be needed in some special cases. One reason for avoiding them is
6901: that the user has to trust the packager that there is no unwanted or
6902: simply erroneous code included in the installation script. Also,
6903: previously there were many similar scripts for the same functionality,
6904: and fixing a common error involved finding and changing all of
6905: them.</p>
6906: <p>The pkginstall framework offers another, standardized way. It
6907: provides generic scripts to abstract the manipulation of such files
6908: and directories based on variables set in the package's
6909: <code class="filename">Makefile</code>. The rest of this section describes
6910: these variables.</p>
6911: <div class="sect2">
6912: <div class="titlepage"><div><div><h3 class="title">
6913: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
6914: <p>The following variables can be set to request the creation of
6915: directories anywhere in the file system:</p>
6916: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6917: <li class="listitem">
6918: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
6919: contain a list of directories that should be created and should attempt
6920: to be destroyed by the installation scripts. The difference between
6921: the two is that the latter prompts the administrator to remove any
6922: directories that may be left after deinstallation (because they were
6923: not empty), while the former does not. Example:</p>
6924: <pre class="programlisting">
6925: MAKE_DIRS+= ${VARBASE}/foo/private
6926: </pre>
6927: </li>
6928: <li class="listitem">
6929: <p><code class="varname">MAKE_DIRS_PERMS</code> and
6930: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
6931: which directories should be created and should attempt to be destroyed
6932: by the installation scripts. Each tuple holds the following values,
6933: separated by spaces: the directory name, its owner, its group and its
6934: numerical mode. For example:</p>
6935: <pre class="programlisting">
6936: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
6937: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
6938: </pre>
6939: <p>The difference between the two is exactly the same as their
6940: non-<code class="varname">PERMS</code> counterparts.</p>
6941: </li>
6942: </ul></div>
1.75 rillig 6943: </div>
1.299 rillig 6944: <div class="sect2">
6945: <div class="titlepage"><div><div><h3 class="title">
6946: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
6947: <p>Creating non-empty files outside the installation prefix is tricky
6948: because the <code class="filename">PLIST</code> forces all files to be inside it.
6949: To overcome this problem, the only solution is to extract the file in the
6950: known place (i.e., inside the installation prefix) and copy it to the
6951: appropriate location during installation (done by the installation scripts
6952: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
6953: file</em></span> in the following paragraphs, which describe the variables
6954: that can be used to automatically and consistently handle files outside the
6955: installation prefix:</p>
6956: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6957: <li class="listitem">
6958: <p><code class="varname">CONF_FILES</code> and
6959: <code class="varname">REQD_FILES</code> are pairs of master and target files.
6960: During installation time, the master file is copied to the target one
6961: if and only if the latter does not exist. Upon deinstallation, the
6962: target file is removed provided that it was not modified by the
6963: installation.</p>
6964: <p>The difference between the two is that the latter prompts the
6965: administrator to remove any files that may be left after
6966: deinstallation (because they were not empty), while the former does
6967: not.</p>
6968: </li>
6969: <li class="listitem">
6970: <p><code class="varname">CONF_FILES_PERMS</code> and
6971: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
6972: files as well as their target locations. For each of them, it also
6973: specifies their owner, their group and their numeric permissions, in
6974: this order. For example:</p>
1.88 wiz 6975: <pre class="programlisting">
1.299 rillig 6976: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
6977: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100 rillig 6978: </pre>
1.299 rillig 6979: <p>The difference between the two is exactly the same as their
6980: non-<code class="varname">PERMS</code> counterparts.</p>
6981: </li>
6982: </ul></div>
6983: </div>
1.75 rillig 6984: </div>
1.148 asau 6985: <div class="sect1">
1.75 rillig 6986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6987: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
6988: <p>Configuration files are special in the sense that they are installed
6989: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
6990: need special treatment during installation (most of which is automated by
6991: pkginstall). The main concept you must bear in mind is that files marked
6992: as configuration files are automatically copied to the right place (somewhere
6993: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
6994: and only if</em></span> they didn't exist before. Similarly, they will not
6995: be removed if they have local modifications. This ensures that
6996: administrators never lose any custom changes they may have made.</p>
6997: <div class="sect2">
6998: <div class="titlepage"><div><div><h3 class="title">
6999: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7000: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7001: specifies where configuration files shall be installed. Its contents are
7002: set based upon the following variables:</p>
7003: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7004: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7005: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
7006: be overridden by the user to point to his preferred location (e.g.,
7007: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7008: Packages must not use it directly.</p></li>
7009: <li class="listitem">
7010: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7011: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7012: for the package being built shall be installed. The definition of this
7013: variable only makes sense in the package's
7014: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7015: <p>As an example, consider the Apache package,
7016: <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
7017: configuration files under the
7018: <code class="filename">httpd/</code> subdirectory of
7019: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7020: Makefile.</p>
7021: </li>
7022: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7023: variable that holds this package's configuration directory (if
7024: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7025: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7026: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7027: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7028: directory where the configuration files for the package identified by
7029: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7030: </ul></div>
7031: <p>Based on the above variables, pkginstall determines the value of
7032: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
7033: variable that can be used within a package to refer to its configuration
7034: directory. The algorithm used to set its value is basically the
7035: following:</p>
7036: <div class="orderedlist"><ol class="orderedlist" type="1">
7037: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7038: its value is used.</p></li>
7039: <li class="listitem"><p>If the previous variable is not defined but
7040: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7041: <code class="filename">Makefile</code>, the resulting value is
7042: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7043: <li class="listitem"><p>Otherwise, it is set to
7044: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7045: </ol></div>
7046: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
7047: 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
7048: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
7049: be created with OWN_DIRS or MAKE_DIRS.</p>
7050: </div>
7051: <div class="sect2">
7052: <div class="titlepage"><div><div><h3 class="title">
7053: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7054: <p>Given that pkgsrc (and users!) expect configuration files to be in a
7055: known place, you need to teach each package where it shall install its
7056: files. In some cases you will have to patch the package Makefiles to
7057: achieve it. If you are lucky, though, it may be as easy as passing an
7058: extra flag to the configuration script; this is the case of GNU Autoconf-
7059: generated files:</p>
1.75 rillig 7060: <pre class="programlisting">
1.299 rillig 7061: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100 rillig 7062: </pre>
1.299 rillig 7063: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
7064: for</em></span> its configuration files, not where they will be originally
7065: installed (although the difference is never explicit,
7066: unfortunately).</p>
1.75 rillig 7067: </div>
1.299 rillig 7068: <div class="sect2">
7069: <div class="titlepage"><div><div><h3 class="title">
7070: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
7071: <p>As said before, pkginstall automatically handles configuration files.
7072: This means that <span class="strong"><strong>the packages themselves must not
7073: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7074: directly</strong></span>. Bad news is that many software installation scripts
7075: will, out of the box, mess with the contents of that directory. So what is
7076: the correct procedure to fix this issue?</p>
7077: <p>You must teach the package (usually by manually patching it) to
7078: install any configuration files under the examples hierarchy,
7079: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7080: <code class="filename">PLIST</code> registers them and the administrator always
7081: has the original copies available.</p>
7082: <p>Once the required configuration files are in place (i.e., under the
7083: examples hierarchy), the pkginstall framework can use them as master copies
7084: during the package installation to update what is in
7085: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7086: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
7087: 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
7088: about their syntax and their purpose. Here is an example, taken from the
7089: <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.88 wiz 7090: <pre class="programlisting">
1.299 rillig 7091: EGDIR= ${PREFIX}/share/doc/mutt/samples
7092: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.100 rillig 7093: </pre>
1.299 rillig 7094: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
7095: package and has no meaning outside it.</p>
1.75 rillig 7096: </div>
1.299 rillig 7097: <div class="sect2">
7098: <div class="titlepage"><div><div><h3 class="title">
7099: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
7100: <p>The automatic copying of config files can be toggled by setting the
7101: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7102: installation.</p>
1.88 wiz 7103: </div>
1.75 rillig 7104: </div>
1.148 asau 7105: <div class="sect1">
1.75 rillig 7106: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7107: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7108: <p>System startup scripts are special files because they must be
7109: installed in a place known by the underlying OS, usually outside the
7110: 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
7111: can be used. However, pkginstall provides a special mechanism to handle
7112: these files.</p>
7113: <p>In order to provide system startup scripts, the package has
7114: to:</p>
7115: <div class="orderedlist"><ol class="orderedlist" type="1">
7116: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7117: the <code class="literal">.sh</code> suffix appended. Considering the
7118: <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
7119: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
7120: <li class="listitem">
7121: <p>Tell pkginstall to handle it, appending the name of the script,
7122: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7123: Continuing the previous example:</p>
7124: <pre class="programlisting">
7125: RCD_SCRIPTS+= cupsd
7126: </pre>
7127: </li>
7128: </ol></div>
7129: <p>Once this is done, pkginstall will do the following steps for each
7130: script in an automated fashion:</p>
7131: <div class="orderedlist"><ol class="orderedlist" type="1">
7132: <li class="listitem"><p>Process the file found in the files directory applying all the
7133: substitutions described in the <code class="filename">FILES_SUBST</code>
7134: variable.</p></li>
7135: <li class="listitem"><p>Copy the script from the files directory to the examples
7136: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
7137: that this master file must be explicitly registered in the
7138: <code class="filename">PLIST</code>.</p></li>
7139: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7140: from the examples hierarchy into the system-wide startup scripts
7141: directory.</p></li>
7142: </ol></div>
7143: <div class="sect2">
7144: <div class="titlepage"><div><div><h3 class="title">
7145: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7146: <p>The automatic copying of config files can be toggled by setting the
7147: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7148: installation. Note that the scripts will be always copied inside the
7149: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7150: matter what the value of this variable is.</p>
1.75 rillig 7151: </div>
7152: </div>
1.299 rillig 7153: <div class="sect1">
7154: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7155: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7156: <p>If a package needs to create special users and/or groups during
7157: installation, it can do so by using the pkginstall framework.</p>
7158: <p>Users can be created by adding entries to the
7159: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7160: syntax:</p>
7161: <pre class="programlisting">
7162: user:group
7163: </pre>
7164: <p>Further specification of user details may be done by setting
7165: per-user variables.
7166: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7167: numeric UID for the user.
7168: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7169: user's description or comment.
7170: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7171: user's home directory, and defaults to
7172: <code class="filename">/nonexistent</code> if not specified.
7173: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7174: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7175: not specified.</p>
7176: <p>Similarly, groups can be created by adding entries to the
7177: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7178: <pre class="programlisting">
7179: group
7180: </pre>
7181: <p>The numeric GID of the group may be set by defining
7182: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7183: <p>If a package needs to create the users and groups at an earlier
7184: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7185: <code class="literal">configure</code>,<code class="literal">build</code>, or
7186: <code class="literal">pre-install</code> to indicate the phase before which the
7187: users and groups are created. In this case, the numeric UIDs and GIDs
7188: of the created users and groups are automatically hardcoded into the
7189: final installation scripts.</p>
1.75 rillig 7190: </div>
1.148 asau 7191: <div class="sect1">
1.75 rillig 7192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7193: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7194: <p>Packages that install system shells should register them in the shell
7195: database, <code class="filename">/etc/shells</code>, to make things easier to the
7196: administrator. This must be done from the installation scripts to keep
7197: binary packages working on any system. pkginstall provides an easy way to
7198: accomplish this task.</p>
7199: <p>When a package provides a shell interpreter, it has to set the
7200: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7201: add some hooks to the installation scripts to handle it. Consider the
7202: 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>
7203: <pre class="programlisting">
7204: PKG_SHELL= ${PREFIX}/bin/zsh
7205: </pre>
7206: <div class="sect2">
7207: <div class="titlepage"><div><div><h3 class="title">
7208: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7209: <p>The automatic registration of shell interpreters can be disabled by
7210: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7211: environment variable to <code class="literal">NO</code>.</p>
7212: </div>
1.75 rillig 7213: </div>
1.148 asau 7214: <div class="sect1">
1.75 rillig 7215: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7216: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7217: <p>Packages that install X11 fonts should update the database files
7218: that index the fonts within each fonts directory. This can easily be
7219: accomplished within the pkginstall framework.</p>
7220: <p>When a package installs X11 fonts, it must list the directories in
7221: which fonts are installed in the
7222: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7223: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7224: <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
7225: installation scripts to run the appropriate commands to update the fonts
7226: database files within each of those directories. For convenience, if the
7227: directory path is relative, it is taken to be relative to the package's
7228: 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.75 rillig 7229: <pre class="programlisting">
1.299 rillig 7230: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75 rillig 7231: </pre>
1.299 rillig 7232: <div class="sect2">
7233: <div class="titlepage"><div><div><h3 class="title">
7234: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7235: <p>The automatic update of fonts databases can be disabled by
7236: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7237: environment variable to <code class="literal">NO</code>.</p>
1.75 rillig 7238: </div>
7239: </div>
7240: </div>
1.148 asau 7241: <div class="chapter">
1.75 rillig 7242: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 7243: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75 rillig 7244: <div class="toc">
7245: <p><b>Table of Contents</b></p>
1.210 leot 7246: <dl class="toc">
1.267 rillig 7247: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75 rillig 7248: <dd><dl>
1.267 rillig 7249: <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>
7250: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7251: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7252: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7253: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7254: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7255: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7256: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7257: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7258: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7259: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7260: </dl></dd>
7261: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7262: <dd><dl>
7263: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7264: <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>
7265: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7266: </dl></dd>
7267: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7268: <dd><dl>
7269: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7270: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7271: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
7272: </dl></dd>
7273: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7274: <dd><dl>
7275: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7276: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
7277: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
7278: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
7279: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
7280: </dl></dd>
7281: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7282: <dd><dl>
7283: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7284: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 7285: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7286: <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>
7287: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 7288: </dl></dd>
7289: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7290: <dd><dl>
7291: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7292: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7293: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7294: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7295: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7296: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
7297: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
7298: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
7299: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
7300: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
7301: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
7302: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
7303: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
7304: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
7305: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
7306: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
7307: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
7308: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87 wiz 7309: emulation</a></span></dt>
1.267 rillig 7310: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
7311: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7312: </dl></dd>
1.267 rillig 7313: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7314: </dl>
7315: </div>
1.148 asau 7316: <div class="sect1">
1.75 rillig 7317: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 7318: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78 rillig 7319: <p>One appealing feature of pkgsrc is that it runs on many
1.218 rillig 7320: different platforms. As a result, it is important to ensure,
7321: where possible, that packages in pkgsrc are portable. This
7322: chapter mentions some particular details you should pay
7323: attention to while working on pkgsrc.</p>
1.148 asau 7324: <div class="sect2">
1.78 rillig 7325: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7326: <a name="pulling-vars-from-etc-mk.conf"></a>21.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93 rillig 7327: </h3></div></div></div>
1.78 rillig 7328: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7329: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7330: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7331: want to use those variables in the preprocessor directives of
1.311 leot 7332: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87 wiz 7333: <code class="literal">.for</code>), you need to include the file
7334: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7335: loads the user preferences.</p>
1.78 rillig 7336: <p>But note that some variables may not be completely defined
1.219 rillig 7337: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7338: included, as they may contain references to variables that are
7339: not yet defined. In shell commands (the lines in
7340: <code class="filename">Makefile</code> that are indented with a tab) this
7341: is no problem, since variables are only expanded when they are
7342: used. But in the preprocessor directives mentioned above and in
7343: dependency lines (of the form <code class="literal">target:
7344: dependencies</code>) the variables are expanded at load
7345: time.</p>
1.148 asau 7346: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7347: <h3 class="title">Note</h3>
1.218 rillig 7348: <p>To check whether a variable can be used at load time,
7349: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78 rillig 7350: </div>
7351: </div>
1.148 asau 7352: <div class="sect2">
1.78 rillig 7353: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7354: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88 wiz 7355: <p>Occasionally, packages require interaction from the user,
7356: and this can be in a number of ways:</p>
1.148 asau 7357: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7358: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7359: interaction such as entering username/password or accepting a
7360: license on a web page.</p></li>
1.128 wiz 7361: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7362: passwords.</p></li>
1.128 wiz 7363: <li class="listitem"><p>help to configure the package before it is built</p></li>
7364: <li class="listitem"><p>help during the build process</p></li>
7365: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7366: </ul></div>
1.218 rillig 7367: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7368: variable to define which stages need interaction. This should be
7369: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7370: <pre class="programlisting">
1.100 rillig 7371: INTERACTIVE_STAGE= configure install
1.222 sevan 7372: </pre>
1.88 wiz 7373: <p>The user can then decide to skip this package by setting the
1.218 rillig 7374: <code class="varname">BATCH</code> variable. Packages that require interaction
7375: are also excluded from bulk builds.</p>
1.75 rillig 7376: </div>
1.148 asau 7377: <div class="sect2">
1.75 rillig 7378: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7379: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222 sevan 7380: <p>Authors of software can choose the licence under which software
7381: can be copied. The Free Software Foundation has declared some
7382: licenses "Free", and the Open Source Initiative has a definition of
7383: "Open Source".</p>
7384: <p>By default, pkgsrc allows packages with Free or Open Source
7385: licenses to be built. To allow packages with other licenses to be
7386: built as well, the pkgsrc user needs to add these licenses to the
7387: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7388: that this variable only affects which packages may be
7389: <span class="emphasis"><em>built</em></span>, while the license terms often also
7390: restrict the actual use of the package and its redistribution.</p>
1.98 wiz 7391: <p>One might want to only install packages with a BSD license,
1.218 rillig 7392: or the GPL, and not the other. The free licenses are added to the
1.222 sevan 7393: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.121 jnemeth 7394: user can override the default by setting the
7395: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222 sevan 7396: of "+=". The licenses accepted by default are defined in the
7397: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7398: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78 rillig 7399: <p>The license tag mechanism is intended to address
1.87 wiz 7400: copyright-related issues surrounding building, installing and
7401: using a package, and not to address redistribution issues (see
7402: <code class="varname">RESTRICTED</code> and
1.222 sevan 7403: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121 jnemeth 7404: Packages with redistribution restrictions should set these
7405: tags.</p>
1.98 wiz 7406: <p>Denoting that a package may be copied according to a
7407: particular license is done by placing the license in
1.87 wiz 7408: <code class="filename">pkgsrc/licenses</code> and setting the
7409: <code class="varname">LICENSE</code> variable to a string identifying the
1.250 leot 7410: 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.87 wiz 7411: <pre class="programlisting">
1.100 rillig 7412: LICENSE= xv-license
1.222 sevan 7413: </pre>
1.87 wiz 7414: <p>When trying to build, the user will get a notice that the
1.98 wiz 7415: package is covered by a license which has not been placed in the
7416: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7417: <pre class="programlisting">
1.100 rillig 7418: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7419: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7420: ===> To view the license, enter "/usr/bin/make show-license".
7421: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7422: ===> ACCEPTABLE_LICENSES+=xv-license
7423: *** Error code 1
1.222 sevan 7424: </pre>
1.110 hubertf 7425: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7426: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7427: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7428: convey to pkgsrc that it should not in the future fail because of
7429: that license:</p>
1.78 rillig 7430: <pre class="programlisting">
1.100 rillig 7431: ACCEPTABLE_LICENSES+=xv-license
1.222 sevan 7432: </pre>
7433: <p>The use of <code class="varname">LICENSE=shareware</code>,
7434: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7435: is deprecated because it does not crisply refer to a particular
7436: license text. Another problem with such usage is that it does not
7437: enable a user to tell pkgsrc to proceed for a single package
7438: without also telling pkgsrc to proceed for all packages with that
7439: tag.</p>
7440: <div class="sect3">
7441: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7442: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154 rodent 7443: <p>When adding a package with a new license, the following steps
7444: are required:</p>
7445: <div class="orderedlist"><ol class="orderedlist" type="1">
7446: <li class="listitem">
1.284 rillig 7447: <p>Check whether the license qualifies as Free or Open Source by
7448: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7449: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222 sevan 7450: Open Source Initiative</a>. If this is the case, the filename in
7451: <code class="filename">pkgsrc/licenses/</code> does not need the
7452: <code class="filename">-license</code> suffix, and the license name should be
7453: added to:</p>
1.154 rodent 7454: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7455: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7456: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7457: <li class="listitem"><p>default_acceptable_licenses in
7458: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154 rodent 7459: </ul></div>
7460: </li>
1.284 rillig 7461: <li class="listitem"><p>The license text should be added to
7462: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7463: licenses can be seen in this directory.</p></li>
1.154 rodent 7464: </ol></div>
1.222 sevan 7465: </div>
7466: <div class="sect3">
7467: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7468: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98 wiz 7469: <p>When the license changes (in a way other than formatting),
1.222 sevan 7470: make sure that the new license has a different name (e.g.,
1.98 wiz 7471: append the version number if it exists, or the date). Just
7472: because a user told pkgsrc to build programs under a previous
7473: version of a license does not mean that pkgsrc should build
1.99 rillig 7474: programs under the new licenses. The higher-level point is that
1.98 wiz 7475: pkgsrc does not evaluate licenses for reasonableness; the only
7476: test is a mechanistic test of whether a particular text has been
1.222 sevan 7477: approved by either of two bodies (FSF or OSI).</p>
7478: </div>
1.75 rillig 7479: </div>
1.148 asau 7480: <div class="sect2">
1.75 rillig 7481: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7482: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75 rillig 7483: <p>Some licenses restrict how software may be re-distributed.
1.222 sevan 7484: By declaring the restrictions, package tools can
1.98 wiz 7485: automatically refrain from e.g. placing binary packages on FTP
7486: sites.</p>
1.222 sevan 7487: <p>There are four possible restrictions, which are
1.98 wiz 7488: the cross product of sources (distfiles) and binaries not being
7489: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7490: language in any license, and because non-Free licenses tend to be
7491: different from each other, pkgsrc adopts a definition of FTP and
1.222 sevan 7492: CD-ROM.
7493:
7494: "FTP" means making the source or binary file available over the
7495: Internet at no charge.
7496:
7497: "CD-ROM" means making the source or binary available on some kind of
7498: media, together with other source and binary packages, which is sold
7499: for a distribution charge.
1.98 wiz 7500: </p>
7501: <p>In order to encode these restrictions, the package system
1.87 wiz 7502: defines five make variables that can be set to note these
7503: restrictions:</p>
1.148 asau 7504: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7505: <li class="listitem">
1.75 rillig 7506: <p><code class="varname">RESTRICTED</code></p>
7507: <p>This variable should be set whenever a restriction
1.87 wiz 7508: exists (regardless of its kind). Set this variable to a
1.98 wiz 7509: string containing the reason for the restriction. It should
7510: be understood that those wanting to understand the restriction
7511: will have to read the license, and perhaps seek advice of
7512: counsel.</p>
1.75 rillig 7513: </li>
1.128 wiz 7514: <li class="listitem">
1.75 rillig 7515: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7516: <p>Binaries may not be placed on CD-ROM containing other
7517: binary packages, for which a distribution charge may be made.
7518: In this case, set this variable to
7519: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7520: </li>
1.128 wiz 7521: <li class="listitem">
1.75 rillig 7522: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7523: <p>Binaries may not made available on the Internet without
7524: charge. In this case, set this variable to
7525: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7526: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7527: </li>
1.128 wiz 7528: <li class="listitem">
1.75 rillig 7529: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7530: <p>Distfiles may not be placed on CD-ROM, together with
7531: other distfiles, for which a fee may be charged. In this
7532: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7533: </p>
1.75 rillig 7534: </li>
1.128 wiz 7535: <li class="listitem">
1.75 rillig 7536: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7537: <p>Distfiles may not made available via FTP at no charge.
7538: In this case, set this variable to
7539: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7540: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7541: </li>
7542: </ul></div>
1.222 sevan 7543: <p>Please note that packages will be removed from pkgsrc when the
7544: distfiles are not distributable and cannot be obtained for a period
7545: of one full quarter branch. Packages with manual/interactive fetch
7546: must have a maintainer and it is his/her responsibility to ensure
7547: this.</p>
1.75 rillig 7548: </div>
1.148 asau 7549: <div class="sect2">
1.75 rillig 7550: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7551: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290 gutterid 7552: <p>Your package may depend on some other package being present,
7553: and there are various ways of expressing this dependency.
7554: pkgsrc supports the <code class="varname">DEPENDS</code>,
7555: <code class="varname">BUILD_DEPENDS</code>,
7556: <code class="varname">TOOL_DEPENDS</code>, and
7557: <code class="varname">TEST_DEPENDS</code> definitions, the
1.88 wiz 7558: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7559: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7560: to handle dependencies, and which uses the variables named above.
1.299 rillig 7561: See <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a> for more information.</p>
1.290 gutterid 7562: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7563: definition registers that pre-requisite in the binary package so it
7564: will be pulled in when the binary package is later installed, whilst
7565: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7566: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7567: dependency that is only needed for building or testing the resulting
1.299 rillig 7568: package. See also <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> for more information.</p>
1.75 rillig 7569: <p>This means that if you only need a package present whilst
1.290 gutterid 7570: you are building or testing, it should be noted as a
7571: <code class="varname">TOOL_DEPENDS</code>,
7572: <code class="varname">BUILD_DEPENDS</code>, or
7573: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.269 leot 7574: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7575: packages, i.e. packages for the architecture where the package
7576: is built;
7577: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290 gutterid 7578: packages, i.e., packages for the architecture for which the package
1.269 leot 7579: is built.</p>
1.290 gutterid 7580: <p>The format for a <code class="varname">DEPENDS</code>,
7581: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7582: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75 rillig 7583: <pre class="programlisting">
1.100 rillig 7584: <pre-req-package-name>:../../<category>/<pre-req-package>
1.222 sevan 7585: </pre>
1.128 wiz 7586: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7587: may include any of the wildcard version numbers recognized by
1.311 leot 7588: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128 wiz 7589: <div class="orderedlist"><ol class="orderedlist" type="1">
7590: <li class="listitem">
1.75 rillig 7591: <p>If your package needs another package's binaries or
1.160 wiz 7592: libraries to build and run, and if that package has a
1.87 wiz 7593: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7594: <pre class="programlisting">
1.100 rillig 7595: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7596: </pre>
1.75 rillig 7597: </li>
1.128 wiz 7598: <li class="listitem">
1.160 wiz 7599: <p>If your package needs another package's binaries or
7600: libraries only for building, and if that package has a
7601: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7602: <pre class="programlisting">
7603: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7604: </pre>
1.160 wiz 7605: <p>but set
7606: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7607: to make it a build dependency only. This case is rather
7608: rare.</p>
7609: </li>
7610: <li class="listitem">
1.132 spz 7611: <p>If your package needs binaries from another package to build,
1.269 leot 7612: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75 rillig 7613: <pre class="programlisting">
1.269 leot 7614: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222 sevan 7615: </pre>
1.75 rillig 7616: </li>
1.269 leot 7617: <li class="listitem"><p>If your package needs static libraries to link against, header
7618: files to include, etc. from another package to build,
7619: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132 spz 7620: <li class="listitem"><p>If your package needs a library with which to link and
7621: there is no <code class="filename">buildlink3.mk</code> file
7622: available, create one. Using
7623: <code class="varname">DEPENDS</code> won't be sufficient because the
7624: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7625: <li class="listitem">
1.132 spz 7626: <p>If your package needs some executable to be able to run
7627: correctly and if there's no
7628: <code class="filename">buildlink3.mk</code> file, this is specified
7629: using the <code class="varname">DEPENDS</code> variable. The
1.250 leot 7630: <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.242 wiz 7631: be able to execute the latex binary from the tex-latex-bin package
1.132 spz 7632: when it runs, and that is specified:</p>
1.75 rillig 7633: <pre class="programlisting">
1.242 wiz 7634: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222 sevan 7635: </pre>
1.132 spz 7636: </li>
1.290 gutterid 7637: <li class="listitem"><p>If your package includes a test suite that has extra
7638: dependencies only required for this purpose (frequently this
7639: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7640: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132 spz 7641: <li class="listitem">
7642: <p>You can use wildcards in package dependencies. Note that
7643: such wildcard dependencies are retained when creating binary
7644: packages. The dependency is checked when installing the binary
7645: package and any package which matches the pattern will be
7646: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7647: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7648: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7649: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7650: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7651: <p>Wildcards can also be used to specify that a package
1.87 wiz 7652: will only build against a certain minimum version of a
7653: pre-requisite:</p>
1.75 rillig 7654: <pre class="programlisting">
1.132 spz 7655: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.222 sevan 7656: </pre>
1.132 spz 7657: <p>This means that the package will build using version 6.0
7658: of ImageMagick or newer. Such a dependency may be warranted
7659: if, for example, the command line options of an executable
7660: have changed.</p>
7661: <p>If you need to depend on minimum versions of libraries,
1.298 wiz 7662: set
7663: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7664: to the appropriate pattern before including its
7665: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7666: <pre class="programlisting">
7667: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7668: .include "../../graphics/jpeg/buildlink3.mk"
7669: </pre>
1.75 rillig 7670: <p>For security fixes, please update the package
1.267 rillig 7671: vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, “Handling packages with security problems”</a> for more
1.87 wiz 7672: information.</p>
1.75 rillig 7673: </li>
7674: </ol></div>
7675: <p>If your package needs files from another package to build,
1.87 wiz 7676: add the relevant distribution files to
7677: <code class="varname">DISTFILES</code>, so they will be extracted
1.250 leot 7678: 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.87 wiz 7679: (It relies on the jpeg sources being present in source form
7680: during the build.)</p>
1.75 rillig 7681: </div>
1.148 asau 7682: <div class="sect2">
1.75 rillig 7683: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7684: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7685: <p>Your package may conflict with other packages a user might
1.87 wiz 7686: already have installed on his system, e.g. if your package
1.88 wiz 7687: installs the same set of files as another package in the pkgsrc
1.190 wiz 7688: tree or has the same <code class="varname">PKGNAME</code>.</p>
1.255 leot 7689: <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>
7690: 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>
7691: install the same shared library, thus you set in
7692: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7693: <pre class="programlisting">
7694: CONFLICTS= Xaw-Xpm-[0-9]*
7695: </pre>
7696: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7697: <pre class="programlisting">
7698: CONFLICTS= libXaw3d-[0-9]*
7699: </pre>
1.311 leot 7700: <p><a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255 leot 7701: that conflict with existing packages and abort. However, in many
7702: situations this is too late in the process. Binary package managers
7703: will not know about the conflict until they attempt to install the
7704: package after already downloading it and all its dependencies.
7705: Users may also waste time building a package and its dependencies
7706: only to find out at the end that it conflicts with another package
7707: they have installed.</p>
7708: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7709: should be added in all cases where it is known that packages conflict
7710: with each other. These <code class="varname">CONFLICTS</code> entries are
1.311 leot 7711: exported in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255 leot 7712: managers to inform users that packages cannot be installed onto
7713: the target system.</p>
1.75 rillig 7714: </div>
1.148 asau 7715: <div class="sect2">
1.75 rillig 7716: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7717: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7718: <p>There are several reasons why a package might be
1.88 wiz 7719: instructed to not build under certain circumstances. If the
1.87 wiz 7720: package builds and runs on most platforms, the exceptions
1.193 dholland 7721: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7722: the package builds and runs on a small handful of platforms,
7723: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7724: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7725: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7726: (OS-version-platform) that can use glob-style
7727: wildcards.</p>
7728: <p>If a package is not appropriate for some platforms (as
1.225 maya 7729: opposed to merely broken), a different set of variables should be
1.193 dholland 7730: used as this affects failure reporting and statistics.
7731: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7732: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 dholland 7733: the package is appropriate for only a small handful of platforms
7734: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7735: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7736: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7737: (OS-version-platform) that can use glob-style
7738: wildcards.</p>
1.88 wiz 7739: <p>Some packages are tightly bound to a specific version of an
1.250 leot 7740: 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.88 wiz 7741: backwards compatible with other versions of the OS, and should be
7742: uploaded to a version specific directory on the FTP server. Mark
7743: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7744: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7745: the package system internals, but may be used in the
7746: future.</p>
1.75 rillig 7747: <p>If the package should be skipped (for example, because it
1.87 wiz 7748: provides functionality already provided by the system), set
1.88 wiz 7749: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7750: the package should fail because some preconditions are not met,
7751: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7752: message.</p>
1.75 rillig 7753: </div>
1.148 asau 7754: <div class="sect2">
1.75 rillig 7755: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7756: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7757: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7758: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7759: be set in the package Makefile. This will be carried into any
7760: binary package that is made from this pkgsrc entry. A
1.128 wiz 7761: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.311 leot 7762: not be deleted using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128 wiz 7763: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7764: </div>
1.148 asau 7765: <div class="sect2">
1.75 rillig 7766: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7767: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7768: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7769: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138 wiz 7770: and after committing that file, ask pkgsrc-security@NetBSD.org to
7771: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7772: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7773: <code class="varname">PKGREVISION</code> should be increased (this is of
7774: course not necessary if the problem is fixed by using a newer
7775: release of the software), and the pattern in the
7776: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7777: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7778: branch, be sure to submit a pullup request!</p>
1.75 rillig 7779: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7780: semi-automatically by a weekly cron job.</p>
1.75 rillig 7781: </div>
1.148 asau 7782: <div class="sect2">
1.75 rillig 7783: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7784: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75 rillig 7785: <p>When making fixes to an existing package it can be useful
1.87 wiz 7786: to change the version number in <code class="varname">PKGNAME</code>. To
7787: avoid conflicting with future versions by the original author, a
1.128 wiz 7788: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.87 wiz 7789: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7790: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7791: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7792: <pre class="programlisting">
1.100 rillig 7793: DISTNAME= foo-17.42
7794: PKGREVISION= 9
1.222 sevan 7795: </pre>
1.75 rillig 7796: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7797: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7798: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7799: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7800: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7801: <p>When a new release of the package is released, the
1.87 wiz 7802: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7803: minor release of the above package, things should be like:</p>
1.75 rillig 7804: <pre class="programlisting">
1.100 rillig 7805: DISTNAME= foo-17.43
1.222 sevan 7806: </pre>
1.87 wiz 7807: <p><code class="varname">PKGREVISION</code> should be incremented for any
7808: non-trivial change in the resulting binary package. Without a
7809: <code class="varname">PKGREVISION</code> bump, someone with the previous
7810: version installed has no way of knowing that their package is out
7811: of date. Thus, changes without increasing
7812: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7813: trivial that no reasonable person would want to upgrade", and this
7814: is the rough test for when increasing
7815: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7816: changes that do not merit increasing
7817: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 7818: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7819: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284 rillig 7820: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7821: comments in Makefile.</p></li>
7822: <li class="listitem"><p>Changing build variables if the resulting binary
7823: package is the same.</p></li>
7824: <li class="listitem"><p>Changing
7825: <code class="filename">DESCR</code>.</p></li>
7826: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7827: default options don't change.</p></li>
1.100 rillig 7828: </ul></div>
1.87 wiz 7829: <p>Examples of changes that do merit an increase to
7830: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 7831: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7832: <li class="listitem"><p>Security fixes</p></li>
7833: <li class="listitem"><p>Changes or additions to a patch
7834: file</p></li>
7835: <li class="listitem"><p>Changes to the
7836: <code class="filename">PLIST</code></p></li>
7837: <li class="listitem"><p>A dependency is changed or
7838: renamed.</p></li>
1.100 rillig 7839: </ul></div>
1.78 rillig 7840: <p>PKGREVISION must also be incremented when dependencies have ABI
7841: changes.</p>
1.75 rillig 7842: </div>
1.148 asau 7843: <div class="sect2">
1.79 rillig 7844: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7845: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.295 rillig 7846: <p>When you want to replace the same text in multiple files, or
7847: multiple times in the same file, it is cumbersome to maintain a patch
7848: file for this. This is where the SUBST framework steps in. It provides an
7849: easy-to-use interface for replacing text in files. It just needs the
7850: following information:</p>
7851: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7852: <li class="listitem"><p>In which phase of the package build cycle should the
7853: replacement happen?</p></li>
7854: <li class="listitem"><p>In which files should the replacement
1.287 rillig 7855: happen?</p></li>
1.295 rillig 7856: <li class="listitem"><p>Which text should be replaced with
7857: what?</p></li>
1.287 rillig 7858: </ul></div>
7859: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295 rillig 7860: variables. A minimal example is:</p>
7861: <pre class="programlisting">
7862: SUBST_CLASSES+= paths
7863: SUBST_STAGE.paths= pre-configure
7864: SUBST_FILES.paths= src/*.c
7865: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
7866: </pre>
7867: <p>Translated into English, it means: In the pre-configure stage (that
7868: is, after applying the patches from the patches/ directory and before
7869: running the configure script and the portability check), replace the text
7870: <code class="literal">/usr/local</code> with the content of the variable
7871: <code class="varname">PREFIX</code>.</p>
7872: <p>Each SUBST block starts by appending an identifier to
7873: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
7874: identifier can be chosen freely by the package. If there should ever be
7875: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
7876: early, so don't worry about name collisions.</p>
7877: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
7878: SUBST block are parameterized using this identifier. In the remainder of
7879: this section, these parameterized variables are written as
7880: <code class="varname">SUBST_STAGE.*</code>.</p>
7881: <pre class="programlisting">
7882: SUBST_CLASSES+= paths
7883: SUBST_STAGE.paths= pre-configure
7884: SUBST_MESSAGE.paths= Fixing absolute paths.
7885: SUBST_FILES.paths= src/*.c
7886: SUBST_FILES.paths+= scripts/*.sh
7887: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
7888: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
7889: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
7890: </pre>
7891: <p>To get a complete picture about the SUBST substitutions, run
7892: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
7893: expected, run pkglint on the package, which detects several typical
7894: mistakes surrounding the SUBST blocks. For any questions that might
7895: remain after this, have a look at
7896: <code class="filename">mk/subst.mk</code>.</p>
7897: <div class="sect3">
7898: <div class="titlepage"><div><div><h4 class="title">
7899: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
7900: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
7901: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
7902: <code class="literal">pre-configure</code> is used most often, by far. The most
7903: popular stages are, in chronological order:</p>
7904: <div class="variablelist"><dl class="variablelist">
7905: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
7906: <dd>
7907: <p>The substitutions are applied immediately after the
7908: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
7909: package will leave no traces of the original files.</p>
7910: <p>When the substitution applies to files for which there is also a
7911: patch in the <code class="filename">patches/</code> directory, this means that the
7912: patches will be computed based on the result of the substitution. When
7913: these patches are sent to the upstream maintainer later, to be fixed in
7914: the upstream package, these patches may no longer match what the upstream
7915: author is used to. Because of this, <code class="literal">pre-configure</code> is
7916: often a better choice.</p>
7917: </dd>
7918: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
7919: <dd>
7920: <p>The substitutions are applied after the patches from the
7921: <code class="filename">patches/</code> directory. This makes it possible to run
7922: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
7923: 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>
7924: <p>When updating the patches, it is helpful to explicitly separate the
7925: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
7926: configure</strong></span>, and to only edit the patches between these commands.
7927: Otherwise the substitutions from the SUBST block will end up in the patch
7928: file. When this happens in really obvious ways, pkglint will complain
7929: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
7930: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
7931: can only detect these really obvious
7932: cases.</p>
7933: </dd>
7934: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
7935: <dd><p>This stage should only be used if the package defines a
7936: <code class="literal">pre-configure</code> action itself, and the substitution must
7937: happen after that. Typical examples are packages that use the
7938: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
7939: script from
7940: <code class="filename">configure.ac</code>.</p></dd>
7941: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
7942: <dd><p>This stage is used to fix up any mistakes by the
7943: configure stage.</p></dd>
7944: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
7945: <dd><p>This stage should only be used for substitutions that are
7946: clearly related to building the package, not for fixing the
7947: configuration. Substitutions for pathnames (such as replacing
7948: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
7949: user names (such as replacing <code class="literal">@MY_USER@</code> with the
7950: actual username) belong in pre-configure or post-configure
7951: instead.</p></dd>
7952: <dt><span class="term"><code class="literal">post-build</code></span></dt>
7953: <dd>
7954: <p>Just as with pre-build, this stage should only be used
7955: for substitutions that are clearly related to building the package, not
7956: for fixing the configuration. Substitutions for pathnames (such as
7957: replacing <code class="filename">/usr/local</code> with
7958: <code class="literal">${PREFIX}</code>) or user names (such as replacing
7959: <code class="literal">@MY_USER@</code> with the actual username) belong in
7960: pre-configure or post-configure instead.</p>
7961: <p>A typical use is to update pkg-config files to include the rpath
7962: compiler options.</p>
7963: </dd>
7964: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
7965: <dd><p>In general, the install phase should be as simple as
7966: possible. As with the pre-build and post-build stages, it should not be
7967: used to fix pathnames or user names, these belong in pre-configure
7968: instead. There are only few legitimate use cases for applying
7969: substitutions in this stage.</p></dd>
7970: </dl></div>
7971: </div>
7972: <div class="sect3">
7973: <div class="titlepage"><div><div><h4 class="title">
1.296 rillig 7974: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295 rillig 7975: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
7976: filename patterns. These patterns are relative to
7977: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
7978: A typical example is:</p>
7979: <pre class="programlisting">
7980: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
7981: </pre>
7982: <p>The above patterns, especially the last, are quite broad. The SUBST
7983: implementation checks that each filename pattern that is mentioned here
7984: has an effect. For example, if none of the
7985: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
7986: and substituted, that filename pattern is redundant and should be left
1.296 rillig 7987: out. By default, the SUBST framework will complain with an error message.
7988: If the text to be substituted occurs in some of the files from a single
7989: pattern, but not in all of them, that is totally ok, and the SUBST
1.295 rillig 7990: framework will only print an INFO message for those files.</p>
7991: <p>If there is a good reason for having redundant filename patterns,
1.296 rillig 7992: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295 rillig 7993: <p>Another popular way of choosing the files for the substitutions is
7994: via a shell command, like this:</p>
7995: <pre class="programlisting">
1.296 rillig 7996: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.295 rillig 7997: SUBST_FILES.path= ${C_FILES_CMD:sh}
7998: </pre>
7999: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8000: freely chosen and independent of the SUBST framework.</p>
8001: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8002: lists each file individually. Thereby chances are higher that there are
8003: filename patterns in which no substitution happens. Since the SUBST
8004: framework cannot know whether the filename patterns in
8005: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8006: Makefile (where any redundant filename pattern would be suspicious) or
8007: been generated by a shell command (in which redundant filename patterns
8008: are more likely and to be expected), it will complain about these
8009: redundant filename patterns. Therefore, SUBST blocks that use a shell
8010: command to generate the list of filename patterns often need to set
8011: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8012: </div>
8013: <div class="sect3">
8014: <div class="titlepage"><div><div><h4 class="title">
8015: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8016: <p>In most cases, the substitutions are given using one or more
1.311 leot 8017: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.295 rillig 8018: <pre class="programlisting">
8019: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8020: </pre>
8021: <p>Each of the sed commands needs to be preceded by the
8022: <code class="literal">-e</code> option and should be specified on a line of its
8023: own, to avoid hiding short sed commands at the end of a line.</p>
8024: <p>Since the sed commands often contain shell metacharacters as the
8025: separator (the <code class="literal">|</code> in the above example), it is common
8026: to enclose them in single quotes.</p>
8027: <p>A common substitution is to replace placeholders of the form
8028: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8029: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8030: <pre class="programlisting">
8031: SUBST_VARS.path= PREFIX
8032: </pre>
8033: <p>This type of substitutions is typically done by the GNU configure
1.296 rillig 8034: scripts during the do-configure stage, but in some cases these need to be
8035: overridden. The same pattern is also used when a package defines patches
8036: that replace previously hard-coded paths like
8037: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8038: placeholder first, which then gets substituted by the actual
8039: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8040: cases, it works equally well to just use the SUBST framework to directly
8041: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8042: thereby omitting the intermediate patch file.</p>
1.295 rillig 8043: <p>If the above is not flexible enough, it is possible to not use sed
8044: at all for the substitution but to specify an entirely different command,
8045: like this:</p>
1.87 wiz 8046: <pre class="programlisting">
1.295 rillig 8047: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8048: </pre>
8049: <p>This is used for the few remaining packages in which the
8050: distributed files use Windows-style line endings that need to be
8051: converted to UNIX-style line endings.</p>
8052: </div>
8053: <div class="sect3">
8054: <div class="titlepage"><div><div><h4 class="title">
8055: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8056: <p>When a SUBST block is applied during a package build, a message is
8057: logged. The default message is fine for most purposes but can be
8058: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8059: message.</p>
8060: </div>
1.79 rillig 8061: </div>
1.75 rillig 8062: </div>
1.148 asau 8063: <div class="sect1">
1.75 rillig 8064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8065: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 8066: <div class="sect2">
1.75 rillig 8067: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8068: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75 rillig 8069: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8070: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8071: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8072: with the name of each file to download as an argument, expecting
8073: it to output the URL of the directory from which to download
1.250 leot 8074: 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.87 wiz 8075: example of this usage.</p>
1.75 rillig 8076: <p>If the download can't be automated, because the user must
1.87 wiz 8077: submit personal information to apply for a password, or must pay
8078: for the source, or whatever, you can set
8079: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8080: displayed to the user before aborting the build. Example:</p>
8081: <pre class="programlisting">
1.100 rillig 8082: FETCH_MESSAGE= "Please download the files"
8083: FETCH_MESSAGE+= " "${DISTFILES:Q}
8084: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222 sevan 8085: </pre>
1.75 rillig 8086: </div>
1.148 asau 8087: <div class="sect2">
1.75 rillig 8088: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8089: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75 rillig 8090: <p>Sometimes authors of a software package make some
1.87 wiz 8091: modifications after the software was released, and they put up a
8092: new distfile without changing the package's version number. If a
8093: package is already in pkgsrc at that time, the checksum will
8094: no longer match. The contents of the new distfile should be
8095: compared against the old one before changing anything, to make
8096: sure the distfile was really updated on purpose, and that
8097: no trojan horse or so crept in.
1.97 rillig 8098: Please mention that the distfiles were compared and what was found
1.159 rodent 8099: in your commit message.</p>
1.220 wiz 8100: <p>Then, the correct way to work around this is to set
8101: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8102: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8103: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8104: a variable prefix). All <code class="varname">DISTFILES</code> and
1.93 rillig 8105: <code class="varname">PATCHFILES</code> for this package will be put in that
1.267 rillig 8106: subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="21.1.10. How to handle incrementing versions when fixing an existing package">Section 21.1.10, “How to handle incrementing versions when fixing an existing package”</a> for more details.) In case this
1.87 wiz 8107: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220 wiz 8108: including the <code class="filename">nbX</code> suffix) or a date stamp can
8109: be appended, like
8110: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284 rillig 8111: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8112: name does not contain a version and the distfile is apt to change. In
8113: cases where the likelihood of this is very small,
8114: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8115: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8116: distfile name changes, even if a package is being moved or
8117: renamed.</p>
1.159 rodent 8118: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8119: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8120: path in the filenames.
1.159 rodent 8121: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8122: Furthermore, a mail to the package's authors seems appropriate
8123: telling them that changing distfiles after releases without
8124: changing the file names is not good practice.</p>
1.75 rillig 8125: </div>
1.199 tnn 8126: <div class="sect2">
8127: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8128: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284 rillig 8129: <p>Helper methods exist for packages hosted on github.com which
8130: will often have distfile names that clash with other packages, for
8131: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8132: from below:</p>
1.199 tnn 8133: <div class="sect3">
8134: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8135: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284 rillig 8136: <p>If your distfile URL looks similar to
1.303 bacon 8137: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284 rillig 8138: then you are packaging a tagged release.</p>
1.199 tnn 8139: <pre class="programlisting">
1.303 bacon 8140: DISTNAME= example-1.0
1.200 tnn 8141: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8142: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8143: GITHUB_TAG= v${PKGVERSION_NOREV}
1.199 tnn 8144: EXTRACT_SUFX= .zip
8145: </pre>
8146: </div>
8147: <div class="sect3">
8148: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8149: <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>
8150: <p>If your distfile looks similar to
8151: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8152: release, then set the package version to 0.0.0.N, where N is the number
8153: of commits to the repository, and set GITHUB_TAG to the commit hash.
8154: This will (almost) ensure that the first tagged release will have a
8155: version greater than this one so that package upgrades will function
8156: properly.</p>
8157: <pre class="programlisting">
8158: DISTNAME= example-0.0.0.347
8159: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8160: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8161: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8162: </pre>
8163: </div>
8164: <div class="sect3">
8165: <div class="titlepage"><div><div><h4 class="title">
8166: <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>
8167: <p>If your distfile looks similar to
8168: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8169: then include the last release version and the commit count since that
8170: release in the package version and set GITHUB_TAG to the commit hash.
8171: The latest release and commit count are shown in the output of
8172: "git describe --tags":
8173: </p>
8174: <pre class="screen">
8175: # git clone https://github.com/username/example
8176: # cd example
8177: # git describe --tags
8178: 1.2.3-5-g988881a
8179: </pre>
1.199 tnn 8180: <pre class="programlisting">
1.303 bacon 8181: DISTNAME= example-1.2.3.5
8182: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8183: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8184: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222 sevan 8185: </pre>
1.199 tnn 8186: </div>
8187: <div class="sect3">
8188: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8189: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284 rillig 8190: <p>If your distfile URL looks similar to
1.303 bacon 8191: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284 rillig 8192: then you are packaging a release.</p>
1.199 tnn 8193: <pre class="programlisting">
8194: DISTNAME= offensive-1.6
1.200 tnn 8195: PKGNAME= ${DISTNAME:S/offensive/proper/}
8196: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8197: GITHUB_PROJECT= example
1.200 tnn 8198: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8199: EXTRACT_SUFX= .zip
1.222 sevan 8200: </pre>
1.199 tnn 8201: </div>
8202: </div>
1.75 rillig 8203: </div>
1.148 asau 8204: <div class="sect1">
1.75 rillig 8205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8206: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 8207: <div class="sect2">
1.75 rillig 8208: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8209: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8210: <p>pkgsrc supports many different machines, with different
1.87 wiz 8211: object formats like a.out and ELF, and varying abilities to do
8212: shared library and dynamic loading at all. To accompany this,
8213: varying commands and options have to be passed to the
8214: compiler, linker, etc. to get the Right Thing, which can be
8215: pretty annoying especially if you don't have all the machines
8216: at your hand to test things. The
1.250 leot 8217: <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.128 wiz 8218: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8219: both static and dynamic libraries from a set of source files,
8220: thus being platform-independent.</p>
8221: <p>Here's how to use libtool in a package in seven simple
8222: steps:</p>
1.128 wiz 8223: <div class="orderedlist"><ol class="orderedlist" type="1">
8224: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8225: Makefile.</p></li>
1.128 wiz 8226: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8227: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8228: add it to the definition of <code class="varname">CC</code>, if only
8229: libraries are being built in a given Makefile. This one command
8230: will build both PIC and non-PIC library objects, so you need not
8231: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8232: <li class="listitem">
1.75 rillig 8233: <p>For the linking of the library, remove any
1.128 wiz 8234: <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
8235: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8236: <pre class="programlisting">
1.100 rillig 8237: ${LIBTOOL} --mode=link \
8238: ${CC} -o ${.TARGET:.a=.la} \
8239: ${OBJS:.o=.lo} \
8240: -rpath ${PREFIX}/lib \
8241: -version-info major:minor
1.222 sevan 8242: </pre>
1.75 rillig 8243: <p>Note that the library is changed to have a
1.87 wiz 8244: <code class="filename">.la</code> extension, and the objects are
8245: changed to have a <code class="filename">.lo</code>
8246: extension. Change <code class="varname">OBJS</code> as
8247: necessary. This automatically creates all of the
8248: <code class="filename">.a</code>,
8249: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8250: necessary) in the build directory. Be sure to include
1.128 wiz 8251: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8252: minor are zero, as libtool will otherwise strip off the
8253: shared library version.</p>
1.75 rillig 8254: <p>From the libtool manual:</p>
8255: <pre class="programlisting">
1.100 rillig 8256: So, libtool library versions are described by three integers:
1.69 rillig 8257:
1.100 rillig 8258: CURRENT
8259: The most recent interface number that this library implements.
1.69 rillig 8260:
1.100 rillig 8261: REVISION
8262: The implementation number of the CURRENT interface.
1.69 rillig 8263:
1.100 rillig 8264: AGE
8265: The difference between the newest and oldest interfaces that
8266: this library implements. In other words, the library implements
8267: all the interface numbers in the range from number `CURRENT -
8268: AGE' to `CURRENT'.
1.1 grant 8269:
1.100 rillig 8270: If two libraries have identical CURRENT and AGE numbers, then the
8271: dynamic linker chooses the library with the greater REVISION number.
1.222 sevan 8272: </pre>
1.128 wiz 8273: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8274: different results for a.out and ELF (excluding symlinks)
8275: in only one case. An ELF library of the form
1.128 wiz 8276: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87 wiz 8277: will have a symlink of
1.128 wiz 8278: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87 wiz 8279: on an a.out platform. This is handled
8280: automatically.</p>
1.128 wiz 8281: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8282: directory of the library being built.</p>
1.76 rillig 8283: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8284: <code class="filename">.la</code> file, the other files will be
8285: added automatically.</p>
1.75 rillig 8286: </li>
1.128 wiz 8287: <li class="listitem">
1.76 rillig 8288: <p>When linking shared object (<code class="filename">.so</code>)
1.311 leot 8289: files, i.e. files that are loaded via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128 wiz 8290: shared libraries, use <span class="quote">“<span class="quote">-module
8291: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8292: tacked on.</p>
1.76 rillig 8293: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8294: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8295: </li>
1.128 wiz 8296: <li class="listitem">
1.75 rillig 8297: <p>When linking programs that depend on these libraries
1.87 wiz 8298: <span class="emphasis"><em>before</em></span> they are installed, preface
1.311 leot 8299: the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/ld.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 8300: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8301: libraries (static or shared), but please be aware that
8302: libtool will not allow you to specify a relative path in
1.128 wiz 8303: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8304: expects you to change that argument to be the
8305: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8306: <pre class="programlisting">
1.100 rillig 8307: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222 sevan 8308: </pre>
1.75 rillig 8309: <p>should be changed to:</p>
8310: <pre class="programlisting">
1.100 rillig 8311: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222 sevan 8312: </pre>
1.75 rillig 8313: <p>and it will do the right thing with the libraries.</p>
8314: </li>
1.128 wiz 8315: <li class="listitem">
1.311 leot 8316: <p>When installing libraries, preface the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8317: or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/cp.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 8318: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8319: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8320: <pre class="programlisting">
1.126 jakllsch 8321: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222 sevan 8322: </pre>
1.76 rillig 8323: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8324: shared library, any needed symlinks, and run
1.311 leot 8325: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75 rillig 8326: </li>
1.128 wiz 8327: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8328: the <code class="filename">.la</code>
8329: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8330: </ol></div>
8331: </div>
1.148 asau 8332: <div class="sect2">
1.75 rillig 8333: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8334: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8335: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8336: package Makefile. This will override the package's own libtool
8337: in most cases. For older libtool using packages, libtool is
8338: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8339: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8340: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8341: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8342: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8343: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8344: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8345: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8346: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8347: libraries built and installed, then use
8348: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8349: <p>If your package makes use of the platform-independent library
1.87 wiz 8350: for loading dynamic shared objects, that comes with libtool
8351: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8352: <p>Some packages use libtool incorrectly so that the package
8353: may not work or build in some circumstances. Some of the more
8354: common errors are:</p>
1.148 asau 8355: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8356: <li class="listitem">
1.75 rillig 8357: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8358: executable or library. This in itself isn't a problem if one of two things
8359: has been done:</p>
1.128 wiz 8360: <div class="orderedlist"><ol class="orderedlist" type="1">
8361: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8362: <code class="filename">libfoo.la</code>, not
8363: <code class="filename">foo.la</code></p></li>
1.128 wiz 8364: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8365: </ol></div>
8366: </li>
1.128 wiz 8367: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8368: The function lt_dlinit() should be called and the macro
8369: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8370: executables.</p></li>
1.75 rillig 8371: </ul></div>
8372: </div>
1.148 asau 8373: <div class="sect2">
1.75 rillig 8374: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8375: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8376: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8377: to regenerate the configure script and Makefile.in makefile
8378: templates, then they should be executed in a pre-configure
8379: target.</p>
1.75 rillig 8380: <p>For packages that need only autoconf:</p>
8381: <pre class="programlisting">
1.100 rillig 8382: AUTOCONF_REQD= 2.50 # if default version is not good enough
8383: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8384: ...
1.1 grant 8385:
1.100 rillig 8386: pre-configure:
8387: cd ${WRKSRC} && autoconf
1.1 grant 8388:
1.100 rillig 8389: ...
1.222 sevan 8390: </pre>
1.75 rillig 8391: <p>and for packages that need automake and autoconf:</p>
8392: <pre class="programlisting">
1.100 rillig 8393: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8394: USE_TOOLS+= automake # use "automake14" for automake-1.4
8395: ...
8396:
8397: pre-configure:
8398: set -e; cd ${WRKSRC}; \
8399: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8400:
1.100 rillig 8401: ...
1.222 sevan 8402: </pre>
1.75 rillig 8403: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8404: require GNU Make.</p>
1.75 rillig 8405: <p>There are times when the configure process makes
1.87 wiz 8406: additional changes to the generated files, which then causes
8407: the build process to try to re-execute the automake sequence.
8408: This is prevented by touching various files in the configure
8409: stage. If this causes problems with your package you can set
8410: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8411: Makefile.</p>
1.75 rillig 8412: </div>
8413: </div>
1.148 asau 8414: <div class="sect1">
1.75 rillig 8415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8416: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148 asau 8417: <div class="sect2">
1.87 wiz 8418: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8419: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8420: <p>Compilers for the C, C++, and Fortran languages comes with
8421: the NetBSD base system. By default, pkgsrc assumes that a package
8422: is written in C and will hide all other compilers (via the wrapper
1.299 rillig 8423: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8424: <p>To declare which language's compiler a package needs, set
8425: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 8426: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8427: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8428: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8429: written in C++, usually need a C compiler for the configure
8430: phase.</p>
8431: </div>
1.148 asau 8432: <div class="sect2">
1.87 wiz 8433: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8434: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87 wiz 8435: <p>If a program is written in Java, use the Java framework in
8436: pkgsrc. The package must include
8437: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8438: provides the following variables:</p>
1.148 asau 8439: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8440: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8441: dependency on the JDK is added. If
1.128 wiz 8442: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8443: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8444: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8445: JDK.</p></li>
1.128 wiz 8446: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8447: a package needs a Java2 implementation. The supported values
1.128 wiz 8448: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8449: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8450: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8451: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8452: above. This variable is not set by default.</p></li>
1.130 wiz 8453: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8454: automatically set to the runtime location of the used Java
8455: implementation dependency. It may be used to set
8456: <code class="varname">JAVA_HOME</code> to a good value if the program
8457: needs this variable to be defined.
8458: </p></li>
1.87 wiz 8459: </ul></div>
8460: </div>
1.148 asau 8461: <div class="sect2">
1.87 wiz 8462: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8463: <a name="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8464: <p>If your package contains interpreted perl scripts, add
1.128 wiz 8465: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8466: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8467: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8468: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8469: that you want adjusted. Every occurrence of
8470: <code class="filename">*/bin/perl</code> in a she-bang line will be
8471: replaced with the full path to the perl executable.</p>
1.87 wiz 8472: <p>If a particular version of perl is needed, set the
8473: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8474: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.267 rillig 8475: <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.87 wiz 8476: about handling perl modules.</p>
8477: </div>
1.148 asau 8478: <div class="sect2">
1.87 wiz 8479: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8480: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.147 wiz 8481: <p><code class="varname">REPLACE_SH</code>,
8482: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8483: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.309 gutterid 8484: hash bangs in files. Please use the appropriate one, preferring
1.147 wiz 8485: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183 wiz 8486: Each should contain a list of scripts, relative to
8487: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8488: occurrence of the matching shell in a she-bang line will be
8489: replaced with the full path to the shell executable.
1.147 wiz 8490: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8491: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8492: </div>
1.148 asau 8493: <div class="sect2">
1.147 wiz 8494: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8495: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.87 wiz 8496: <p>Currently, there is no special handling for other languages
8497: in pkgsrc. If a compiler package provides a
8498: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8499: just add a (build) dependency on the appropriate compiler
8500: package.</p>
8501: </div>
8502: </div>
1.148 asau 8503: <div class="sect1">
1.87 wiz 8504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8505: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8506: <p>The most common failures when building a package are that
8507: some platforms do not provide certain header files, functions or
8508: libraries, or they provide the functions in a library that the
8509: original package author didn't know. To work around this, you
8510: can rewrite the source code in most cases so that it does not
8511: use the missing functions or provides a replacement function.</p>
1.148 asau 8512: <div class="sect2">
1.77 rillig 8513: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8514: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8515: <p>If a package already comes with a GNU configure script, the
8516: preferred way to fix the build failure is to change the
8517: configure script, not the code. In the other cases, you can
8518: utilize the C preprocessor, which defines certain macros
8519: depending on the operating system and hardware architecture it
8520: compiles for. These macros can be queried using for example
8521: <code class="varname">#if defined(__i386)</code>. Almost every operating
8522: system, hardware architecture and compiler has its own macro.
8523: For example, if the macros <code class="varname">__GNUC__</code>,
8524: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8525: are all defined, you know that you are using NetBSD on an i386
8526: compatible CPU, and your compiler is GCC.</p>
8527: <p>The list of the following macros for hardware and
8528: operating system depends on the compiler that is used. For
8529: example, if you want to conditionally compile code on Solaris,
8530: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8531: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8532: <div class="sect3">
1.75 rillig 8533: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8534: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75 rillig 8535: <p>To distinguish between 4.4 BSD-derived systems and the
8536: rest of the world, you should use the following code.</p>
8537: <pre class="programlisting">
1.100 rillig 8538: #include <sys/param.h>
8539: #if (defined(BSD) && BSD >= 199306)
8540: /* BSD-specific code goes here */
8541: #else
8542: /* non-BSD-specific code goes here */
8543: #endif
1.75 rillig 8544: </pre>
1.77 rillig 8545: <p>If this distinction is not fine enough, you can also test
8546: for the following macros.</p>
1.75 rillig 8547: <pre class="programlisting">
1.151 obache 8548: Cygwin __CYGWIN__
8549: DragonFly __DragonFly__
1.100 rillig 8550: FreeBSD __FreeBSD__
1.151 obache 8551: Haiku __HAIKU__
1.100 rillig 8552: Interix __INTERIX
8553: IRIX __sgi (TODO: get a definite source for this)
8554: Linux linux, __linux, __linux__
1.193 dholland 8555: Mac OS X __APPLE__
1.151 obache 8556: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8557: Minix3 __minix
1.100 rillig 8558: NetBSD __NetBSD__
8559: OpenBSD __OpenBSD__
8560: Solaris sun, __sun
1.75 rillig 8561: </pre>
8562: </div>
1.148 asau 8563: <div class="sect3">
1.75 rillig 8564: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8565: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75 rillig 8566: <pre class="programlisting">
1.100 rillig 8567: i386 i386, __i386, __i386__
8568: MIPS __mips
8569: SPARC sparc, __sparc
1.75 rillig 8570: </pre>
8571: </div>
1.148 asau 8572: <div class="sect3">
1.75 rillig 8573: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8574: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75 rillig 8575: <pre class="programlisting">
1.100 rillig 8576: GCC __GNUC__ (major version), __GNUC_MINOR__
8577: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8578: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8579: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8580: </pre>
8581: </div>
8582: </div>
1.148 asau 8583: <div class="sect2">
1.78 rillig 8584: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8585: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8586: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8587: combinations of compiler version and architecture and almost
8588: always relation to optimisation being enabled. Common symptoms
8589: are gcc internal errors or never finishing compiling a
1.78 rillig 8590: file.</p>
8591: <p>Typically, a workaround involves testing the
8592: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8593: optimisation for that combination of file,
1.198 tnn 8594: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8595: <p>This used to be a big problem in the past, but is rarely
8596: needed now as compiler technology has matured. If you still need
8597: to add a compiler specific workaround, please do so in the file
8598: <code class="filename">hacks.mk</code> and describe the symptom and
8599: compiler version as detailed as possible.</p>
1.78 rillig 8600: </div>
1.148 asau 8601: <div class="sect2">
1.78 rillig 8602: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 8603: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8604: <p>Compilation sometimes fails with an error message like this:</p>
8605: <pre class="programlisting">
8606: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8607: fatal error: pango/pango.h: No such file or directory
8608: </pre>
8609: <p>The proper way to fix this problem depends on the type of the
8610: header, which is described in the following sections.</p>
8611: <div class="sect3">
8612: <div class="titlepage"><div><div><h4 class="title">
8613: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8614: <p>If the header name looks like it comes from a different package,
8615: that other package should be included via the buildlink3
8616: framework.</p>
8617: <p>First, look whether the header is somewhere in the buildlink3
8618: directory below <code class="varname">WRKDIR</code>. In the above case of
8619: the missing Pango header:</p>
8620: <pre class="programlisting">
8621: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8622: </pre>
8623: <p>In the case of Pango, the output is:</p>
8624: <pre class="programlisting">
8625: work/.buildlink/include/pango-1.0/pango/pango.h
8626: </pre>
8627: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8628: in the <code class="filename">.buildlink</code> directory, it would have been
8629: found automatically. There is an extra <code class="filename">pango-1.0</code>
8630: path component though, which means that the compiler command line must
8631: contain an option of the form
8632: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8633: most cases this option is generated by the configure script, which can be examined using:</p>
8634: <pre class="programlisting">
8635: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8636: -I/usr/pkg/include/pango-1.0
8637: -I/usr/pkg/include/pango-1.0
8638: -I/usr/pkg/include/pango-1.0
8639: -I/usr/pkg/include/pango-1.0
8640: -I/usr/pkg/include/pango-1.0
8641: </pre>
8642: <p>This looks good. These options are transformed by the buildlink
8643: wrapper to refer to the correct path inside
8644: <code class="filename">work/.buildlink</code>.</p>
8645: <p>Since the compilation fails though, examine the compiler command
8646: lines in <code class="filename">work/.work.log</code> to see whether the
8647: <code class="literal">-I</code> option is included in the particular command
8648: line.</p>
8649: <p>To further analyze the situation, run <span class="command"><strong>bmake
8650: build-env</strong></span>, which sets up an interactive, realistic environment
8651: including all the pkgsrc wrapper commands and environment variables. From
8652: there, try to compile some simple example programs that use the
8653: header.</p>
8654: </div>
8655: <div class="sect3">
8656: <div class="titlepage"><div><div><h4 class="title">
8657: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8658: <p>If the name of the header seems to come from the package itself,
8659: and if the build is run with parallel jobs, the package may have some
8660: undeclared dependencies between the <code class="filename">.c</code> and the
8661: <code class="filename">.h</code> files, and a C file is compiled before its
8662: required header is generated.</p>
8663: <p>To see whether the build runs with parallel jobs, run
8664: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8665: like this:</p>
8666: <pre class="programlisting">
8667: usr MAKE_JOBS= 7
8668: pkg MAKE_JOBS_SAFE # undefined
8669: def _MAKE_JOBS_N= 7
8670: </pre>
8671: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8672: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8673: package could have disabled parallel builds by setting
8674: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8675: in this case it hasn't.</p>
8676: <p>To see whether the build failure is caused by parallel builds,
8677: first save the exact error message and a bit of context, maybe you need
8678: it later for reporting a bug. Next, run:</p>
8679: <pre class="programlisting">
8680: MAKE_JOBS_SAFE=no bmake clean build
8681: </pre>
8682: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8683: report</a> against the pkgsrc package, including the exact error
8684: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8685: </div>
1.288 rillig 8686: <div class="sect3">
8687: <div class="titlepage"><div><div><h4 class="title">
8688: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
8689: <p>Pkgsrc does not work reliably if any of
8690: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
8691: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
8692: bootstrap program prevents installing pkgsrc in symlink-based
8693: directories. Existing pkgsrc installations are not checked for symlinks
8694: though.</p>
8695: <p>The "No such file or directory" error messages are a typical
8696: symptom of symlinks, and it's quite difficult to find out that this is
8697: the actual cause.</p>
8698: </div>
8699: <div class="sect3">
8700: <div class="titlepage"><div><div><h4 class="title">
8701: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
8702: <p>When building a hierarchy of packages, it may happen that one
8703: package is built and then pkgsrc is updated. This situation can provoke
8704: various hard to diagnose build errors. To clean up the situation:</p>
8705: <pre class="programlisting">
8706: <code class="prompt">$</code> (cd ../../ && test -f mk/bsd.pkg.mk && rm -rf */*/work)
8707: </pre>
8708: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
8709: this command in the wrong directory.)</p>
8710: <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
8711: that directory as well.</p>
8712: </div>
8713: <div class="sect3">
8714: <div class="titlepage"><div><div><h4 class="title">
8715: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
8716: <p>On platforms other than BSD, third-party packages are installed in
8717: <code class="filename">/usr/include</code>, together with the base system. This
8718: means that pkgsrc cannot distinguish between headers provided by the base
8719: system (which it needs) and headers from third-party packages (which are
8720: often included in pkgsrc as well). This can lead to subtle version
8721: mismatches.</p>
8722: <p>In pkgsrc installations that have been active for several years, it
8723: may happen that some files are manually deleted. To exclude this unlikely
8724: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
8725: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
8726: check/fix dependencies.</p>
8727: <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>
8728: for contact information. Be prepared to describe what you have tried so
8729: far and what any error messages were.</p>
8730: </div>
1.287 rillig 8731: </div>
8732: <div class="sect2">
8733: <div class="titlepage"><div><div><h3 class="title">
8734: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.128 wiz 8735: </h3></div></div></div>
1.92 rillig 8736: <p>This error message often means that a package did not
1.78 rillig 8737: link to a shared library it needs. The following functions are
8738: known to cause this error message over and over.</p>
8739: <div class="informaltable">
1.216 tnn 8740: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78 rillig 8741: <colgroup>
8742: <col>
8743: <col>
8744: <col>
8745: </colgroup>
8746: <thead><tr>
8747: <th>Function</th>
8748: <th>Library</th>
8749: <th>Affected platforms</th>
8750: </tr></thead>
8751: <tbody>
8752: <tr>
8753: <td>accept, bind, connect</td>
8754: <td>-lsocket</td>
8755: <td>Solaris</td>
8756: </tr>
8757: <tr>
8758: <td>crypt</td>
8759: <td>-lcrypt</td>
8760: <td>DragonFly, NetBSD</td>
8761: </tr>
8762: <tr>
8763: <td>dlopen, dlsym</td>
8764: <td>-ldl</td>
8765: <td>Linux</td>
8766: </tr>
8767: <tr>
8768: <td>gethost*</td>
8769: <td>-lnsl</td>
8770: <td>Solaris</td>
8771: </tr>
8772: <tr>
8773: <td>inet_aton</td>
8774: <td>-lresolv</td>
8775: <td>Solaris</td>
8776: </tr>
8777: <tr>
8778: <td>nanosleep, sem_*, timer_*</td>
8779: <td>-lrt</td>
8780: <td>Solaris</td>
8781: </tr>
8782: <tr>
8783: <td>openpty</td>
8784: <td>-lutil</td>
8785: <td>Linux</td>
8786: </tr>
8787: </tbody>
8788: </table>
8789: </div>
8790: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8791: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8792: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8793: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8794: bmake</strong></span>.</p>
1.148 asau 8795: <div class="sect3">
1.92 rillig 8796: <div class="titlepage"><div><div><h4 class="title">
1.287 rillig 8797: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8798: <p>When you are using the SunPro compiler, there is another
8799: possibility. That compiler cannot handle the following code:</p>
8800: <pre class="programlisting">
1.100 rillig 8801: extern int extern_func(int);
1.93 rillig 8802:
1.100 rillig 8803: static inline int
8804: inline_func(int x)
8805: {
1.92 rillig 8806: return extern_func(x);
1.100 rillig 8807: }
1.93 rillig 8808:
1.100 rillig 8809: int main(void)
8810: {
1.92 rillig 8811: return 0;
1.100 rillig 8812: }
1.92 rillig 8813: </pre>
8814: <p>It generates the code for <code class="function">inline_func</code> even if
8815: that function is never used. This code then refers to
8816: <code class="function">extern_func</code>, which can usually not be resolved. To
8817: solve this problem you can try to tell the package to disable inlining
8818: of functions.</p>
8819: </div>
1.87 wiz 8820: </div>
1.148 asau 8821: <div class="sect2">
1.87 wiz 8822: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 8823: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87 wiz 8824: <p>Sometimes packages fail to build because the compiler runs
8825: into an operating system specific soft limit. With the
8826: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204 wiz 8827: to unlimit the resources. Currently, the allowed values are any combination of
8828: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8829: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.87 wiz 8830: Setting this variable is similar to running the shell builtin
1.110 hubertf 8831: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8832: segment size or maximum stack size of a process, respectively, to
8833: their hard limits.</p>
1.78 rillig 8834: </div>
1.75 rillig 8835: </div>
1.148 asau 8836: <div class="sect1">
1.75 rillig 8837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8838: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 8839: <div class="sect2">
1.75 rillig 8840: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8841: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8842: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8843: with some operating systems cannot create more than one
8844: directory at a time. As such, you should call
8845: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8846: <pre class="programlisting">
1.100 rillig 8847: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8848: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222 sevan 8849: </pre>
1.128 wiz 8850: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8851: dir2</code></span>”</span> to the
1.87 wiz 8852: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8853: automatically do the right thing.</p>
1.75 rillig 8854: </div>
1.148 asau 8855: <div class="sect2">
1.75 rillig 8856: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8857: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8858: <p>In general, documentation should be installed into
1.87 wiz 8859: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8860: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8861: includes the version number of the package).</p>
1.84 wiz 8862: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8863: directory where HTML documentation is installed with the
1.128 wiz 8864: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8865: is needed because otherwise the documentation ends up in
8866: <code class="filename">${PREFIX}/share/doc/html</code> or other
8867: places.</p>
8868: <p>An exception to the above is that library API documentation
1.250 leot 8869: 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.87 wiz 8870: browsers (devhelp) should be left at their default location, which
8871: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8872: documentation can be recognized from files ending in
8873: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8874: (It is also acceptable to install such files in
8875: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8876: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8877: <code class="filename">.devhelp*</code> file must be directly in that
8878: directory then, no additional subdirectory level is allowed in
8879: this case. This is usually achieved by using
1.128 wiz 8880: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8881: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8882: though.)</p>
1.75 rillig 8883: </div>
1.148 asau 8884: <div class="sect2">
1.75 rillig 8885: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8886: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8887: <p>Certain packages, most of them in the games category, install
1.87 wiz 8888: a score file that allows all users on the system to record their
8889: highscores. In order for this to work, the binaries need to be
8890: installed setgid and the score files owned by the appropriate
1.142 wiz 8891: group and/or owner (traditionally the "games" user/group). Set
8892: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8893: following variables, documented in more detail in
8894: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 8895: behaviour: <code class="varname">GAMEDATAMODE</code>,
8896: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210 leot 8897: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8898: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8899: <code class="varname">GAMEDATA_PERMS</code> and
8900: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8901: <p>An example that illustrates some of the variables described above is
8902: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8903: used to properly set directory permissions of the directory where the
8904: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8905: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8906: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8907: binary:</p>
8908: <pre class="programlisting">
1.223 rillig 8909: USE_GAMESGROUP= yes
1.210 leot 8910:
1.223 rillig 8911: BUILD_DEFS+= VARBASE
1.210 leot 8912:
1.223 rillig 8913: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8914: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8915: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222 sevan 8916: </pre>
1.210 leot 8917: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8918: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8919: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8920: needed to be accessed by setgid games and
8921: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114 jmcneill 8922: <p>A package should therefore never hard code file ownership or
1.210 leot 8923: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8924: or alternatively on <code class="varname">INSTALL_GAME</code>,
8925: <code class="varname">INSTALL_GAME_DATA</code> and
8926: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75 rillig 8927: </div>
1.148 asau 8928: <div class="sect2">
1.75 rillig 8929: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8930: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8931: <p><code class="varname">DESTDIR</code> support means that a package
8932: installs into a staging directory, not the final location of the
8933: files. Then a binary package is created which can be used for
8934: installation as usual. There are two ways: Either the package must
1.128 wiz 8935: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8936: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 8937: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8938: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224 leot 8939: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8940: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145 wiz 8941: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8942: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 8943: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8944: the inclusion.</p></li>
1.128 wiz 8945: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8946: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 8947: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8948: automatically. Many manual rules and pre/post-install often are
8949: incorrect; fix them.</p></li>
1.128 wiz 8950: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8951: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 8952: <li class="listitem"><p>In general, packages should support
1.103 wiz 8953: <code class="varname">UNPRIVILEGED</code> to be able to use
8954: DESTDIR.</p></li>
8955: </ul></div>
8956: </div>
1.148 asau 8957: <div class="sect2">
1.103 wiz 8958: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8959: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8960: <p>Your package may also contain scripts with hardcoded paths to
8961: other interpreters besides (or as well as) perl. To correct the
8962: full pathname to the script interpreter, you need to set the
8963: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8964: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8965: <pre class="programlisting">
1.100 rillig 8966: REPLACE_INTERPRETER+= tcl
8967: REPLACE.tcl.old= .*/bin/tclsh
8968: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8969: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8970: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222 sevan 8971: </pre>
1.148 asau 8972: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8973: <h3 class="title">Note</h3>
8974: <p>Before March 2006, these variables were called
1.87 wiz 8975: <code class="varname">_REPLACE.*</code> and
8976: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8977: </div>
8978: </div>
1.148 asau 8979: <div class="sect2">
1.75 rillig 8980: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8981: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8982: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8983: the Makefile fragment
8984: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8985: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8986: configuration for such modules as well as various hooks to tune
8987: this configuration. See comments in this file for
8988: details.</p>
1.75 rillig 8989: <p>Perl5 modules will install into different places depending
1.87 wiz 8990: on the version of perl used during the build process. To
8991: address this, pkgsrc will append lines to the
8992: <code class="filename">PLIST</code> corresponding to the files listed in
8993: the installed <code class="filename">.packlist</code> file generated by
8994: most perl5 modules. This is invoked by defining
8995: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 8996: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8997: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8998: e.g.:</p>
1.75 rillig 8999: <pre class="programlisting">
1.153 wiz 9000: PERL5_PACKLIST= auto/Pg/.packlist
1.222 sevan 9001: </pre>
1.153 wiz 9002: <p>The perl5 config variables
9003: <code class="varname">installarchlib</code>,
9004: <code class="varname">installscript</code>,
9005: <code class="varname">installvendorbin</code>,
9006: <code class="varname">installvendorscript</code>,
9007: <code class="varname">installvendorarch</code>,
9008: <code class="varname">installvendorlib</code>,
9009: <code class="varname">installvendorman1dir</code>, and
9010: <code class="varname">installvendorman3dir</code> represent those
9011: locations in which components of perl5 modules may be installed,
9012: provided as variable with uppercase and prefixed with
9013: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9014: and may be used by perl5 packages that don't have a packlist.
9015: These variables are also substituted for in the
9016: <code class="filename">PLIST</code> as uppercase prefixed with
9017: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 9018: </div>
1.148 asau 9019: <div class="sect2">
1.75 rillig 9020: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9021: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 9022: <p>Some packages install info files or use the
1.128 wiz 9023: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 9024: commands. <code class="varname">INFO_FILES</code> should be defined in
9025: the package Makefile so that <code class="filename">INSTALL</code> and
9026: <code class="filename">DEINSTALL</code> scripts will be generated to
9027: handle registration of the info files in the Info directory
1.128 wiz 9028: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 9029: files registration is either provided by the system, or by a
9030: special purpose package automatically added as dependency if
9031: needed.</p>
1.75 rillig 9032: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 9033: <code class="filename">${PREFIX}</code> where info files are primarily
9034: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 9035: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 9036: <p>The info files for the package should be listed in the
1.87 wiz 9037: package <code class="filename">PLIST</code>; however any split info files
9038: need not be listed.</p>
1.128 wiz 9039: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9040: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 9041: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 9042: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 9043: should be noted with the <code class="varname">TEXINFO_REQD</code>
9044: variable in the package <code class="filename">Makefile</code>. By
9045: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 9046: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 9047: does not match the required minimum, a build dependency on the
1.250 leot 9048: <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.87 wiz 9049: be added automatically.</p>
1.75 rillig 9050: <p>The build and installation process of the software provided
1.87 wiz 9051: by the package should not use the
1.110 hubertf 9052: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 9053: info files is the task of the package
9054: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 9055: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 9056: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 9057: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9058: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 9059: in <code class="varname">PATH</code>.</p>
1.110 hubertf 9060: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 9061: no effect except the logging of a message. The script overriding
1.110 hubertf 9062: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 9063: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 9064: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 9065: </div>
1.148 asau 9066: <div class="sect2">
1.75 rillig 9067: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9068: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 9069: <p>All packages that install manual pages should install them
1.87 wiz 9070: into the same directory, so that there is one common place to look
9071: for them. In pkgsrc, this place is
9072: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9073: should be used in packages. The default for
9074: <code class="varname">PKGMANDIR</code> is
1.128 wiz 9075: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9076: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 9077: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9078: <h3 class="title">Note</h3>
1.87 wiz 9079: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9080: is far from complete.</p>
1.75 rillig 9081: </div>
1.81 rillig 9082: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 9083: <code class="filename">man/</code> as the top level directory for the man
9084: page file entries, and the pkgsrc framework will convert as
9085: needed. In all other places, the correct
9086: <code class="varname">PKGMANDIR</code> must be used.</p>
9087: <p>Packages that are
9088: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 9089: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 9090: <code class="filename">./configure</code>
9091: --mandir switch to set where the man pages should be installed.
9092: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9093: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9094: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9095: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 9096: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 9097: Or if the <code class="filename">./configure</code> script uses
9098: a non-standard use of --mandir, you can set
9099: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299 rillig 9100: <p>See <a class="xref" href="#manpage-compression" title="19.5. Man page compression">Section 19.5, “Man page compression”</a> for
1.87 wiz 9101: information on installation of compressed manual pages.</p>
1.75 rillig 9102: </div>
1.148 asau 9103: <div class="sect2">
1.75 rillig 9104: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9105: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 9106: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 9107: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 9108: you need to take some extra steps to make sure they get registered
9109: in the database:</p>
1.128 wiz 9110: <div class="orderedlist"><ol class="orderedlist" type="1">
9111: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 9112: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 9113: takes care of rebuilding the GConf database at installation and
1.87 wiz 9114: deinstallation time, and tells the package where to install
1.107 rillig 9115: GConf data files using some standard configure arguments. It
1.87 wiz 9116: also disallows any access to the database directly from the
9117: package.</p></li>
1.128 wiz 9118: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 9119: <code class="filename">.schemas</code> files under
9120: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
9121: installed under <code class="filename">${PREFIX}/etc</code>, you will
9122: need to manually patch the package.</p></li>
1.128 wiz 9123: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 9124: directory, as they will be handled automatically. See
1.267 rillig 9125: <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.128 wiz 9126: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 9127: your <code class="filename">Makefile</code> with a list of all
9128: <code class="filename">.schemas</code> files installed by the package, if
9129: any. Names must not contain any directories in them.</p></li>
1.128 wiz 9130: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 9131: your <code class="filename">Makefile</code> with a
9132: list of all <code class="filename">.entries</code> files installed by the
9133: package, if any. Names must not contain any directories in
9134: them.</p></li>
1.75 rillig 9135: </ol></div>
9136: </div>
1.148 asau 9137: <div class="sect2">
1.75 rillig 9138: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9139: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 9140: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 9141: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 9142: get registered in the database:</p>
1.128 wiz 9143: <div class="orderedlist"><ol class="orderedlist" type="1">
9144: <li class="listitem"><p>Include
1.119 mishka 9145: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9146: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 9147: takes care of rebuilding the scrollkeeper database at
9148: installation and deinstallation time, and disallows any access
9149: to it directly from the package.</p></li>
1.128 wiz 9150: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9151: <code class="filename">libdata/scrollkeeper</code> directory, as they
9152: will be handled automatically.</p></li>
1.128 wiz 9153: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 9154: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9155: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 9156: </ol></div>
9157: </div>
1.148 asau 9158: <div class="sect2">
1.75 rillig 9159: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9160: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9161: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9162: the fonts database in the directory where they get installed at
9163: installation and deinstallation time. This can be automatically
9164: done by using the pkginstall framework.</p>
1.75 rillig 9165: <p>You can list the directories where fonts are installed in the
1.87 wiz 9166: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9167: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 9168: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.87 wiz 9169: Also make sure that the database file
9170: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9171: <p>Note that you should not create new directories for fonts;
1.87 wiz 9172: instead use the standard ones to avoid that the user needs to
9173: manually configure his X server to find them.</p>
1.75 rillig 9174: </div>
1.148 asau 9175: <div class="sect2">
1.75 rillig 9176: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9177: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 9178: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 9179: take some extra steps to get them registered in the GTK2 database
9180: properly:</p>
1.128 wiz 9181: <div class="orderedlist"><ol class="orderedlist" type="1">
9182: <li class="listitem"><p>Include
1.87 wiz 9183: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9184: <code class="filename">buildlink3.mk</code> file. This takes care of
9185: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 9186: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 9187: your package installs GTK2 immodules.</p></li>
1.128 wiz 9188: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 9189: GTK2 loaders.</p></li>
1.128 wiz 9190: <li class="listitem">
1.87 wiz 9191: <p>Patch the package to not touch any of the GTK2
9192: databases directly. These are:</p>
1.148 asau 9193: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9194: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9195: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9196: </ul></div>
9197: </li>
1.128 wiz 9198: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 9199: any entries under the <code class="filename">libdata/gtk-2.0</code>
9200: directory, as they will be handled automatically.</p></li>
1.75 rillig 9201: </ol></div>
9202: </div>
1.148 asau 9203: <div class="sect2">
1.75 rillig 9204: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9205: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9206: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9207: registered in system-wide catalogs (like DTDs, sub-catalogs,
9208: etc.), you need to take some extra steps:</p>
1.128 wiz 9209: <div class="orderedlist"><ol class="orderedlist" type="1">
9210: <li class="listitem"><p>Include
1.87 wiz 9211: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9212: your <code class="filename">Makefile</code>, which takes care of
9213: registering those files in system-wide catalogs at
9214: installation and deinstallation time.</p></li>
1.128 wiz 9215: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9216: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9217: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9218: any XML catalogs installed by the package.</p></li>
1.128 wiz 9219: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9220: to be added to the SGML catalog. These come in groups of
9221: three strings; see xmlcatmgr(1) for more information
9222: (specifically, arguments recognized by the 'add' action).
9223: Note that you will normally not use this variable.</p></li>
1.128 wiz 9224: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9225: to be added to the XML catalog. These come in groups of three
9226: strings; see xmlcatmgr(1) for more information (specifically,
9227: arguments recognized by the 'add' action). Note that you will
9228: normally not use this variable.</p></li>
1.75 rillig 9229: </ol></div>
9230: </div>
1.148 asau 9231: <div class="sect2">
1.75 rillig 9232: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9233: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9234: <p>If a package provides extensions to the MIME database by
1.87 wiz 9235: installing <code class="filename">.xml</code> files inside
9236: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9237: need to take some extra steps to ensure that the database is kept
9238: consistent with respect to these new files:</p>
1.128 wiz 9239: <div class="orderedlist"><ol class="orderedlist" type="1">
9240: <li class="listitem"><p>Include
1.87 wiz 9241: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9242: (avoid using the <code class="filename">buildlink3.mk</code> file from
9243: this same directory, which is reserved for inclusion from
9244: other <code class="filename">buildlink3.mk</code> files). It takes
9245: care of rebuilding the MIME database at installation and
9246: deinstallation time, and disallows any access to it directly
9247: from the package.</p></li>
1.128 wiz 9248: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9249: <code class="filename">share/mime</code> directory,
9250: <span class="emphasis"><em>except</em></span> for files saved under
9251: <code class="filename">share/mime/packages</code>. The former are
9252: handled automatically by
9253: the update-mime-database program, but the latter are
9254: package-dependent and must be removed by the package that
9255: installed them in the first place.</p></li>
1.128 wiz 9256: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9257: from the PLIST. They will be handled by the shared-mime-info
9258: package.</p></li>
1.75 rillig 9259: </ol></div>
9260: </div>
1.148 asau 9261: <div class="sect2">
1.75 rillig 9262: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9263: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9264: <p>If a package uses intltool during its build, add
9265: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9266: which forces it to use the intltool package provided by pkgsrc,
9267: instead of the one bundled with the distribution file.</p>
1.75 rillig 9268: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9269: latest available version; this way, the package benefits of any
9270: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9271: </div>
1.148 asau 9272: <div class="sect2">
1.75 rillig 9273: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9274: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9275: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9276: the startup directory by default, but you can enable it, by adding
9277: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9278: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9279: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9280: it will automatically remove the scripts when the package is
9281: deinstalled.</p>
1.75 rillig 9282: </div>
1.148 asau 9283: <div class="sect2">
1.75 rillig 9284: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9285: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9286: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9287: the <code class="filename">ls-R</code> database of the tree needs to be
9288: updated.</p>
1.148 asau 9289: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9290: <h3 class="title">Note</h3>
1.125 wiz 9291: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9292: packages should install files
1.125 wiz 9293: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9294: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9295: </div>
1.128 wiz 9296: <div class="orderedlist"><ol class="orderedlist" type="1">
9297: <li class="listitem"><p>Include
1.125 wiz 9298: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9299: takes care of rebuilding the <code class="filename">ls-R</code>
9300: database at installation and deinstallation time.</p></li>
1.128 wiz 9301: <li class="listitem">
1.75 rillig 9302: <p>If your package installs files into a texmf
1.87 wiz 9303: tree other than the one
1.125 wiz 9304: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9305: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9306: trees that need database update.</p>
1.75 rillig 9307: <p>If your package also installs font map files that need
1.110 hubertf 9308: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9309: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9310: set <code class="varname">TEX_MAP_FILES</code> and/or
9311: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9312: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9313: be run automatically at installation/deinstallation to
9314: enable/disable font map files for TeX output
9315: drivers.</p>
1.75 rillig 9316: </li>
1.128 wiz 9317: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9318: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9319: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9320: </ol></div>
9321: </div>
1.148 asau 9322: <div class="sect2">
1.85 jmmv 9323: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9324: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.87 wiz 9325: emulation</h3></div></div></div>
9326: <p>There are some packages that provide libraries and
9327: executables for running binaries from a one operating system
9328: on a different one (if the latter supports it). One example
9329: is running Linux binaries on NetBSD.</p>
1.250 leot 9330: <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.87 wiz 9331: helps in extracting and packaging Linux rpm packages.</p>
9332: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9333: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9334: if all libraries for each installed executable can be found by
9335: the dynamic linker. Since the standard dynamic linker is run,
9336: this fails for emulation packages, because the libraries used
9337: by the emulation are not in the standard directories.</p>
9338: </div>
1.299 rillig 9339: <div class="sect2">
9340: <div class="titlepage"><div><div><h3 class="title">
9341: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
9342: <p>If a package installs images under the
9343: <code class="filename">share/icons/hicolor</code> and/or updates the
9344: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9345: database, you need to take some extra steps to make sure that the
9346: shared theme directory is handled appropriately and that the cache
9347: database is rebuilt:</p>
9348: <div class="orderedlist"><ol class="orderedlist" type="1">
9349: <li class="listitem"><p>Include
9350: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9351: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9352: entry that refers to the theme cache.</p></li>
9353: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9354: directories from the <code class="filename">share/icons/hicolor</code>
9355: hierarchy because they will be handled automatically.</p></li>
9356: </ol></div>
9357: <p>The best way to verify that the PLIST is correct with
9358: respect to the last two points is to regenerate it using
9359: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9360: </div>
9361: <div class="sect2">
9362: <div class="titlepage"><div><div><h3 class="title">
9363: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
9364: <p>If a package installs <code class="filename">.desktop</code> files
9365: under <code class="filename">share/applications</code> and these include
9366: MIME information (MimeType key), you need to take extra steps to
9367: ensure that they are registered into the MIME database:</p>
9368: <div class="orderedlist"><ol class="orderedlist" type="1">
9369: <li class="listitem"><p>Include
9370: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9371: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9372: <code class="filename">share/applications/mimeinfo.cache</code> file.
9373: It will be handled automatically.</p></li>
9374: </ol></div>
9375: <p>The best way to verify that the PLIST is correct with
9376: respect to the last point is to regenerate it using <span class="command"><strong>make
9377: print-PLIST</strong></span>.</p>
9378: </div>
9379: </div>
9380: <div class="sect1">
9381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9382: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9383: <p>In some cases one does not have the time to solve a problem
9384: immediately. In this case, one can plainly mark a package as broken. For
9385: this, one just sets the variable <code class="varname">BROKEN</code> to the
9386: reason why the package is broken (similar to the
9387: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9388: the package will immediately be shown this message, and the build
9389: will not be even tried.</p>
9390: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9391: intervals.</p>
9392: </div>
9393: </div>
9394: <div class="chapter">
9395: <div class="titlepage"><div><div><h2 class="title">
9396: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9397: <div class="toc">
9398: <p><b>Table of Contents</b></p>
9399: <dl class="toc">
9400: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9401: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9402: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9403: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9404: </dl>
9405: </div>
9406: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9407: site</a>:</p>
9408: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9409: environment, an intuitive and attractive desktop for users, and the
9410: GNOME development platform, an extensive framework for building
9411: applications that integrate into the rest of the desktop.</p></blockquote></div>
9412: <p>pkgsrc provides a seamless way to automatically build and install
9413: a complete GNOME environment <span class="emphasis"><em>under many different
9414: platforms</em></span>. We can say with confidence that pkgsrc is one of
9415: the most advanced build and packaging systems for GNOME due to its
9416: included technologies buildlink3, the wrappers and tools framework and
9417: automatic configuration file management. Lots of efforts are put into
9418: achieving a completely clean deinstallation of installed software
9419: components.</p>
9420: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9421: the above also means that great efforts are put into making GNOME work
9422: under this operating system. Recently, <a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9423: pkgsrc as its preferred packaging system, contributing lots of
9424: portability fixes to make GNOME build and install under it.</p>
9425: <p>This chapter is aimed at pkgsrc developers and other people
9426: interested in helping our GNOME porting and packaging efforts. It
9427: provides instructions on how to manage the existing packages and some
9428: important information regarding their internals.</p>
9429: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9430: <h3 class="title">We need your help!</h3>
9431: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9432: and GNOME and are willing to learn new exciting stuff, please jump
9433: straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9434: work</a> list! There is still a long way to go to get a
9435: fully-functional GNOME desktop under NetBSD and we need your help to
9436: achieve it!</p>
9437: </div>
9438: <div class="sect1">
9439: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9440: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9441: <p>pkgsrc includes three GNOME-related meta packages:</p>
9442: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9443: <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
9444: the core GNOME desktop environment. It only includes the necessary
9445: bits to get it to boot correctly, although it may lack important
9446: functionality for daily operation. The idea behind this package is
9447: to let end users build their own configurations on top of this one,
9448: first installing this meta package to achieve a functional setup and
9449: then adding individual applications.</p></li>
9450: <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
9451: complete installation of the GNOME platform and desktop as defined
9452: by the GNOME project; this is based on the components distributed in
9453: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9454: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9455: official FTP server. Developer-only tools found in those
9456: directories are not installed unless required by some other
9457: component to work properly. Similarly, packages from the bindings
9458: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9459: in unless required as a dependency for an end-user component. This
9460: 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>
9461: <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>:
9462: Installs all the tools required to build a GNOME component when
9463: fetched from the CVS repository. These are required to let the
9464: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9465: </ul></div>
9466: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9467: sorted in a way that eases updates: a package may depend on other
9468: packages listed before it but not on any listed after it. It is very
9469: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9470: change it to alphabetical sorting!</em></span></p>
9471: </div>
9472: <div class="sect1">
9473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9474: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9475: <p>Almost all GNOME applications are written in C and use a common
9476: set of tools as their build system. Things get different with the new
9477: bindings to other languages (such as Python), but the following will
9478: give you a general idea on the minimum required tools:</p>
9479: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9480: <li class="listitem">
9481: <p>Almost all GNOME applications use the GNU Autotools as their
9482: build system. As a general rule you will need to tell this to your
9483: package:</p>
9484: <pre class="programlisting">
9485: GNU_CONFIGURE=yes
9486: USE_LIBTOOL=yes
9487: USE_TOOLS+=gmake
9488: </pre>
9489: </li>
9490: <li class="listitem">
9491: <p>If the package uses pkg-config to detect dependencies, add this
9492: tool to the list of required utilities:</p>
9493: <pre class="programlisting">
9494: USE_TOOLS+=pkg-config
9495: </pre>
9496: <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
9497: the end of the build process to ensure that you did not miss to
9498: specify any dependency in your package and that the version
9499: requirements are all correct.</p>
9500: </li>
9501: <li class="listitem"><p>If the package uses intltool, be sure to add
9502: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9503: to handle dependencies and to force the package to use the latest
9504: available version.</p></li>
9505: <li class="listitem">
9506: <p>If the package uses gtk-doc (a documentation generation
9507: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9508: tool is rather big and the distfile should come with pregenerated
9509: documentation anyway; if it does not, it is a bug that you ought to
9510: report. For such packages you should disable gtk-doc (unless it is
9511: the default):</p>
9512: <pre class="programlisting">
9513: CONFIGURE_ARGS+=--disable-gtk-doc
9514: </pre>
9515: <p>The default location of installed HTML files
9516: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9517: and should not be changed unless the package insists on installing
9518: them somewhere else. Otherwise programs as
9519: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9520: do that with an entry similar to:</p>
9521: <pre class="programlisting">
9522: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9523: </pre>
9524: </li>
9525: </ul></div>
9526: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9527: files under the installation prefix to maintain databases. In this
9528: context, shared means that those exact same directories and files are
9529: used among several different packages, leading to conflicts in the
9530: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9531: handle the most common cases, so you have to forget about using
9532: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9533: omitting shared files from them. If you find yourself doing those,
9534: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9535: <p>The following table lists the common situations that result in
9536: using shared directories or files. For each of them, the appropriate
9537: solution is given. After applying the solution be sure to
9538: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9539: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9540: <div class="table">
9541: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9542: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9543: <colgroup>
9544: <col>
9545: <col>
9546: </colgroup>
9547: <thead><tr>
9548: <th>If the package...</th>
9549: <th>Then...</th>
9550: </tr></thead>
9551: <tbody>
9552: <tr>
9553: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
9554: <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>
9555: </tr>
9556: <tr>
9557: <td>Installs icons under the
9558: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9559: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
9560: <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>
9561: </tr>
9562: <tr>
9563: <td>Installs files under
9564: <code class="filename">share/mime/packages</code>.</td>
9565: <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>
9566: </tr>
9567: <tr>
9568: <td>Installs <code class="filename">.desktop</code> files under
9569: <code class="filename">share/applications</code> and these include MIME
9570: information.</td>
9571: <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>
9572: </tr>
9573: </tbody>
9574: </table></div>
1.75 rillig 9575: </div>
1.299 rillig 9576: <br class="table-break">
1.75 rillig 9577: </div>
1.148 asau 9578: <div class="sect1">
1.87 wiz 9579: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 9580: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9581: <p>When seeing GNOME as a whole, there are two kinds of
9582: updates:</p>
9583: <div class="variablelist"><dl class="variablelist">
9584: <dt><span class="term">Major update</span></dt>
9585: <dd>
9586: <p>Given that there is still a very long way for GNOME 3 (if it
9587: ever appears), we consider a major update one that goes from a
9588: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9589: where <code class="literal">Y</code> is even and greater than
9590: <code class="literal">X</code>. These are hard to achieve because they
9591: introduce lots of changes in the components' code and almost all
9592: GNOME distfiles are updated to newer versions. Some of them can
9593: even break API and ABI compatibility with the previous major
9594: version series. As a result, the update needs to be done all at
9595: once to minimize breakage.</p>
9596: <p>A major update typically consists of around 80 package
9597: updates and the addition of some new ones.</p>
9598: </dd>
9599: <dt><span class="term">Minor update</span></dt>
9600: <dd>
9601: <p>We consider a minor update one that goes from a
9602: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9603: one where <code class="literal">Y</code> is greater than
9604: <code class="literal">X</code>. These are easy to achieve because they do
9605: not update all GNOME components, can be done in an incremental way
9606: and do not break API nor ABI compatibility.</p>
9607: <p>A minor update typically consists of around 50 package
9608: updates, although the numbers here may vary a lot.</p>
9609: </dd>
9610: </dl></div>
9611: <p>In order to update the GNOME components in pkgsrc to a new stable
9612: release (either major or minor), the following steps should be
9613: followed:</p>
9614: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128 wiz 9615: <li class="listitem">
1.299 rillig 9616: <p>Get a list of all the tarballs that form the new release by
9617: using the following commands. These will leave the full list of the
9618: components' distfiles into the <code class="filename">list.txt</code>
9619: file:</p>
9620: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9621: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9622: awk '{ print $9 }' >list.txt</code></strong>
9623: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9624: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9625: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.75 rillig 9626: </li>
1.299 rillig 9627: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9628: bump their version to the release you are updating them to. The
9629: three meta packages should be always consistent with versioning.
9630: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9631: in them.</p></li>
1.128 wiz 9632: <li class="listitem">
1.299 rillig 9633: <p>For each meta package, update all its
9634: <code class="varname">DEPENDS</code> lines to match the latest versions as
9635: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9636: newer version (even if found in the FTP) because the meta packages
9637: are supposed to list the exact versions that form a specific GNOME
9638: release. Exceptions are permitted here if a newer version solves a
9639: serious issue in the overall desktop experience; these typically
9640: come in the form of a revision bump in pkgsrc, not in newer versions
9641: from the developers.</p>
9642: <p>Packages not listed in the <code class="filename">list.txt</code> file
9643: should be updated to the latest version available (if found in
9644: pkgsrc). This is the case, for example, of the dependencies on the
9645: 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.75 rillig 9646: </li>
1.128 wiz 9647: <li class="listitem">
1.299 rillig 9648: <p>Generate a patch from the modified meta packages and extract the
9649: list of "new" lines. This will provide you an outline on what
9650: packages need to be updated in pkgsrc and in what order:</p>
9651: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
1.75 rillig 9652: </li>
1.299 rillig 9653: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9654: installed packages and start over from scratch at this point.</p></li>
9655: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9656: of <code class="filename">todo.txt</code> and update the packages listed in
9657: it in order. For major desktop updates none of these should be
9658: committed until the entire set is completed because there are chances
9659: of breaking not-yet-updated packages.</p></li>
9660: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9661: the tree one by one with appropriate log messages. At the end,
9662: commit the three meta package updates and all the corresponding
9663: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9664: <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>
9665: </ol></div>
9666: </div>
9667: <div class="sect1">
9668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9669: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9670: <p>GNOME is a very big component in pkgsrc which approaches 100
9671: packages. Please, it is very important that you always, always,
9672: <span class="strong"><strong>always</strong></span> feed back any portability
9673: 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
9674: their attention on portability issues and to ensure that future versions
9675: can be built out-of-the box on NetBSD. The less custom patches in
9676: pkgsrc, the easier further updates are. Those developers in charge of
9677: issuing major GNOME updates will be grateful if you do that.</p>
9678: <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
9679: Bugzilla</a>. Not all components use these to track bugs, but most
9680: of them do. Do not be short on your reports: always provide detailed
9681: explanations of the current failure, how it can be improved to achieve
9682: maximum portability and, if at all possible, provide a patch against CVS
9683: head. The more verbose you are, the higher chances of your patch being
9684: accepted.</p>
9685: <p>Also, please avoid using preprocessor magic to fix portability
9686: issues. While the FreeBSD GNOME people are doing a great job in porting
9687: GNOME to their operating system, the official GNOME sources are now
9688: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9689: and similar macros. This hurts portability. Please see our patching
9690: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9691: details.</p>
9692: </div>
1.75 rillig 9693: </div>
1.148 asau 9694: <div class="chapter">
1.75 rillig 9695: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9696: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75 rillig 9697: <div class="toc">
9698: <p><b>Table of Contents</b></p>
1.210 leot 9699: <dl class="toc">
1.267 rillig 9700: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9701: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9702: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9703: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9704: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9705: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9706: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9707: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9708: </dl>
9709: </div>
1.148 asau 9710: <div class="sect1">
1.75 rillig 9711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9712: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9713: <p>Our policy is that we accept binaries only from pkgsrc
9714: developers to guarantee that the packages don't contain any
9715: trojan horses etc. This is not to annoy anyone but rather to
9716: protect our users! You're still free to put up your home-made
9717: binary packages and tell the world where to get them. NetBSD
9718: developers doing bulk builds and wanting to upload them please
1.267 rillig 9719: see <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.174 asau 9720: builds)</i></a>.</p>
1.75 rillig 9721: </div>
1.148 asau 9722: <div class="sect1">
1.75 rillig 9723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9724: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9725: <p>First, check that your package is complete, compiles and
1.299 rillig 9726: 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.311 leot 9727: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82 rillig 9728: archive that contains all files that make up the package.
1.87 wiz 9729: Finally, send this package to the pkgsrc bug tracking system,
1.311 leot 9730: either with the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87 wiz 9731: that, go to the web page
1.289 leot 9732: <a class="ulink" href="https://www.NetBSD.org/support/send-pr.html" target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
1.124 snj 9733: which contains some instructions and a link to a form where you
9734: can submit packages. The
1.250 leot 9735: <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.124 snj 9736: also available as a substitute for either of the above two tools.
9737: </p>
1.87 wiz 9738: <p>In the form of the problem report, the category should be
1.128 wiz 9739: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9740: and version number, and the description field should contain a
9741: short description of your package (contents of the COMMENT
9742: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9743: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9744: <p>If you want to submit several packages, please send a
9745: separate PR for each one, it's easier for us to track things
9746: that way.</p>
9747: <p>Alternatively, you can also import new packages into
1.128 wiz 9748: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.289 leot 9749: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
1.75 rillig 9750: for details.</p>
9751: </div>
1.148 asau 9752: <div class="sect1">
1.75 rillig 9753: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9754: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9755: <p>Please note all package additions, updates, moves, and
1.93 rillig 9756: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9757: important to keep this file up to date and conforming to the
9758: existing format, because it will be used by scripts to
1.289 leot 9759: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9760: sites. Additionally, check the
1.76 rillig 9761: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9762: for the package you updated or removed, in case it was mentioned
9763: there.</p>
9764: <p>When the <code class="varname">PKGREVISION</code> of a package is
9765: bumped, the change should appear in
1.93 rillig 9766: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9767: related or otherwise relevant. Mass bumps that result from a
9768: dependency being updated should not be mentioned. In all other
9769: cases it's the developer's decision.</p>
9770: <p>There is a make target that helps in creating proper
1.110 hubertf 9771: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9772: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9773: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9774: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9775: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9776: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9777: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9778: For new packages, or package moves or removals, set the
9779: <code class="varname">CTYPE</code> variable on the command line to "Added",
9780: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9781: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9782: not the same as your NetBSD login name. The target also automatically
9783: removes possibly existing entries for the package in the
9784: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9785: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9786: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9787: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9788: makes the cvs commands use the main repository.
9789: </p>
1.75 rillig 9790: </div>
1.148 asau 9791: <div class="sect1">
1.75 rillig 9792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9793: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243 wiz 9794: <p>For several years, there have been mirrors of pkgsrc in
9795: fossil, git, and hg. Standard practise when using these tools is to
9796: make the first line of a commit message function as a summary that
9797: can be read without the rest, such as is commonly done with "git log
9798: --oneline". For this reason, we have the following guidelines for
9799: pkgsrc commit messages:</p>
9800: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9801: <li class="listitem"><p>Start the commit message with a line that explains the
1.244 wiz 9802: big picture in 65 characters or less. When a commit is for one
1.243 wiz 9803: package, include the name of the package. For updates, include the
9804: version to which it is updated.</p></li>
9805: <li class="listitem"><p>Leave the next line empty.</p></li>
9806: <li class="listitem"><p>Then come the details for the commit (changes in that
9807: package, reason for a change) and any relevant PRs. Wrap this
9808: section.</p></li>
9809: </ul></div>
9810: <p>Here is an example:
9811: </p>
9812: <pre class="programlisting">
9813: libxslt: update to 1.0.30
9814:
9815: Changes since 1.0.29:
9816: ...
9817: </pre>
9818: <p>
9819: </p>
9820: <p>Here is another example:
9821: </p>
9822: <pre class="programlisting">
9823: mk/bsd.pkg.mk: enable SSP by default on NetBSD
9824:
9825: (rationale)
9826: </pre>
9827: <p>
9828: </p>
9829: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
9830: allowed on the pkgsrc repository to change commit messages.</p>
9831: </div>
9832: <div class="sect1">
9833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9834: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9835: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9836: access to the pkgsrc repository.</p>
9837: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9838: Start by adding the directory and then files in the directory. Don't
9839: forget to add the new package to the category's
9840: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9841: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9842: <pre class="programlisting">
9843: <code class="prompt">$</code> cd .../pkgsrc/category
9844: <code class="prompt">$</code> cvs add pkgname
9845: <code class="prompt">$</code> cd pkgname
9846: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9847: <code class="prompt">$</code> cvs add patches/p*
9848: <code class="prompt">$</code> cvs status | less
1.141 wiz 9849: <code class="prompt">$</code> cvs commit
1.140 wiz 9850: <code class="prompt">$</code> cd ..
9851: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9852: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 9853: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 9854: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 9855: </pre>
1.87 wiz 9856: <p>The commit message of the initial import should include part of the
1.76 rillig 9857: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9858: what the package is/does.</p>
1.140 wiz 9859: <p>Also mention the new package in
9860: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9861: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9862: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9863: </div>
1.148 asau 9864: <div class="sect1">
1.75 rillig 9865: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9866: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9867: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9868: changes between old and new versions into the commit log when updating
1.87 wiz 9869: a package. There are various reasons for this:</p>
1.148 asau 9870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9871: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9872: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9873: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9874: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9875: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9876: repository is very useful for people who read the pkgsrc-changes mailing
9877: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9878: the package.</p></li>
1.75 rillig 9879: </ul></div>
1.87 wiz 9880: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9881: has been released, it should not automatically be upgraded in the CVS
9882: repository. We prefer to be conservative in the packages that are
9883: included in pkgsrc - development or beta packages are not really the
9884: best thing for most places in which pkgsrc is used. Please use your
9885: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9886: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9887: </div>
1.148 asau 9888: <div class="sect1">
1.75 rillig 9889: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9890: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122 reed 9891: <p>Renaming packages is not recommended.</p>
1.290 gutterid 9892: <p>When renaming packages, be sure to fix any references to the old name
1.122 reed 9893: in other Makefiles, options, buildlink files, etc.</p>
1.282 leot 9894: <p>
1.290 gutterid 9895: Also, when renaming a package, please add
1.282 leot 9896: the package name and version pattern(s) of the previous package
9897: to <code class="varname">SUPERSEDES</code>.
1.122 reed 9898: This may be repeated for multiple renames.
9899: The new package would be an exact replacement.
1.282 leot 9900: Example:
1.122 reed 9901: </p>
1.282 leot 9902: <pre class="programlisting">
9903: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
9904: SUPERSEDES+= optcomp-[0-9]*
9905: </pre>
1.128 wiz 9906: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9907: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9908: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9909: not be an exact replacement but is a suggestion for the replaced
9910: functionality.</p>
9911: </div>
1.148 asau 9912: <div class="sect1">
1.122 reed 9913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9914: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122 reed 9915: <p>It is preferred that packages are not renamed or moved, but if needed
9916: please follow these steps.
9917: </p>
1.128 wiz 9918: <div class="orderedlist"><ol class="orderedlist" type="1">
9919: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9920: <li class="listitem">
1.75 rillig 9921: <p>Remove all CVS dirs.</p>
1.87 wiz 9922: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9923: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87 wiz 9924: <p>and use that for further work.</p>
1.75 rillig 9925: </li>
1.128 wiz 9926: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9927: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9928: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9929: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9930: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9931: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9932: for doing an update using pkgsrc building; for example, it can
1.311 leot 9933: search the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122 reed 9934: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9935: new <code class="varname">PKGPATH</code> for that moved package. Note that
9936: it may have multiple matches, so the tool should also check on the
9937: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9938: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9939: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9940: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9941: place.</p></li>
1.128 wiz 9942: <li class="listitem">
1.75 rillig 9943: <p>Check if any package depends on it:
9944: </p>
9945: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9946: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9947: </li>
1.128 wiz 9948: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9949: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9950: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9951: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9952: <li class="listitem">
1.75 rillig 9953: <p>Commit the changed and removed files:</p>
9954: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87 wiz 9955: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9956: </li>
9957: </ol></div>
9958: </div>
9959: </div>
1.148 asau 9960: <div class="chapter">
1.75 rillig 9961: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9962: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9963: <p>This section contains the answers to questions that may
9964: arise when you are writing a package. If you don't find your
9965: question answered here, first have a look in the other chapters,
9966: and if you still don't have the answer, ask on the
9967: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 9968: <div class="qandaset">
1.289 leot 9969: <a name="devfaq.qandaset"></a><dl>
1.267 rillig 9970: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9971: MAKEFLAGS, .MAKEFLAGS and
9972: MAKE_FLAGS?</a>
9973: </dt>
1.267 rillig 9974: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9975: MAKE, GMAKE and
9976: MAKE_PROGRAM?</a>
9977: </dt>
1.267 rillig 9978: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9979: CC, PKG_CC and
9980: PKGSRC_COMPILER?</a>
9981: </dt>
1.267 rillig 9982: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9983: BUILDLINK_LDFLAGS,
9984: BUILDLINK_LDADD and
9985: BUILDLINK_LIBS?</a>
9986: </dt>
1.267 rillig 9987: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9988: VARNAME=BUILDLINK_PREFIX.foo
9989: say it's empty?</a>
9990: </dt>
1.267 rillig 9991: <dt>24.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9992: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9993: don't understand the := inside
9994: it.</a>
9995: </dt>
1.267 rillig 9996: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9997: developers?</a>
9998: </dt>
1.267 rillig 9999: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 10000: documentation?</a>
10001: </dt>
1.289 leot 10002: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill.
10003: What shall I do?</a>
1.92 rillig 10004: </dt>
1.75 rillig 10005: </dl>
1.148 asau 10006: <table border="0" style="width: 100%;">
10007: <colgroup>
1.75 rillig 10008: <col align="left" width="1%">
1.128 wiz 10009: <col>
1.148 asau 10010: </colgroup>
1.75 rillig 10011: <tbody>
1.148 asau 10012: <tr class="question">
1.75 rillig 10013: <td align="left" valign="top">
1.289 leot 10014: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75 rillig 10015: </td>
10016: <td align="left" valign="top"><p>What is the difference between
10017: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10018: <code class="varname">MAKE_FLAGS</code>?</p></td>
10019: </tr>
10020: <tr class="answer">
1.91 rillig 10021: <td align="left" valign="top"></td>
1.75 rillig 10022: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.311 leot 10023: to the pkgsrc-internal invocations of <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75 rillig 10024: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
10025: the <code class="varname">MAKE_PROGRAM</code> when building the
10026: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
10027: </tr>
1.148 asau 10028: <tr class="question">
1.75 rillig 10029: <td align="left" valign="top">
1.289 leot 10030: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75 rillig 10031: </td>
10032: <td align="left" valign="top"><p>What is the difference between
10033: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10034: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10035: </tr>
10036: <tr class="answer">
1.91 rillig 10037: <td align="left" valign="top"></td>
1.75 rillig 10038: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.311 leot 10039: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75 rillig 10040: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
10041: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
10042: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
10043: Make program that is used for building the
10044: package.</p></td>
10045: </tr>
1.148 asau 10046: <tr class="question">
1.75 rillig 10047: <td align="left" valign="top">
1.289 leot 10048: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75 rillig 10049: </td>
10050: <td align="left" valign="top"><p>What is the difference between
10051: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10052: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10053: </tr>
10054: <tr class="answer">
1.91 rillig 10055: <td align="left" valign="top"></td>
1.75 rillig 10056: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
10057: compiler, which can be configured by the pkgsrc user.
10058: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
10059: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
10060: path to a compiler, but the type of compiler that should be
1.76 rillig 10061: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 10062: information about the latter variable.</p></td>
10063: </tr>
1.148 asau 10064: <tr class="question">
1.75 rillig 10065: <td align="left" valign="top">
1.289 leot 10066: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.75 rillig 10067: </td>
10068: <td align="left" valign="top"><p>What is the difference between
10069: <code class="varname">BUILDLINK_LDFLAGS</code>,
10070: <code class="varname">BUILDLINK_LDADD</code> and
10071: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
10072: </tr>
10073: <tr class="answer">
1.91 rillig 10074: <td align="left" valign="top"></td>
1.75 rillig 10075: <td align="left" valign="top"><p>[FIXME]</p></td>
10076: </tr>
1.148 asau 10077: <tr class="question">
1.75 rillig 10078: <td align="left" valign="top">
1.289 leot 10079: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.75 rillig 10080: </td>
1.110 hubertf 10081: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 10082: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10083: say it's empty?</p></td>
10084: </tr>
10085: <tr class="answer">
1.91 rillig 10086: <td align="left" valign="top"></td>
1.75 rillig 10087: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 10088: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10089: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 10090: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 10091: command.</p></td>
10092: </tr>
1.148 asau 10093: <tr class="question">
1.78 rillig 10094: <td align="left" valign="top">
1.289 leot 10095: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.78 rillig 10096: </td>
10097: <td align="left" valign="top"><p>What does
1.220 wiz 10098: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10099: don't understand the <code class="code">:=</code> inside
1.78 rillig 10100: it.</p></td>
10101: </tr>
10102: <tr class="answer">
1.91 rillig 10103: <td align="left" valign="top"></td>
1.220 wiz 10104: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
10105: assignment operator, although it looks like it.
1.78 rillig 10106: Instead, it is a degenerate form of
1.220 wiz 10107: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.311 leot 10108: which is documented in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220 wiz 10109: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78 rillig 10110: case of <code class="varname">MASTER_SITE_*</code>,
10111: <em class="replaceable"><code>old_string</code></em> is the empty string and
10112: <em class="replaceable"><code>new_string</code></em> is
1.220 wiz 10113: <code class="code">package/</code>. That's where the
10114: <code class="code">:</code> and the <code class="code">=</code> fall
1.78 rillig 10115: together.</p></td>
10116: </tr>
1.148 asau 10117: <tr class="question">
1.78 rillig 10118: <td align="left" valign="top">
1.289 leot 10119: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.78 rillig 10120: </td>
10121: <td align="left" valign="top"><p>Which mailing lists are there for package
10122: developers?</p></td>
10123: </tr>
10124: <tr class="answer">
1.91 rillig 10125: <td align="left" valign="top"></td>
1.148 asau 10126: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289 leot 10127: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78 rillig 10128: <dd><p>This is a list for technical discussions related
10129: to pkgsrc development, e.g. soliciting feedback for changes to
10130: pkgsrc infrastructure, proposed new features, questions related
10131: to porting pkgsrc to a new platform, advice for maintaining a
10132: package, patches that affect many packages, help requests moved
10133: from pkgsrc-users when an infrastructure bug is found,
10134: etc.</p></dd>
1.289 leot 10135: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78 rillig 10136: <dd><p>All bug reports in category "pkg" sent with
1.311 leot 10137: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78 rillig 10138: directly; use one of the other mailing
10139: lists.</p></dd>
10140: </dl></div></td>
10141: </tr>
1.148 asau 10142: <tr class="question">
1.80 rillig 10143: <td align="left" valign="top">
1.289 leot 10144: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.80 rillig 10145: </td>
10146: <td align="left" valign="top"><p>Where is the pkgsrc
10147: documentation?</p></td>
10148: </tr>
10149: <tr class="answer">
1.91 rillig 10150: <td align="left" valign="top"></td>
1.80 rillig 10151: <td align="left" valign="top">
10152: <p>There are many places where you can find
10153: documentation about pkgsrc:</p>
1.148 asau 10154: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10155: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 10156: of chapters that explain large parts of pkgsrc, but some
10157: chapters tend to be outdated. Which ones they are is hard to
10158: say.</p></li>
1.289 leot 10159: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>), you can find discussions
1.80 rillig 10160: about certain features, announcements of new parts of the pkgsrc
10161: infrastructure and sometimes even announcements that a certain
10162: feature has been marked as obsolete. The benefit here is that
10163: each message has a date appended to it.</p></li>
1.128 wiz 10164: <li class="listitem"><p>Many of the files in the
1.80 rillig 10165: <code class="filename">mk/</code> directory start with a comment that
10166: describes the purpose of the file and how it can be used by the
1.92 rillig 10167: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 10168: documentation is to run <span class="command"><strong>bmake
1.92 rillig 10169: help</strong></span>.</p></li>
1.128 wiz 10170: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 10171: information, but they tend to be highly abbreviated, especially
10172: for actions that occur often. Some contain a detailed
10173: description of what has changed, but they are geared towards the
10174: other pkgsrc developers, not towards an average pkgsrc user.
10175: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10176: don't know what has been before, these messages may not be worth
10177: too much to you.</p></li>
1.128 wiz 10178: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10179: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 10180: mind of the developer who wrote the code. To get this
1.110 hubertf 10181: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 10182: to see who has written it and ask on the
10183: <code class="literal">tech-pkg</code> mailing list, so that others can
10184: find your questions later (see above). To be sure that the
10185: developer in charge reads the mail, you may CC him or
10186: her.</p></li>
10187: </ul></div>
1.299 rillig 10188: </td>
10189: </tr>
10190: <tr class="question">
10191: <td align="left" valign="top">
10192: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
10193: </td>
10194: <td align="left" valign="top"><p>I have a little time to kill.
10195: What shall I do?</p></td>
10196: </tr>
10197: <tr class="answer">
10198: <td align="left" valign="top"></td>
10199: <td align="left" valign="top">
10200: <p>This is not really an FAQ yet, but here's the answer
10201: anyway.</p>
1.148 asau 10202: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 10203: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
10204: <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
10205: will tell you about newer versions of installed packages that are
10206: available, but not yet updated in pkgsrc.</p></li>
10207: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10208: — it contains a list of suggested new packages and a list of
10209: cleanups and enhancements for pkgsrc that would be nice to
10210: have.</p></li>
10211: <li class="listitem"><p>Review packages for which review was requested on
10212: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10213: mailing list.</p></li>
1.85 jmmv 10214: </ul></div>
1.299 rillig 10215: </td>
1.85 jmmv 10216: </tr>
10217: </tbody>
1.299 rillig 10218: </table>
1.85 jmmv 10219: </div>
10220: </div>
1.75 rillig 10221: </div>
1.148 asau 10222: <div class="part">
1.75 rillig 10223: <div class="titlepage"><div><div><h1 class="title">
10224: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10225: <div class="partintro">
1.75 rillig 10226: <div></div>
10227: <p>This part of the guide deals with everything
10228: from the infrastructure that is behind the interfaces described
10229: in the developer's guide. A casual package maintainer should not
10230: need anything from this part.</p>
10231: <div class="toc">
10232: <p><b>Table of Contents</b></p>
1.210 leot 10233: <dl class="toc">
1.299 rillig 10234: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10235: <dd><dl>
1.299 rillig 10236: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10237: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10238: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.75 rillig 10239: <dd><dl>
1.299 rillig 10240: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10241: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.75 rillig 10242: </dl></dd>
1.299 rillig 10243: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10244: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10245: <dd><dl>
1.299 rillig 10246: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10247: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81 rillig 10248: </dl></dd>
1.299 rillig 10249: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10250: <dd><dl>
1.299 rillig 10251: <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>
10252: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10253: </dl></dd>
10254: </dl></dd>
1.299 rillig 10255: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 10256: <dd><dl>
1.299 rillig 10257: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10258: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10259: <dd><dl>
1.299 rillig 10260: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10261: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10262: </dl></dd>
10263: </dl></dd>
1.299 rillig 10264: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10265: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75 rillig 10266: </dl>
10267: </div>
10268: </div>
1.148 asau 10269: <div class="chapter">
1.75 rillig 10270: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10271: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10272: <div class="toc">
10273: <p><b>Table of Contents</b></p>
1.210 leot 10274: <dl class="toc">
1.299 rillig 10275: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10276: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10277: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81 rillig 10278: <dd><dl>
1.299 rillig 10279: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10280: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81 rillig 10281: </dl></dd>
1.299 rillig 10282: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10283: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10284: <dd><dl>
1.299 rillig 10285: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10286: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 10287: </dl></dd>
1.299 rillig 10288: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10289: <dd><dl>
1.299 rillig 10290: <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>
10291: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10292: </dl></dd>
10293: </dl>
10294: </div>
10295: <p>The pkgsrc infrastructure consists of many small Makefile
10296: fragments. Each such fragment needs a properly specified
10297: interface. This chapter explains how such an interface looks
10298: like.</p>
1.148 asau 10299: <div class="sect1">
1.75 rillig 10300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10301: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10302: <p>Whenever a variable is defined in the pkgsrc
10303: infrastructure, the location and the way of definition provide
10304: much information about the intended use of that variable.
10305: Additionally, more documentation may be found in a header
10306: comment or in this pkgsrc guide.</p>
10307: <p>A special file is
10308: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10309: variables that are intended to be user-defined. They are either
10310: defined using the <code class="literal">?=</code> operator or they are
10311: left undefined because defining them to anything would
1.128 wiz 10312: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10313: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10314: file.</p>
10315: <p>Outside this file, the following conventions apply:
10316: Variables that are defined using the <code class="literal">?=</code>
10317: operator may be overridden by a package.</p>
10318: <p>Variables that are defined using the <code class="literal">=</code>
10319: operator may be used read-only at run-time.</p>
10320: <p>Variables whose name starts with an underscore must not be
10321: accessed outside the pkgsrc infrastructure at all. They may
10322: change without further notice.</p>
1.148 asau 10323: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10324: <h3 class="title">Note</h3>
10325: <p>These conventions are currently not applied
10326: consistently to the complete pkgsrc
10327: infrastructure.</p>
10328: </div>
10329: </div>
1.148 asau 10330: <div class="sect1">
1.81 rillig 10331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10332: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10333: <p>All variables that contain lists of things should default
10334: to being empty. Two examples that do not follow this rule are
10335: <code class="varname">USE_LANGUAGES</code> and
10336: <code class="varname">DISTFILES</code>. These variables cannot simply be
10337: modified using the <code class="literal">+=</code> operator in package
10338: <code class="filename">Makefile</code>s (or other files included by
10339: them), since there is no guarantee whether the variable is
10340: already set or not, and what its value is. In the case of
1.128 wiz 10341: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10342: the default value and just define it as in the following
10343: example.</p>
10344: <pre class="programlisting">
1.100 rillig 10345: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10346: </pre>
10347: <p>Because of the selection of this default value, the same
10348: value appears in many package Makefiles. Similarly for
10349: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10350: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10351: doesn't stand out. Nevertheless it is mentioned in many
10352: files.</p>
10353: </div>
1.148 asau 10354: <div class="sect1">
1.81 rillig 10355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10356: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.148 asau 10357: <div class="sect2">
1.75 rillig 10358: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10359: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.75 rillig 10360: <p>Variable evaluation takes place either at load time or at
10361: runtime, depending on the context in which they occur. The
10362: contexts where variables are evaluated at load time are:</p>
1.148 asau 10363: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10364: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10365: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10366: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10367: <code class="literal">.for</code>,</p></li>
1.128 wiz 10368: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10369: </ul></div>
10370: <p>A special exception are references to the iteration
10371: variables of <code class="literal">.for</code> loops, which are expanded
10372: inline, no matter in which context they appear.</p>
10373: <p>As the values of variables may change during load time,
10374: care must be taken not to evaluate them by accident. Typical
10375: examples for variables that should not be evaluated at load time
10376: are <code class="varname">DEPENDS</code> and
10377: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10378: clear, here is an example:</p>
10379: <pre class="programlisting">
1.100 rillig 10380: CONFIGURE_ARGS= # none
10381: CFLAGS= -O
10382: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10383:
1.100 rillig 10384: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10385:
1.100 rillig 10386: CFLAGS+= -Wall
1.222 sevan 10387: </pre>
1.75 rillig 10388: <p>This code shows how the use of the <code class="literal">:=</code>
10389: operator can quickly lead to unexpected results. The first
10390: paragraph is fairly common code. The second paragraph evaluates
10391: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10392: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10393: <code class="literal">-Wall</code> is appended to the
10394: <code class="varname">CFLAGS</code>, but this addition will not appear in
10395: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10396: paragraphs from above typically occur in completely unrelated
10397: files.</p>
10398: </div>
1.148 asau 10399: <div class="sect2">
1.75 rillig 10400: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10401: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.75 rillig 10402: <p>After all the files have been loaded, the values of the
10403: variables cannot be changed anymore. Variables that are used in
10404: the shell commands are expanded at this point.</p>
10405: </div>
10406: </div>
1.148 asau 10407: <div class="sect1">
1.75 rillig 10408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10409: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10410: <p>There are many ways in which the definition and use of a
1.218 rillig 10411: variable can be restricted in order to detect bugs and violations
10412: of the (mostly unwritten) policies. A package can be checked with
10413: <code class="literal">pkglint -Wall</code> to see whether it meets these
10414: rules.</p>
1.78 rillig 10415: </div>
1.148 asau 10416: <div class="sect1">
1.78 rillig 10417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10418: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10419: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10420: of the following classes. Cases where a file falls into more
10421: than one class should be avoided as it often leads to subtle
10422: bugs.</p>
1.148 asau 10423: <div class="sect2">
1.75 rillig 10424: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10425: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10426: <p>In a traditional imperative programming language some of
1.76 rillig 10427: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10428: procedures. They take some input parameters and—after
10429: inclusion—provide a result in output parameters. Since all
1.76 rillig 10430: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10431: care must be taken not to use parameter names that have already
10432: another meaning. For example, <code class="varname">PKGNAME</code> is a
10433: bad choice for a parameter name.</p>
10434: <p>Procedures are completely evaluated at preprocessing time.
10435: That is, when calling a procedure all input parameters must be
10436: completely resolvable. For example,
10437: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10438: parameter since it is very likely that further text will be
10439: added after calling the procedure, which would effectively apply
10440: the procedure to only a part of the variable. Also, references
1.218 rillig 10441: to other variables will be modified after calling the
1.75 rillig 10442: procedure.</p>
10443: <p>A procedure can declare its output parameters either as
10444: suitable for use in preprocessing directives or as only
10445: available at runtime. The latter alternative is for variables
10446: that contain references to other runtime variables.</p>
10447: <p>Procedures shall be written such that it is possible to
10448: call the procedure more than once. That is, the file must not
10449: contain multiple-inclusion guards.</p>
10450: <p>Examples for procedures are
1.76 rillig 10451: <code class="filename">mk/bsd.options.mk</code> and
10452: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10453: that the parameters are evaluated at load time, they should be
10454: assigned using the <code class="literal">:=</code> operator, which should
10455: be used only for this purpose.</p>
10456: </div>
1.148 asau 10457: <div class="sect2">
1.75 rillig 10458: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10459: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10460: <p>Action files take some input parameters and may define
10461: runtime variables. They shall not define loadtime variables.
10462: There are action files that are included implicitly by the
10463: pkgsrc infrastructure, while other must be included
10464: explicitly.</p>
10465: <p>An example for action files is
1.76 rillig 10466: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10467: </div>
10468: </div>
1.148 asau 10469: <div class="sect1">
1.81 rillig 10470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10471: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10472: <p>Package <code class="filename">Makefile</code>s usually consist of
10473: a set of variable definitions, and include the file
10474: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10475: Before that, they may also include various other
10476: <code class="filename">*.mk</code> files if they need to query the
10477: availability of certain features like the type of compiler or
10478: the X11 implementation. Due to the heavy use of preprocessor
10479: directives like <code class="literal">.if</code> and
10480: <code class="literal">.for</code>, the order in which the files are loaded
10481: matters.</p>
10482: <p>This section describes at which point the various files
10483: are loaded and gives reasons for that order.</p>
1.148 asau 10484: <div class="sect2">
1.81 rillig 10485: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10486: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10487: </h3></div></div></div>
10488: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10489: is to define some essential variables like
10490: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10491: <code class="varname">MACHINE_ARCH</code>.</p>
10492: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10493: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104 rillig 10494: After that, those variables
1.81 rillig 10495: that have not been overridden by the user are loaded from
10496: <code class="filename">mk/defaults/mk.conf</code>.</p>
10497: <p>After the user settings, the system settings and platform
10498: settings are loaded, which may override the user
10499: settings.</p>
10500: <p>Then, the tool definitions are loaded. The tool wrappers
10501: are not yet in effect. This only happens when building a
10502: package, so the proper variables must be used instead of the
10503: direct tool names.</p>
10504: <p>As the last steps, some essential variables from the
10505: wrapper and the package system flavor are loaded, as well as the
10506: variables that have been cached in earlier phases of a package
10507: build.</p>
10508: </div>
1.148 asau 10509: <div class="sect2">
1.81 rillig 10510: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10511: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10512: </h3></div></div></div>
1.81 rillig 10513: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10514: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10515: loaded, which fill default values for those variables that have
1.93 rillig 10516: not been defined by the package. These variables may later
1.81 rillig 10517: be used even in unrelated files.</p>
10518: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10519: provides the target <code class="literal">error-check</code> that is added
10520: as a special dependency to all other targets that use
10521: <code class="varname">DELAYED_ERROR_MSG</code> or
10522: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10523: <p>Then, the package-specific hacks from
10524: <code class="filename">hacks.mk</code> are included.</p>
10525: <p>Then, various other files follow. Most of them don't have
10526: any dependencies on what they need to have included before or
10527: after them, though some do.</p>
10528: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10529: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10530: restricts the use of these variables to all the files that have
10531: been included before. Appearances in later files will be
10532: silently ignored.</p>
10533: <p>Then, the files for the main targets are included, in the
10534: order of later execution, though the actual order should not
10535: matter.</p>
10536: <p>At last, some more files are included that don't set any
10537: interesting variables but rather just define make targets to be
10538: executed.</p>
10539: </div>
10540: </div>
1.75 rillig 10541: </div>
1.148 asau 10542: <div class="chapter">
1.75 rillig 10543: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10544: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.75 rillig 10545: <div class="toc">
10546: <p><b>Table of Contents</b></p>
1.210 leot 10547: <dl class="toc">
1.299 rillig 10548: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10549: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10550: <dd><dl>
1.299 rillig 10551: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10552: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10553: </dl></dd>
10554: </dl>
10555: </div>
10556: <p>The pkgsrc infrastructure consists of a large codebase,
10557: and there are many corners where every little bit of a file is
10558: well thought out, making pkgsrc likely to fail as soon as
10559: anything is changed near those parts. To prevent most changes
10560: from breaking anything, a suite of regression tests should go
10561: along with every important part of the pkgsrc infrastructure.
10562: This chapter describes how regression tests work in pkgsrc and
10563: how you can add new tests.</p>
1.148 asau 10564: <div class="sect1">
1.75 rillig 10565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10566: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.250 leot 10567: <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.110 hubertf 10568: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10569: can simply run that command, which will run all tests in the
1.283 rillig 10570: <code class="filename">regress/</code> directory.</p>
1.75 rillig 10571: </div>
1.148 asau 10572: <div class="sect1">
1.75 rillig 10573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10574: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.283 rillig 10575: <p>Every directory in the <code class="filename">regress/</code>
10576: directory that contains a file called <code class="filename">spec</code>
1.75 rillig 10577: is considered a regression test. This file is a shell program
1.110 hubertf 10578: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10579: The following functions can be overridden to suit your
10580: needs.</p>
1.148 asau 10581: <div class="sect2">
1.75 rillig 10582: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10583: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.218 rillig 10584: <p>These functions do not take any parameters. Although they
10585: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.289 leot 10586: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218 rillig 10587: question</a> for details.</p>
1.148 asau 10588: <div class="variablelist"><dl class="variablelist">
1.218 rillig 10589: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75 rillig 10590: <dd><p>This function prepares the environment for the
10591: test. By default it does nothing.</p></dd>
1.218 rillig 10592: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10593: <dd>
10594: <p>This function runs the actual test. By default,
1.75 rillig 10595: it calls <code class="varname">TEST_MAKE</code> with the arguments
10596: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10597: error messages into the file
1.218 rillig 10598: <code class="varname">TEST_OUTFILE</code>.</p>
10599: <p>When defining this function, make sure that all output that
10600: needs to be checked is written to the correct output file.
10601: Example:</p>
10602: <pre class="programlisting">
10603: do_test() {
1.223 rillig 10604: echo "Example output"
1.218 rillig 10605: } 1>$TEST_OUTFILE 2>&1
10606: </pre>
10607: </dd>
10608: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10609: <dd>
10610: <p>This function is run after the test and is
1.75 rillig 10611: typically used to compare the actual output from the one that is
10612: expected. It can make use of the various helper functions from
1.218 rillig 10613: the next section. Example:</p>
10614: <pre class="programlisting">
10615: check_result() {
1.223 rillig 10616: exit_status 0
10617: output_require "Example"
10618: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10619: output_prohibit "no such file or directory"
1.283 rillig 10620: regress_fail "expected $expected but got $actual for input $input"
1.218 rillig 10621: }
10622: </pre>
10623: </dd>
10624: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75 rillig 10625: <dd><p>This function cleans everything up after the
10626: test has been run. By default it does nothing.</p></dd>
10627: </dl></div>
10628: </div>
1.148 asau 10629: <div class="sect2">
1.75 rillig 10630: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10631: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.148 asau 10632: <div class="variablelist"><dl class="variablelist">
1.283 rillig 10633: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10634: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218 rillig 10635: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75 rillig 10636: <dd><p>This function compares the exitcode of the
1.218 rillig 10637: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75 rillig 10638: If they differ, the test will fail.</p></dd>
1.218 rillig 10639: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10640: <dd>
10641: <p>This function checks for each of its parameters
10642: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75 rillig 10643: extended regular expression. If it does not, the test will
1.218 rillig 10644: fail. Example:</p>
10645: <pre class="programlisting">
1.219 rillig 10646: output_require "looks fine"
10647: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218 rillig 10648: </pre>
10649: </dd>
1.292 leot 10650: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75 rillig 10651: <dd><p>This function checks for each of its parameters
1.110 hubertf 10652: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10653: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10654: If any of the regular expressions matches, the test will
10655: fail.</p></dd>
10656: </dl></div>
10657: </div>
10658: </div>
10659: </div>
1.148 asau 10660: <div class="chapter">
1.75 rillig 10661: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10662: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10663: <div class="toc">
10664: <p><b>Table of Contents</b></p>
1.299 rillig 10665: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.75 rillig 10666: </div>
10667: <p>The pkgsrc system has already been ported to many
10668: operating systems, hardware architectures and compilers. This
10669: chapter explains the necessary steps to make pkgsrc even more
10670: portable.</p>
1.148 asau 10671: <div class="sect1">
1.75 rillig 10672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10673: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10674: <p>To port pkgsrc to a new operating system (called
10675: <code class="literal">MyOS</code> in this example), you need to touch the
10676: following files:</p>
1.148 asau 10677: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10678: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75 rillig 10679: <dd><p>This file contains some basic definitions, for
10680: example the name of the C
10681: compiler.</p></dd>
1.76 rillig 10682: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10683: <dd><p>Insert code that defines the variables
10684: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10685: <code class="varname">LOWER_OS_VERSION</code>,
10686: <code class="varname">LOWER_VENDOR</code>,
10687: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10688: <code class="varname">APPEND_ELF</code>, and the other variables that
10689: appear in this file.</p></dd>
1.93 rillig 10690: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10691: <dd><p>This file contains the platform-specific
10692: definitions that are used by pkgsrc. Start by copying one of the
10693: other files and edit it to your
10694: needs.</p></dd>
1.93 rillig 10695: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10696: <dd><p>This file defines the paths to all the tools
10697: that are needed by one or the other package in pkgsrc, as well
10698: as by pkgsrc itself. Find out where these tools are on your
10699: platform and add them.</p></dd>
10700: </dl></div>
10701: <p>Now, you should be able to build some basic packages, like
1.250 leot 10702: <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.75 rillig 10703: </div>
10704: </div>
10705: </div>
1.148 asau 10706: <div class="appendix">
10707: <div class="titlepage"><div><div><h1 class="title">
10708: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10709: <div class="toc">
10710: <p><b>Table of Contents</b></p>
1.210 leot 10711: <dl class="toc">
1.75 rillig 10712: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10713: <dd><dl>
10714: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10715: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10716: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287 rillig 10717: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 10718: </dl></dd>
10719: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10720: </dl>
10721: </div>
10722: <p>We checked to find a piece of software that wasn't in the packages
10723: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10724: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10725: present in the tree is beyond us, but it's useful for the purposes of
10726: this exercise.</p>
1.148 asau 10727: <div class="sect1">
1.75 rillig 10728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10729: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10730: <div class="sect2">
1.75 rillig 10731: <div class="titlepage"><div><div><h3 class="title">
10732: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10733: <pre class="programlisting">
1.100 rillig 10734: # $NetBSD$
10735: #
1.1 grant 10736:
1.100 rillig 10737: DISTNAME= bison-1.25
10738: CATEGORIES= devel
1.286 rillig 10739: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 grant 10740:
1.136 dholland 10741: MAINTAINER= pkgsrc-users@NetBSD.org
1.289 leot 10742: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.100 rillig 10743: COMMENT= GNU yacc clone
1.1 grant 10744:
1.100 rillig 10745: GNU_CONFIGURE= yes
1.152 wiz 10746: INFO_FILES= yes
1.1 grant 10747:
1.100 rillig 10748: .include "../../mk/bsd.pkg.mk"
1.1 grant 10749: </pre>
1.75 rillig 10750: </div>
1.148 asau 10751: <div class="sect2">
1.75 rillig 10752: <div class="titlepage"><div><div><h3 class="title">
10753: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10754: <pre class="programlisting">
1.100 rillig 10755: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.311 leot 10756: improvements. Why you would want this when Berkeley <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100 rillig 10757: of the NetBSD source tree is beyond me.
1.1 grant 10758: </pre>
1.75 rillig 10759: </div>
1.148 asau 10760: <div class="sect2">
1.75 rillig 10761: <div class="titlepage"><div><div><h3 class="title">
10762: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10763: <pre class="programlisting">
1.100 rillig 10764: @comment $NetBSD$
10765: bin/bison
10766: man/man1/bison.1.gz
10767: share/bison.simple
10768: share/bison.hairy
1.1 grant 10769: </pre>
1.75 rillig 10770: </div>
1.148 asau 10771: <div class="sect2">
1.75 rillig 10772: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 10773: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75 rillig 10774: <p>The NetBSD package system comes with
1.250 leot 10775: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75 rillig 10776: which helps to check the contents of these
10777: files. After installation it is quite easy to use, just change to the
1.286 rillig 10778: directory of the package you wish to examine and run
1.110 hubertf 10779: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10780: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286 rillig 10781: ERROR: Makefile: Each package must define its LICENSE.
10782: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10783: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10784: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10785: 1 error, 2 warnings and 1 note found.
10786: (Run "pkglint -e" to show explanations.)
10787: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287 rillig 10788: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75 rillig 10789: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285 rillig 10790: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75 rillig 10791: -Wall</strong></span> for a very thorough check.</p>
10792: </div>
10793: </div>
1.148 asau 10794: <div class="sect1">
1.75 rillig 10795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10796: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10797: <p>Create the directory where the package lives,
10798: plus any auxiliary directories:</p>
10799: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10800: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10801: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10802: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10803: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299 rillig 10804: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 12. Package components - files, directories and contents">Chapter 12, <i>Package components - files, directories and contents</i></a>)
1.75 rillig 10805: then continue with fetching the distfile:</p>
10806: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10807: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10808: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10809: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10810: ftp: Error retrieving file: 500 Internal error
10811:
10812: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10813: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10814: ftp: Error retrieving file: 500 Internal error
10815:
10816: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10817: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10818: Successfully retrieved file.</pre>
10819: <p>Generate the checksum of the distfile into
1.76 rillig 10820: <code class="filename">distinfo</code>:</p>
1.88 wiz 10821: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10822: <p>Now compile:</p>
10823: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10824: >> Checksum OK for bison-1.25.tar.gz.
10825: ===> Extracting for bison-1.25
10826: ===> Patching for bison-1.25
10827: ===> Ignoring empty patch directory
10828: ===> Configuring for bison-1.25
10829: creating cache ./config.cache
10830: checking for gcc... cc
10831: checking whether we are using GNU C... yes
10832: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10833: checking how to run the C preprocessor... cc -E
10834: checking for minix/config.h... no
10835: checking for POSIXized ISC... no
10836: checking whether cross-compiling... no
10837: checking for ANSI C header files... yes
10838: checking for string.h... yes
10839: checking for stdlib.h... yes
10840: checking for memory.h... yes
10841: checking for working const... yes
10842: checking for working alloca.h... no
10843: checking for alloca... yes
10844: checking for strerror... yes
10845: updating cache ./config.cache
10846: creating ./config.status
10847: creating Makefile
10848: ===> Building for bison-1.25
10849: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
10850: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
10851: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
10852: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
10853: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 10854: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\" -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -g ./files.c
1.1 grant 10855: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
10856: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
10857: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lalr.c
10858: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lex.c
10859: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g main.c
10860: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g nullable.c
10861: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g output.c
10862: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g print.c
10863: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reader.c
10864: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reduce.c
10865: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g symtab.c
10866: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g warshall.c
10867: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g version.c
10868: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt.c
10869: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt1.c
10870: cc -g -o bison LR0.o allocate.o closure.o conflicts.o derives.o files.o getargs.o gram.o lalr.o lex.o main.o nullable.o output.o print.o reader.o reduce.o symtab.o warshall.o version.o getopt.o getopt1.o
10871: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10872: rm -f bison.s1
1.75 rillig 10873: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10874: <p>Everything seems OK, so install the files:</p>
10875: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10876: >> Checksum OK for bison-1.25.tar.gz.
10877: ===> Installing for bison-1.25
10878: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10879: rm -f /usr/pkg/bin/bison
10880: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10881: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10882: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10883: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10884: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10885: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10886: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10887: ===> Registering installation for bison-1.25</pre>
10888: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10889: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10890: binary package, do this now:</p>
10891: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10892: >> Checksum OK for bison-1.25.tar.gz.
10893: ===> Building package for bison-1.25
10894: Creating package bison-1.25.tgz
10895: Registering depends:.
1.75 rillig 10896: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10897: <p>Now that you don't need the source and object files
10898: any more, clean up:</p>
10899: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10900: ===> Cleaning for bison-1.25</pre>
10901: </div>
10902: </div>
1.148 asau 10903: <div class="appendix">
10904: <div class="titlepage"><div><div><h1 class="title">
10905: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 10906: <div class="toc">
10907: <p><b>Table of Contents</b></p>
1.210 leot 10908: <dl class="toc">
1.75 rillig 10909: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10910: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10911: </dl>
10912: </div>
1.148 asau 10913: <div class="sect1">
1.75 rillig 10914: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10915: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10916: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10917: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10918: => figlet221.tar.gz doesn't seem to exist on this system.
10919: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10920: => [172219 bytes]
10921: Connected to ftp.plig.net.
10922: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10923: 331 Guest login ok, send your complete e-mail address as password.
10924: 230-You are user #5 of 500 simultaneous users allowed.
10925: 230-
1.68 rillig 10926: 230- ___ _ _ _
10927: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10928: 230- | _| _| . |_| . | | | . |_| . | _| . |
10929: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10930: 230- |_| |_| |___| |___|
10931: 230-
10932: 230-** Welcome to ftp.plig.org **
10933: 230-
10934: 230-Please note that all transfers from this FTP site are logged. If you
10935: 230-do not like this, please disconnect now.
10936: 230-
1.120 snj 10937: 230-This archive is available via
1.1 grant 10938: 230-
10939: 230-HTTP: http://ftp.plig.org/
10940: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10941: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10942: 230-
10943: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10944: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10945: 230-
10946: 230-
10947: 230 Logged in anonymously.
10948: Remote system type is UNIX.
10949: Using binary mode to transfer files.
10950: 200 Type okay.
10951: 250 "/pub" is new cwd.
10952: 250-"/pub/figlet" is new cwd.
10953: 250-
10954: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10955: 250-
1.75 rillig 10956: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10957: 250-
10958: 250-The official FIGlet web page is:
1.75 rillig 10959: 250- http://www.figlet.org/
1.1 grant 10960: 250-
10961: 250-If you have questions, please mailto:info@figlet.org. If you want to
10962: 250-contribute a font or something else, you can email us.
1.68 rillig 10963: 250
1.1 grant 10964: 250 "/pub/figlet/program" is new cwd.
10965: 250 "/pub/figlet/program/unix" is new cwd.
10966: local: figlet221.tar.gz remote: figlet221.tar.gz
10967: 502 Unimplemented command.
10968: 227 Entering Passive Mode (195,40,6,41,246,104)
10969: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10970: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10971: 226 Transfer completed.
10972: 172219 bytes received in 00:02 (75.99 KB/s)
10973: 221 Goodbye.
10974: => Checksum OK for figlet221.tar.gz.
10975: ===> Extracting for figlet-2.2.1nb2
10976: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10977: ===> Patching for figlet-2.2.1nb2
10978: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10979: ===> Overriding tools for figlet-2.2.1nb2
10980: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10981: ===> Configuring for figlet-2.2.1nb2
10982: ===> Building for figlet-2.2.1nb2
10983: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10984: chmod a+x figlet
10985: gcc -O2 -o chkfont chkfont.c
10986: => Unwrapping files-to-be-installed.
1.14 xtraeme 10987: <code class="prompt">#</code>
1.75 rillig 10988: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10989: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10990: ===> Installing for figlet-2.2.1nb2
10991: install -d -o root -g wheel -m 755 /usr/pkg/bin
10992: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10993: mkdir -p /usr/pkg/share/figlet
10994: cp figlet /usr/pkg/bin
10995: cp chkfont /usr/pkg/bin
10996: chmod 555 figlist showfigfonts
10997: cp figlist /usr/pkg/bin
10998: cp showfigfonts /usr/pkg/bin
10999: cp fonts/*.flf /usr/pkg/share/figlet
11000: cp fonts/*.flc /usr/pkg/share/figlet
11001: cp figlet.6 /usr/pkg/man/man6
11002: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 11003: <code class="prompt">#</code></pre>
11004: </div>
1.148 asau 11005: <div class="sect1">
1.75 rillig 11006: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11007: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
11008: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 11009: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11010: ===> Packaging figlet-2.2.1nb2
11011: ===> Building binary package for figlet-2.2.1nb2
11012: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11013: Using SrcDir value of /usr/pkg
1.68 rillig 11014: Registering depends:.
1.75 rillig 11015: <code class="prompt">#</code></pre>
11016: </div>
11017: </div>
1.148 asau 11018: <div class="appendix">
11019: <div class="titlepage"><div><div><h1 class="title">
11020: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 11021: <div class="toc">
11022: <p><b>Table of Contents</b></p>
1.210 leot 11023: <dl class="toc">
1.128 wiz 11024: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11025: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11026: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11027: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11028: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261 leot 11029: <code class="filename">stable</code>,
1.128 wiz 11030: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11031: source packages</a></span></dt>
11032: </dl>
11033: </div>
11034: <p>As in other big projects, the directory layout of pkgsrc
11035: is quite complex for newbies. This chapter explains where you
11036: find things on the FTP server. The base directory on
1.110 hubertf 11037: <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.89 rillig 11038: On other servers it may be different, but inside this directory,
11039: everything should look the same, no matter on which server you
11040: are. This directory contains some subdirectories, which are
11041: explained below.</p>
1.148 asau 11042: <div class="sect1">
1.76 rillig 11043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11044: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 11045: <p>The directory <code class="filename">distfiles</code> contains lots
11046: of archive files from all pkgsrc packages, which are mirrored
11047: here. The subdirectories are called after their package names
11048: and are used when the distributed files have names that don't
11049: explicitly contain a version number or are otherwise too generic
11050: (for example <code class="filename">release.tar.gz</code>).</p>
11051: </div>
1.148 asau 11052: <div class="sect1">
1.76 rillig 11053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11054: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 11055: <p>This directory contains things that individual pkgsrc
11056: developers find worth publishing.</p>
11057: </div>
1.148 asau 11058: <div class="sect1">
1.76 rillig 11059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11060: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 11061: <p>This directory contains binary packages for the various
11062: platforms that are supported by pkgsrc.
11063: 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.148 asau 11064: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 11065: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 11066: operating system for which the packages have been built. The
1.110 hubertf 11067: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 11068: command, so it may differ from the one you are used to
11069: hear.</p></li>
1.128 wiz 11070: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 11071: architecture of the platform for which the packages have been
1.110 hubertf 11072: built. It also includes the <code class="varname">ABI</code> (Application
11073: Binary Interface) for platforms that have several of
11074: them.</p></li>
1.128 wiz 11075: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 11076: the operating system. For version numbers that change often (for
11077: example NetBSD-current), the often-changing part should be
11078: replaced with an <code class="literal">x</code>, for example
11079: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 11080: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 11081: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 11082: for a stable branch, or <code class="literal">head</code> for packages
11083: built from the HEAD branch. The latter should only be used when
11084: the packages are updated on a regular basis. Otherwise the date
11085: from checking out pkgsrc should be appended, for example
11086: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 11087: </ul></div>
11088: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11089: can quickly click through the directories on the
11090: server and find the best binary packages for their machines. Since they
11091: usually know the operating system and the hardware architecture, OPSYS
11092: and ARCH are placed first. After these choices, they can select the
11093: best combination of OSVERSION and TAG together, since it is usually the
11094: case that packages stay compatible between different version of the
11095: operating system.</p>
11096: <p>In each of these directories, there is a
11097: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 11098: <code class="filename">All</code> which contains all binary packages.
11099: Besides that, there are various category directories that
11100: contain symbolic links to the real binary packages.</p>
11101: </div>
1.148 asau 11102: <div class="sect1">
1.76 rillig 11103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11104: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 11105: <p>Here are the reports from bulk builds, for those who want
11106: to fix packages that didn't build on some of the platforms. The
1.128 wiz 11107: 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.108 rillig 11108: </div>
1.148 asau 11109: <div class="sect1">
1.108 rillig 11110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11111: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.261 leot 11112: <code class="filename">stable</code>,
1.126 jakllsch 11113: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11114: source packages</h2></div></div></div>
1.128 wiz 11115: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 11116: that is the files that define how to create binary packages from
11117: source archives.</p>
1.262 leot 11118: <p>Each of the <code class="filename">current</code>,
11119: <code class="filename">stable</code> and
11120: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11121: directories share the same structure. They each contain a
11122: <code class="filename">pkgsrc</code> directory and
11123: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76 rillig 11124: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11125: snapshot of the CVS repository, which is updated regularly. The
1.262 leot 11126: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11127: as the directory, ready to be downloaded as a whole.</p>
11128: <p>The <code class="filename">current</code> directory contains files
11129: related to the HEAD branch of the CVS repository.
11130: In this directory there is an additional file called
11131: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11132: all pkgsrc <code class="filename">README</code>s with information about
11133: categories and packages.
11134: </p>
11135: <p>The <code class="filename">stable</code> directory is a symlink to
11136: the latest
11137: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11138: </p>
11139: <p>The
11140: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11141: directories contain files related to the
11142: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11143: stable branch of the CVS repository. In these directories there is
11144: an additional file called
11145: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.{bz,gz,xz}</code>,
1.76 rillig 11146: which contains the state of pkgsrc when it was branched.</p>
11147: </div>
1.75 rillig 11148: </div>
1.148 asau 11149: <div class="appendix">
11150: <div class="titlepage"><div><div><h1 class="title">
1.267 rillig 11151: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
11152: <p>
11153: The following list contains all help topics that are available
11154: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11155: </p>
1.269 leot 11156: <table border="0" summary="Simple list" class="simplelist">
11157: <tr>
11158: <td>#!</td>
11159: <td>-lintl</td>
11160: </tr>
11161: <tr>
11162: <td>64bit</td>
11163: <td>ABI</td>
11164: </tr>
11165: <tr>
11166: <td>ACCEPTABLE_LICENSES</td>
11167: <td>ACROREAD_FONTPATH</td>
11168: </tr>
11169: <tr>
11170: <td>ADDITIONAL</td>
11171: <td>AFAIK</td>
11172: </tr>
11173: <tr>
11174: <td>AIX</td>
11175: <td>ALLOW_VULNERABLE_PACKAGES</td>
11176: </tr>
11177: <tr>
11178: <td>ALL_ENV</td>
1.311 leot 11179: <td>ALSA_PC</td>
11180: </tr>
11181: <tr>
1.310 jnemeth 11182: <td>ALTERNATIVES_SRC</td>
1.311 leot 11183: <td>AMANDA_TMP</td>
1.292 leot 11184: </tr>
11185: <tr>
1.310 jnemeth 11186: <td>AMANDA_USER</td>
1.311 leot 11187: <td>AMANDA_VAR</td>
1.274 rillig 11188: </tr>
11189: <tr>
1.310 jnemeth 11190: <td>APACHE_GROUP</td>
1.311 leot 11191: <td>APACHE_MODULE_NAME</td>
1.269 leot 11192: </tr>
11193: <tr>
1.310 jnemeth 11194: <td>APACHE_MODULE_SRC</td>
1.311 leot 11195: <td>APACHE_MODULE_SRCDIR</td>
1.269 leot 11196: </tr>
11197: <tr>
1.310 jnemeth 11198: <td>APACHE_PKG_PREFIX</td>
1.311 leot 11199: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.269 leot 11200: </tr>
11201: <tr>
1.310 jnemeth 11202: <td>APACHE_SUEXEC_DOCROOT</td>
1.311 leot 11203: <td>APACHE_USER</td>
1.269 leot 11204: </tr>
11205: <tr>
1.310 jnemeth 11206: <td>APPEND_ABI</td>
1.311 leot 11207: <td>APPEND_ELF</td>
1.269 leot 11208: </tr>
11209: <tr>
1.310 jnemeth 11210: <td>ARLA_CACHE</td>
1.311 leot 11211: <td>AUDIT_PACKAGES_FLAGS</td>
1.269 leot 11212: </tr>
11213: <tr>
1.310 jnemeth 11214: <td>AUTOCONF_REQD</td>
1.311 leot 11215: <td>AUTOMAKE_OVERRIDE</td>
1.269 leot 11216: </tr>
11217: <tr>
1.310 jnemeth 11218: <td>AUTOMAKE_REQD</td>
1.311 leot 11219: <td>AUTO_MKDIRS</td>
1.269 leot 11220: </tr>
11221: <tr>
1.310 jnemeth 11222: <td>BDB185_DEFAULT</td>
1.311 leot 11223: <td>BDBBASE</td>
1.269 leot 11224: </tr>
11225: <tr>
1.310 jnemeth 11226: <td>BDB_ACCEPTED</td>
1.311 leot 11227: <td>BDB_DEFAULT</td>
1.269 leot 11228: </tr>
11229: <tr>
1.310 jnemeth 11230: <td>BDB_LIBS</td>
1.311 leot 11231: <td>BDB_TYPE</td>
1.269 leot 11232: </tr>
11233: <tr>
1.312 gdt 11234: <td>BINCIMAP_GROUP</td>
11235: <td>BINCIMAP_USER</td>
11236: </tr>
11237: <tr>
1.310 jnemeth 11238: <td>BIND_DIR</td>
1.311 leot 11239: <td>BIND_GROUP</td>
1.269 leot 11240: </tr>
11241: <tr>
1.310 jnemeth 11242: <td>BIND_USER</td>
1.311 leot 11243: <td>BINOWN</td>
1.269 leot 11244: </tr>
11245: <tr>
1.310 jnemeth 11246: <td>BINPKG_SITES</td>
1.311 leot 11247: <td>BIN_INSTALL_FLAGS</td>
1.303 bacon 11248: </tr>
11249: <tr>
1.310 jnemeth 11250: <td>BISON_PKGDATADIR</td>
1.311 leot 11251: <td>BLAS_ACCEPTED</td>
1.269 leot 11252: </tr>
11253: <tr>
1.310 jnemeth 11254: <td>BLAS_LIBS</td>
1.311 leot 11255: <td>BLAS_TYPE</td>
1.292 leot 11256: </tr>
11257: <tr>
1.310 jnemeth 11258: <td>BOOTSTRAP_DEPENDS</td>
1.311 leot 11259: <td>BOOTSTRAP_SETUPTOOLS</td>
1.269 leot 11260: </tr>
11261: <tr>
1.310 jnemeth 11262: <td>BROKEN</td>
1.311 leot 11263: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.269 leot 11264: </tr>
11265: <tr>
1.310 jnemeth 11266: <td>BROKEN_ON_PLATFORM</td>
1.311 leot 11267: <td>BSDSRCDIR</td>
1.269 leot 11268: </tr>
11269: <tr>
1.310 jnemeth 11270: <td>BSDXSRCDIR</td>
1.311 leot 11271: <td>BSD_MAKE_ENV</td>
1.269 leot 11272: </tr>
11273: <tr>
1.310 jnemeth 11274: <td>BUILDLINK_AUTO_DIRS</td>
1.311 leot 11275: <td>BUILDLINK_AUTO_VARS</td>
1.269 leot 11276: </tr>
11277: <tr>
1.310 jnemeth 11278: <td>BUILDLINK_CFLAGS</td>
1.311 leot 11279: <td>BUILDLINK_CONTENTS_FILTER</td>
1.269 leot 11280: </tr>
11281: <tr>
11282: <td>BUILDLINK_CPPFLAGS</td>
1.311 leot 11283: <td>BUILDLINK_DEPMETHOD</td>
1.269 leot 11284: </tr>
11285: <tr>
11286: <td>BUILDLINK_FILES</td>
1.303 bacon 11287: <td>BUILDLINK_FILES_CMD</td>
1.269 leot 11288: </tr>
11289: <tr>
11290: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.303 bacon 11291: <td>BUILDLINK_LDFLAGS</td>
1.269 leot 11292: </tr>
11293: <tr>
11294: <td>BUILDLINK_LIBS</td>
1.303 bacon 11295: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.269 leot 11296: </tr>
11297: <tr>
11298: <td>BUILDLINK_PKGNAME</td>
1.303 bacon 11299: <td>BUILDLINK_PREFIX</td>
1.269 leot 11300: </tr>
11301: <tr>
11302: <td>BUILDLINK_RPATHDIRS</td>
1.303 bacon 11303: <td>BUILDLINK_TREE</td>
1.269 leot 11304: </tr>
11305: <tr>
11306: <td>BUILD_DEFS</td>
1.303 bacon 11307: <td>BUILD_DEFS_EFFECTS</td>
1.269 leot 11308: </tr>
11309: <tr>
11310: <td>BUILD_DEPENDS</td>
1.303 bacon 11311: <td>BUILD_DIRS</td>
1.269 leot 11312: </tr>
11313: <tr>
11314: <td>BUILD_ENV_SHELL</td>
1.303 bacon 11315: <td>BUILD_MAKE_CMD</td>
1.269 leot 11316: </tr>
11317: <tr>
11318: <td>BUILD_MAKE_FLAGS</td>
1.303 bacon 11319: <td>BUILD_TARGET</td>
1.269 leot 11320: </tr>
11321: <tr>
11322: <td>BUILTIN_FIND_FILES</td>
1.303 bacon 11323: <td>BUILTIN_FIND_FILES_VAR</td>
1.269 leot 11324: </tr>
11325: <tr>
11326: <td>BUILTIN_FIND_GREP</td>
1.303 bacon 11327: <td>BUILTIN_FIND_HEADERS</td>
1.269 leot 11328: </tr>
11329: <tr>
11330: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.309 gutterid 11331: <td>BUILTIN_FIND_PKGCONFIG</td>
11332: </tr>
11333: <tr>
11334: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.303 bacon 11335: <td>BUILTIN_PKG</td>
1.269 leot 11336: </tr>
11337: <tr>
11338: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.303 bacon 11339: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.269 leot 11340: </tr>
11341: <tr>
11342: <td>BUILTIN_VERSION_SCRIPT</td>
1.303 bacon 11343: <td>BUILTIN_X11_TYPE</td>
1.269 leot 11344: </tr>
11345: <tr>
11346: <td>BUILTIN_X11_VERSION</td>
1.303 bacon 11347: <td>CACTI_GROUP</td>
1.269 leot 11348: </tr>
11349: <tr>
11350: <td>CACTI_USER</td>
1.303 bacon 11351: <td>CANNA_GROUP</td>
1.269 leot 11352: </tr>
11353: <tr>
11354: <td>CANNA_USER</td>
1.303 bacon 11355: <td>CAT</td>
1.269 leot 11356: </tr>
11357: <tr>
11358: <td>CCACHE_BASE</td>
1.303 bacon 11359: <td>CCACHE_DIR</td>
1.269 leot 11360: </tr>
11361: <tr>
11362: <td>CCACHE_LOGFILE</td>
1.303 bacon 11363: <td>CC_VERSION</td>
1.269 leot 11364: </tr>
11365: <tr>
11366: <td>CC_VERSION_STRING</td>
1.303 bacon 11367: <td>CDRECORD_CONF</td>
1.269 leot 11368: </tr>
11369: <tr>
11370: <td>CDROM_PKG_URL_DIR</td>
1.303 bacon 11371: <td>CDROM_PKG_URL_HOST</td>
1.269 leot 11372: </tr>
11373: <tr>
1.311 leot 11374: <td>CHECKOUT_DATE</td>
1.303 bacon 11375: <td>CHECK_COMPILER</td>
1.311 leot 11376: </tr>
11377: <tr>
1.310 jnemeth 11378: <td>CHECK_FAKEHOME</td>
1.311 leot 11379: <td>CHECK_FILES</td>
1.292 leot 11380: </tr>
11381: <tr>
1.310 jnemeth 11382: <td>CHECK_FILES_SKIP</td>
1.311 leot 11383: <td>CHECK_FILES_STRICT</td>
1.274 rillig 11384: </tr>
11385: <tr>
1.310 jnemeth 11386: <td>CHECK_HEADERS</td>
1.311 leot 11387: <td>CHECK_HEADERS_SKIP</td>
1.269 leot 11388: </tr>
11389: <tr>
1.310 jnemeth 11390: <td>CHECK_INTERPRETER</td>
1.311 leot 11391: <td>CHECK_INTERPRETER_SKIP</td>
1.269 leot 11392: </tr>
11393: <tr>
1.310 jnemeth 11394: <td>CHECK_PERMS</td>
1.311 leot 11395: <td>CHECK_PERMS_AUTOFIX</td>
1.269 leot 11396: </tr>
11397: <tr>
1.310 jnemeth 11398: <td>CHECK_PERMS_SKIP</td>
1.311 leot 11399: <td>CHECK_PORTABILITY</td>
1.269 leot 11400: </tr>
11401: <tr>
1.310 jnemeth 11402: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.311 leot 11403: <td>CHECK_PORTABILITY_SKIP</td>
1.269 leot 11404: </tr>
11405: <tr>
1.310 jnemeth 11406: <td>CHECK_RELRO</td>
1.311 leot 11407: <td>CHECK_RELRO_SKIP</td>
1.269 leot 11408: </tr>
11409: <tr>
1.310 jnemeth 11410: <td>CHECK_RELRO_SUPPORTED</td>
1.311 leot 11411: <td>CHECK_SHLIBS</td>
1.269 leot 11412: </tr>
11413: <tr>
1.310 jnemeth 11414: <td>CHECK_SHLIBS_BLACKLIST</td>
1.311 leot 11415: <td>CHECK_SHLIBS_SKIP</td>
1.269 leot 11416: </tr>
11417: <tr>
1.310 jnemeth 11418: <td>CHECK_SHLIBS_SUPPORTED</td>
1.311 leot 11419: <td>CHECK_SSP</td>
1.269 leot 11420: </tr>
11421: <tr>
1.310 jnemeth 11422: <td>CHECK_SSP_SKIP</td>
1.311 leot 11423: <td>CHECK_SSP_SUPPORTED</td>
1.269 leot 11424: </tr>
11425: <tr>
1.310 jnemeth 11426: <td>CHECK_STRIPPED</td>
1.311 leot 11427: <td>CHECK_STRIPPED_SKIP</td>
1.269 leot 11428: </tr>
11429: <tr>
1.310 jnemeth 11430: <td>CHECK_WRKREF</td>
1.311 leot 11431: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.269 leot 11432: </tr>
11433: <tr>
1.310 jnemeth 11434: <td>CHECK_WRKREF_SKIP</td>
1.311 leot 11435: <td>CLAMAV_DBDIR</td>
1.269 leot 11436: </tr>
11437: <tr>
1.310 jnemeth 11438: <td>CLAMAV_GROUP</td>
1.311 leot 11439: <td>CLAMAV_USER</td>
1.269 leot 11440: </tr>
11441: <tr>
1.310 jnemeth 11442: <td>CLANGBASE</td>
1.311 leot 11443: <td>CLEANDEPENDS</td>
1.269 leot 11444: </tr>
11445: <tr>
1.310 jnemeth 11446: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.311 leot 11447: <td>CMAKE_INSTALL_NAME_DIR</td>
1.269 leot 11448: </tr>
11449: <tr>
1.310 jnemeth 11450: <td>CMAKE_INSTALL_PREFIX</td>
1.311 leot 11451: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.269 leot 11452: </tr>
11453: <tr>
1.310 jnemeth 11454: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.311 leot 11455: <td>CMAKE_PREFIX_PATH</td>
1.269 leot 11456: </tr>
11457: <tr>
1.305 bacon 11458: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.311 leot 11459: <td>COMMON_LISP_DOCFILES</td>
11460: </tr>
11461: <tr>
11462: <td>COMMON_LISP_EXAMPLES</td>
11463: <td>COMMON_LISP_EXTRAFILES</td>
11464: </tr>
11465: <tr>
11466: <td>COMMON_LISP_PACKAGES</td>
11467: <td>COMMON_LISP_SYSTEM</td>
1.292 leot 11468: </tr>
11469: <tr>
1.305 bacon 11470: <td>COMPILER_RPATH_FLAG</td>
1.269 leot 11471: <td>COMPILER_USE_SYMLINKS</td>
11472: </tr>
11473: <tr>
1.305 bacon 11474: <td>CONFIGURE_ARGS</td>
1.269 leot 11475: <td>CONFIGURE_DIRS</td>
11476: </tr>
11477: <tr>
1.305 bacon 11478: <td>CONFIGURE_ENV</td>
1.287 rillig 11479: <td>CONFIGURE_ENV_SHELL</td>
1.269 leot 11480: </tr>
11481: <tr>
1.305 bacon 11482: <td>CONFIGURE_HAS_INFODIR</td>
1.269 leot 11483: <td>CONFIGURE_HAS_MANDIR</td>
11484: </tr>
11485: <tr>
1.305 bacon 11486: <td>CONFIGURE_SCRIPT</td>
1.269 leot 11487: <td>CONFIG_SHELL</td>
11488: </tr>
11489: <tr>
1.305 bacon 11490: <td>CONFIG_SHELL_FLAGS</td>
1.269 leot 11491: <td>CONF_FILES</td>
11492: </tr>
11493: <tr>
1.305 bacon 11494: <td>CONF_FILES_MODE</td>
1.269 leot 11495: <td>CONF_FILES_PERMS</td>
11496: </tr>
11497: <tr>
1.305 bacon 11498: <td>CONSERVER_DEFAULTHOST</td>
1.269 leot 11499: <td>CONSERVER_DEFAULTPORT</td>
11500: </tr>
11501: <tr>
1.305 bacon 11502: <td>CP</td>
1.269 leot 11503: <td>CPP</td>
11504: </tr>
11505: <tr>
1.305 bacon 11506: <td>CPP_PRECOMP_FLAGS</td>
1.269 leot 11507: <td>CREATE_WRKDIR_SYMLINK</td>
11508: </tr>
11509: <tr>
1.305 bacon 11510: <td>CROSSBASE</td>
1.269 leot 11511: <td>CTFCONVERT</td>
11512: </tr>
11513: <tr>
1.305 bacon 11514: <td>CTF_FILES_SKIP</td>
1.269 leot 11515: <td>CTF_SUPPORTED</td>
11516: </tr>
11517: <tr>
1.305 bacon 11518: <td>CTYPE</td>
1.269 leot 11519: <td>CUPS_GROUP</td>
11520: </tr>
11521: <tr>
1.305 bacon 11522: <td>CUPS_SYSTEM_GROUPS</td>
1.269 leot 11523: <td>CUPS_USER</td>
11524: </tr>
11525: <tr>
1.305 bacon 11526: <td>CURSES_DEFAULT</td>
1.269 leot 11527: <td>CURSES_TYPE</td>
1.292 leot 11528: </tr>
11529: <tr>
1.311 leot 11530: <td>CVS_EXTRACTDIR</td>
11531: <td>CVS_MODULE</td>
11532: </tr>
11533: <tr>
11534: <td>CVS_PROJECT</td>
11535: <td>CVS_REPOSITORIES</td>
11536: </tr>
11537: <tr>
11538: <td>CVS_ROOT</td>
11539: <td>CVS_ROOT_GNU</td>
11540: </tr>
11541: <tr>
11542: <td>CVS_ROOT_NONGNU</td>
11543: <td>CVS_ROOT_SOURCEFORGE</td>
11544: </tr>
11545: <tr>
11546: <td>CVS_TAG</td>
1.273 brook 11547: <td>CXX</td>
1.311 leot 11548: </tr>
11549: <tr>
1.310 jnemeth 11550: <td>CYRUS_GROUP</td>
1.311 leot 11551: <td>CYRUS_IDLE</td>
1.269 leot 11552: </tr>
11553: <tr>
1.310 jnemeth 11554: <td>CYRUS_USER</td>
1.311 leot 11555: <td>DAEMONTOOLS_GROUP</td>
1.269 leot 11556: </tr>
11557: <tr>
1.310 jnemeth 11558: <td>DAEMONTOOLS_LOG_USER</td>
1.311 leot 11559: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.269 leot 11560: </tr>
11561: <tr>
1.310 jnemeth 11562: <td>DARWIN_REQUIRES_FILTER</td>
1.311 leot 11563: <td>DBUS_GROUP</td>
1.309 gutterid 11564: </tr>
11565: <tr>
1.310 jnemeth 11566: <td>DBUS_USER</td>
1.311 leot 11567: <td>DEFANG_GROUP</td>
1.269 leot 11568: </tr>
11569: <tr>
1.310 jnemeth 11570: <td>DEFANG_USER</td>
1.311 leot 11571: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.269 leot 11572: </tr>
11573: <tr>
1.310 jnemeth 11574: <td>DEFAULT_DISTFILES</td>
1.311 leot 11575: <td>DEFAULT_IRC_SERVER</td>
1.269 leot 11576: </tr>
11577: <tr>
1.310 jnemeth 11578: <td>DEFAULT_SERIAL_DEVICE</td>
1.311 leot 11579: <td>DEF_UMASK</td>
1.269 leot 11580: </tr>
11581: <tr>
1.310 jnemeth 11582: <td>DEINSTALLDEPENDS</td>
1.311 leot 11583: <td>DEINSTALL_SRC</td>
1.269 leot 11584: </tr>
11585: <tr>
1.310 jnemeth 11586: <td>DEINSTALL_TEMPLATES</td>
1.311 leot 11587: <td>DELAYED_ERROR_MSG</td>
1.269 leot 11588: </tr>
11589: <tr>
1.310 jnemeth 11590: <td>DELAYED_WARNING_MSG</td>
1.311 leot 11591: <td>DEPENDS</td>
1.269 leot 11592: </tr>
11593: <tr>
1.310 jnemeth 11594: <td>DEPENDS_TARGET</td>
1.311 leot 11595: <td>DEPENDS_TYPE</td>
1.269 leot 11596: </tr>
11597: <tr>
1.310 jnemeth 11598: <td>DESTDIR</td>
1.311 leot 11599: <td>DESTDIR_VARNAME</td>
1.269 leot 11600: </tr>
11601: <tr>
1.310 jnemeth 11602: <td>DIALER_GROUP</td>
1.311 leot 11603: <td>DIGEST_REQD</td>
1.269 leot 11604: </tr>
11605: <tr>
1.310 jnemeth 11606: <td>DISTDIR</td>
1.311 leot 11607: <td>DISTFILES</td>
1.269 leot 11608: </tr>
11609: <tr>
1.310 jnemeth 11610: <td>DISTINFO_FILE</td>
1.311 leot 11611: <td>DISTNAME</td>
1.269 leot 11612: </tr>
11613: <tr>
1.310 jnemeth 11614: <td>DIST_PATH</td>
1.311 leot 11615: <td>DIST_SUBDIR</td>
1.269 leot 11616: </tr>
11617: <tr>
1.310 jnemeth 11618: <td>DJBDNS_AXFR_USER</td>
1.311 leot 11619: <td>DJBDNS_CACHE_USER</td>
1.269 leot 11620: </tr>
11621: <tr>
1.310 jnemeth 11622: <td>DJBDNS_DJBDNS_GROUP</td>
1.311 leot 11623: <td>DJBDNS_LOG_USER</td>
1.269 leot 11624: </tr>
11625: <tr>
1.310 jnemeth 11626: <td>DJBDNS_RBL_USER</td>
1.311 leot 11627: <td>DJBDNS_TINY_USER</td>
1.269 leot 11628: </tr>
11629: <tr>
1.310 jnemeth 11630: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.311 leot 11631: <td>DL_AUTO_VARS</td>
1.269 leot 11632: </tr>
11633: <tr>
1.310 jnemeth 11634: <td>DL_CFLAGS</td>
1.311 leot 11635: <td>DL_LDFLAGS</td>
1.269 leot 11636: </tr>
11637: <tr>
1.310 jnemeth 11638: <td>DL_LIBS</td>
1.311 leot 11639: <td>DNS</td>
1.269 leot 11640: </tr>
11641: <tr>
1.310 jnemeth 11642: <td>DOCOWN</td>
1.311 leot 11643: <td>DOWNLOADED_DISTFILE</td>
1.269 leot 11644: </tr>
11645: <tr>
1.310 jnemeth 11646: <td>DT_LAYOUT</td>
1.311 leot 11647: <td>DYNAMIC_SITES_CMD</td>
1.269 leot 11648: </tr>
11649: <tr>
1.310 jnemeth 11650: <td>DYNAMIC_SITES_SCRIPT</td>
1.311 leot 11651: <td>ECHO</td>
1.269 leot 11652: </tr>
11653: <tr>
1.310 jnemeth 11654: <td>ECHO_N</td>
1.311 leot 11655: <td>ELK_GUI</td>
1.269 leot 11656: </tr>
11657: <tr>
1.310 jnemeth 11658: <td>EMACS_TYPE</td>
1.311 leot 11659: <td>EMULDIR</td>
1.269 leot 11660: </tr>
11661: <tr>
1.310 jnemeth 11662: <td>EMULSUBDIR</td>
1.311 leot 11663: <td>EMULSUBDIRSLASH</td>
1.269 leot 11664: </tr>
11665: <tr>
1.310 jnemeth 11666: <td>EMUL_ARCH</td>
1.311 leot 11667: <td>EMUL_DISTRO</td>
1.269 leot 11668: </tr>
11669: <tr>
1.310 jnemeth 11670: <td>EMUL_EXEC_FMT</td>
1.311 leot 11671: <td>EMUL_IS_NATIVE</td>
1.269 leot 11672: </tr>
11673: <tr>
1.310 jnemeth 11674: <td>EMUL_MODULES</td>
1.311 leot 11675: <td>EMUL_OPSYS</td>
1.269 leot 11676: </tr>
11677: <tr>
1.310 jnemeth 11678: <td>EMUL_PKG_FMT</td>
1.311 leot 11679: <td>EMUL_PLATFORM</td>
1.269 leot 11680: </tr>
11681: <tr>
1.310 jnemeth 11682: <td>EMUL_PLATFORMS</td>
1.311 leot 11683: <td>EMUL_PREFER</td>
1.269 leot 11684: </tr>
11685: <tr>
1.310 jnemeth 11686: <td>EMUL_REQD</td>
1.311 leot 11687: <td>EMUL_TYPE</td>
1.269 leot 11688: </tr>
11689: <tr>
1.310 jnemeth 11690: <td>ERROR_MSG</td>
1.311 leot 11691: <td>EXIM_GROUP</td>
1.269 leot 11692: </tr>
11693: <tr>
1.310 jnemeth 11694: <td>EXIM_USER</td>
1.311 leot 11695: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.269 leot 11696: </tr>
11697: <tr>
1.310 jnemeth 11698: <td>EXTRACTOR</td>
1.311 leot 11699: <td>EXTRACT_CMD</td>
1.269 leot 11700: </tr>
11701: <tr>
1.310 jnemeth 11702: <td>EXTRACT_CMD_DEFAULT</td>
1.311 leot 11703: <td>EXTRACT_DIR</td>
1.269 leot 11704: </tr>
11705: <tr>
1.310 jnemeth 11706: <td>EXTRACT_ELEMENTS</td>
1.311 leot 11707: <td>EXTRACT_ENV</td>
1.269 leot 11708: </tr>
11709: <tr>
1.310 jnemeth 11710: <td>EXTRACT_ONLY</td>
1.311 leot 11711: <td>EXTRACT_OPTS</td>
1.269 leot 11712: </tr>
11713: <tr>
1.310 jnemeth 11714: <td>EXTRACT_SUFX</td>
1.311 leot 11715: <td>EXTRACT_USING</td>
1.269 leot 11716: </tr>
11717: <tr>
1.310 jnemeth 11718: <td>FAIL</td>
1.311 leot 11719: <td>FAILOVER_FETCH</td>
1.292 leot 11720: </tr>
11721: <tr>
1.310 jnemeth 11722: <td>FAIL_MSG</td>
1.311 leot 11723: <td>FAKE_NCURSES</td>
1.269 leot 11724: </tr>
11725: <tr>
1.310 jnemeth 11726: <td>FAM</td>
1.311 leot 11727: <td>FAM_ACCEPTED</td>
1.269 leot 11728: </tr>
11729: <tr>
1.310 jnemeth 11730: <td>FAM_DEFAULT</td>
1.311 leot 11731: <td>FAM_SERVER</td>
1.269 leot 11732: </tr>
11733: <tr>
1.310 jnemeth 11734: <td>FCPATH</td>
1.311 leot 11735: <td>FEATURE_CPPFLAGS</td>
1.269 leot 11736: </tr>
11737: <tr>
1.310 jnemeth 11738: <td>FEATURE_LDFLAGS</td>
1.311 leot 11739: <td>FEATURE_LIBS</td>
1.269 leot 11740: </tr>
11741: <tr>
1.310 jnemeth 11742: <td>FETCH_AFTER_ARGS</td>
1.311 leot 11743: <td>FETCH_BEFORE_ARGS</td>
1.269 leot 11744: </tr>
11745: <tr>
1.310 jnemeth 11746: <td>FETCH_CMD</td>
1.311 leot 11747: <td>FETCH_OUTPUT_ARGS</td>
1.269 leot 11748: </tr>
11749: <tr>
1.310 jnemeth 11750: <td>FETCH_PROXY</td>
1.311 leot 11751: <td>FETCH_RESUME_ARGS</td>
1.269 leot 11752: </tr>
11753: <tr>
1.310 jnemeth 11754: <td>FETCH_TIMEOUT</td>
1.311 leot 11755: <td>FETCH_USE_IPV4_ONLY</td>
1.303 bacon 11756: </tr>
11757: <tr>
1.310 jnemeth 11758: <td>FETCH_USING</td>
1.311 leot 11759: <td>FILES_SUBST</td>
1.269 leot 11760: </tr>
11761: <tr>
1.310 jnemeth 11762: <td>FILES_SUBST_SED</td>
1.311 leot 11763: <td>FIX_SYSTEM_HEADERS</td>
1.269 leot 11764: </tr>
11765: <tr>
1.310 jnemeth 11766: <td>FLUXBOX_USE_GNOME</td>
1.311 leot 11767: <td>FLUXBOX_USE_KDE</td>
1.269 leot 11768: </tr>
11769: <tr>
1.310 jnemeth 11770: <td>FLUXBOX_USE_XFT</td>
1.311 leot 11771: <td>FLUXBOX_USE_XINERAMA</td>
1.269 leot 11772: </tr>
11773: <tr>
1.311 leot 11774: <td>FONTDIR</td>
1.295 rillig 11775: <td>FONTS_DIRS</td>
1.274 rillig 11776: </tr>
11777: <tr>
1.305 bacon 11778: <td>FONTS_VERBOSE</td>
1.295 rillig 11779: <td>FOO_HACKS_MK</td>
1.292 leot 11780: </tr>
11781: <tr>
1.311 leot 11782: <td>FOSSIL_EXTRACTDIR</td>
11783: <td>FOSSIL_REPO</td>
11784: </tr>
11785: <tr>
11786: <td>FOSSIL_REPOSITORIES</td>
11787: <td>FOSSIL_VERSION</td>
11788: </tr>
11789: <tr>
1.305 bacon 11790: <td>FOX_USE_XUNICODE</td>
1.295 rillig 11791: <td>FREEWNN_GROUP</td>
1.269 leot 11792: </tr>
11793: <tr>
1.305 bacon 11794: <td>FREEWNN_USER</td>
1.295 rillig 11795: <td>FTP_PKG_URL_DIR</td>
1.269 leot 11796: </tr>
11797: <tr>
1.305 bacon 11798: <td>FTP_PKG_URL_HOST</td>
1.295 rillig 11799: <td>GAMEDATAMODE</td>
1.269 leot 11800: </tr>
11801: <tr>
1.305 bacon 11802: <td>GAMEDATA_PERMS</td>
1.295 rillig 11803: <td>GAMEDIRMODE</td>
1.269 leot 11804: </tr>
11805: <tr>
1.305 bacon 11806: <td>GAMEDIR_PERMS</td>
1.295 rillig 11807: <td>GAMEGRP</td>
1.269 leot 11808: </tr>
11809: <tr>
1.305 bacon 11810: <td>GAMEMODE</td>
1.295 rillig 11811: <td>GAMEOWN</td>
1.269 leot 11812: </tr>
11813: <tr>
1.305 bacon 11814: <td>GAMES_GROUP</td>
1.295 rillig 11815: <td>GAMES_USER</td>
1.269 leot 11816: </tr>
11817: <tr>
1.305 bacon 11818: <td>GCC</td>
1.295 rillig 11819: <td>GCCBASE</td>
1.269 leot 11820: </tr>
11821: <tr>
1.305 bacon 11822: <td>GCC_REQD</td>
1.295 rillig 11823: <td>GCC_VERSION_SUFFIX</td>
1.269 leot 11824: </tr>
11825: <tr>
1.305 bacon 11826: <td>GEM_BUILD</td>
1.295 rillig 11827: <td>GEM_CLEANBUILD</td>
1.269 leot 11828: </tr>
11829: <tr>
1.305 bacon 11830: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.295 rillig 11831: <td>GEM_DOCDIR</td>
1.269 leot 11832: </tr>
11833: <tr>
1.305 bacon 11834: <td>GEM_EXTSDIR</td>
1.295 rillig 11835: <td>GEM_HOME</td>
1.292 leot 11836: </tr>
11837: <tr>
1.305 bacon 11838: <td>GEM_KEEPBUILD</td>
1.295 rillig 11839: <td>GEM_LIBDIR</td>
1.269 leot 11840: </tr>
11841: <tr>
1.305 bacon 11842: <td>GEM_NAME</td>
1.295 rillig 11843: <td>GEM_PATH</td>
1.269 leot 11844: </tr>
11845: <tr>
1.312 gdt 11846: <td>GEM_PLUGINSDIR</td>
1.305 bacon 11847: <td>GEM_SPECFILE</td>
1.269 leot 11848: </tr>
11849: <tr>
1.312 gdt 11850: <td>GENERATE_PLIST</td>
1.305 bacon 11851: <td>GHOSTSCRIPT_REQD</td>
1.269 leot 11852: </tr>
11853: <tr>
1.312 gdt 11854: <td>GITHUB_PROJECT</td>
1.305 bacon 11855: <td>GITHUB_RELEASE</td>
1.292 leot 11856: </tr>
11857: <tr>
1.313 leot 11858: <td>GITHUB_SUBMODULE</td>
1.312 gdt 11859: <td>GITHUB_TAG</td>
1.311 leot 11860: </tr>
11861: <tr>
1.313 leot 11862: <td>GITHUB_TYPE</td>
1.312 gdt 11863: <td>GITLAB_PROJECT</td>
1.311 leot 11864: </tr>
11865: <tr>
1.313 leot 11866: <td>GITLAB_TAG</td>
1.312 gdt 11867: <td>GITLAB_TYPE</td>
1.311 leot 11868: </tr>
11869: <tr>
1.313 leot 11870: <td>GIT_BRANCH</td>
1.312 gdt 11871: <td>GIT_ENV</td>
1.311 leot 11872: </tr>
11873: <tr>
1.313 leot 11874: <td>GIT_EXTRACTDIR</td>
1.312 gdt 11875: <td>GIT_REPO</td>
1.311 leot 11876: </tr>
11877: <tr>
1.313 leot 11878: <td>GIT_REPOSITORIES</td>
1.312 gdt 11879: <td>GIT_REVISION</td>
1.269 leot 11880: </tr>
11881: <tr>
1.313 leot 11882: <td>GIT_TAG</td>
1.312 gdt 11883: <td>GNU</td>
1.269 leot 11884: </tr>
11885: <tr>
1.313 leot 11886: <td>GNU_CONFIGURE</td>
1.312 gdt 11887: <td>GNU_CONFIGURE_INFODIR</td>
1.269 leot 11888: </tr>
11889: <tr>
1.313 leot 11890: <td>GNU_CONFIGURE_MANDIR</td>
1.312 gdt 11891: <td>GNU_CONFIGURE_QUIET</td>
1.269 leot 11892: </tr>
11893: <tr>
1.313 leot 11894: <td>GNU_CONFIGURE_STRICT</td>
1.312 gdt 11895: <td>GODEP_REDIRECTS</td>
1.269 leot 11896: </tr>
11897: <tr>
1.313 leot 11898: <td>GO_BUILD_PATTERN</td>
1.312 gdt 11899: <td>GO_DEPS</td>
1.276 leot 11900: </tr>
11901: <tr>
1.313 leot 11902: <td>GO_DIST_BASE</td>
1.312 gdt 11903: <td>GO_MODULE_FILES</td>
1.269 leot 11904: </tr>
11905: <tr>
1.313 leot 11906: <td>GO_SRCPATH</td>
1.312 gdt 11907: <td>GO_VERSION_DEFAULT</td>
1.269 leot 11908: </tr>
11909: <tr>
1.313 leot 11910: <td>GROUP_SPECIFIC_PKGS</td>
1.312 gdt 11911: <td>GRUB_NETWORK_CARDS</td>
1.269 leot 11912: </tr>
11913: <tr>
1.313 leot 11914: <td>GRUB_PRESET_COMMAND</td>
1.312 gdt 11915: <td>GRUB_SCAN_ARGS</td>
1.311 leot 11916: </tr>
11917: <tr>
1.313 leot 11918: <td>GZIP</td>
1.312 gdt 11919: <td>HASKELL_COMPILER</td>
1.269 leot 11920: </tr>
11921: <tr>
1.313 leot 11922: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.312 gdt 11923: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.269 leot 11924: </tr>
11925: <tr>
1.313 leot 11926: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.312 gdt 11927: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.292 leot 11928: </tr>
11929: <tr>
1.313 leot 11930: <td>HAS_CONFIGURE</td>
1.312 gdt 11931: <td>HEADER_TEMPLATES</td>
1.311 leot 11932: </tr>
11933: <tr>
1.313 leot 11934: <td>HG_REPO</td>
1.312 gdt 11935: <td>HG_REPOSITORIES</td>
1.269 leot 11936: </tr>
11937: <tr>
1.313 leot 11938: <td>HG_TAG</td>
1.312 gdt 11939: <td>HOMEPAGE</td>
1.269 leot 11940: </tr>
11941: <tr>
1.313 leot 11942: <td>HOST_PKGTOOLS_ARGS</td>
1.312 gdt 11943: <td>HOST_SPECIFIC_PKGS</td>
1.269 leot 11944: </tr>
11945: <tr>
1.313 leot 11946: <td>HOWL_GROUP</td>
1.312 gdt 11947: <td>HOWL_USER</td>
1.305 bacon 11948: </tr>
11949: <tr>
1.313 leot 11950: <td>ICCBASE</td>
1.312 gdt 11951: <td>ICECAST_CHROOTDIR</td>
1.269 leot 11952: </tr>
11953: <tr>
1.313 leot 11954: <td>ICON_THEMES</td>
1.312 gdt 11955: <td>IDOBASE</td>
1.269 leot 11956: </tr>
11957: <tr>
1.313 leot 11958: <td>IGNORE_CCACHE</td>
1.312 gdt 11959: <td>IGNORE_INFO_DIRS</td>
1.269 leot 11960: </tr>
11961: <tr>
1.313 leot 11962: <td>IGNORE_INTERACTIVE_FETCH</td>
1.312 gdt 11963: <td>IMAKE</td>
1.269 leot 11964: </tr>
11965: <tr>
1.313 leot 11966: <td>IMAKEOPTS</td>
1.312 gdt 11967: <td>IMAKE_MAKE</td>
1.269 leot 11968: </tr>
11969: <tr>
1.313 leot 11970: <td>IMAKE_MANINSTALL</td>
1.312 gdt 11971: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.269 leot 11972: </tr>
11973: <tr>
1.313 leot 11974: <td>IMDICTDIR</td>
1.312 gdt 11975: <td>INCOMPAT_CURSES</td>
1.269 leot 11976: </tr>
11977: <tr>
1.313 leot 11978: <td>INFO_DIR</td>
1.312 gdt 11979: <td>INFO_FILES</td>
1.269 leot 11980: </tr>
11981: <tr>
1.313 leot 11982: <td>INFO_FILES_VERBOSE</td>
1.312 gdt 11983: <td>INFO_MSG</td>
1.269 leot 11984: </tr>
11985: <tr>
1.313 leot 11986: <td>INIT_SYSTEM</td>
1.312 gdt 11987: <td>INN_DATA_DIR</td>
1.287 rillig 11988: </tr>
11989: <tr>
1.313 leot 11990: <td>INN_GROUP</td>
1.312 gdt 11991: <td>INN_USER</td>
1.269 leot 11992: </tr>
11993: <tr>
1.313 leot 11994: <td>INSTALLATION_DIRS</td>
1.312 gdt 11995: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.269 leot 11996: </tr>
11997: <tr>
1.313 leot 11998: <td>INSTALL_ENV</td>
1.312 gdt 11999: <td>INSTALL_SH_OVERRIDE</td>
1.269 leot 12000: </tr>
12001: <tr>
1.313 leot 12002: <td>INSTALL_SRC</td>
1.312 gdt 12003: <td>INSTALL_TEMPLATES</td>
1.269 leot 12004: </tr>
12005: <tr>
1.313 leot 12006: <td>INSTALL_UNSTRIPPED</td>
1.312 gdt 12007: <td>IRCD_HYBRID_IRC_GROUP</td>
1.269 leot 12008: </tr>
12009: <tr>
1.313 leot 12010: <td>IRCD_HYBRID_IRC_USER</td>
1.312 gdt 12011: <td>IRCD_HYBRID_MAXCONN</td>
1.269 leot 12012: </tr>
12013: <tr>
1.313 leot 12014: <td>IRCD_HYBRID_NICLEN</td>
1.312 gdt 12015: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.269 leot 12016: </tr>
12017: <tr>
1.313 leot 12018: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.312 gdt 12019: <td>IRCD_HYBRID_TOPICLEN</td>
1.269 leot 12020: </tr>
12021: <tr>
1.313 leot 12022: <td>IRIX</td>
1.312 gdt 12023: <td>IRRD_USE_PGP</td>
1.269 leot 12024: </tr>
12025: <tr>
1.313 leot 12026: <td>JABBERD_GROUP</td>
1.312 gdt 12027: <td>JABBERD_LOGDIR</td>
1.269 leot 12028: </tr>
12029: <tr>
1.313 leot 12030: <td>JABBERD_PIDDIR</td>
1.312 gdt 12031: <td>JABBERD_SPOOLDIR</td>
1.292 leot 12032: </tr>
12033: <tr>
1.313 leot 12034: <td>JABBERD_USER</td>
1.312 gdt 12035: <td>JAKARTA_HOME</td>
1.311 leot 12036: </tr>
12037: <tr>
1.313 leot 12038: <td>JAVA_APP_PATH</td>
1.312 gdt 12039: <td>JAVA_APP_TARGETS</td>
1.269 leot 12040: </tr>
12041: <tr>
1.313 leot 12042: <td>JAVA_BINPREFIX</td>
1.312 gdt 12043: <td>JAVA_CLASSPATH</td>
1.269 leot 12044: </tr>
12045: <tr>
1.313 leot 12046: <td>JAVA_HOME</td>
1.312 gdt 12047: <td>JAVA_LD_LIBRARY_PATH</td>
1.269 leot 12048: </tr>
12049: <tr>
1.313 leot 12050: <td>JAVA_NAME</td>
1.312 gdt 12051: <td>JAVA_UNLIMIT</td>
1.269 leot 12052: </tr>
12053: <tr>
1.313 leot 12054: <td>JAVA_WRAPPERS</td>
1.312 gdt 12055: <td>JPEG_ACCEPTED</td>
1.269 leot 12056: </tr>
12057: <tr>
1.313 leot 12058: <td>JPEG_DEFAULT</td>
1.312 gdt 12059: <td>KERBEROS</td>
1.269 leot 12060: </tr>
12061: <tr>
1.313 leot 12062: <td>KERMIT_SUID_UUCP</td>
1.312 gdt 12063: <td>KJS_USE_PCRE</td>
1.269 leot 12064: </tr>
12065: <tr>
1.313 leot 12066: <td>KNEWS_DOMAIN_FILE</td>
1.312 gdt 12067: <td>KNEWS_DOMAIN_NAME</td>
1.292 leot 12068: </tr>
12069: <tr>
1.313 leot 12070: <td>KRB5_ACCEPTED</td>
1.312 gdt 12071: <td>KRB5_DEFAULT</td>
1.271 brook 12072: </tr>
12073: <tr>
1.313 leot 12074: <td>LANGUAGES</td>
1.312 gdt 12075: <td>LAPACK_LIBS</td>
1.269 leot 12076: </tr>
12077: <tr>
1.313 leot 12078: <td>LATEX2HTML_ICONPATH</td>
1.312 gdt 12079: <td>LDCONFIG_ADD_CMD</td>
1.269 leot 12080: </tr>
12081: <tr>
1.313 leot 12082: <td>LDCONFIG_REMOVE_CMD</td>
1.312 gdt 12083: <td>LEAFNODE_DATA_DIR</td>
1.269 leot 12084: </tr>
12085: <tr>
1.313 leot 12086: <td>LEAFNODE_GROUP</td>
1.312 gdt 12087: <td>LEAFNODE_USER</td>
1.269 leot 12088: </tr>
12089: <tr>
1.313 leot 12090: <td>LIBDVDCSS_HOMEPAGE</td>
1.312 gdt 12091: <td>LIBDVDCSS_MASTER_SITES</td>
1.270 leot 12092: </tr>
12093: <tr>
1.313 leot 12094: <td>LIBRSVG_TYPE</td>
1.312 gdt 12095: <td>LIBTOOL</td>
1.269 leot 12096: </tr>
12097: <tr>
1.313 leot 12098: <td>LIBTOOLIZE_PLIST</td>
1.312 gdt 12099: <td>LIBTOOL_M4_OVERRIDE</td>
1.292 leot 12100: </tr>
12101: <tr>
1.313 leot 12102: <td>LIBUSB_TYPE</td>
1.312 gdt 12103: <td>LICENSE</td>
1.269 leot 12104: </tr>
12105: <tr>
1.313 leot 12106: <td>LINKER_RPATH_FLAG</td>
1.312 gdt 12107: <td>LINK_RPATH_FLAG</td>
1.311 leot 12108: </tr>
12109: <tr>
1.313 leot 12110: <td>LINUX_BASE_NODEPS</td>
1.312 gdt 12111: <td>LINUX_BASE_PREFERRED</td>
1.311 leot 12112: </tr>
12113: <tr>
1.313 leot 12114: <td>LINUX_BASE_REQUIRED</td>
1.312 gdt 12115: <td>LINUX_LOCALES</td>
1.269 leot 12116: </tr>
12117: <tr>
1.313 leot 12118: <td>LOCALBASE</td>
1.312 gdt 12119: <td>LOCALBASE_LOCKTYPE</td>
1.269 leot 12120: </tr>
12121: <tr>
1.313 leot 12122: <td>LOCALPATCHES</td>
1.312 gdt 12123: <td>LOVE_DATA</td>
1.269 leot 12124: </tr>
12125: <tr>
1.313 leot 12126: <td>LOVE_GAME</td>
1.312 gdt 12127: <td>LOVE_VERSION</td>
1.269 leot 12128: </tr>
12129: <tr>
1.313 leot 12130: <td>LP64PLATFORMS</td>
1.312 gdt 12131: <td>MACHINE_PLATFORM</td>
1.269 leot 12132: </tr>
12133: <tr>
1.313 leot 12134: <td>MAILAGENT_DOMAIN</td>
1.312 gdt 12135: <td>MAILAGENT_EMAIL</td>
1.269 leot 12136: </tr>
12137: <tr>
1.313 leot 12138: <td>MAILAGENT_FQDN</td>
1.312 gdt 12139: <td>MAILAGENT_ORGANIZATION</td>
1.269 leot 12140: </tr>
12141: <tr>
1.313 leot 12142: <td>MAJORDOMO_HOMEDIR</td>
1.312 gdt 12143: <td>MAJOR_OS_VERSION</td>
1.269 leot 12144: </tr>
12145: <tr>
1.313 leot 12146: <td>MAKEINFO_ARGS</td>
1.312 gdt 12147: <td>MAKE_DIRS</td>
1.269 leot 12148: </tr>
12149: <tr>
1.313 leot 12150: <td>MAKE_DIRS_PERMS</td>
1.312 gdt 12151: <td>MAKE_ENV</td>
1.269 leot 12152: </tr>
12153: <tr>
1.313 leot 12154: <td>MAKE_FILE</td>
1.312 gdt 12155: <td>MAKE_FLAGS</td>
1.269 leot 12156: </tr>
12157: <tr>
1.313 leot 12158: <td>MAKE_JOBS</td>
1.312 gdt 12159: <td>MAKE_JOBS_SAFE</td>
1.269 leot 12160: </tr>
12161: <tr>
1.313 leot 12162: <td>MAKE_PROGRAM</td>
1.312 gdt 12163: <td>MANCOMPRESSED_IF_MANZ</td>
1.303 bacon 12164: </tr>
12165: <tr>
1.313 leot 12166: <td>MANINSTALL</td>
1.312 gdt 12167: <td>MANZ</td>
1.269 leot 12168: </tr>
12169: <tr>
1.313 leot 12170: <td>MASTER_SITES</td>
1.312 gdt 12171: <td>MASTER_SITE_BACKUP</td>
1.269 leot 12172: </tr>
12173: <tr>
1.313 leot 12174: <td>MASTER_SITE_LOCAL</td>
1.312 gdt 12175: <td>MASTER_SITE_MOZILLA</td>
1.269 leot 12176: </tr>
12177: <tr>
1.313 leot 12178: <td>MASTER_SITE_OVERRIDE</td>
1.312 gdt 12179: <td>MASTER_SITE_PERL_CPAN</td>
1.269 leot 12180: </tr>
12181: <tr>
1.313 leot 12182: <td>MASTER_SORT</td>
1.312 gdt 12183: <td>MASTER_SORT_RANDOM</td>
1.269 leot 12184: </tr>
12185: <tr>
1.313 leot 12186: <td>MASTER_SORT_REGEX</td>
1.312 gdt 12187: <td>MECAB_CHARSET</td>
1.269 leot 12188: </tr>
12189: <tr>
1.313 leot 12190: <td>MEDIATOMB_GROUP</td>
1.312 gdt 12191: <td>MEDIATOMB_USER</td>
1.269 leot 12192: </tr>
12193: <tr>
1.313 leot 12194: <td>MIPSPROBASE</td>
1.312 gdt 12195: <td>MIREDO_GROUP</td>
1.269 leot 12196: </tr>
12197: <tr>
1.313 leot 12198: <td>MIREDO_USER</td>
1.312 gdt 12199: <td>MISSING_FEATURES</td>
1.269 leot 12200: </tr>
12201: <tr>
1.313 leot 12202: <td>MKDIR</td>
1.312 gdt 12203: <td>MLDONKEY_GROUP</td>
1.269 leot 12204: </tr>
12205: <tr>
1.313 leot 12206: <td>MLDONKEY_HOME</td>
1.312 gdt 12207: <td>MLDONKEY_USER</td>
1.269 leot 12208: </tr>
12209: <tr>
1.313 leot 12210: <td>MONOTONE_GROUP</td>
1.312 gdt 12211: <td>MONOTONE_USER</td>
1.269 leot 12212: </tr>
12213: <tr>
1.313 leot 12214: <td>MOTIFBASE</td>
1.312 gdt 12215: <td>MOTIF_TYPE</td>
1.269 leot 12216: </tr>
12217: <tr>
1.313 leot 12218: <td>MOTIF_TYPE_DEFAULT</td>
1.312 gdt 12219: <td>MPI_TYPE</td>
1.269 leot 12220: </tr>
12221: <tr>
1.313 leot 12222: <td>MSGFMT_STRIP_MSGCTXT</td>
1.312 gdt 12223: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.311 leot 12224: </tr>
12225: <tr>
1.313 leot 12226: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.312 gdt 12227: <td>MUST</td>
1.269 leot 12228: </tr>
12229: <tr>
1.313 leot 12230: <td>MV</td>
1.312 gdt 12231: <td>MYSQL_CHARSET</td>
1.269 leot 12232: </tr>
12233: <tr>
1.313 leot 12234: <td>MYSQL_DATADIR</td>
1.312 gdt 12235: <td>MYSQL_EXTRA_CHARSET</td>
1.269 leot 12236: </tr>
12237: <tr>
1.313 leot 12238: <td>MYSQL_GROUP</td>
1.312 gdt 12239: <td>MYSQL_PKGSRCDIR</td>
1.269 leot 12240: </tr>
12241: <tr>
1.313 leot 12242: <td>MYSQL_USER</td>
1.312 gdt 12243: <td>MYSQL_VERSION</td>
1.309 gutterid 12244: </tr>
12245: <tr>
1.313 leot 12246: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.312 gdt 12247: <td>MYSQL_VERSION_DEFAULT</td>
1.269 leot 12248: </tr>
12249: <tr>
1.313 leot 12250: <td>NAGIOSCMD_GROUP</td>
1.312 gdt 12251: <td>NAGIOSDIR</td>
1.269 leot 12252: </tr>
12253: <tr>
1.313 leot 12254: <td>NAGIOS_GROUP</td>
1.312 gdt 12255: <td>NAGIOS_USER</td>
1.269 leot 12256: </tr>
12257: <tr>
1.313 leot 12258: <td>NATIVE_APPEND_ABI</td>
1.312 gdt 12259: <td>NATIVE_APPEND_ELF</td>
1.269 leot 12260: </tr>
12261: <tr>
1.313 leot 12262: <td>NATIVE_EXEC_FMT</td>
1.312 gdt 12263: <td>NATIVE_MACHINE_PLATFORM</td>
1.269 leot 12264: </tr>
12265: <tr>
1.313 leot 12266: <td>NATIVE_OBJECT_FMT</td>
1.312 gdt 12267: <td>NBPAX_PROGRAM_PREFIX</td>
1.269 leot 12268: </tr>
12269: <tr>
1.313 leot 12270: <td>NETBSD_LOGIN_NAME</td>
1.312 gdt 12271: <td>NMH_EDITOR</td>
1.293 rillig 12272: </tr>
12273: <tr>
1.313 leot 12274: <td>NMH_MTA</td>
1.312 gdt 12275: <td>NMH_PAGER</td>
1.269 leot 12276: </tr>
12277: <tr>
1.313 leot 12278: <td>NOLOGIN</td>
1.312 gdt 12279: <td>NOTE</td>
1.269 leot 12280: </tr>
12281: <tr>
1.313 leot 12282: <td>NOT_FOR_PLATFORM</td>
1.312 gdt 12283: <td>NOT_PAX_ASLR_SAFE</td>
1.269 leot 12284: </tr>
12285: <tr>
1.313 leot 12286: <td>NOT_PAX_MPROTECT_SAFE</td>
1.312 gdt 12287: <td>NO_BUILD</td>
1.269 leot 12288: </tr>
12289: <tr>
1.313 leot 12290: <td>NO_CHECKSUM</td>
1.312 gdt 12291: <td>NO_CONFIGURE</td>
1.269 leot 12292: </tr>
12293: <tr>
1.313 leot 12294: <td>NO_SKIP</td>
1.312 gdt 12295: <td>NS_PREFERRED</td>
1.269 leot 12296: </tr>
12297: <tr>
1.313 leot 12298: <td>NULLMAILER_GROUP</td>
1.312 gdt 12299: <td>NULLMAILER_USER</td>
1.269 leot 12300: </tr>
12301: <tr>
1.313 leot 12302: <td>OASIS</td>
1.312 gdt 12303: <td>OASIS_BUILD_ARGS</td>
1.269 leot 12304: </tr>
12305: <tr>
1.313 leot 12306: <td>OBJHOSTNAME</td>
1.312 gdt 12307: <td>OBJMACHINE</td>
1.269 leot 12308: </tr>
12309: <tr>
1.313 leot 12310: <td>OCAML_FINDLIB_DIRS</td>
1.312 gdt 12311: <td>OCAML_FINDLIB_REGISTER</td>
1.269 leot 12312: </tr>
12313: <tr>
1.313 leot 12314: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.312 gdt 12315: <td>OCAML_SITELIBDIR</td>
1.269 leot 12316: </tr>
12317: <tr>
1.313 leot 12318: <td>OCAML_TOPKG_DOCDIR</td>
1.312 gdt 12319: <td>OCAML_USE_DUNE</td>
1.269 leot 12320: </tr>
12321: <tr>
1.313 leot 12322: <td>OCAML_USE_FINDLIB</td>
1.312 gdt 12323: <td>OCAML_USE_JBUILDER</td>
1.269 leot 12324: </tr>
12325: <tr>
1.313 leot 12326: <td>OCAML_USE_OASIS</td>
1.312 gdt 12327: <td>OCAML_USE_OASIS_DYNRUN</td>
1.269 leot 12328: </tr>
12329: <tr>
1.313 leot 12330: <td>OCAML_USE_OPAM</td>
1.312 gdt 12331: <td>OCAML_USE_OPT_COMPILER</td>
1.269 leot 12332: </tr>
12333: <tr>
1.313 leot 12334: <td>OCAML_USE_TOPKG</td>
1.312 gdt 12335: <td>OMF</td>
1.269 leot 12336: </tr>
12337: <tr>
1.313 leot 12338: <td>ONLY_FOR_COMPILER</td>
1.312 gdt 12339: <td>ONLY_FOR_PLATFORM</td>
1.269 leot 12340: </tr>
12341: <tr>
1.313 leot 12342: <td>OPENSSH_CHROOT</td>
1.312 gdt 12343: <td>OPENSSH_GROUP</td>
1.269 leot 12344: </tr>
12345: <tr>
1.313 leot 12346: <td>OPENSSH_USER</td>
1.312 gdt 12347: <td>OPSYS</td>
1.269 leot 12348: </tr>
12349: <tr>
1.313 leot 12350: <td>OPSYS_EMULDIR</td>
1.312 gdt 12351: <td>OS</td>
12352: </tr>
12353: <tr>
1.313 leot 12354: <td>OSS_TYPE</td>
1.311 leot 12355: <td>OSX</td>
1.269 leot 12356: </tr>
12357: <tr>
1.313 leot 12358: <td>OSX_TOLERATE_SDK_SKEW</td>
1.311 leot 12359: <td>OS_HAVE_ALSA</td>
1.292 leot 12360: </tr>
12361: <tr>
1.313 leot 12362: <td>OS_HAVE_RCD</td>
1.309 gutterid 12363: <td>OS_VARIANT</td>
1.311 leot 12364: </tr>
12365: <tr>
1.313 leot 12366: <td>OS_VERSION</td>
1.311 leot 12367: <td>OTF_FONTS_DIR</td>
1.269 leot 12368: </tr>
12369: <tr>
1.313 leot 12370: <td>OVERRIDE_DIRDEPTH</td>
1.311 leot 12371: <td>OVERRIDE_GEMSPEC</td>
1.269 leot 12372: </tr>
12373: <tr>
1.313 leot 12374: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.311 leot 12375: <td>OVERRIDE_ROCKSPEC</td>
1.269 leot 12376: </tr>
12377: <tr>
1.313 leot 12378: <td>OWN_DIRS</td>
1.309 gutterid 12379: <td>OWN_DIRS_PERMS</td>
1.269 leot 12380: </tr>
12381: <tr>
1.313 leot 12382: <td>P4GROUP</td>
1.309 gutterid 12383: <td>P4PORT</td>
1.269 leot 12384: </tr>
12385: <tr>
1.313 leot 12386: <td>P4ROOT</td>
1.309 gutterid 12387: <td>P4USER</td>
1.269 leot 12388: </tr>
12389: <tr>
1.313 leot 12390: <td>PACKAGES</td>
1.309 gutterid 12391: <td>PALMOS_DEFAULT_SDK</td>
1.269 leot 12392: </tr>
12393: <tr>
1.313 leot 12394: <td>PAMBASE</td>
1.309 gutterid 12395: <td>PAM_DEFAULT</td>
1.269 leot 12396: </tr>
12397: <tr>
1.313 leot 12398: <td>PAPERSIZE</td>
1.309 gutterid 12399: <td>PASSIVE_FETCH</td>
1.269 leot 12400: </tr>
12401: <tr>
1.313 leot 12402: <td>PATCHDIR</td>
1.309 gutterid 12403: <td>PATCHFILES</td>
1.269 leot 12404: </tr>
12405: <tr>
1.313 leot 12406: <td>PATCH_ARGS</td>
1.309 gutterid 12407: <td>PATCH_DEBUG</td>
1.269 leot 12408: </tr>
12409: <tr>
1.313 leot 12410: <td>PATCH_DIST_ARGS</td>
1.309 gutterid 12411: <td>PATCH_DIST_CAT</td>
1.284 rillig 12412: </tr>
12413: <tr>
1.313 leot 12414: <td>PATCH_DIST_STRIP</td>
1.309 gutterid 12415: <td>PATCH_FUZZ_FACTOR</td>
1.269 leot 12416: </tr>
12417: <tr>
1.313 leot 12418: <td>PATCH_STRIP</td>
1.309 gutterid 12419: <td>PATH</td>
1.269 leot 12420: </tr>
12421: <tr>
1.313 leot 12422: <td>PCCBASE</td>
1.311 leot 12423: <td>PEAR</td>
12424: </tr>
12425: <tr>
1.313 leot 12426: <td>PEAR_CHANNEL</td>
1.311 leot 12427: <td>PEAR_CHANNEL_ALIAS</td>
12428: </tr>
12429: <tr>
1.313 leot 12430: <td>PEAR_CHANNEL_VERSION</td>
1.309 gutterid 12431: <td>PEAR_CMD</td>
1.292 leot 12432: </tr>
12433: <tr>
1.313 leot 12434: <td>PEAR_LIB</td>
1.309 gutterid 12435: <td>PEAR_PACKAGE_XML</td>
1.274 rillig 12436: </tr>
12437: <tr>
1.313 leot 12438: <td>PERL5</td>
1.309 gutterid 12439: <td>PERL5_CONFIGURE</td>
1.274 rillig 12440: </tr>
12441: <tr>
1.313 leot 12442: <td>PERL5_CONFIGURE_DIRS</td>
1.309 gutterid 12443: <td>PERL5_LDFLAGS</td>
1.269 leot 12444: </tr>
12445: <tr>
1.313 leot 12446: <td>PERL5_LICENSE</td>
1.309 gutterid 12447: <td>PERL5_MODULE_TYPE</td>
1.269 leot 12448: </tr>
12449: <tr>
1.313 leot 12450: <td>PERL5_PACKLIST</td>
1.309 gutterid 12451: <td>PERL5_PACKLIST_DIR</td>
1.269 leot 12452: </tr>
12453: <tr>
1.313 leot 12454: <td>PERL5_PERLBASE</td>
1.309 gutterid 12455: <td>PERL5_SITEBASE</td>
1.269 leot 12456: </tr>
12457: <tr>
1.313 leot 12458: <td>PERL5_USE_PACKLIST</td>
1.309 gutterid 12459: <td>PERL5_VENDORBASE</td>
1.269 leot 12460: </tr>
12461: <tr>
1.313 leot 12462: <td>PFCTL</td>
1.309 gutterid 12463: <td>PFVAR_H</td>
1.269 leot 12464: </tr>
12465: <tr>
1.313 leot 12466: <td>PF_VERSION</td>
1.309 gutterid 12467: <td>PGGROUP</td>
1.269 leot 12468: </tr>
12469: <tr>
1.313 leot 12470: <td>PGHOME</td>
1.309 gutterid 12471: <td>PGPKGSRCDIR</td>
1.269 leot 12472: </tr>
12473: <tr>
1.313 leot 12474: <td>PGSQL_TYPE</td>
1.309 gutterid 12475: <td>PGSQL_VERSION</td>
1.269 leot 12476: </tr>
12477: <tr>
1.313 leot 12478: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.305 bacon 12479: <td>PGSQL_VERSION_DEFAULT</td>
1.269 leot 12480: </tr>
12481: <tr>
1.313 leot 12482: <td>PGUSER</td>
1.305 bacon 12483: <td>PG_LIB_EXT</td>
1.269 leot 12484: </tr>
12485: <tr>
1.313 leot 12486: <td>PHP</td>
1.305 bacon 12487: <td>PHPCOMMON_MK</td>
1.269 leot 12488: </tr>
12489: <tr>
1.313 leot 12490: <td>PHPPKGSRCDIR</td>
1.305 bacon 12491: <td>PHP_BASE_VERS</td>
1.269 leot 12492: </tr>
12493: <tr>
1.313 leot 12494: <td>PHP_CHECK_INSTALLED</td>
1.305 bacon 12495: <td>PHP_EXTENSION_DIR</td>
1.269 leot 12496: </tr>
12497: <tr>
1.313 leot 12498: <td>PHP_INITIAL_TEENY</td>
1.305 bacon 12499: <td>PHP_PKG_PREFIX</td>
1.269 leot 12500: </tr>
12501: <tr>
1.313 leot 12502: <td>PHP_VERSION</td>
1.305 bacon 12503: <td>PHP_VERSIONS_ACCEPTED</td>
1.269 leot 12504: </tr>
12505: <tr>
1.313 leot 12506: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.305 bacon 12507: <td>PHP_VERSION_DEFAULT</td>
1.269 leot 12508: </tr>
12509: <tr>
1.313 leot 12510: <td>PHP_VERSION_REQD</td>
1.305 bacon 12511: <td>PILRC_USE_GTK</td>
1.269 leot 12512: </tr>
12513: <tr>
1.313 leot 12514: <td>PKGCONFIG_BASE</td>
1.305 bacon 12515: <td>PKGCONFIG_FILE</td>
1.269 leot 12516: </tr>
12517: <tr>
1.313 leot 12518: <td>PKGCONFIG_OVERRIDE</td>
1.305 bacon 12519: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.269 leot 12520: </tr>
12521: <tr>
1.313 leot 12522: <td>PKGDIR</td>
1.305 bacon 12523: <td>PKGGNUDIR</td>
1.269 leot 12524: </tr>
12525: <tr>
1.313 leot 12526: <td>PKGINFODIR</td>
1.305 bacon 12527: <td>PKGLOCALEDIR</td>
1.269 leot 12528: </tr>
12529: <tr>
1.313 leot 12530: <td>PKGMANDIR</td>
1.305 bacon 12531: <td>PKGNAME</td>
1.269 leot 12532: </tr>
12533: <tr>
1.313 leot 12534: <td>PKGNAME_REQD</td>
1.305 bacon 12535: <td>PKGPATH</td>
1.269 leot 12536: </tr>
12537: <tr>
1.313 leot 12538: <td>PKGREVISION</td>
1.305 bacon 12539: <td>PKGSRC_BLAS_TYPES</td>
1.292 leot 12540: </tr>
12541: <tr>
1.313 leot 12542: <td>PKGSRC_CHANGES</td>
1.305 bacon 12543: <td>PKGSRC_COMPILER</td>
1.269 leot 12544: </tr>
12545: <tr>
1.313 leot 12546: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.305 bacon 12547: <td>PKGSRC_LOCKTYPE</td>
1.274 rillig 12548: </tr>
12549: <tr>
1.313 leot 12550: <td>PKGSRC_MAKE_ENV</td>
1.305 bacon 12551: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.269 leot 12552: </tr>
12553: <tr>
1.313 leot 12554: <td>PKGSRC_MKPIE</td>
1.305 bacon 12555: <td>PKGSRC_MKREPRO</td>
1.269 leot 12556: </tr>
12557: <tr>
1.313 leot 12558: <td>PKGSRC_RUN_TEST</td>
1.305 bacon 12559: <td>PKGSRC_SETENV</td>
1.269 leot 12560: </tr>
12561: <tr>
1.313 leot 12562: <td>PKGSRC_SLEEPSECS</td>
1.305 bacon 12563: <td>PKGSRC_TODO</td>
1.269 leot 12564: </tr>
12565: <tr>
1.313 leot 12566: <td>PKGSRC_USE_CTF</td>
1.305 bacon 12567: <td>PKGSRC_USE_FORTIFY</td>
1.269 leot 12568: </tr>
12569: <tr>
1.313 leot 12570: <td>PKGSRC_USE_RELRO</td>
1.305 bacon 12571: <td>PKGSRC_USE_SSP</td>
1.269 leot 12572: </tr>
12573: <tr>
1.313 leot 12574: <td>PKGSRC_USE_STACK_CHECK</td>
1.305 bacon 12575: <td>PKGTASKS_DATAFILE</td>
1.269 leot 12576: </tr>
12577: <tr>
1.313 leot 12578: <td>PKGTOOLS_ARGS</td>
1.305 bacon 12579: <td>PKGTOOLS_ENV</td>
1.269 leot 12580: </tr>
12581: <tr>
1.313 leot 12582: <td>PKG_ALTERNATIVES</td>
1.305 bacon 12583: <td>PKG_APACHE</td>
1.269 leot 12584: </tr>
12585: <tr>
1.313 leot 12586: <td>PKG_APACHE_ACCEPTED</td>
1.305 bacon 12587: <td>PKG_APACHE_DEFAULT</td>
1.269 leot 12588: </tr>
12589: <tr>
1.313 leot 12590: <td>PKG_BEST_EXISTS</td>
1.305 bacon 12591: <td>PKG_BUILD_OPTIONS</td>
1.269 leot 12592: </tr>
12593: <tr>
1.313 leot 12594: <td>PKG_COMPRESSION</td>
1.305 bacon 12595: <td>PKG_CONFIG</td>
1.269 leot 12596: </tr>
12597: <tr>
1.313 leot 12598: <td>PKG_CONFIG_PERMS</td>
1.305 bacon 12599: <td>PKG_CREATE_USERGROUP</td>
1.269 leot 12600: </tr>
12601: <tr>
1.313 leot 12602: <td>PKG_DB_TMPDIR</td>
1.305 bacon 12603: <td>PKG_DEBUG_LEVEL</td>
1.269 leot 12604: </tr>
12605: <tr>
1.313 leot 12606: <td>PKG_DEFAULT_OPTIONS</td>
1.305 bacon 12607: <td>PKG_DESTDIR_SUPPORT</td>
1.269 leot 12608: </tr>
12609: <tr>
1.313 leot 12610: <td>PKG_DEVELOPER</td>
1.305 bacon 12611: <td>PKG_DISABLED_OPTIONS</td>
1.269 leot 12612: </tr>
12613: <tr>
1.313 leot 12614: <td>PKG_FATAL_ERRORS</td>
1.305 bacon 12615: <td>PKG_FC</td>
1.269 leot 12616: </tr>
12617: <tr>
1.313 leot 12618: <td>PKG_FILELIST_CMD</td>
1.305 bacon 12619: <td>PKG_GECOS</td>
1.269 leot 12620: </tr>
12621: <tr>
1.313 leot 12622: <td>PKG_GID</td>
1.305 bacon 12623: <td>PKG_GROUPS</td>
1.269 leot 12624: </tr>
12625: <tr>
1.313 leot 12626: <td>PKG_GROUPS_VARS</td>
1.305 bacon 12627: <td>PKG_HOME</td>
1.269 leot 12628: </tr>
12629: <tr>
1.313 leot 12630: <td>PKG_INIT_SCRIPTS</td>
1.305 bacon 12631: <td>PKG_JAVA_HOME</td>
1.269 leot 12632: </tr>
12633: <tr>
1.313 leot 12634: <td>PKG_JVM</td>
1.305 bacon 12635: <td>PKG_JVMS_ACCEPTED</td>
1.269 leot 12636: </tr>
12637: <tr>
1.313 leot 12638: <td>PKG_JVM_DEFAULT</td>
1.305 bacon 12639: <td>PKG_LEGACY_OPTIONS</td>
1.269 leot 12640: </tr>
12641: <tr>
1.313 leot 12642: <td>PKG_LIBTOOL</td>
1.305 bacon 12643: <td>PKG_OPTIONS</td>
1.269 leot 12644: </tr>
12645: <tr>
1.313 leot 12646: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.305 bacon 12647: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.269 leot 12648: </tr>
12649: <tr>
1.313 leot 12650: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.305 bacon 12651: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.269 leot 12652: </tr>
12653: <tr>
1.313 leot 12654: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.305 bacon 12655: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.269 leot 12656: </tr>
12657: <tr>
1.313 leot 12658: <td>PKG_OPTIONS_VAR</td>
1.305 bacon 12659: <td>PKG_PHP</td>
1.269 leot 12660: </tr>
12661: <tr>
1.313 leot 12662: <td>PKG_PHP_MAJOR_VERS</td>
1.305 bacon 12663: <td>PKG_PHP_VERSION</td>
1.269 leot 12664: </tr>
12665: <tr>
1.313 leot 12666: <td>PKG_RCD_SCRIPTS</td>
1.305 bacon 12667: <td>PKG_REFCOUNT_DBDIR</td>
1.269 leot 12668: </tr>
12669: <tr>
1.313 leot 12670: <td>PKG_REGISTER_SHELLS</td>
1.305 bacon 12671: <td>PKG_RESUME_TRANSFERS</td>
1.269 leot 12672: </tr>
12673: <tr>
1.313 leot 12674: <td>PKG_SHELL</td>
1.305 bacon 12675: <td>PKG_SUGGESTED_OPTIONS</td>
1.269 leot 12676: </tr>
12677: <tr>
1.313 leot 12678: <td>PKG_SUPPORTED_OPTIONS</td>
1.305 bacon 12679: <td>PKG_SYSCONFBASE</td>
1.269 leot 12680: </tr>
12681: <tr>
1.313 leot 12682: <td>PKG_SYSCONFBASEDIR</td>
1.305 bacon 12683: <td>PKG_SYSCONFDIR</td>
1.269 leot 12684: </tr>
12685: <tr>
1.313 leot 12686: <td>PKG_SYSCONFDIR_PERMS</td>
1.305 bacon 12687: <td>PKG_SYSCONFSUBDIR</td>
1.269 leot 12688: </tr>
12689: <tr>
1.313 leot 12690: <td>PKG_SYSCONFVAR</td>
1.305 bacon 12691: <td>PKG_TOOLS_BIN</td>
1.269 leot 12692: </tr>
12693: <tr>
1.313 leot 12694: <td>PKG_UID</td>
1.305 bacon 12695: <td>PKG_UPDATE_FONTS_DB</td>
1.269 leot 12696: </tr>
12697: <tr>
1.313 leot 12698: <td>PKG_USERS</td>
1.305 bacon 12699: <td>PKG_USERS_VARS</td>
1.269 leot 12700: </tr>
12701: <tr>
1.313 leot 12702: <td>PKG_VERBOSE</td>
1.305 bacon 12703: <td>PLIST</td>
1.269 leot 12704: </tr>
12705: <tr>
1.313 leot 12706: <td>PLIST_AWK</td>
1.305 bacon 12707: <td>PLIST_AWK_ENV</td>
1.269 leot 12708: </tr>
12709: <tr>
1.313 leot 12710: <td>PLIST_SRC</td>
1.305 bacon 12711: <td>PLIST_SUBST</td>
1.269 leot 12712: </tr>
12713: <tr>
1.313 leot 12714: <td>PLIST_TYPE</td>
1.305 bacon 12715: <td>PLIST_VARS</td>
1.269 leot 12716: </tr>
12717: <tr>
1.313 leot 12718: <td>POPTOP_USE_MPPE</td>
1.305 bacon 12719: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.269 leot 12720: </tr>
12721: <tr>
1.313 leot 12722: <td>POST_FETCH_HOOK</td>
1.305 bacon 12723: <td>PREFER</td>
1.269 leot 12724: </tr>
12725: <tr>
1.313 leot 12726: <td>PREFER_NATIVE</td>
1.305 bacon 12727: <td>PREFER_NATIVE_PTHREADS</td>
1.269 leot 12728: </tr>
12729: <tr>
1.313 leot 12730: <td>PREFER_PKGSRC</td>
1.305 bacon 12731: <td>PREFIX</td>
1.269 leot 12732: </tr>
12733: <tr>
1.313 leot 12734: <td>PREPEND_PATH</td>
1.305 bacon 12735: <td>PRE_ROOT_CMD</td>
1.269 leot 12736: </tr>
12737: <tr>
1.313 leot 12738: <td>PRIVILEGED_STAGES</td>
1.305 bacon 12739: <td>PS</td>
1.269 leot 12740: </tr>
12741: <tr>
1.313 leot 12742: <td>PTHREAD_AUTO_VARS</td>
1.305 bacon 12743: <td>PTHREAD_CFLAGS</td>
1.269 leot 12744: </tr>
12745: <tr>
1.313 leot 12746: <td>PTHREAD_LDFLAGS</td>
1.305 bacon 12747: <td>PTHREAD_LIBS</td>
1.269 leot 12748: </tr>
12749: <tr>
1.313 leot 12750: <td>PTHREAD_OPTS</td>
1.305 bacon 12751: <td>PTHREAD_TYPE</td>
1.269 leot 12752: </tr>
12753: <tr>
1.313 leot 12754: <td>PVM_SSH</td>
1.305 bacon 12755: <td>PYPKGPREFIX</td>
1.269 leot 12756: </tr>
12757: <tr>
1.313 leot 12758: <td>PYTHON_FOR_BUILD_ONLY</td>
1.305 bacon 12759: <td>PYTHON_SELF_CONFLICT</td>
1.269 leot 12760: </tr>
12761: <tr>
1.313 leot 12762: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.305 bacon 12763: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.269 leot 12764: </tr>
12765: <tr>
1.313 leot 12766: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.305 bacon 12767: <td>PYTHON_VERSION_DEFAULT</td>
1.269 leot 12768: </tr>
12769: <tr>
1.313 leot 12770: <td>PYTHON_VERSION_REQD</td>
1.305 bacon 12771: <td>PYVERSSUFFIX</td>
1.269 leot 12772: </tr>
12773: <tr>
1.313 leot 12774: <td>PY_NO_EGG</td>
1.305 bacon 12775: <td>QMAILDIR</td>
1.269 leot 12776: </tr>
12777: <tr>
1.313 leot 12778: <td>QMAIL_ALIAS_USER</td>
1.305 bacon 12779: <td>QMAIL_DAEMON_USER</td>
1.269 leot 12780: </tr>
12781: <tr>
1.313 leot 12782: <td>QMAIL_LOG_USER</td>
1.305 bacon 12783: <td>QMAIL_NOFILES_GROUP</td>
1.269 leot 12784: </tr>
12785: <tr>
1.313 leot 12786: <td>QMAIL_PASSWD_USER</td>
1.305 bacon 12787: <td>QMAIL_QMAIL_GROUP</td>
1.269 leot 12788: </tr>
12789: <tr>
1.313 leot 12790: <td>QMAIL_QUEUE_DIR</td>
1.305 bacon 12791: <td>QMAIL_QUEUE_EXTRA</td>
1.269 leot 12792: </tr>
12793: <tr>
1.313 leot 12794: <td>QMAIL_QUEUE_USER</td>
1.305 bacon 12795: <td>QMAIL_REMOTE_USER</td>
1.269 leot 12796: </tr>
12797: <tr>
1.313 leot 12798: <td>QMAIL_ROOT_USER</td>
1.305 bacon 12799: <td>QMAIL_SEND_USER</td>
1.269 leot 12800: </tr>
12801: <tr>
1.313 leot 12802: <td>QPOPPER_FAC</td>
1.305 bacon 12803: <td>QPOPPER_SPOOL_DIR</td>
1.269 leot 12804: </tr>
12805: <tr>
1.313 leot 12806: <td>QPOPPER_USER</td>
1.305 bacon 12807: <td>RAKE_NAME</td>
1.269 leot 12808: </tr>
12809: <tr>
1.313 leot 12810: <td>RASMOL_DEPTH</td>
1.311 leot 12811: <td>RCD_DIR</td>
12812: </tr>
12813: <tr>
1.313 leot 12814: <td>RCD_ORDER</td>
1.305 bacon 12815: <td>RCD_SCRIPTS</td>
1.292 leot 12816: </tr>
12817: <tr>
1.313 leot 12818: <td>RCD_SCRIPTS_DIR</td>
1.305 bacon 12819: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.269 leot 12820: </tr>
12821: <tr>
1.313 leot 12822: <td>RCD_SCRIPTS_MODE</td>
1.305 bacon 12823: <td>RCD_SCRIPTS_SHELL</td>
1.269 leot 12824: </tr>
12825: <tr>
1.313 leot 12826: <td>RCD_SCRIPT_SRC</td>
1.311 leot 12827: <td>RCD_SUBR</td>
12828: </tr>
12829: <tr>
1.313 leot 12830: <td>RDOC</td>
1.311 leot 12831: <td>READLINE_DEFAULT</td>
1.269 leot 12832: </tr>
12833: <tr>
1.313 leot 12834: <td>READLINE_TYPE</td>
1.311 leot 12835: <td>REAL_ROOT_GROUP</td>
1.269 leot 12836: </tr>
12837: <tr>
1.313 leot 12838: <td>REAL_ROOT_USER</td>
1.311 leot 12839: <td>RECURSIVE_MAKE</td>
1.269 leot 12840: </tr>
12841: <tr>
1.313 leot 12842: <td>RELAY_CTRL_DIR</td>
1.311 leot 12843: <td>RELRO_SUPPORTED</td>
1.269 leot 12844: </tr>
12845: <tr>
1.313 leot 12846: <td>REPLACE_AWK</td>
1.311 leot 12847: <td>REPLACE_BASH</td>
1.269 leot 12848: </tr>
12849: <tr>
1.313 leot 12850: <td>REPLACE_CSH</td>
1.311 leot 12851: <td>REPLACE_KSH</td>
1.269 leot 12852: </tr>
12853: <tr>
1.313 leot 12854: <td>REPLACE_PERL</td>
1.311 leot 12855: <td>REPLACE_PERL6</td>
1.269 leot 12856: </tr>
12857: <tr>
1.313 leot 12858: <td>REPLACE_PHP</td>
1.311 leot 12859: <td>REPLACE_PYTHON</td>
1.269 leot 12860: </tr>
12861: <tr>
1.313 leot 12862: <td>REPLACE_RUBY</td>
1.311 leot 12863: <td>REPLACE_RUBY_DIRS</td>
1.281 leot 12864: </tr>
12865: <tr>
1.313 leot 12866: <td>REPLACE_RUBY_PAT</td>
1.311 leot 12867: <td>REPLACE_SH</td>
1.269 leot 12868: </tr>
12869: <tr>
1.313 leot 12870: <td>REPLACE_TEXLUA</td>
1.311 leot 12871: <td>REQD_DIRS</td>
1.269 leot 12872: </tr>
12873: <tr>
1.313 leot 12874: <td>REQD_DIRS_PERMS</td>
1.311 leot 12875: <td>REQD_FILES</td>
1.269 leot 12876: </tr>
12877: <tr>
1.313 leot 12878: <td>REQD_FILES_MODE</td>
1.311 leot 12879: <td>REQD_FILES_PERMS</td>
1.269 leot 12880: </tr>
12881: <tr>
1.313 leot 12882: <td>RESOLV_AUTO_VARS</td>
1.311 leot 12883: <td>RESOLV_LDFLAGS</td>
1.269 leot 12884: </tr>
12885: <tr>
1.313 leot 12886: <td>RESOLV_LIBS</td>
1.311 leot 12887: <td>RM</td>
12888: </tr>
12889: <tr>
1.313 leot 12890: <td>ROCKSPEC_NAME</td>
1.311 leot 12891: <td>ROCKSPEC_SPECFILE</td>
1.269 leot 12892: </tr>
12893: <tr>
1.313 leot 12894: <td>ROOT_CMD</td>
1.311 leot 12895: <td>ROOT_GROUP</td>
1.274 rillig 12896: </tr>
12897: <tr>
1.313 leot 12898: <td>ROOT_USER</td>
1.311 leot 12899: <td>RPCGEN</td>
1.269 leot 12900: </tr>
12901: <tr>
1.313 leot 12902: <td>RPM</td>
1.311 leot 12903: <td>RPM2PKG_PLIST</td>
1.269 leot 12904: </tr>
12905: <tr>
1.313 leot 12906: <td>RPM2PKG_PREFIX</td>
1.311 leot 12907: <td>RPM2PKG_STAGE</td>
1.269 leot 12908: </tr>
12909: <tr>
1.313 leot 12910: <td>RPM2PKG_STRIP</td>
1.311 leot 12911: <td>RPM2PKG_SUBPREFIX</td>
1.269 leot 12912: </tr>
12913: <tr>
1.313 leot 12914: <td>RPMFILES</td>
1.311 leot 12915: <td>RPMIGNOREPATH</td>
1.269 leot 12916: </tr>
12917: <tr>
1.313 leot 12918: <td>RPM_DB_PREFIX</td>
1.311 leot 12919: <td>RSSH_CVS_PATH</td>
1.269 leot 12920: </tr>
12921: <tr>
1.313 leot 12922: <td>RSSH_RDIST_PATH</td>
1.311 leot 12923: <td>RSSH_RSYNC_PATH</td>
1.269 leot 12924: </tr>
12925: <tr>
1.313 leot 12926: <td>RSSH_SCP_PATH</td>
1.311 leot 12927: <td>RSSH_SFTP_SERVER_PATH</td>
1.269 leot 12928: </tr>
12929: <tr>
1.313 leot 12930: <td>RUBY</td>
1.311 leot 12931: <td>RUBYGEM</td>
1.269 leot 12932: </tr>
12933: <tr>
1.313 leot 12934: <td>RUBYGEM_NAME</td>
1.311 leot 12935: <td>RUBYGEM_OPTIONS</td>
1.269 leot 12936: </tr>
12937: <tr>
1.313 leot 12938: <td>RUBYGEM_VERBOSE</td>
1.306 kim 12939: <td>RUBY_ABI_VERSION</td>
1.269 leot 12940: </tr>
12941: <tr>
1.313 leot 12942: <td>RUBY_ARCH</td>
1.306 kim 12943: <td>RUBY_ARCHINC</td>
1.269 leot 12944: </tr>
12945: <tr>
1.313 leot 12946: <td>RUBY_ARCHLIB</td>
1.306 kim 12947: <td>RUBY_BASE</td>
1.269 leot 12948: </tr>
12949: <tr>
1.313 leot 12950: <td>RUBY_BASERIDIR</td>
1.306 kim 12951: <td>RUBY_BUILD_DOCUMENT</td>
1.269 leot 12952: </tr>
12953: <tr>
1.313 leot 12954: <td>RUBY_DLEXT</td>
1.306 kim 12955: <td>RUBY_DOC</td>
1.269 leot 12956: </tr>
12957: <tr>
1.313 leot 12958: <td>RUBY_DYNAMIC_DIRS</td>
1.306 kim 12959: <td>RUBY_EG</td>
1.269 leot 12960: </tr>
12961: <tr>
1.313 leot 12962: <td>RUBY_ENCODING_ARG</td>
1.306 kim 12963: <td>RUBY_EXTCONF</td>
1.269 leot 12964: </tr>
12965: <tr>
1.313 leot 12966: <td>RUBY_EXTCONF_CHECK</td>
1.306 kim 12967: <td>RUBY_EXTCONF_DEBUG</td>
1.269 leot 12968: </tr>
12969: <tr>
1.313 leot 12970: <td>RUBY_EXTCONF_MAKEFILE</td>
1.306 kim 12971: <td>RUBY_GEM_BASE</td>
1.269 leot 12972: </tr>
12973: <tr>
1.313 leot 12974: <td>RUBY_INC</td>
1.306 kim 12975: <td>RUBY_LIB</td>
1.269 leot 12976: </tr>
12977: <tr>
1.313 leot 12978: <td>RUBY_LIB_BASE</td>
1.306 kim 12979: <td>RUBY_NAME</td>
1.269 leot 12980: </tr>
12981: <tr>
1.313 leot 12982: <td>RUBY_NOVERSION</td>
1.306 kim 12983: <td>RUBY_PKGPREFIX</td>
1.269 leot 12984: </tr>
12985: <tr>
1.313 leot 12986: <td>RUBY_RAILS</td>
1.295 rillig 12987: <td>RUBY_RAILS52_VERSION</td>
1.269 leot 12988: </tr>
12989: <tr>
1.313 leot 12990: <td>RUBY_RAILS60_VERSION</td>
1.312 gdt 12991: <td>RUBY_RAILS61_VERSION</td>
12992: </tr>
12993: <tr>
1.313 leot 12994: <td>RUBY_RAILS_ACCEPTED</td>
1.311 leot 12995: <td>RUBY_RAILS_DEFAULT</td>
1.289 leot 12996: </tr>
12997: <tr>
1.313 leot 12998: <td>RUBY_RAILS_REQD</td>
1.311 leot 12999: <td>RUBY_RAILS_STRICT_DEP</td>
1.269 leot 13000: </tr>
13001: <tr>
1.313 leot 13002: <td>RUBY_RIDIR</td>
1.311 leot 13003: <td>RUBY_SETUP</td>
1.269 leot 13004: </tr>
13005: <tr>
1.313 leot 13006: <td>RUBY_SHLIB</td>
1.311 leot 13007: <td>RUBY_SHLIBALIAS</td>
1.269 leot 13008: </tr>
13009: <tr>
1.313 leot 13010: <td>RUBY_SHLIBVER</td>
1.311 leot 13011: <td>RUBY_SIMPLE_INSTALL</td>
1.269 leot 13012: </tr>
13013: <tr>
1.313 leot 13014: <td>RUBY_SITEARCHLIB</td>
1.311 leot 13015: <td>RUBY_SITELIB</td>
1.269 leot 13016: </tr>
13017: <tr>
1.313 leot 13018: <td>RUBY_SITELIB_BASE</td>
1.311 leot 13019: <td>RUBY_SITERIDIR</td>
1.269 leot 13020: </tr>
13021: <tr>
1.313 leot 13022: <td>RUBY_SLEXT</td>
1.311 leot 13023: <td>RUBY_SRCDIR</td>
1.269 leot 13024: </tr>
13025: <tr>
1.313 leot 13026: <td>RUBY_STATICLIB</td>
1.311 leot 13027: <td>RUBY_SUFFIX</td>
1.269 leot 13028: </tr>
13029: <tr>
1.313 leot 13030: <td>RUBY_SYSRIDIR</td>
1.311 leot 13031: <td>RUBY_USE_PTHREAD</td>
1.269 leot 13032: </tr>
13033: <tr>
1.313 leot 13034: <td>RUBY_VENDORARCHLIB</td>
1.311 leot 13035: <td>RUBY_VENDORLIB</td>
1.269 leot 13036: </tr>
13037: <tr>
1.313 leot 13038: <td>RUBY_VENDORLIB_BASE</td>
1.311 leot 13039: <td>RUBY_VER</td>
1.269 leot 13040: </tr>
13041: <tr>
1.313 leot 13042: <td>RUBY_VERSION</td>
1.311 leot 13043: <td>RUBY_VERSIONS_ACCEPTED</td>
1.269 leot 13044: </tr>
13045: <tr>
1.313 leot 13046: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.311 leot 13047: <td>RUBY_VERSION_DEFAULT</td>
1.269 leot 13048: </tr>
13049: <tr>
1.313 leot 13050: <td>RUBY_VERSION_REQD</td>
1.311 leot 13051: <td>RUBY_VER_DIR</td>
1.269 leot 13052: </tr>
13053: <tr>
1.313 leot 13054: <td>RUN</td>
1.311 leot 13055: <td>RUN_LDCONFIG</td>
1.269 leot 13056: </tr>
13057: <tr>
1.313 leot 13058: <td>SAWFISH_THEMES</td>
1.311 leot 13059: <td>SCO</td>
1.269 leot 13060: </tr>
13061: <tr>
1.313 leot 13062: <td>SCREWS_GROUP</td>
1.311 leot 13063: <td>SCREWS_USER</td>
1.269 leot 13064: </tr>
13065: <tr>
1.313 leot 13066: <td>SCRIPTS_ENV</td>
1.311 leot 13067: <td>SCROLLKEEPER_DATADIR</td>
1.269 leot 13068: </tr>
13069: <tr>
1.313 leot 13070: <td>SCROLLKEEPER_REBUILDDB</td>
1.311 leot 13071: <td>SCROLLKEEPER_UPDATEDB</td>
1.269 leot 13072: </tr>
13073: <tr>
1.313 leot 13074: <td>SDIST_PAWD</td>
1.311 leot 13075: <td>SERIAL_DEVICES</td>
1.269 leot 13076: </tr>
13077: <tr>
1.313 leot 13078: <td>SETGIDGAME</td>
1.311 leot 13079: <td>SETGID_GAMES_PERMS</td>
1.269 leot 13080: </tr>
13081: <tr>
1.313 leot 13082: <td>SETUID_ROOT_PERMS</td>
1.311 leot 13083: <td>SH</td>
1.269 leot 13084: </tr>
13085: <tr>
1.313 leot 13086: <td>SHLIB</td>
1.311 leot 13087: <td>SHORTNAME</td>
1.292 leot 13088: </tr>
13089: <tr>
1.313 leot 13090: <td>SIGN_PACKAGES</td>
1.308 leot 13091: <td>SILC_CLIENT_WITH_PERL</td>
1.269 leot 13092: </tr>
13093: <tr>
1.313 leot 13094: <td>SITE_SPECIFIC_PKGS</td>
1.308 leot 13095: <td>SKIP_DEPENDS</td>
1.269 leot 13096: </tr>
13097: <tr>
1.313 leot 13098: <td>SMF_INSTANCES</td>
1.308 leot 13099: <td>SMF_MANIFEST</td>
1.274 rillig 13100: </tr>
13101: <tr>
1.313 leot 13102: <td>SMF_METHODS</td>
1.308 leot 13103: <td>SMF_METHOD_SHELL</td>
1.269 leot 13104: </tr>
13105: <tr>
1.313 leot 13106: <td>SMF_METHOD_SRC</td>
1.308 leot 13107: <td>SMF_NAME</td>
1.269 leot 13108: </tr>
13109: <tr>
1.313 leot 13110: <td>SMF_PREFIX</td>
1.308 leot 13111: <td>SMF_SRCDIR</td>
1.269 leot 13112: </tr>
13113: <tr>
1.313 leot 13114: <td>SNIPROXY_GROUP</td>
1.308 leot 13115: <td>SNIPROXY_USER</td>
1.269 leot 13116: </tr>
13117: <tr>
1.313 leot 13118: <td>SOURCE_BUFFSIZE</td>
1.308 leot 13119: <td>SPECIAL_PERMS</td>
1.269 leot 13120: </tr>
13121: <tr>
1.313 leot 13122: <td>SPECIFIC_PKGS</td>
1.308 leot 13123: <td>SSH_SUID</td>
1.269 leot 13124: </tr>
13125: <tr>
1.313 leot 13126: <td>SSP_SUPPORTED</td>
1.308 leot 13127: <td>SSYNC_PAWD</td>
1.269 leot 13128: </tr>
13129: <tr>
1.313 leot 13130: <td>STEP_MSG</td>
1.308 leot 13131: <td>STRIP</td>
1.269 leot 13132: </tr>
13133: <tr>
1.313 leot 13134: <td>STRIP_DBG</td>
1.308 leot 13135: <td>STRIP_DEBUG</td>
1.269 leot 13136: </tr>
13137: <tr>
1.313 leot 13138: <td>STRIP_DEBUG_SUPPORTED</td>
1.308 leot 13139: <td>STRIP_FILES_SKIP</td>
1.269 leot 13140: </tr>
13141: <tr>
1.313 leot 13142: <td>SU</td>
1.308 leot 13143: <td>SUBDIR</td>
1.269 leot 13144: </tr>
13145: <tr>
1.313 leot 13146: <td>SUBST</td>
1.308 leot 13147: <td>SUBST_CLASSES</td>
1.289 leot 13148: </tr>
13149: <tr>
1.313 leot 13150: <td>SUBST_FILES</td>
1.308 leot 13151: <td>SUBST_FILTER_CMD</td>
1.269 leot 13152: </tr>
13153: <tr>
1.313 leot 13154: <td>SUBST_MESSAGE</td>
1.308 leot 13155: <td>SUBST_NOOP_OK</td>
1.269 leot 13156: </tr>
13157: <tr>
1.313 leot 13158: <td>SUBST_SED</td>
1.308 leot 13159: <td>SUBST_SHOW_DIFF</td>
1.269 leot 13160: </tr>
13161: <tr>
1.313 leot 13162: <td>SUBST_SKIP_TEXT_CHECK</td>
1.308 leot 13163: <td>SUBST_STAGE</td>
1.269 leot 13164: </tr>
13165: <tr>
1.313 leot 13166: <td>SUBST_VARS</td>
1.308 leot 13167: <td>SUNWSPROBASE</td>
1.269 leot 13168: </tr>
13169: <tr>
1.313 leot 13170: <td>SUSE_PREFER</td>
1.308 leot 13171: <td>SU_CMD</td>
1.292 leot 13172: </tr>
13173: <tr>
1.313 leot 13174: <td>SVN_EXTRACTDIR</td>
1.311 leot 13175: <td>SVN_REPO</td>
13176: </tr>
13177: <tr>
1.313 leot 13178: <td>SVN_REPOSITORIES</td>
1.311 leot 13179: <td>SVN_REVISION</td>
13180: </tr>
13181: <tr>
1.313 leot 13182: <td>TBL</td>
1.308 leot 13183: <td>TERMCAP_TYPE</td>
1.303 bacon 13184: </tr>
13185: <tr>
1.313 leot 13186: <td>TERMINFO_DEFAULT</td>
1.308 leot 13187: <td>TERMINFO_TYPE</td>
1.274 rillig 13188: </tr>
13189: <tr>
1.313 leot 13190: <td>TEST</td>
1.308 leot 13191: <td>TEST_DEPENDS</td>
1.269 leot 13192: </tr>
13193: <tr>
1.313 leot 13194: <td>TEST_DIRS</td>
1.308 leot 13195: <td>TEST_ENV</td>
1.269 leot 13196: </tr>
13197: <tr>
1.313 leot 13198: <td>TEST_ENV_SHELL</td>
1.308 leot 13199: <td>TEST_MAKE_CMD</td>
1.269 leot 13200: </tr>
13201: <tr>
1.313 leot 13202: <td>TEST_MAKE_FLAGS</td>
1.308 leot 13203: <td>TEST_TARGET</td>
1.269 leot 13204: </tr>
13205: <tr>
1.313 leot 13206: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.308 leot 13207: <td>TEXLIVE_REV</td>
1.269 leot 13208: </tr>
13209: <tr>
1.313 leot 13210: <td>TEXLIVE_UNVERSIONED</td>
1.308 leot 13211: <td>TEXMFSITE</td>
1.269 leot 13212: </tr>
13213: <tr>
1.313 leot 13214: <td>TEX_FORMATS</td>
1.308 leot 13215: <td>TEX_HYPHEN_DAT</td>
1.269 leot 13216: </tr>
13217: <tr>
1.313 leot 13218: <td>TEX_HYPHEN_DEF</td>
1.308 leot 13219: <td>TEX_TEXMF_DIRS</td>
1.269 leot 13220: </tr>
13221: <tr>
1.313 leot 13222: <td>THTTPD_LOG_FACILITY</td>
1.309 gutterid 13223: <td>TINYDYN_USER</td>
1.269 leot 13224: </tr>
13225: <tr>
1.313 leot 13226: <td>TO</td>
1.303 bacon 13227: <td>TOOLS_ALIASES</td>
1.269 leot 13228: </tr>
13229: <tr>
1.313 leot 13230: <td>TOOLS_ALWAYS_WRAP</td>
1.303 bacon 13231: <td>TOOLS_ARGS</td>
1.269 leot 13232: </tr>
13233: <tr>
1.313 leot 13234: <td>TOOLS_BROKEN</td>
1.303 bacon 13235: <td>TOOLS_CMD</td>
1.269 leot 13236: </tr>
13237: <tr>
1.313 leot 13238: <td>TOOLS_CMDLINE_SED</td>
1.295 rillig 13239: <td>TOOLS_CREATE</td>
1.269 leot 13240: </tr>
13241: <tr>
1.313 leot 13242: <td>TOOLS_DIR</td>
1.295 rillig 13243: <td>TOOLS_FAIL</td>
1.269 leot 13244: </tr>
13245: <tr>
1.313 leot 13246: <td>TOOLS_GNU_MISSING</td>
1.295 rillig 13247: <td>TOOLS_LDCONFIG</td>
1.269 leot 13248: </tr>
13249: <tr>
1.313 leot 13250: <td>TOOLS_NOOP</td>
1.295 rillig 13251: <td>TOOLS_PATH</td>
1.269 leot 13252: </tr>
13253: <tr>
1.313 leot 13254: <td>TOOLS_SCRIPT</td>
1.295 rillig 13255: <td>TOOL_DEPENDS</td>
1.269 leot 13256: </tr>
13257: <tr>
1.313 leot 13258: <td>TTF_FONTDIR</td>
1.295 rillig 13259: <td>TTF_FONTS_DIR</td>
1.311 leot 13260: </tr>
13261: <tr>
1.313 leot 13262: <td>TYPE</td>
1.311 leot 13263: <td>UAC_REQD_EXECS</td>
1.269 leot 13264: </tr>
13265: <tr>
1.313 leot 13266: <td>UCSPI_SSL_GROUP</td>
1.311 leot 13267: <td>UCSPI_SSL_USER</td>
1.269 leot 13268: </tr>
13269: <tr>
1.313 leot 13270: <td>UNLIMIT_RESOURCES</td>
1.311 leot 13271: <td>UNPRIVILEGED</td>
1.269 leot 13272: </tr>
13273: <tr>
1.313 leot 13274: <td>UNPRIVILEGED_GROUP</td>
1.311 leot 13275: <td>UNPRIVILEGED_GROUPS</td>
1.269 leot 13276: </tr>
13277: <tr>
1.313 leot 13278: <td>UNPRIVILEGED_USER</td>
1.311 leot 13279: <td>UNWRAP_FILES</td>
1.269 leot 13280: </tr>
13281: <tr>
1.313 leot 13282: <td>UNWRAP_PATTERNS</td>
1.311 leot 13283: <td>UPDATE_GEMSPEC</td>
1.269 leot 13284: </tr>
13285: <tr>
1.313 leot 13286: <td>UPDATE_TARGET</td>
1.311 leot 13287: <td>URI</td>
1.269 leot 13288: </tr>
13289: <tr>
1.313 leot 13290: <td>USERGROUP_PHASE</td>
1.311 leot 13291: <td>USERPPP_GROUP</td>
1.269 leot 13292: </tr>
13293: <tr>
1.313 leot 13294: <td>USER_SPECIFIC_PKGS</td>
1.311 leot 13295: <td>USE_ABI_DEPENDS</td>
1.269 leot 13296: </tr>
13297: <tr>
1.313 leot 13298: <td>USE_APR</td>
1.311 leot 13299: <td>USE_BSD_MAKEFILE</td>
1.269 leot 13300: </tr>
13301: <tr>
1.313 leot 13302: <td>USE_BUILTIN</td>
1.311 leot 13303: <td>USE_CROSS_COMPILE</td>
1.269 leot 13304: </tr>
13305: <tr>
1.313 leot 13306: <td>USE_CURSES</td>
1.311 leot 13307: <td>USE_CWRAPPERS</td>
1.269 leot 13308: </tr>
13309: <tr>
1.313 leot 13310: <td>USE_DB185</td>
1.311 leot 13311: <td>USE_FEATURES</td>
1.269 leot 13312: </tr>
13313: <tr>
1.313 leot 13314: <td>USE_GAMESGROUP</td>
1.311 leot 13315: <td>USE_GCC_RUNTIME</td>
1.269 leot 13316: </tr>
13317: <tr>
1.313 leot 13318: <td>USE_IMAKE</td>
1.311 leot 13319: <td>USE_JAVA</td>
1.269 leot 13320: </tr>
13321: <tr>
1.313 leot 13322: <td>USE_JAVA2</td>
1.311 leot 13323: <td>USE_LANGUAGES</td>
1.269 leot 13324: </tr>
13325: <tr>
1.313 leot 13326: <td>USE_LIBTOOL</td>
1.311 leot 13327: <td>USE_NATIVE_GCC</td>
1.269 leot 13328: </tr>
13329: <tr>
1.313 leot 13330: <td>USE_NETBSD_REPO</td>
1.311 leot 13331: <td>USE_PKGSRC_GCC</td>
1.269 leot 13332: </tr>
13333: <tr>
1.313 leot 13334: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.311 leot 13335: <td>USE_PKGTASKS</td>
1.269 leot 13336: </tr>
13337: <tr>
1.313 leot 13338: <td>USE_PKG_ADMIN_DIGEST</td>
1.311 leot 13339: <td>USE_RUBY_EXTCONF</td>
1.269 leot 13340: </tr>
13341: <tr>
1.313 leot 13342: <td>USE_RUBY_INSTALL</td>
1.311 leot 13343: <td>USE_RUBY_SETUP</td>
1.269 leot 13344: </tr>
13345: <tr>
1.313 leot 13346: <td>USE_RUBY_SETUP_PKG</td>
1.311 leot 13347: <td>USE_TOOLS</td>
1.269 leot 13348: </tr>
13349: <tr>
1.313 leot 13350: <td>UUCP_GROUP</td>
1.311 leot 13351: <td>UUCP_USER</td>
1.269 leot 13352: </tr>
13353: <tr>
1.313 leot 13354: <td>VARBASE</td>
1.311 leot 13355: <td>VARNAME</td>
1.269 leot 13356: </tr>
13357: <tr>
1.313 leot 13358: <td>VIM_EXTRA_OPTS</td>
1.311 leot 13359: <td>WARNING_MSG</td>
1.269 leot 13360: </tr>
13361: <tr>
1.313 leot 13362: <td>WCALC_CGIDIR</td>
1.311 leot 13363: <td>WCALC_CGIPATH</td>
1.269 leot 13364: </tr>
13365: <tr>
1.313 leot 13366: <td>WCALC_HTMLDIR</td>
1.311 leot 13367: <td>WCALC_HTMLPATH</td>
1.269 leot 13368: </tr>
13369: <tr>
1.313 leot 13370: <td>WDM_MANAGERS</td>
1.311 leot 13371: <td>WRAPPER_CC</td>
1.269 leot 13372: </tr>
13373: <tr>
1.313 leot 13374: <td>WRAPPER_REORDER_CMDS</td>
1.311 leot 13375: <td>WRKDIR</td>
1.303 bacon 13376: </tr>
13377: <tr>
1.313 leot 13378: <td>WRKDIR_BASENAME</td>
1.311 leot 13379: <td>WRKDIR_LOCKTYPE</td>
1.269 leot 13380: </tr>
13381: <tr>
1.313 leot 13382: <td>WRKLOG</td>
1.311 leot 13383: <td>WRKOBJDIR</td>
1.269 leot 13384: </tr>
13385: <tr>
1.313 leot 13386: <td>WRKSRC</td>
1.311 leot 13387: <td>X10_PORT</td>
1.269 leot 13388: </tr>
13389: <tr>
1.313 leot 13390: <td>X11</td>
1.311 leot 13391: <td>X11BASE</td>
1.269 leot 13392: </tr>
13393: <tr>
1.313 leot 13394: <td>X11_PKGSRCDIR</td>
1.311 leot 13395: <td>X11_TYPE</td>
1.269 leot 13396: </tr>
13397: <tr>
1.313 leot 13398: <td>X509_CERTIFICATE</td>
1.311 leot 13399: <td>X509_KEY</td>
1.269 leot 13400: </tr>
13401: <tr>
1.313 leot 13402: <td>XAW_TYPE</td>
1.311 leot 13403: <td>XLOCK_DEFAULT_MODE</td>
1.269 leot 13404: </tr>
13405: <tr>
1.313 leot 13406: <td>XMKMF</td>
1.311 leot 13407: <td>XMKMF_FLAGS</td>
1.269 leot 13408: </tr>
13409: <tr>
1.313 leot 13410: <td>XXX</td>
1.311 leot 13411: <td>XXXX</td>
1.274 rillig 13412: </tr>
13413: <tr>
1.313 leot 13414: <td>YES</td>
1.295 rillig 13415: <td>ZSH_STATIC</td>
1.269 leot 13416: </tr>
13417: <tr>
1.313 leot 13418: <td>__stdc__</td>
1.295 rillig 13419: <td>_vargroups</td>
1.289 leot 13420: </tr>
13421: <tr>
1.313 leot 13422: <td>accept</td>
1.295 rillig 13423: <td>acquire-localbase-lock</td>
1.269 leot 13424: </tr>
13425: <tr>
1.313 leot 13426: <td>acquire-lock</td>
1.295 rillig 13427: <td>add</td>
1.269 leot 13428: </tr>
13429: <tr>
1.313 leot 13430: <td>administrator</td>
1.295 rillig 13431: <td>alloca</td>
1.289 leot 13432: </tr>
13433: <tr>
1.313 leot 13434: <td>alternatives</td>
1.295 rillig 13435: <td>aslr</td>
1.269 leot 13436: </tr>
13437: <tr>
1.313 leot 13438: <td>asprintf</td>
1.295 rillig 13439: <td>atlas</td>
1.269 leot 13440: </tr>
13441: <tr>
1.313 leot 13442: <td>autoconf</td>
1.295 rillig 13443: <td>automake</td>
1.269 leot 13444: </tr>
13445: <tr>
1.313 leot 13446: <td>autoreconf</td>
1.295 rillig 13447: <td>awk</td>
1.271 brook 13448: </tr>
13449: <tr>
1.313 leot 13450: <td>bash</td>
1.295 rillig 13451: <td>big-endian</td>
1.269 leot 13452: </tr>
13453: <tr>
1.313 leot 13454: <td>bin-install</td>
1.295 rillig 13455: <td>bind</td>
1.292 leot 13456: </tr>
13457: <tr>
1.313 leot 13458: <td>binpkg-list</td>
1.295 rillig 13459: <td>blas</td>
1.274 rillig 13460: </tr>
13461: <tr>
1.313 leot 13462: <td>bootstrap-depends</td>
1.295 rillig 13463: <td>broken</td>
1.269 leot 13464: </tr>
13465: <tr>
1.313 leot 13466: <td>broken_on_platform</td>
1.295 rillig 13467: <td>bsd</td>
1.289 leot 13468: </tr>
13469: <tr>
1.313 leot 13470: <td>bsd.prog.mk</td>
1.295 rillig 13471: <td>build</td>
1.269 leot 13472: </tr>
13473: <tr>
1.313 leot 13474: <td>build-env</td>
1.295 rillig 13475: <td>buildlink-directories</td>
1.269 leot 13476: </tr>
13477: <tr>
1.313 leot 13478: <td>buildlink-oss-soundcard-h</td>
1.295 rillig 13479: <td>c</td>
1.269 leot 13480: </tr>
13481: <tr>
1.313 leot 13482: <td>c++</td>
1.295 rillig 13483: <td>ccache</td>
1.269 leot 13484: </tr>
13485: <tr>
1.313 leot 13486: <td>cce</td>
1.295 rillig 13487: <td>cdefs</td>
1.289 leot 13488: </tr>
13489: <tr>
1.313 leot 13490: <td>ceil</td>
1.295 rillig 13491: <td>changes</td>
1.269 leot 13492: </tr>
13493: <tr>
1.313 leot 13494: <td>changes-entry</td>
1.295 rillig 13495: <td>changes-entry-noupdate</td>
1.269 leot 13496: </tr>
13497: <tr>
1.313 leot 13498: <td>check</td>
1.295 rillig 13499: <td>check-clean</td>
1.269 leot 13500: </tr>
13501: <tr>
1.313 leot 13502: <td>check-files</td>
1.295 rillig 13503: <td>check-files-clean</td>
1.269 leot 13504: </tr>
13505: <tr>
1.313 leot 13506: <td>check-vulnerable</td>
1.295 rillig 13507: <td>checksum</td>
1.269 leot 13508: </tr>
13509: <tr>
1.313 leot 13510: <td>checksum-phase</td>
1.295 rillig 13511: <td>clean</td>
1.269 leot 13512: </tr>
13513: <tr>
1.313 leot 13514: <td>clean-depends</td>
1.295 rillig 13515: <td>cleandir</td>
1.269 leot 13516: </tr>
13517: <tr>
1.313 leot 13518: <td>commit</td>
1.295 rillig 13519: <td>commit-changes-entry</td>
1.269 leot 13520: </tr>
13521: <tr>
1.313 leot 13522: <td>compact</td>
1.295 rillig 13523: <td>compiler</td>
1.269 leot 13524: </tr>
13525: <tr>
1.313 leot 13526: <td>conf</td>
1.295 rillig 13527: <td>config.guess</td>
1.269 leot 13528: </tr>
13529: <tr>
1.313 leot 13530: <td>config.sub</td>
1.295 rillig 13531: <td>configuration</td>
1.269 leot 13532: </tr>
13533: <tr>
1.313 leot 13534: <td>configure</td>
1.295 rillig 13535: <td>configure-env</td>
1.269 leot 13536: </tr>
13537: <tr>
1.313 leot 13538: <td>configure-help</td>
1.295 rillig 13539: <td>configure_args</td>
1.269 leot 13540: </tr>
13541: <tr>
1.313 leot 13542: <td>connect</td>
1.295 rillig 13543: <td>cos</td>
1.289 leot 13544: </tr>
13545: <tr>
1.313 leot 13546: <td>cputime</td>
1.295 rillig 13547: <td>create-usergroup</td>
1.269 leot 13548: </tr>
13549: <tr>
1.313 leot 13550: <td>csh</td>
1.295 rillig 13551: <td>ctf</td>
1.269 leot 13552: </tr>
13553: <tr>
1.313 leot 13554: <td>cvs</td>
1.295 rillig 13555: <td>debug</td>
1.311 leot 13556: </tr>
13557: <tr>
1.313 leot 13558: <td>declaration</td>
1.311 leot 13559: <td>declare</td>
1.269 leot 13560: </tr>
13561: <tr>
1.313 leot 13562: <td>defined</td>
1.311 leot 13563: <td>depend</td>
1.269 leot 13564: </tr>
13565: <tr>
1.313 leot 13566: <td>dependencies</td>
1.311 leot 13567: <td>depends</td>
1.269 leot 13568: </tr>
13569: <tr>
1.313 leot 13570: <td>depends-checksum</td>
1.311 leot 13571: <td>depends-fetch</td>
1.269 leot 13572: </tr>
13573: <tr>
1.313 leot 13574: <td>deps</td>
1.311 leot 13575: <td>describe</td>
1.269 leot 13576: </tr>
13577: <tr>
1.313 leot 13578: <td>destdir</td>
1.311 leot 13579: <td>disable</td>
1.269 leot 13580: </tr>
13581: <tr>
1.313 leot 13582: <td>distclean</td>
1.311 leot 13583: <td>distinfo</td>
1.277 rillig 13584: </tr>
13585: <tr>
1.313 leot 13586: <td>dl</td>
1.311 leot 13587: <td>dlopen</td>
1.269 leot 13588: </tr>
13589: <tr>
1.313 leot 13590: <td>do-build</td>
1.311 leot 13591: <td>do-buildlink</td>
1.269 leot 13592: </tr>
13593: <tr>
1.313 leot 13594: <td>do-clean</td>
1.311 leot 13595: <td>do-configure</td>
1.269 leot 13596: </tr>
13597: <tr>
1.313 leot 13598: <td>do-configure-post-hook</td>
1.311 leot 13599: <td>do-extract</td>
1.285 rillig 13600: </tr>
13601: <tr>
1.313 leot 13602: <td>do-fetch</td>
1.311 leot 13603: <td>do-install</td>
1.289 leot 13604: </tr>
13605: <tr>
1.313 leot 13606: <td>emul</td>
1.295 rillig 13607: <td>emul-distinfo</td>
1.269 leot 13608: </tr>
13609: <tr>
1.313 leot 13610: <td>emul-fetch</td>
1.295 rillig 13611: <td>emulation</td>
1.274 rillig 13612: </tr>
13613: <tr>
1.313 leot 13614: <td>emulator</td>
1.295 rillig 13615: <td>enable</td>
1.269 leot 13616: </tr>
13617: <tr>
1.313 leot 13618: <td>endian</td>
1.311 leot 13619: <td>endif</td>
13620: </tr>
13621: <tr>
1.313 leot 13622: <td>enomem</td>
1.311 leot 13623: <td>err</td>
1.269 leot 13624: </tr>
13625: <tr>
1.313 leot 13626: <td>errx</td>
1.311 leot 13627: <td>etc</td>
1.269 leot 13628: </tr>
13629: <tr>
1.313 leot 13630: <td>exp</td>
1.311 leot 13631: <td>extract-rpm</td>
1.289 leot 13632: </tr>
13633: <tr>
1.313 leot 13634: <td>fabs</td>
1.311 leot 13635: <td>feature</td>
1.269 leot 13636: </tr>
13637: <tr>
1.313 leot 13638: <td>features</td>
1.311 leot 13639: <td>fetch</td>
1.269 leot 13640: </tr>
13641: <tr>
1.313 leot 13642: <td>fetch-list</td>
1.311 leot 13643: <td>follows</td>
1.269 leot 13644: </tr>
13645: <tr>
1.313 leot 13646: <td>forbids</td>
1.311 leot 13647: <td>form</td>
1.269 leot 13648: </tr>
13649: <tr>
1.313 leot 13650: <td>format</td>
1.311 leot 13651: <td>fortify</td>
1.269 leot 13652: </tr>
13653: <tr>
1.313 leot 13654: <td>fortify_source</td>
1.311 leot 13655: <td>fossil</td>
1.269 leot 13656: </tr>
13657: <tr>
1.313 leot 13658: <td>friend</td>
1.295 rillig 13659: <td>fts</td>
1.269 leot 13660: </tr>
13661: <tr>
1.313 leot 13662: <td>fts_close</td>
1.295 rillig 13663: <td>fts_open</td>
1.269 leot 13664: </tr>
13665: <tr>
1.313 leot 13666: <td>fts_read</td>
1.295 rillig 13667: <td>fts_set</td>
1.289 leot 13668: </tr>
13669: <tr>
1.313 leot 13670: <td>gcc</td>
1.295 rillig 13671: <td>gethostbyaddr</td>
1.269 leot 13672: </tr>
13673: <tr>
1.313 leot 13674: <td>gethostbyname</td>
1.295 rillig 13675: <td>gethostbyname2</td>
1.269 leot 13676: </tr>
13677: <tr>
1.313 leot 13678: <td>getopt_long</td>
1.295 rillig 13679: <td>getprogname</td>
1.289 leot 13680: </tr>
13681: <tr>
1.313 leot 13682: <td>getservbyname</td>
1.295 rillig 13683: <td>getservbyport</td>
1.289 leot 13684: </tr>
13685: <tr>
1.313 leot 13686: <td>getservent</td>
1.295 rillig 13687: <td>gettext</td>
1.269 leot 13688: </tr>
13689: <tr>
1.313 leot 13690: <td>git</td>
1.295 rillig 13691: <td>github</td>
1.311 leot 13692: </tr>
13693: <tr>
1.313 leot 13694: <td>gitlab</td>
1.295 rillig 13695: <td>glob</td>
1.274 rillig 13696: </tr>
13697: <tr>
1.313 leot 13698: <td>gnu</td>
1.295 rillig 13699: <td>gnu_configure_strict</td>
1.269 leot 13700: </tr>
13701: <tr>
1.313 leot 13702: <td>go</td>
1.295 rillig 13703: <td>go-deps</td>
1.269 leot 13704: </tr>
13705: <tr>
1.313 leot 13706: <td>golang</td>
1.295 rillig 13707: <td>guess-license</td>
1.269 leot 13708: </tr>
13709: <tr>
1.313 leot 13710: <td>hashbang</td>
1.295 rillig 13711: <td>heimdal</td>
1.269 leot 13712: </tr>
13713: <tr>
1.313 leot 13714: <td>help</td>
1.311 leot 13715: <td>hg</td>
13716: </tr>
13717: <tr>
1.313 leot 13718: <td>imake</td>
1.311 leot 13719: <td>increment</td>
1.269 leot 13720: </tr>
13721: <tr>
1.313 leot 13722: <td>inet_aton</td>
1.311 leot 13723: <td>interp</td>
1.269 leot 13724: </tr>
13725: <tr>
1.313 leot 13726: <td>interpreter</td>
1.311 leot 13727: <td>intl</td>
1.269 leot 13728: </tr>
13729: <tr>
1.313 leot 13730: <td>ip4</td>
1.311 leot 13731: <td>ip6</td>
1.269 leot 13732: </tr>
13733: <tr>
1.313 leot 13734: <td>ipv4</td>
1.311 leot 13735: <td>ipv6</td>
1.303 bacon 13736: </tr>
13737: <tr>
1.313 leot 13738: <td>iso</td>
1.311 leot 13739: <td>kerberos</td>
1.303 bacon 13740: </tr>
13741: <tr>
1.313 leot 13742: <td>krb</td>
1.311 leot 13743: <td>krb5</td>
1.269 leot 13744: </tr>
13745: <tr>
1.313 leot 13746: <td>ksh</td>
1.311 leot 13747: <td>lapack</td>
1.292 leot 13748: </tr>
13749: <tr>
1.313 leot 13750: <td>latex</td>
1.311 leot 13751: <td>libintl_bindtextdomain</td>
1.269 leot 13752: </tr>
13753: <tr>
1.313 leot 13754: <td>libintl_gettext</td>
1.311 leot 13755: <td>libintl_textdomain</td>
1.289 leot 13756: </tr>
13757: <tr>
1.313 leot 13758: <td>libnbcompat</td>
1.311 leot 13759: <td>libs</td>
1.274 rillig 13760: </tr>
13761: <tr>
1.313 leot 13762: <td>libtool</td>
1.311 leot 13763: <td>licence</td>
1.271 brook 13764: </tr>
13765: <tr>
1.313 leot 13766: <td>license</td>
1.311 leot 13767: <td>lintl</td>
1.269 leot 13768: </tr>
13769: <tr>
1.313 leot 13770: <td>little-endian</td>
1.311 leot 13771: <td>lock</td>
1.269 leot 13772: </tr>
13773: <tr>
1.313 leot 13774: <td>locking</td>
1.311 leot 13775: <td>lvalue</td>
1.269 leot 13776: </tr>
13777: <tr>
1.313 leot 13778: <td>make</td>
1.311 leot 13779: <td>makesum</td>
1.269 leot 13780: </tr>
13781: <tr>
1.313 leot 13782: <td>memory</td>
1.311 leot 13783: <td>mercurial</td>
1.269 leot 13784: </tr>
13785: <tr>
1.313 leot 13786: <td>meta</td>
1.295 rillig 13787: <td>meta-package</td>
1.269 leot 13788: </tr>
13789: <tr>
1.313 leot 13790: <td>meta_package</td>
1.295 rillig 13791: <td>mit-krb5</td>
1.292 leot 13792: </tr>
13793: <tr>
1.313 leot 13794: <td>mk.conf</td>
1.295 rillig 13795: <td>mkl</td>
1.274 rillig 13796: </tr>
13797: <tr>
1.313 leot 13798: <td>mount</td>
1.295 rillig 13799: <td>mprotect</td>
1.269 leot 13800: </tr>
13801: <tr>
1.313 leot 13802: <td>mremap</td>
1.295 rillig 13803: <td>nb</td>
1.269 leot 13804: </tr>
13805: <tr>
1.313 leot 13806: <td>nbcompat</td>
1.295 rillig 13807: <td>obstack</td>
1.269 leot 13808: </tr>
13809: <tr>
1.313 leot 13810: <td>obstack_ptr_grow</td>
1.295 rillig 13811: <td>occurs</td>
1.269 leot 13812: </tr>
13813: <tr>
1.313 leot 13814: <td>only</td>
1.295 rillig 13815: <td>openblas</td>
1.269 leot 13816: </tr>
13817: <tr>
1.313 leot 13818: <td>options</td>
1.295 rillig 13819: <td>options.mk</td>
1.271 brook 13820: </tr>
13821: <tr>
1.313 leot 13822: <td>order</td>
1.295 rillig 13823: <td>override</td>
1.269 leot 13824: </tr>
13825: <tr>
1.313 leot 13826: <td>override-intltool</td>
1.295 rillig 13827: <td>override-message-intltool</td>
1.269 leot 13828: </tr>
13829: <tr>
1.313 leot 13830: <td>package</td>
1.295 rillig 13831: <td>parallel</td>
1.269 leot 13832: </tr>
13833: <tr>
1.313 leot 13834: <td>path</td>
1.295 rillig 13835: <td>pax</td>
1.269 leot 13836: </tr>
13837: <tr>
1.313 leot 13838: <td>paxctl</td>
1.295 rillig 13839: <td>pbulk-index</td>
1.269 leot 13840: </tr>
13841: <tr>
1.313 leot 13842: <td>pc</td>
1.295 rillig 13843: <td>perl</td>
1.269 leot 13844: </tr>
13845: <tr>
1.313 leot 13846: <td>perl5</td>
1.295 rillig 13847: <td>perms</td>
1.269 leot 13848: </tr>
13849: <tr>
1.313 leot 13850: <td>php</td>
1.295 rillig 13851: <td>pkg-build-options</td>
1.269 leot 13852: </tr>
13853: <tr>
1.313 leot 13854: <td>pkg-config</td>
1.295 rillig 13855: <td>pkg_build_options</td>
1.269 leot 13856: </tr>
13857: <tr>
1.313 leot 13858: <td>platform</td>
1.295 rillig 13859: <td>plist</td>
1.269 leot 13860: </tr>
13861: <tr>
1.313 leot 13862: <td>post-extract</td>
1.295 rillig 13863: <td>post-fetch</td>
1.269 leot 13864: </tr>
13865: <tr>
1.313 leot 13866: <td>post-wrapper</td>
1.295 rillig 13867: <td>pre-build-checks-hook</td>
1.289 leot 13868: </tr>
13869: <tr>
1.313 leot 13870: <td>pre-configure</td>
1.295 rillig 13871: <td>pre-configure-checks-hook</td>
1.269 leot 13872: </tr>
13873: <tr>
1.313 leot 13874: <td>pre-extract</td>
1.295 rillig 13875: <td>pre-fetch</td>
1.269 leot 13876: </tr>
13877: <tr>
1.313 leot 13878: <td>print-go-deps</td>
1.295 rillig 13879: <td>print-plist</td>
1.269 leot 13880: </tr>
13881: <tr>
1.313 leot 13882: <td>print-summary-data</td>
1.295 rillig 13883: <td>privileged-install-hook</td>
1.269 leot 13884: </tr>
13885: <tr>
1.313 leot 13886: <td>pypi</td>
1.295 rillig 13887: <td>python</td>
1.269 leot 13888: </tr>
13889: <tr>
1.313 leot 13890: <td>readme-all</td>
1.295 rillig 13891: <td>recv</td>
1.289 leot 13892: </tr>
13893: <tr>
1.313 leot 13894: <td>recvfrom</td>
1.295 rillig 13895: <td>regcomp</td>
1.289 leot 13896: </tr>
13897: <tr>
1.313 leot 13898: <td>release-localbase-lock</td>
1.295 rillig 13899: <td>release-lock</td>
1.269 leot 13900: </tr>
13901: <tr>
1.313 leot 13902: <td>relro</td>
1.295 rillig 13903: <td>rename</td>
1.269 leot 13904: </tr>
13905: <tr>
1.313 leot 13906: <td>reorder</td>
1.295 rillig 13907: <td>replace</td>
1.269 leot 13908: </tr>
13909: <tr>
1.313 leot 13910: <td>replace_interpreter</td>
1.295 rillig 13911: <td>reproducible</td>
1.269 leot 13912: </tr>
13913: <tr>
1.313 leot 13914: <td>resolv</td>
1.295 rillig 13915: <td>root</td>
1.289 leot 13916: </tr>
13917: <tr>
1.313 leot 13918: <td>ruby</td>
1.295 rillig 13919: <td>send</td>
1.269 leot 13920: </tr>
13921: <tr>
1.313 leot 13922: <td>sendfile</td>
1.295 rillig 13923: <td>sendto</td>
1.269 leot 13924: </tr>
13925: <tr>
1.313 leot 13926: <td>setenv</td>
1.295 rillig 13927: <td>setgid</td>
1.269 leot 13928: </tr>
13929: <tr>
1.313 leot 13930: <td>setprogname</td>
1.295 rillig 13931: <td>setuid</td>
1.269 leot 13932: </tr>
13933: <tr>
1.313 leot 13934: <td>sh</td>
1.296 rillig 13935: <td>shebang</td>
13936: </tr>
13937: <tr>
1.313 leot 13938: <td>show</td>
1.273 brook 13939: <td>show-all</td>
1.269 leot 13940: </tr>
13941: <tr>
1.313 leot 13942: <td>show-build-defs</td>
1.273 brook 13943: <td>show-depends</td>
1.269 leot 13944: </tr>
13945: <tr>
1.313 leot 13946: <td>show-deps</td>
1.273 brook 13947: <td>show-distfiles</td>
1.269 leot 13948: </tr>
13949: <tr>
1.313 leot 13950: <td>show-downlevel</td>
1.273 brook 13951: <td>show-subdir-var</td>
1.269 leot 13952: </tr>
13953: <tr>
1.313 leot 13954: <td>show-tools</td>
1.273 brook 13955: <td>show-var</td>
1.269 leot 13956: </tr>
13957: <tr>
1.313 leot 13958: <td>show-vars</td>
1.273 brook 13959: <td>snprintf</td>
1.289 leot 13960: </tr>
13961: <tr>
1.313 leot 13962: <td>socket</td>
1.285 rillig 13963: <td>ssp</td>
1.269 leot 13964: </tr>
13965: <tr>
1.313 leot 13966: <td>st_mode</td>
1.285 rillig 13967: <td>stage-install</td>
1.269 leot 13968: </tr>
13969: <tr>
1.313 leot 13970: <td>strcasestr</td>
1.277 rillig 13971: <td>strict</td>
13972: </tr>
13973: <tr>
1.313 leot 13974: <td>strip</td>
1.289 leot 13975: <td>strndup</td>
1.269 leot 13976: </tr>
13977: <tr>
1.313 leot 13978: <td>strnlen</td>
1.289 leot 13979: <td>strsep</td>
13980: </tr>
13981: <tr>
1.313 leot 13982: <td>subst</td>
1.289 leot 13983: <td>substitutions</td>
1.292 leot 13984: </tr>
13985: <tr>
1.313 leot 13986: <td>subversion</td>
1.290 gutterid 13987: <td>sun</td>
1.311 leot 13988: </tr>
13989: <tr>
1.313 leot 13990: <td>sunpro</td>
1.311 leot 13991: <td>sunwspro</td>
1.269 leot 13992: </tr>
13993: <tr>
1.313 leot 13994: <td>svn</td>
1.276 leot 13995: <td>symlink</td>
1.269 leot 13996: </tr>
13997: <tr>
1.313 leot 13998: <td>test</td>
1.289 leot 13999: <td>test-env</td>
1.269 leot 14000: </tr>
14001: <tr>
1.313 leot 14002: <td>tex</td>
1.289 leot 14003: <td>texlive</td>
1.269 leot 14004: </tr>
14005: <tr>
1.313 leot 14006: <td>tmp</td>
1.289 leot 14007: <td>tool</td>
1.269 leot 14008: </tr>
14009: <tr>
1.313 leot 14010: <td>tools</td>
1.289 leot 14011: <td>tools-libtool-m4-override</td>
1.269 leot 14012: </tr>
14013: <tr>
1.313 leot 14014: <td>type</td>
1.289 leot 14015: <td>ulimit</td>
1.269 leot 14016: </tr>
14017: <tr>
1.313 leot 14018: <td>undefined</td>
1.289 leot 14019: <td>undo-replace</td>
1.269 leot 14020: </tr>
14021: <tr>
1.313 leot 14022: <td>unlimit</td>
1.289 leot 14023: <td>unprivileged</td>
1.269 leot 14024: </tr>
14025: <tr>
1.313 leot 14026: <td>unprivileged-install-hook</td>
1.289 leot 14027: <td>unstripped</td>
1.269 leot 14028: </tr>
14029: <tr>
1.313 leot 14030: <td>update</td>
1.289 leot 14031: <td>upload</td>
1.269 leot 14032: </tr>
14033: <tr>
1.313 leot 14034: <td>upload-distfiles</td>
1.270 leot 14035: <td>use_tools</td>
1.269 leot 14036: </tr>
14037: <tr>
1.313 leot 14038: <td>user</td>
1.270 leot 14039: <td>utimes</td>
1.269 leot 14040: </tr>
14041: <tr>
1.313 leot 14042: <td>vasprintf</td>
1.270 leot 14043: <td>verbose</td>
1.269 leot 14044: </tr>
14045: <tr>
1.313 leot 14046: <td>vsnprintf</td>
1.270 leot 14047: <td>warn</td>
1.269 leot 14048: </tr>
14049: <tr>
1.313 leot 14050: <td>warning</td>
1.270 leot 14051: <td>warnings</td>
1.269 leot 14052: </tr>
14053: <tr>
1.313 leot 14054: <td>warnx</td>
1.289 leot 14055: <td>wattr_off</td>
1.269 leot 14056: </tr>
14057: <tr>
1.313 leot 14058: <td>wattr_on</td>
1.289 leot 14059: <td>work</td>
1.269 leot 14060: </tr>
14061: <tr>
1.313 leot 14062: <td>wrapper</td>
1.289 leot 14063: <td>wrkdir</td>
1.269 leot 14064: </tr>
14065: </table>
1.267 rillig 14066: </div>
14067: <div class="appendix">
14068: <div class="titlepage"><div><div><h1 class="title">
14069: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 14070: <div class="toc">
14071: <p><b>Table of Contents</b></p>
1.210 leot 14072: <dl class="toc">
1.267 rillig 14073: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
14074: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75 rillig 14075: </dl>
14076: </div>
1.79 rillig 14077: <p>This section contains information on editing the pkgsrc
14078: guide itself.</p>
1.148 asau 14079: <div class="sect1">
1.75 rillig 14080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 14081: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.79 rillig 14082: <p>The pkgsrc guide's source code is stored in
14083: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
14084: are created from it:</p>
1.148 asau 14085: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 14086: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
14087: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289 leot 14088: <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>
14089: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79 rillig 14090: The PDF version of the pkgsrc guide.</p></li>
1.289 leot 14091: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79 rillig 14092: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 14093: </ul></div>
14094: </div>
1.148 asau 14095: <div class="sect1">
1.75 rillig 14096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 14097: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.79 rillig 14098: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 14099: <div class="procedure"><ol class="procedure" type="1">
1.304 bacon 14100: <li class="step"><p>Make sure you have checked out the htdocs repository
14101: into a sibling directory of your pkgsrc directory. You will need
14102: the ability to commit from both pkgsrc and htdocs.</p></li>
1.148 asau 14103: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 14104: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 14105: documentation) installed. These are automatically installed when
1.250 leot 14106: 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.148 asau 14107: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 14108: right directory. All further steps will take place
14109: here.</p></li>
1.148 asau 14110: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 14111: <code class="filename">files/</code>.</p></li>
1.148 asau 14112: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 14113: guide for valid XML and to build the final output files. If you
14114: get any errors at this stage, you can just edit the files, as
14115: there are only symbolic links in the working directory, pointing
14116: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 14117: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 14118: commit)</strong></span></p></li>
1.148 asau 14119: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 14120: regenerate the output files with the proper RCS
14121: Ids.</p></li>
1.148 asau 14122: <li class="step">
1.110 hubertf 14123: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 14124: commit the files in both <code class="filename">pkgsrc/doc</code> and
14125: <code class="filename">htdocs</code>.</p>
1.148 asau 14126: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 14127: <h3 class="title">Note</h3>
14128: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 14129: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
14130: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 14131: directory.</p>
14132: </div>
14133: </li>
1.79 rillig 14134: </ol></div>
1.75 rillig 14135: </div>
14136: </div>
14137: </div></body>
1.1 grant 14138: </html>
CVSweb <webmaster@jp.NetBSD.org>