Annotation of pkgsrc/doc/pkgsrc.html, revision 1.321
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>
1.317 nia 88: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
89: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
90: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
91: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
92: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
93: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75 rillig 94: </dl></dd>
1.267 rillig 95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75 rillig 96: <dd><dl>
1.267 rillig 97: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
98: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
99: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75 rillig 100: </dl></dd>
101: </dl></dd>
1.267 rillig 102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75 rillig 103: <dd><dl>
1.267 rillig 104: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
105: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
106: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
107: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 108: <dd><dl>
1.267 rillig 109: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
110: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
111: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 112: </dl></dd>
1.267 rillig 113: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
114: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75 rillig 115: </dl></dd>
1.267 rillig 116: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75 rillig 117: <dd><dl>
1.267 rillig 118: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
119: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 120: </dl></dd>
1.267 rillig 121: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 122: builds)</a></span></dt>
1.75 rillig 123: <dd><dl>
1.267 rillig 124: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 125: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 126: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
127: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 128: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
129: <dd><dl>
1.294 rillig 130: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
131: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296 rillig 132: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
133: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
134: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
135: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
136: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
137: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
138: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
139: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 140: </dl></dd>
141: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
142: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267 rillig 143: </dl></dd>
144: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
145: <dd><dl>
146: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
147: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
148: </dl></dd>
149: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
150: <dd><dl>
151: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
152: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
153: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
154: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
155: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
156: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
157: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
158: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
159: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
160: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.128 wiz 161: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
164: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
165: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
166: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
167: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
168: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.75 rillig 169: </dl></dd>
170: </dl></dd>
171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
172: <dd><dl>
1.267 rillig 173: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299 rillig 174: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91 rillig 175: <dd><dl>
1.299 rillig 176: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
177: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
178: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91 rillig 179: <dd><dl>
1.299 rillig 180: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
181: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
182: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
183: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
184: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91 rillig 185: </dl></dd>
1.299 rillig 186: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
187: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
188: <dd><dl>
189: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
190: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
191: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
192: </dl></dd>
193: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
194: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 195: </dl></dd>
1.299 rillig 196: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106 rillig 197: <dd><dl>
1.299 rillig 198: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
199: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
200: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
201: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
202: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106 rillig 203: <dd><dl>
1.299 rillig 204: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
205: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106 rillig 206: </dl></dd>
1.299 rillig 207: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
208: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
209: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
210: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
211: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
212: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
213: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
214: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
215: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
216: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
217: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
218: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
219: </dl></dd>
220: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
221: <dd><dl>
222: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106 rillig 223: <dd><dl>
1.299 rillig 224: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
225: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
226: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
227: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
1.106 rillig 228: </dl></dd>
1.299 rillig 229: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
230: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106 rillig 231: </dl></dd>
1.299 rillig 232: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 233: <dd><dl>
1.299 rillig 234: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
235: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
236: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
237: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106 rillig 238: <dd><dl>
1.299 rillig 239: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
240: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
241: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
242: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106 rillig 243: </dl></dd>
244: </dl></dd>
1.299 rillig 245: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106 rillig 246: <dd><dl>
1.299 rillig 247: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
248: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
249: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
250: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 251: </dl></dd>
1.299 rillig 252: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106 rillig 253: <dd><dl>
1.299 rillig 254: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
255: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
256: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
257: </dl></dd>
258: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
259: <dd><dl>
260: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
261: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 262: <dd><dl>
1.299 rillig 263: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
264: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133 wiz 265: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
266: and
267: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
268: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 269: </dl></dd>
1.299 rillig 270: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
271: <dd><dl>
272: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
273: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
274: </dl></dd>
275: </dl></dd>
276: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106 rillig 277: <dd><dl>
1.299 rillig 278: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
279: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
280: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
281: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
282: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
283: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
284: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
285: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
286: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106 rillig 287: </dl></dd>
1.299 rillig 288: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
289: <dd><dl>
290: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
291: <dd><dl>
292: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
293: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106 rillig 294: </dl></dd>
1.299 rillig 295: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106 rillig 296: <dd><dl>
1.299 rillig 297: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
298: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
299: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
300: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
301: </dl></dd>
302: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
303: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
304: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
305: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
306: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
307: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
308: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.267 rillig 309: </dl></dd>
310: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
311: <dd><dl>
312: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
313: <dd><dl>
314: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
315: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
316: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
317: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
318: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
319: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
320: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
321: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
322: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
323: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
324: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
325: </dl></dd>
326: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
327: <dd><dl>
328: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
329: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
330: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
331: </dl></dd>
332: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
333: <dd><dl>
334: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
336: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
337: </dl></dd>
338: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
339: <dd><dl>
340: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
341: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 342: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
343: <dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
344: <dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
345: <dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
1.267 rillig 346: </dl></dd>
347: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
348: <dd><dl>
349: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
350: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 351: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
352: <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>
353: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 354: </dl></dd>
355: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
356: <dd><dl>
357: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
358: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
359: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
360: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
361: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 362: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 363: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
364: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 365: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
366: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
367: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
368: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
369: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
370: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
371: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 372: emulation</a></span></dt>
1.318 nia 373: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
374: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.77 rillig 375: </dl></dd>
1.267 rillig 376: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 377: </dl></dd>
1.299 rillig 378: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
379: <dd><dl>
380: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
381: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
382: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
383: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
384: </dl></dd>
1.267 rillig 385: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 386: <dd><dl>
1.267 rillig 387: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
388: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
389: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
390: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
391: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
392: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
393: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
394: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
395: </dl></dd>
396: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75 rillig 397: </dl></dd>
398: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
399: <dd><dl>
1.299 rillig 400: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 401: <dd><dl>
1.299 rillig 402: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
403: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
404: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81 rillig 405: <dd><dl>
1.299 rillig 406: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
407: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81 rillig 408: </dl></dd>
1.299 rillig 409: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
410: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 411: <dd><dl>
1.299 rillig 412: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
413: <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 414: </dl></dd>
1.299 rillig 415: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 416: <dd><dl>
1.299 rillig 417: <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>
418: <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 419: </dl></dd>
420: </dl></dd>
1.299 rillig 421: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 422: <dd><dl>
1.299 rillig 423: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
424: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 425: <dd><dl>
1.299 rillig 426: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
427: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 428: </dl></dd>
429: </dl></dd>
1.299 rillig 430: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
431: <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 432: </dl></dd>
433: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
434: <dd><dl>
435: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
436: <dd><dl>
437: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
438: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
439: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287 rillig 440: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 441: </dl></dd>
442: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
443: </dl></dd>
444: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
445: <dd><dl>
446: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
447: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
448: </dl></dd>
1.76 rillig 449: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
450: <dd><dl>
1.128 wiz 451: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
452: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
453: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
454: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
455: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261 leot 456: <code class="filename">stable</code>,
1.128 wiz 457: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 458: source packages</a></span></dt>
459: </dl></dd>
1.267 rillig 460: <dt><span class="appendix"><a href="#help-topics">D. Help topics</a></span></dt>
461: <dt><span class="appendix"><a href="#editing">E. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75 rillig 462: <dd><dl>
1.267 rillig 463: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
464: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75 rillig 465: </dl></dd>
466: </dl>
467: </div>
1.82 rillig 468: <div class="list-of-tables">
469: <p><b>List of Tables</b></p>
470: <dl>
471: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
472: </dt>
1.299 rillig 473: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 474: </dt>
1.299 rillig 475: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 476: </dt>
1.82 rillig 477: </dl>
478: </div>
1.148 asau 479: <div class="chapter">
480: <div class="titlepage"><div><div><h1 class="title">
481: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 482: <div class="toc">
483: <p><b>Table of Contents</b></p>
1.210 leot 484: <dl class="toc">
1.75 rillig 485: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 486: <dd><dl>
487: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
488: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
489: </dl></dd>
1.75 rillig 490: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
491: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 492: <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 493: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
494: </dl>
495: </div>
1.148 asau 496: <div class="sect1">
1.75 rillig 497: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
498: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 499: <p>There is a lot of software freely available for Unix-based
500: systems, which is usually available in form of the source code. Before
501: such software can be used, it needs to be configured to the local
502: system, compiled and installed, and this is exactly what The NetBSD
503: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
504: to handle binary packages, so that not every user has to build the
505: packages for himself, which is a time-costly task.</p>
1.75 rillig 506: <p>pkgsrc currently contains several thousand packages,
507: including:</p>
1.148 asau 508: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 leot 509: <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 510: web server</p></li>
1.250 leot 511: <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 512: web browser</p></li>
1.250 leot 513: <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 514: Desktop Environment</p></li>
1.250 leot 515: <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 516: Desktop Environment</p></li>
517: </ul></div>
1.219 rillig 518: <p>… just to name a few.</p>
1.75 rillig 519: <p>pkgsrc has built-in support for handling varying dependencies,
520: such as pthreads and X11, and extended features such as IPv6 support on
521: a range of platforms.</p>
1.148 asau 522: <div class="sect2">
1.82 rillig 523: <div class="titlepage"><div><div><h3 class="title">
524: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
525: <p>
526: pkgsrc provides the following key features:
527: </p>
1.148 asau 528: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 529: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 530: and installation of binary packages. The source and latest
531: patches are retrieved from a master or mirror download site, checksum
532: verified, then built on your system. Support for binary-only
533: distributions is available for both native platforms and NetBSD
534: emulated platforms.</p></li>
1.128 wiz 535: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 536: including binaries, libraries, man pages and other
537: documentation.</p></li>
1.214 sevan 538: <li class="listitem"><p>Tracking of package dependencies automatically, including when
539: performing updates, to ensure required packages are installed. The
540: configuration files of various packages are handled automatically during
541: updates, so local changes are preserved.</p></li>
1.128 wiz 542: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 543: consists of highly portable code. This allows the greatest speed of
1.132 spz 544: development when porting to a new platform. This portability also
1.82 rillig 545: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
546: platforms</em></span>.</p></li>
1.128 wiz 547: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 548: international encryption requirements and build-time options for a
549: large number of packages are all set in a simple, central
550: configuration file.</p></li>
1.128 wiz 551: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 552: freely available under a BSD license, so you may extend and adapt
553: pkgsrc to your needs. Support for local packages and patches is
554: available right out of the box, so you can configure it specifically
555: for your environment.</p></li>
556: </ul></div>
1.91 rillig 557: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 558: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 559: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 560: — That means, if a package contains bugs, it's better to find
1.91 rillig 561: them and to complain about them rather than to just install the package
562: and hope that it works. There are numerous checks in pkgsrc that try to
1.290 gutterid 563: 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 564: of shell scripts), and post-installation checks (installed files,
565: references to shared libraries, script interpreters).</p></li>
1.128 wiz 566: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 567: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 568: pkgsrc has been ported to many operating systems. Care is taken that
569: packages behave the same on all platforms.</p></li>
570: </ul></div>
1.82 rillig 571: </div>
1.148 asau 572: <div class="sect2">
1.82 rillig 573: <div class="titlepage"><div><div><h3 class="title">
574: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
575: <p>pkgsrc consists of both a source distribution and a binary
576: distribution for these operating systems. After retrieving the required
577: source or binaries, you can be up and running with pkgsrc in just
578: minutes!</p>
1.75 rillig 579: <p>pkgsrc was derived from FreeBSD's ports system, and
580: initially developed for NetBSD only. Since then, pkgsrc has
581: grown a lot, and now supports the following platforms:</p>
1.82 rillig 582: <div class="table">
583: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216 tnn 584: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 585: <colgroup>
586: <col>
587: <col>
1.202 sevan 588: <col>
1.82 rillig 589: </colgroup>
590: <thead><tr>
591: <th>Platform</th>
592: <th>Date Support Added</th>
1.202 sevan 593: <th>Notes</th>
1.82 rillig 594: </tr></thead>
595: <tbody>
596: <tr>
1.289 leot 597: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 598: <td align="center">Aug 1997</td>
1.202 sevan 599: <td class="auto-generated"> </td>
1.82 rillig 600: </tr>
601: <tr>
1.110 hubertf 602: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 603: <td align="center">Mar 1999</td>
1.264 sevan 604: <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 605: </tr>
606: <tr>
1.289 leot 607: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 608: <td align="center">Jun 1999</td>
1.264 sevan 609: <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 610: </tr>
611: <tr>
612: <td>
1.230 sevan 613: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82 rillig 614: </td>
615: <td align="center">Oct 2001</td>
1.305 bacon 616: <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 617: </tr>
618: <tr>
1.289 leot 619: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 620: <td align="center">Nov 2002</td>
1.264 sevan 621: <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 622: </tr>
623: <tr>
1.289 leot 624: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 625: <td align="center">Nov 2002</td>
1.264 sevan 626: <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 627: </tr>
628: <tr>
1.289 leot 629: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 630: <td align="center">Dec 2002</td>
1.202 sevan 631: <td>
1.264 sevan 632: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
633: <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 634: </td>
1.82 rillig 635: </tr>
636: <tr>
637: <td>BSD/OS</td>
638: <td align="center">Dec 2003</td>
1.202 sevan 639: <td class="auto-generated"> </td>
1.82 rillig 640: </tr>
641: <tr>
1.289 leot 642: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 643: <td align="center">Dec 2003</td>
1.264 sevan 644: <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 645: </tr>
646: <tr>
647: <td>
1.289 leot 648: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 649: (Microsoft Windows Services for Unix)
650: </td>
651: <td align="center">Mar 2004</td>
1.264 sevan 652: <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 653: </tr>
654: <tr>
1.289 leot 655: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 656: <td align="center">Oct 2004</td>
1.202 sevan 657: <td class="auto-generated"> </td>
1.82 rillig 658: </tr>
659: <tr>
1.110 hubertf 660: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 661: <td align="center">Nov 2004</td>
1.264 sevan 662: <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 663: </tr>
1.98 wiz 664: <tr>
1.289 leot 665: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 666: <td align="center">Apr 2007</td>
1.264 sevan 667: <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 668: </tr>
1.128 wiz 669: <tr>
1.289 leot 670: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128 wiz 671: <td align="center">Sep 2010</td>
1.264 sevan 672: <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 673: </tr>
1.151 obache 674: <tr>
1.289 leot 675: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 676: <td align="center">Jan 2011</td>
1.202 sevan 677: <td class="auto-generated"> </td>
1.151 obache 678: </tr>
679: <tr>
1.289 leot 680: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151 obache 681: <td align="center">Nov 2011</td>
1.264 sevan 682: <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 683: </tr>
684: <tr>
1.289 leot 685: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151 obache 686: <td align="center">Mar 2013</td>
1.264 sevan 687: <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 688: </tr>
1.166 jnemeth 689: <tr>
1.289 leot 690: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166 jnemeth 691: <td align="center">Jul 2013</td>
1.264 sevan 692: <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 693: </tr>
1.214 sevan 694: <tr>
1.289 leot 695: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214 sevan 696: <td align="center">Jun 2014</td>
1.264 sevan 697: <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 698: </tr>
1.82 rillig 699: </tbody>
1.91 rillig 700: </table></div>
1.82 rillig 701: </div>
1.91 rillig 702: <br class="table-break">
1.82 rillig 703: </div>
1.75 rillig 704: </div>
1.148 asau 705: <div class="sect1">
1.75 rillig 706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
707: <a name="overview"></a>1.2. Overview</h2></div></div></div>
708: <p>This document is divided into three parts. The first,
1.110 hubertf 709: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 710: describes how one can use one of the packages in the Package
711: Collection, either by installing a precompiled binary package,
1.93 rillig 712: or by building one's own copy using the NetBSD package system.
1.110 hubertf 713: 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 714: package so it can be easily built by other NetBSD users without
715: knowing about the package's building details. The third part,
1.110 hubertf 716: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 717: is intended for those who want to understand how pkgsrc is
718: implemented.</p>
719: <p>This document is available in various formats:
1.110 hubertf 720: <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 721: </div>
1.148 asau 722: <div class="sect1">
1.75 rillig 723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
724: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 725: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
726: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 727: terminology used within this document.</p>
1.148 asau 728: <div class="variablelist"><dl class="variablelist">
1.75 rillig 729: <dt><span class="term">Package</span></dt>
730: <dd><p>A set of files and building instructions
731: that describe what's necessary
732: to build a certain piece of software using
733: pkgsrc. Packages are traditionally stored under
1.236 wiz 734: <code class="filename">/usr/pkgsrc</code>,
735: but may be stored in any location,
736: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75 rillig 737: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 738: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 739: is part of the NetBSD operating system and can be bootstrapped
740: to run on non-NetBSD operating systems as well. It handles
741: building (compiling), installing, and removing of
742: packages.</p></dd>
1.75 rillig 743: <dt><span class="term">Distfile</span></dt>
744: <dd><p>This term describes the file or files that are
745: provided by the author of the piece of software to
746: distribute his work. All the changes necessary to build on
747: NetBSD are reflected in the corresponding package. Usually
748: the distfile is in the form of a compressed tar-archive,
749: but other types are possible, too. Distfiles are usually
750: stored below
1.76 rillig 751: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 752: <dt><span class="term">Port</span></dt>
753: <dd><p>This is the term used by FreeBSD and OpenBSD people
754: for what we call a package.
1.128 wiz 755: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 756: architecture.</p></dd>
757: <dt><span class="term">Precompiled/binary package</span></dt>
758: <dd>
759: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 760: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 761: file so it can be installed on machines of the same
762: machine architecture without the need to
763: recompile. Packages are usually generated in
1.76 rillig 764: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 765: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 766: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 767: especially in the context of precompiled packages.</p>
768: </dd>
769: <dt><span class="term">Program</span></dt>
1.88 wiz 770: <dd><p>The piece of software to be installed which will be
771: constructed from all the files in the distfile by the
772: actions defined in the corresponding package.</p></dd>
1.75 rillig 773: </dl></div>
1.148 asau 774: <div class="sect2">
1.75 rillig 775: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 776: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 777: <div class="variablelist"><dl class="variablelist">
1.75 rillig 778: <dt><span class="term">pkgsrc users</span></dt>
779: <dd>
780: <p>The
781: pkgsrc users are people who use the packages provided by pkgsrc.
782: Typically they are system administrators. The people using the
1.128 wiz 783: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
784: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 785: <p>There are two kinds of pkgsrc users: Some only want to
786: install pre-built binary packages. Others build the pkgsrc
787: packages from source, either for installing them directly or for
1.110 hubertf 788: 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 789: documentation.</p>
790: </dd>
791: <dt><span class="term">package maintainers</span></dt>
792: <dd><p>A
1.110 hubertf 793: 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 794: <dt><span class="term">infrastructure developers</span></dt>
795: <dd><p>These people are involved in all those files
1.76 rillig 796: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 797: 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 798: too.</p></dd>
799: </dl></div>
800: </div>
801: </div>
1.148 asau 802: <div class="sect1">
1.75 rillig 803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
804: <a name="typography"></a>1.4. Typography</h2></div></div></div>
805: <p>When giving examples for commands, shell prompts are used to
806: show if the command should/can be issued as root, or if
1.128 wiz 807: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.226 sevan 808: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
809: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
810: bourne shell and derivatives.</p>
1.75 rillig 811: </div>
812: </div>
1.148 asau 813: <div class="part">
1.75 rillig 814: <div class="titlepage"><div><div><h1 class="title">
815: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
816: <div class="toc">
817: <p><b>Table of Contents</b></p>
1.210 leot 818: <dl class="toc">
1.267 rillig 819: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
820: <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 821: <dd><dl>
1.267 rillig 822: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 823: <dd><dl>
1.267 rillig 824: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
825: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 826: </dl></dd>
1.267 rillig 827: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 828: <dd><dl>
1.267 rillig 829: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
830: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 831: </dl></dd>
832: </dl></dd>
1.267 rillig 833: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75 rillig 834: <dd><dl>
1.267 rillig 835: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
836: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 837: </dl></dd>
1.267 rillig 838: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75 rillig 839: <dd><dl>
1.267 rillig 840: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 841: <dd><dl>
1.267 rillig 842: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
843: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317 nia 844: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
845: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
846: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
847: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
848: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
849: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. 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>
1.317 nia 1225: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1226: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1227: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1228: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1229: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
1230: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.267 rillig 1231: </dl></dd>
1232: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1233: <dd><dl>
1234: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1235: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1236: <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 1237: </dl></dd>
1238: </dl>
1239: </div>
1240: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1241: is to only install the package tools and to use binary packages
1.128 wiz 1242: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1243: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1244: of pkgsrc, too. Then you are able to build your own packages,
1245: and you can still use binary packages from someone else.</p>
1.148 asau 1246: <div class="sect1">
1.75 rillig 1247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1248: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.317 nia 1249: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264 sevan 1250: site and mirrors, there are collections of binary packages,
1.109 rillig 1251: ready to be installed. These binary packages have been built using the
1252: default settings for the directories, that is:</p>
1.148 asau 1253: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1254: <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>
1255: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1256: <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 1257: </ul></div>
1258: <p>If you cannot use these directories for whatever reasons (maybe
1259: because you're not root), you cannot use these binary packages, but
1.267 rillig 1260: 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 1261: <div class="sect2">
1.75 rillig 1262: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1263: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1264: <p>To install binary packages, you first need to know from where
1265: to get them. The first place where you should look is on the main
1.317 nia 1266: pkgsrc CDN in the directory <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.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
1.317 nia 1286: that may not be distributed via HTTP or FTP.</p>
1.109 rillig 1287: <p>To install packages directly from an FTP or HTTP server, run
1288: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1289: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1290: <pre class="screen">
1.317 nia 1291: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1292: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284 rillig 1293: <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 1294: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.317 nia 1295: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.109 rillig 1296: </pre>
1297: <p>Instead of URLs, you can also use local paths, for example if
1298: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1299: repository. If you want to install packages from multiple sources,
1300: you can separate them by a semicolon in
1301: <code class="varname">PKG_PATH</code>.</p>
1302: <p>After these preparations, installing a package is very
1303: easy:</p>
1304: <pre class="screen">
1.317 nia 1305: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1306: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1307: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1308: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1309: </pre>
1310: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1311: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1312: <p>Any prerequisite packages needed to run the
1.88 wiz 1313: package in question will be installed, too, assuming they are
1.317 nia 1314: present in the repository.</p>
1.75 rillig 1315: <p>After you've installed packages, be sure to have
1.88 wiz 1316: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1317: <code class="varname">PATH</code> so you can actually start the just
1318: installed program.</p>
1.75 rillig 1319: </div>
1.148 asau 1320: <div class="sect2">
1.75 rillig 1321: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1322: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1323: <p>To update binary packages, it is recommended that you use
1324: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1325: package repository to your locally installed packages and safely
1326: replace any older packages.</p>
1327: <p>Note that pkgsrc is released as quarterly branches.
1328: If you are updating to a newer quarterly branch of pkgsrc, you may
1329: need to adjust the repository in
1330: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1331: </div>
1332: <div class="sect2">
1333: <div class="titlepage"><div><div><h3 class="title">
1334: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.82 rillig 1335: <p>To deinstall a package, it does not matter whether it was
1.317 nia 1336: installed from source code or from a binary package. Neither the
1337: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1338: command need to know.</p>
1339: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.88 wiz 1340: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.317 nia 1341: name can be given with or without version number.</p>
1.82 rillig 1342: </div>
1.148 asau 1343: <div class="sect2">
1.82 rillig 1344: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1345: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1346: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.317 nia 1347: installed packages or binary package files.
1348: As with other management tools, it works with packages installed
1349: from source or binaries.</p>
1.82 rillig 1350: </div>
1.148 asau 1351: <div class="sect2">
1.82 rillig 1352: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1353: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82 rillig 1354: <p>
1.279 leot 1355: The pkgsrc Security Team and Packages Groups maintain a list of
1.317 nia 1356: known vulnerabilities to packages which are (or have been)
1.88 wiz 1357: included in pkgsrc. The list is available from the NetBSD
1.317 nia 1358: CDN at <a class="ulink" href="https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
1359: </p>
1360: <p>
1361: Please note that not every "vulnerability" with a CVE assignment is
1362: exploitable in every configuration.
1363: Some bugs are marked as active simply because an fix was not
1364: marked as such.
1365: Operating system specific hardening and mitigation features may also
1366: reduce the impact of bugs.
1.88 wiz 1367: </p>
1.82 rillig 1368: <p>
1.125 wiz 1369: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1370: this list can be downloaded
1371: automatically, and a security audit of all packages installed on a system
1372: can take place.
1373: </p>
1.82 rillig 1374: <p>
1.125 wiz 1375: There are two components to auditing. The first
1376: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1377: is for downloading
1.88 wiz 1378: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1379: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1380: installed packages are vulnerable. If a package is vulnerable, you
1381: will see output similar to the following:
1382: </p>
1.82 rillig 1383: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289 leot 1384: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1385: <p>
1.125 wiz 1386: You may wish to have the
1.317 nia 1387: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1388: file downloaded daily so that
1389: it remains current. This may be done by adding an appropriate entry
1.311 leot 1390: 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 1391: </p>
1392: <pre class="screen">
1.233 sevan 1393: # Download vulnerabilities file
1.230 sevan 1394: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.233 sevan 1395: # Audit the installed packages and email results to root
1396: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1397: root >/dev/null 2>&1
1.125 wiz 1398: </pre>
1399: <p>
1.230 sevan 1400: will update the vulnerability list every day at 3AM, followed by an audit
1401: at 3:09AM. The result of the audit are then emailed to root.
1.125 wiz 1402:
1.230 sevan 1403: On NetBSD this may be accomplished instead by adding the following
1404: line to <code class="filename">/etc/daily.conf</code>:
1405: </p>
1406: <pre class="screen">
1407: fetch_pkg_vulnerabilities=YES
1408: </pre>
1409: <p>
1410: to fetch the vulnerability list from the daily security script. The system
1411: is set to audit the packages by default but can be set explicitly, if
1.235 yyamano 1412: desired (not required), by adding the following line to
1.230 sevan 1413: <code class="filename">/etc/security.conf</code>:
1.125 wiz 1414: </p>
1415: <pre class="screen">
1.230 sevan 1416: check_pkg_vulnerabilities=YES
1.125 wiz 1417: </pre>
1418: <p>
1.311 leot 1419: 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 1420: </p>
1.82 rillig 1421: </div>
1.148 asau 1422: <div class="sect2">
1.82 rillig 1423: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1424: <a name="pkg_versions"></a>5.1.7. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.82 rillig 1425: <p>
1.250 leot 1426: 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 1427: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.317 nia 1428: argument to check if any packages are stale, e.g.
1.88 wiz 1429: </p>
1430: <pre class="screen">
1431: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1432: ...
1.88 wiz 1433: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1434: </pre>
1.82 rillig 1435: </div>
1.148 asau 1436: <div class="sect2">
1.82 rillig 1437: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1438: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.110 hubertf 1439: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1440: administrative functions on the package system.</p>
1.82 rillig 1441: </div>
1.75 rillig 1442: </div>
1.148 asau 1443: <div class="sect1">
1.75 rillig 1444: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1445: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88 wiz 1446: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1447: directory now contains a set of packages, organized into
1448: categories. You can browse the online index of packages, or run
1.110 hubertf 1449: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1450: directory to build local <code class="filename">README.html</code> files for
1.250 leot 1451: 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 1452: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1453: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1454: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1455: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1456: different <code class="varname">LOCALBASE</code> definitions on the same
1457: system (inside a chroot is an exception). </p>
1458: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1459: 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 1460: instructions how to create your own packages.</p>
1.148 asau 1461: <div class="sect2">
1.75 rillig 1462: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1463: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82 rillig 1464: <p>To build packages from source, you need a working C
1.88 wiz 1465: compiler. On NetBSD, you need to install the
1.128 wiz 1466: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1467: sets. If you want to build X11-related packages, the
1.128 wiz 1468: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1469: sets are required, too.</p>
1.75 rillig 1470: </div>
1.148 asau 1471: <div class="sect2">
1.75 rillig 1472: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1473: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75 rillig 1474: <p>The first step for building a package is downloading the
1.88 wiz 1475: distfiles (i.e. the unmodified source). If they have not yet been
1476: downloaded, pkgsrc will fetch them automatically.</p>
1477: <p>If you have all files that you need in the
1478: <code class="filename">distfiles</code> directory,
1479: you don't need to connect. If the distfiles are on CD-ROM, you can
1480: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1481: </p>
1.82 rillig 1482: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1483: <p>
1.110 hubertf 1484: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1485: <p>By default a list of distribution sites will be randomly
1486: intermixed to prevent huge load on servers which holding popular
1487: packages (for example, SourceForge.net mirrors). Thus, every
1488: time when you need to fetch yet another distfile all the mirrors
1489: will be tried in new (random) order. You can turn this feature
1490: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1491: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1492: <p>You can overwrite some of the major distribution sites to
1493: fit to sites that are close to your own. By setting one or two
1494: variables you can modify the order in which the master sites are
1495: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1496: delimited list of domain suffixes.
1497: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1498: contains a whitespace delimited list of regular expressions. It
1499: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1500: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1501: some examples. This may save some of your bandwidth and
1502: time.</p>
1.75 rillig 1503: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1504: if you want to keep the settings, by editing the
1.110 hubertf 1505: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1506: and adding the definitions there.</p>
1.82 rillig 1507: <p>
1.88 wiz 1508: If a package depends on many other packages (such as
1.250 leot 1509: <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 1510: alternate between periods of
1511: downloading source, and compiling. To ensure you have all the source
1512: downloaded initially you can run the command:
1513: </p>
1.82 rillig 1514: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1515: <p>
1.88 wiz 1516: which will output and run a set of shell commands to fetch the
1517: necessary files into the <code class="filename">distfiles</code> directory. You can
1518: also choose to download the files manually.
1519: </p>
1.75 rillig 1520: </div>
1.148 asau 1521: <div class="sect2">
1.75 rillig 1522: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1523: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1524: <p>
1.88 wiz 1525: Once the software has downloaded, any patches will be applied, then it
1526: will be compiled for you. This may take some time depending on your
1527: computer, and how many other packages the software depends on and their
1528: compile time.
1529: </p>
1.148 asau 1530: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1531: <h3 class="title">Note</h3>
1532: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1533: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1534: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1535: </div>
1.87 wiz 1536: <p>For example, type</p>
1.88 wiz 1537: <pre class="screen">
1538: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1539: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1540: </pre>
1.75 rillig 1541: <p>at the shell prompt to build the various components of the
1.88 wiz 1542: package.</p>
1.82 rillig 1543: <p>The next stage is to actually install the newly compiled
1.88 wiz 1544: program onto your system. Do this by entering:
1.82 rillig 1545:
1.88 wiz 1546: </p>
1.82 rillig 1547: <pre class="screen">
1.88 wiz 1548: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1549: </pre>
1.82 rillig 1550: <p>
1551:
1.88 wiz 1552: while you are still in the directory for whatever package you
1553: are installing.</p>
1.82 rillig 1554: <p>Installing the package on your system may require you to
1.88 wiz 1555: be root. However, pkgsrc has a
1556: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1557: to only become root for the actual installation step.</p>
1.82 rillig 1558: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1559: You can now enter:
1.82 rillig 1560:
1.88 wiz 1561: </p>
1.82 rillig 1562: <pre class="screen">
1.88 wiz 1563: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1564: </pre>
1.82 rillig 1565: <p>
1566:
1.88 wiz 1567: to remove the compiled files in the work directory, as you shouldn't need
1568: them any more. If other packages were also added to your system
1569: (dependencies) to allow your program to compile, you can tidy these up
1570: also with the command:</p>
1.82 rillig 1571: <pre class="screen">
1.88 wiz 1572: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1573: </pre>
1.75 rillig 1574: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 1575: 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 1576: <p>The program is installed under the default root of the
1577: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1578: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1579: variable in your environment, and it will use that value as the
1580: root of your packages tree. So, to use
1581: <code class="filename">/usr/local</code>, set
1582: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1583: Please note that you should use a directory which is dedicated to
1584: packages and not shared with other programs (i.e., do not try and
1585: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1586: to add any of your own files or directories (such as
1587: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1588: <code class="filename">pkgsrc/</code>) below the
1589: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1590: conflicts between programs and other files installed by the
1591: package system and whatever else may have been installed
1592: there.</p>
1.110 hubertf 1593: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1594: alter some configuration options at build time. Have a look at
1595: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1596: of what will be set there by default. Environment variables such
1597: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1598: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1599: set them each time you want to use pkgsrc.</p>
1.128 wiz 1600: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1601: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 1602: or being installed. This may be for debugging purposes, or out of
1603: simple curiosity. A number of utility values have been added to
1604: help with this.</p>
1.128 wiz 1605: <div class="orderedlist"><ol class="orderedlist" type="1">
1606: <li class="listitem">
1.311 leot 1607: <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 1608: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1609: information will be displayed. For example,</p>
1.75 rillig 1610: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1611: <p>will show all the commands that are invoked, up to and
1.128 wiz 1612: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1613: </li>
1.128 wiz 1614: <li class="listitem">
1.311 leot 1615: <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 1616: definition, then the <code class="varname">VARNAME</code> definition
1617: should be used, in conjunction with the show-var
1.311 leot 1618: 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 1619: variable <code class="varname">LOCALBASE</code>:</p>
1620: <pre class="screen">
1621: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 1622: /usr/pkg
1623: <code class="prompt">%</code>
1.88 wiz 1624: </pre>
1.75 rillig 1625: </li>
1626: </ol></div>
1627: <p>If you want to install a binary package that you've either
1.88 wiz 1628: created yourself (see next section), that you put into
1629: pkgsrc/packages manually or that is located on a remote FTP
1630: server, you can use the "bin-install" target. This target will
1.311 leot 1631: 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 1632: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1633: sites searched is kept in the variable
1634: <code class="varname">BINPKG_SITES</code>, which defaults to
1.311 leot 1635: 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 1636: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1637: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1638: details.</p>
1639: <p>A final word of warning: If you set up a system that has a
1640: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1641: set that before any packages are installed, as you cannot use
1642: several directories for the same purpose. Doing so will result in
1643: pkgsrc not being able to properly detect your installed packages,
1644: and fail miserably. Note also that precompiled binary packages are
1645: usually built with the default <code class="varname">LOCALBASE</code> of
1646: <code class="filename">/usr/pkg</code>, and that you should
1647: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1648: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 1649: </div>
1650: </div>
1651: </div>
1.148 asau 1652: <div class="chapter">
1.75 rillig 1653: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1654: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75 rillig 1655: <div class="toc">
1656: <p><b>Table of Contents</b></p>
1.210 leot 1657: <dl class="toc">
1.267 rillig 1658: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1659: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1660: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
1661: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1662: <dd><dl>
1663: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
1664: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1665: <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 1666: </dl></dd>
1.267 rillig 1667: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
1668: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75 rillig 1669: </dl>
1670: </div>
1.104 rillig 1671: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 1672: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1673: that file depends on the installation. On NetBSD, when you use
1.311 leot 1674: <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 1675: <code class="filename">/etc/</code>. In all other cases the default location is
1676: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1677: bootstrap program to install the binary packages.</p>
1678: <p>The format of the configuration file is that of the usual
1679: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1680: is done by setting variables in this file. Note that you can define all
1681: kinds of variables, and no special error checking (for example for
1.223 rillig 1682: spelling mistakes) takes place.</p>
1.148 asau 1683: <div class="sect1">
1.75 rillig 1684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1685: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223 rillig 1686: <p>The following variables apply to all
1.89 rillig 1687: pkgsrc packages. A complete list of the variables that can be
1688: configured by the user is available in
1689: <code class="filename">mk/defaults/mk.conf</code>, together with some
1690: comments that describe each variable's intent.</p>
1.148 asau 1691: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1692: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 1693: packages will be installed. The default is
1.76 rillig 1694: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 1695: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 1696: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1697: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 1698: installed. The default is
1.76 rillig 1699: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 1700: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 1701: X11 is installed on the system. The default is
1.194 bsiegert 1702: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 1703: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 1704: downloaded copies of the original source distributions used
1705: for building pkgsrc packages. The default is
1.76 rillig 1706: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 1707: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 1708: database about installed packages is stored. The default is
1.230 sevan 1709: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128 wiz 1710: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 1711: If set, override the packages'
1712: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 1713: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 1714: Backup location(s) for distribution files and patch files
1715: if not found locally or in
1.76 rillig 1716: <code class="filename">${MASTER_SITES}</code> or
1717: <code class="filename">${PATCH_SITES}</code> respectively.
1.230 sevan 1718: The defaults is
1719: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 1720: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 1721: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1722: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 1723: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1724: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1725: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 1726: List of acceptable licenses. License names are case-sensitive.
1727: Whenever you try to build a package whose license is not in this
1728: list, you will get an error message. If the license condition is
1729: simple enough, the error message will include specific
1730: instructions on how to change this variable.</p></li>
1.75 rillig 1731: </ul></div>
1732: </div>
1.148 asau 1733: <div class="sect1">
1.75 rillig 1734: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1735: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219 rillig 1736: <p>
1.75 rillig 1737: </p>
1.148 asau 1738: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1739: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 1740: directory for the binary packages. The default is
1.76 rillig 1741: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 1742: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 1743: The top level directory where, if defined, the separate
1744: working directories will get created, and symbolically
1.76 rillig 1745: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 1746: This is useful for building packages on several
1.76 rillig 1747: architectures, then <code class="filename">${PKGSRCDIR}</code>
1748: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 1749: is local to every architecture. (It should be noted that
1750: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 1751: — it is an internal definition which refers to the
1.75 rillig 1752: root of the pkgsrc tree. It is possible to have many
1753: pkgsrc tree instances.)</p></li>
1.128 wiz 1754: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 1755: Directory for local patches that aren't part of pkgsrc.
1.299 rillig 1756: 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 1757: information.</p></li>
1.128 wiz 1758: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 1759: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 1760: BSD-style Makefile. If this is not set,
1761: <code class="varname">MAKECONF</code> is set to
1.76 rillig 1762: <code class="filename">/dev/null</code> to avoid picking up
1763: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75 rillig 1764: </ul></div>
1765: </div>
1.148 asau 1766: <div class="sect1">
1.75 rillig 1767: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1768: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.312 gdt 1769: <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 1770: By default, binary packages of built packages are
1.263 leot 1771: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256 maya 1772: this variable to "no" prevents this.</p></li></ul></div>
1.217 jnemeth 1773: <p>Packages have to support installation into a
1.103 wiz 1774: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1775: to be built, before the actual filesystem is touched. DESTDIR
1776: support exists in two variations:</p>
1.148 asau 1777: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1778: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 1779: installation and packaging is still run as root.</p></li>
1780: <li class="listitem"><p>Full DESTDIR support can run the complete
1781: build, installation and packaging as normal user. Root
1782: privileges are only needed to add packages.</p></li>
1783: </ul></div>
1.103 wiz 1784: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1785: clean</code></strong> needs to be run as root.</p>
1.118 imil 1786: <p>Considering the <code class="filename">foo/bar</code> package,
1787: DESTDIR full support can be tested using the following commands
1788:
1789: </p>
1790: <pre class="programlisting">
1791: <code class="prompt">$</code> id
1792: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1793: <code class="prompt">$</code> mkdir $HOME/packages
1794: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1795: </pre>
1796: <p>
1797:
1798: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1799: should be needed
1800:
1801: </p>
1802: <pre class="programlisting">
1.174 asau 1803: <code class="prompt">$</code> make stage-install
1.118 imil 1804: </pre>
1805: <p>
1806:
1807: Create a package without root privileges
1808:
1809: </p>
1810: <pre class="programlisting">
1.174 asau 1811: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 1812: </pre>
1813: <p>
1814:
1815: For the following command, you must be able to gain root
1.311 leot 1816: 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 1817:
1818: </p>
1819: <pre class="programlisting">
1.174 asau 1820: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 1821: </pre>
1822: <p>
1823:
1824: Then, as a simple user
1825:
1826: </p>
1827: <pre class="programlisting">
1828: <code class="prompt">$</code> make clean
1829: </pre>
1830: <p>
1831:
1832: </p>
1.103 wiz 1833: </div>
1.148 asau 1834: <div class="sect1">
1.103 wiz 1835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1836: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 1837: <div class="sect2">
1.78 rillig 1838: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1839: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 1840: <p>By default, pkgsrc will use GCC to build packages. This may be
1841: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 1842: <div class="variablelist"><dl class="variablelist">
1.89 rillig 1843: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1844: <dd>
1845: <p>This is a list of values specifying the chain of
1846: compilers to invoke when building packages. Valid values
1847: are:</p>
1.148 asau 1848: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 1849: <li class="listitem"><p><code class="varname">ccc</code>:
1850: Compaq C Compilers (Tru64)</p></li>
1851: <li class="listitem"><p><code class="varname">ccache</code>:
1852: compiler cache (chainable)</p></li>
1853: <li class="listitem"><p><code class="varname">clang</code>:
1854: Clang C and Objective-C compiler</p></li>
1.128 wiz 1855: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 1856: distributed C/C++ (chainable)</p></li>
1.174 asau 1857: <li class="listitem"><p><code class="varname">f2c</code>:
1858: Fortran 77 to C compiler (chainable)</p></li>
1859: <li class="listitem"><p><code class="varname">icc</code>:
1860: Intel C++ Compiler (Linux)</p></li>
1861: <li class="listitem"><p><code class="varname">ido</code>:
1862: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 1863: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 1864: GNU C/C++ Compiler</p></li>
1.174 asau 1865: <li class="listitem"><p><code class="varname">hp</code>:
1866: HP-UX C/aC++ compilers</p></li>
1.128 wiz 1867: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 1868: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 1869: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 1870: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 1871: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 1872: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 1873: <li class="listitem"><p><code class="varname">xlc</code>:
1.230 sevan 1874: IBM's XL C/C++ compiler suite</p></li>
1.89 rillig 1875: </ul></div>
1876: <p>The default is
1.128 wiz 1877: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 1878: <code class="varname">ccache</code> and/or
1879: <code class="varname">distcc</code> with an appropriate
1880: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 1881: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 1882: variable should always be terminated with a value for
1883: a real compiler. Note that only one real compiler
1.128 wiz 1884: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 1885: is not allowed).</p>
1.89 rillig 1886: </dd>
1887: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1888: <dd><p>This specifies the minimum version of GCC to use
1889: when building packages. If the system GCC doesn't
1890: satisfy this requirement, then pkgsrc will build and
1891: install one of the GCC packages to use instead.</p></dd>
1.266 leot 1892: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225 maya 1893: <dd><p>Specifies which version of python to use when several
1894: options are available.</p></dd>
1895: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291 gutterid 1896: <dd><p>Specifies the Fortran compiler to use.
1897: The default is <code class="varname">gfortran</code>.</p></dd>
1.225 maya 1898: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1899: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1900: <code class="varname">gfortran</code> is used, this option specifies which
1901: version to use.</p></dd>
1.89 rillig 1902: </dl></div>
1903: </div>
1.148 asau 1904: <div class="sect2">
1.89 rillig 1905: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1906: <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 1907: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1908: please make sure to use the <code class="literal">+=</code> operator
1909: instead of the <code class="literal">=</code> operator:</p>
1910: <pre class="programlisting">
1.100 rillig 1911: CFLAGS+= -your -flags
1.78 rillig 1912: </pre>
1913: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 1914: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 1915: need to add their own flags. You may want to take a look
1.250 leot 1916: 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 1917: package if you're interested in optimization specifically
1918: for the current CPU. </p>
1.78 rillig 1919: </div>
1.148 asau 1920: <div class="sect2">
1.88 wiz 1921: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1922: <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 1923: <p>If you want to pass flags to the linker, both in the configure
1924: step and the build step, you can do this in two ways. Either set
1925: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1926: between the two is that <code class="varname">LIBS</code> will be appended to
1927: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1928: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1929: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1930: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1931: <code class="varname">CFLAGS</code>, if you do not wish to override these
1932: settings, use the <code class="literal">+=</code> operator:</p>
1933: <pre class="programlisting">
1.100 rillig 1934: LDFLAGS+= -your -linkerflags
1.88 wiz 1935: </pre>
1936: </div>
1.78 rillig 1937: </div>
1.148 asau 1938: <div class="sect1">
1.78 rillig 1939: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1940: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 1941: <p>
1.75 rillig 1942: </p>
1.148 asau 1943: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1944: <li class="listitem">
1.75 rillig 1945: <p><code class="varname">PKG_DEVELOPER</code>:
1946: Run some sanity checks that package developers want:
1947: </p>
1.148 asau 1948: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 1949: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 1950: fuzz</p></li>
1.128 wiz 1951: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 1952: binaries will find their shared libs.</p></li>
1.75 rillig 1953: </ul></div>
1954: <p>
1.87 wiz 1955: </p>
1.75 rillig 1956: </li>
1.128 wiz 1957: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 1958: of debugging output which is displayed whilst making and
1959: installing the package. The default value for this is 0,
1960: which will not display the commands as they are executed
1961: (normal, default, quiet operation); the value 1 will display
1962: all shell commands before their invocation, and the value 2
1963: will display both the shell commands before their invocation,
1.223 rillig 1964: as well as their actual execution progress with <span class="command"><strong>set
1965: -x</strong></span>.</p></li>
1.75 rillig 1966: </ul></div>
1967: <p>
1968: </p>
1969: </div>
1.148 asau 1970: <div class="sect1">
1.75 rillig 1971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1972: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 1973: <p>Some packages have build time options, usually to select
1974: between different dependencies, enable optional support for big
1975: dependencies or enable experimental features.</p>
1.75 rillig 1976: <p>To see which options, if any, a package supports, and which
1.110 hubertf 1977: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 1978: show-options</strong></span>, for example:</p>
1.75 rillig 1979: <pre class="programlisting">
1980: The following options are supported by this package:
1981: ssl Enable SSL support.
1982: Exactly one of the following gecko options is required:
1983: firefox Use firefox as gecko rendering engine.
1984: mozilla Use mozilla as gecko rendering engine.
1985: At most one of the following database options may be selected:
1986: mysql Enable support for MySQL database.
1987: pgsql Enable support for PostgreSQL database.
1.1 grant 1988:
1.75 rillig 1989: These options are enabled by default: firefox
1990: These options are currently enabled: mozilla ssl
1.1 grant 1991: </pre>
1.75 rillig 1992: <p>The following variables can be defined in
1.110 hubertf 1993: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 1994: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1995: which can be used to select or disable options for all packages
1996: that support them, and
1997: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1998: which can be used to select or disable options specifically for
1999: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2000: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2001: are disabled. A few examples:</p>
1.75 rillig 2002: <pre class="screen">
1.110 hubertf 2003: <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 2004: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2005: PKG_OPTIONS.kdebase= debug -sasl
2006: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2007: <p>It is important to note that options that were specifically
1.120 snj 2008: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2009: you do not wish to include the option. If you are unsure you can view
2010: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2011: <p>The following settings are consulted in the order given, and
2012: the last setting that selects or disables an option is
2013: used:</p>
1.128 wiz 2014: <div class="orderedlist"><ol class="orderedlist" type="1">
2015: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2016: maintainer</p></li>
1.128 wiz 2017: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2018: variables (see below)</p></li>
1.128 wiz 2019: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2020: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2021: </ol></div>
2022: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2023: selected is used, all others are automatically disabled. If an
2024: option of the group is explicitly disabled, the previously
2025: selected option, if any, is used. It is an error if no option
2026: from a required group of options is selected, and building the
2027: package will fail.</p>
2028: <p>Before the options framework was introduced, build options
2029: were selected by setting a variable (often named
2030: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2031: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2032: transition to the options framework for the user, these legacy
2033: variables are converted to the appropriate options setting
2034: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2035: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2036: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2037: directly. Support for the legacy variables will be removed
2038: eventually.</p>
1.75 rillig 2039: </div>
2040: </div>
1.148 asau 2041: <div class="chapter">
1.75 rillig 2042: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2043: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75 rillig 2044: <div class="toc">
2045: <p><b>Table of Contents</b></p>
1.210 leot 2046: <dl class="toc">
1.267 rillig 2047: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2048: <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 2049: </dl>
2050: </div>
1.148 asau 2051: <div class="sect1">
1.75 rillig 2052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2053: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2054: <p>Once you have built and installed a package, you can create
2055: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.311 leot 2056: 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 2057: the same package on a group of hosts and wasting CPU time. It also
2058: provides a simple means for others to install your package, should
2059: you distribute it.</p>
2060: <p>To create a binary package, change into the appropriate
1.110 hubertf 2061: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2062: package</strong></span>:</p>
2063: <pre class="screen">
1.223 rillig 2064: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2065: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2066: </pre>
1.87 wiz 2067: <p>This will build and install your package (if not already done),
2068: and then build a binary package from what was installed. You can
1.110 hubertf 2069: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2070: it. Binary packages are created by default in
2071: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2072: 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 2073: 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 2074: <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 2075: such a binary package.</p>
1.75 rillig 2076: </div>
1.148 asau 2077: <div class="sect1">
1.75 rillig 2078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2079: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.299 rillig 2080: <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 2081: </div>
2082: </div>
1.148 asau 2083: <div class="chapter">
1.106 rillig 2084: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2085: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 2086: builds)</h2></div></div></div>
2087: <div class="toc">
2088: <p><b>Table of Contents</b></p>
1.210 leot 2089: <dl class="toc">
1.267 rillig 2090: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 2091: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 2092: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2093: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 2094: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2095: <dd><dl>
1.294 rillig 2096: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2097: <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 2098: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
2099: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
2100: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
2101: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
2102: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
2103: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
2104: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
2105: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 2106: </dl></dd>
2107: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2108: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2109: </dl>
2110: </div>
1.290 gutterid 2111: <p>For a number of reasons, you may want to build binary packages
2112: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180 wiz 2113: For instance, when you have multiple machines that should run the same software,
2114: it is wasted time if they all build their packages themselves from source.
2115: Or you may want to build a list of packages you want and check them before
1.290 gutterid 2116: deploying onto production systems.
1.180 wiz 2117: There is a way of getting a set of binary packages:
1.290 gutterid 2118: the bulk build system, or pbulk ("p" stands for "parallel").
1.223 rillig 2119: This chapter describes how to set it up.</p>
1.148 asau 2120: <div class="sect1">
1.106 rillig 2121: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2122: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180 wiz 2123: <p>First of all, you have to decide whether you build all packages
2124: or a limited set of them. Full bulk builds usually consume a lot more resources,
2125: both space and time, than builds for some practical sets of packages.
1.290 gutterid 2126: A number of particularly heavy packages exist that are not actually
2127: interesting to a wide audience. (The approximate resource consumption for a
2128: 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>.)
2129: For limited bulk builds you need to make a list of packages you want to build.
1.223 rillig 2130: Note that all their dependencies will be built, so you don't need to track them manually.
1.180 wiz 2131: </p>
2132: <p>During bulk builds various packages are installed and deinstalled
2133: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2134: so make sure that you don't need any package during the builds.
1.223 rillig 2135: Essentially, you should provide a fresh system, either a chroot environment
1.180 wiz 2136: or something even more restrictive, depending on what the operating system provides,
2137: or dedicate the whole physical machine.
2138: As a useful side effect this makes sure that bulk builds cannot
2139: break anything in your system. There have been numerous cases where
1.106 rillig 2140: certain packages tried to install files outside the
2141: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2142: <code class="filename">/etc</code>.
2143: </p>
1.106 rillig 2144: </div>
1.148 asau 2145: <div class="sect1">
1.106 rillig 2146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.295 rillig 2147: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
2148: <p>Running a bulk build works roughly as follows:</p>
1.148 asau 2149: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2150: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2151: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2152: </ul></div>
1.148 asau 2153: <div class="sect2">
1.116 rillig 2154: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 2155: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223 rillig 2156: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178 asau 2157: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2158: Configure network access to fetch distribution files.
1.223 rillig 2159: Create a user with name "pbulk".</p>
1.178 asau 2160: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2161: <pre class="screen">
1.264 sevan 2162: <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>
2163: <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 2164: <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 2165: </pre>
2166: <p>Or any other way that fits (e.g., curl, wget).</p>
2167: <p>Deploy and configure pbulk tools, e.g.:</p>
2168: <pre class="screen">
1.230 sevan 2169: <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 2170: <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>
2171: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2172: </pre>
2173: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2174: <h3 class="title">Note</h3>
2175: <p><code class="filename">mk.conf.frag</code> is a fragment of
2176: <code class="filename">mk.conf</code> that contains settings you want to
2177: apply to packages you build. For instance,</p>
2178: <pre class="programlisting">
1.223 rillig 2179: PKG_DEVELOPER= yes # perform more checks
2180: X11_TYPE= modular # use pkgsrc X11
2181: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2182: # when building all packages)
1.178 asau 2183: </pre>
2184: </div>
2185: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223 rillig 2186: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178 asau 2187: <pre class="programlisting">
2188: www/firefox
2189: mail/thunderbird
2190: misc/libreoffice4
2191: </pre>
1.179 asau 2192: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2193: and make final amendments, if wanted.</p>
1.178 asau 2194: <p>Start it:</p>
2195: <pre class="screen">
2196: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2197: </pre>
2198: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2199: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2200: </p>
2201: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2202: <h3 class="title">Note</h3>
2203: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2204: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2205: The script is kept small enough for better understanding.</p>
2206: </div>
2207: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2208: <h3 class="title">Note</h3>
2209: <p>The <code class="filename">pbulk.sh</code> script supports running
1.320 wiz 2210: unprivileged bulk build and helps configuring distributed bulk builds.
2211: Distributed bulk builds support either building in worker chroots
2212: (each node is a path to a different chroot)
2213: that replicate the target system, including the pbulk prefix,
2214: or remote machines (each node is
2215: an IP address that must be accessible over SSH without a password).</p>
1.178 asau 2216: </div>
1.106 rillig 2217: </div>
2218: </div>
1.148 asau 2219: <div class="sect1">
1.106 rillig 2220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2221: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180 wiz 2222: <p>A complete bulk build requires lots of disk space. Some of the
2223: disk space can be read-only, some other must be writable. Some can be on
2224: remote filesystems (such as NFS) and some should be local. Some can be
2225: temporary filesystems, others must survive a sudden reboot.</p>
2226: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.320 wiz 2227: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2228: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.180 wiz 2229: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2230: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2231: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2232: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2233: </ul></div>
2234: </div>
2235: <div class="sect1">
2236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.293 rillig 2237: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2238: <p>To ensure that pkgsrc packages work in different configurations, it
2239: makes sense to run non-default bulk builds from time to time. This
2240: section lists some ideas for bulk builds that intentionally let packages
2241: fail if they don't follow the pkgsrc style.</p>
2242: <div class="sect2">
2243: <div class="titlepage"><div><div><h3 class="title">
1.294 rillig 2244: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.293 rillig 2245: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2246: <pre class="programlisting">
2247: GNU_CONFIGURE_STRICT= yes
2248: </pre>
2249: <p>When a package fails this additional check, the most common cause
2250: is that the configure option was valid for an older version of the
2251: package but does not apply anymore. In that case, just remove it.</p>
2252: </div>
2253: <div class="sect2">
2254: <div class="titlepage"><div><div><h3 class="title">
1.294 rillig 2255: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293 rillig 2256: <p>The job of a compiler is not restricted to producing executable
1.294 rillig 2257: code, most compilers also detect typical programming mistakes. The pkgsrc
2258: compiler wrappers make it easy to force compiler options when the package
2259: is built. This can be used to find typical bugs across all packages that
2260: are in pkgsrc. By reporting these bugs upstream, the packages will be
2261: more reliable with the next updates.</p>
2262: <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 2263: <pre class="programlisting">
2264: CFLAGS+= -Werror=char-subscripts
1.294 rillig 2265: CFLAGS+= -Werror=implicit-function-declaration
1.293 rillig 2266: </pre>
1.294 rillig 2267: <p>When a package fails to build using these stricter compiler
2268: options, document the circumstances in which the compiler produced the
2269: error message. This includes:</p>
1.293 rillig 2270: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2271: <li class="listitem"><p>The platform
2272: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2273: <li class="listitem"><p>The source file</p></li>
2274: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2275: part of the diagnostic.</p></li>
1.294 rillig 2276: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293 rillig 2277: </ul></div>
2278: <p>If a package produces these error messages, but the package is
1.294 rillig 2279: 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
2280: in the next builds:</p>
1.293 rillig 2281: <pre class="programlisting">
1.294 rillig 2282: .if ${PKGPATH} == category/package
1.293 rillig 2283: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2284: # error message
2285: # code
1.294 rillig 2286: # Reason why the code does not need to be fixed.
1.293 rillig 2287: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.294 rillig 2288: .endif
1.293 rillig 2289: </pre>
2290: <p>If the error messages from the compiler are valid and the code
1.294 rillig 2291: needs to be fixed, prepare a local patch (see
2292: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2293: authors of the package, providing them with the information you collected
2294: above.</p>
2295: <p>Patches that are not essential for the package to work should only
2296: be reported upstream but not committed to pkgsrc, to make future updates
2297: easier.</p>
1.293 rillig 2298: </div>
2299: <div class="sect2">
2300: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2301: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
2302: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2303: these apply to all phases of the package build process. Especially in the
2304: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2305: decisions. The GNU configure scripts feed many small test programs to the
2306: C compiler to see whether certain headers are available, functions are
2307: defined in a library and programs can be run. In many cases these
2308: programs would not survive a strict compiler run with <code class="literal">-Wall
2309: -Wextra -Werror</code>.</p>
2310: <p>The pkgsrc infrastructure is flexible enough to support compiler
2311: options being added between the <code class="literal">configure</code> and
2312: <code class="literal">build</code> phases. It's a little more complicated than the
2313: other examples in this section but still easy enough.</p>
2314: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2315: desired compiler options. The compiler wrapper's original task is to hide
2316: unwanted directories of include files and to normalize compiler options.
2317: It does this by wrapping the compiler command and rewriting the command
2318: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2319: package directory and examine the
2320: <code class="filename">work/.cwrappers/config</code> directory. It contains
2321: individual configurations for the C compiler and the related tools. The
2322: plan is to find a hook between the configure and build phases, and to
2323: modify these configuration files at that point.</p>
2324: <p>To find this hook, have a look at
2325: <code class="filename">mk/build/build.mk</code>, which contains among others the
2326: <code class="literal">pre-build-checks-hook</code>. The word
2327: <code class="literal">checks</code> doesn't quite fit, but the
2328: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2329: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2330: <pre class="programlisting">
2331: # Just a few example options.
2332: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2333:
2334: .if ${BUILD_ONLY_CFLAGS:U:M*}
2335: pre-build-checks-hook: add-build-only-cflags
2336:
2337: add-build-only-cflags: .PHONY
2338: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2339: ${TEST} ! -f ${.TARGET} || exit 0; \
2340: for flag in ${BUILD_ONLY_CFLAGS}; do \
2341: ${ECHO} "append=$$flag" >> cc; \
2342: done; \
2343: > ${.TARGET}
2344: .endif
2345: </pre>
2346: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2347: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2348: not with spaces.)</p>
2349: <p>The condition in the <code class="literal">.if</code> statement contains the
2350: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2351: should be undefined, possibly because it is only defined for a subset of
2352: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2353: at least one compiler option, to prevent a syntax error in the shell
2354: parser.</p>
2355: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2356: that the additional compiler options are only appended once, even if
2357: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2358: creates a marker file.</p>
2359: <p>To verify that this setup works, run <span class="command"><strong>bmake
2360: configure</strong></span> in a package directory. Up to now, everything works
2361: as usual. Examine the directory
2362: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2363: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2364: the file <code class="filename">cc</code>. Examine the tail of the
2365: <code class="filename">work/.work.log</code> file to see that the normal compiler
2366: options are used.</p>
2367: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2368: options to the file <code class="filename">cc</code> and will create the marker
2369: file in the same directory. After that, the build starts as usual, but
2370: with the added compiler options. Examine the tail of the file
2371: <code class="filename">work/.work.log</code> to see that the lines starting with
2372: <code class="literal">[*]</code> don't contain the compiler options, but the
2373: corresponding lines starting with <code class="literal"><.></code> do end
2374: with these options.</p>
2375: <p>Building packages using this setup variant and fixing the resulting
2376: 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>
2377: </div>
2378: <div class="sect2">
2379: <div class="titlepage"><div><div><h3 class="title">
2380: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.293 rillig 2381: <p>Some directories like <code class="varname">PREFIX</code>,
2382: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2383: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2384: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2385: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2386: <pre class="programlisting">
2387: PREFIX= /a-random-uuid
2388: PKG_SYSCONFDIR= /a-random-uuid
2389: VARBASE= /a-random-uuid
2390: PKGMANDIR= a-random-uuid
2391: PKG_INFODIR= a-random-uuid
2392: </pre>
2393: </div>
2394: <div class="sect2">
2395: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2396: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.293 rillig 2397: <p>When building a package, warnings are typically ignored since they
2398: just flow by and do not cause the build to fail immediately. To find
2399: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2400: <pre class="programlisting">
2401: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2402: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2403: </pre>
2404: <p>(There are many more classes of warnings in pkgsrc, and most of
2405: them can be redefined with a simple definition like above.</p>
1.294 rillig 2406: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293 rillig 2407: the package Makefile, research whether the package actually needs Perl.
2408: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2409: Makefile, and if it doesn't, add
2410: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2411: </div>
2412: <div class="sect2">
2413: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2414: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293 rillig 2415: <p>Using pkglint as part of the regular build process is mostly a
2416: waste of time. If you want to fix some of the warnings, just run pkglint
2417: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2418: 10), which is much faster than a complete bulk build.</p>
2419: </div>
2420: <div class="sect2">
2421: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2422: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293 rillig 2423: <p>To ensure that the binary packages don't contain references to the
2424: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2425: that variable includes the item <code class="literal">extra</code>, it is
2426: possible to define additional patterns that must not appear in any
2427: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2428: <pre class="programlisting">
2429: CHECK_WRKREF= extra
2430: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2431: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2432: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2433: </pre>
2434: <p>The above patterns will probably generate many false positives,
2435: therefore the results need to be taken with a grain of salt.</p>
2436: </div>
2437: <div class="sect2">
2438: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2439: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.293 rillig 2440: <p>To run the test suites that come with each package, add this line
2441: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2442: <pre class="programlisting">
2443: PKGSRC_RUN_TEST= yes
2444: </pre>
2445: <p>Be prepared that even the most basic packages fail this test. When
2446: doing a bulk build with this, it will often abort in the early phase
2447: where the packages are scanned for their dependencies since there are
2448: cyclic dependencies. There is still a lot to do in this area.</p>
2449: </div>
2450: <div class="sect2">
2451: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2452: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293 rillig 2453: <p>To catch typos in the shell snippets from the Makefile fragments,
2454: add the <code class="literal">-u</code> flag to most of the commands by adding this
2455: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2456: <pre class="programlisting">
2457: RUN= @set -eu;
2458: </pre>
1.296 rillig 2459: <p>After that, ensure that none of the bulk build log files (even
2460: those for successfully built packages) contains the string
2461: <code class="literal">parameter not set</code> or whatever error message the
2462: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293 rillig 2463: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2464: definition.</p>
2465: </div>
2466: <div class="sect2">
2467: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2468: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.293 rillig 2469: <p>The build logs of a package are often quite long. This allows error
2470: messages or other interesting details to hide between the noise. To make
2471: the actual error message stand out more, add these lines to
2472: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2473: <pre class="programlisting">
2474: GNU_CONFIGURE_QUIET= yes
2475: MAKE_FLAGS+= -s
2476: </pre>
2477: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2478: Make. On exotic platforms with their own make, it may be a little
2479: different.</p>
2480: </div>
2481: </div>
2482: <div class="sect1">
2483: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2484: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2485: <p>After your pkgsrc bulk-build has completed, you may wish to
2486: create a CD-ROM set of the resulting binary packages to assist
2487: in installing packages on other machines. The
1.250 leot 2488: <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 2489: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2490: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2491: way that keeps all the dependencies for a given package on the same
2492: CD as that package.</p>
1.148 asau 2493: <div class="sect2">
1.75 rillig 2494: <div class="titlepage"><div><div><h3 class="title">
1.293 rillig 2495: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2496: <p>Complete documentation for cdpack is found in the cdpack(1)
2497: man page. The following short example assumes that the binary
2498: packages are left in
2499: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2500: sufficient disk space exists in <code class="filename">/u2</code> to
2501: hold the ISO 9660 images.</p>
2502: <pre class="screen">
2503: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2504: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2505: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2506: </pre>
2507: <p>If you wish to include a common set of files
2508: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2509: etc.) on each CD in the collection, then you need to create a
1.290 gutterid 2510: directory which contains these files, e.g.:</p>
1.87 wiz 2511: <pre class="screen">
2512: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2513: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2514: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2515: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2516: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2517: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2518: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2519: </pre>
1.75 rillig 2520: <p>Now create the images:</p>
2521: <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 2522: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2523: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2524: in their root directories.</p>
1.75 rillig 2525: </div>
2526: </div>
2527: </div>
1.148 asau 2528: <div class="chapter">
1.75 rillig 2529: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2530: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2531: <div class="toc">
2532: <p><b>Table of Contents</b></p>
1.210 leot 2533: <dl class="toc">
1.267 rillig 2534: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2535: <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 2536: </dl>
2537: </div>
2538: <p>The files that are installed by pkgsrc are organized in a way that
2539: is similar to what you find in the <code class="filename">/usr</code> directory
2540: of the base system. But some details are different. This is because
2541: pkgsrc initially came from FreeBSD and had adopted its file system
2542: hierarchy. Later it was largely influenced by NetBSD. But no matter
2543: which operating system you are using pkgsrc with, you can expect the
2544: same layout for pkgsrc.</p>
1.91 rillig 2545: <p>There are mainly four root directories for pkgsrc, which are all
2546: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2547: When pkgsrc has been installed as root, the default locations
2548: are:</p>
2549: <pre class="programlisting">
1.100 rillig 2550: LOCALBASE= /usr/pkg
2551: PKG_SYSCONFBASE= /usr/pkg/etc
2552: VARBASE= /var
1.231 sevan 2553: PKG_DBDIR= /usr/pkg/pkgdb
1.91 rillig 2554: </pre>
2555: <p>In unprivileged mode (when pkgsrc has been installed as any other
2556: user), the default locations are:</p>
2557: <pre class="programlisting">
1.100 rillig 2558: LOCALBASE= ${HOME}/pkg
2559: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2560: VARBASE= ${HOME}/pkg/var
1.231 sevan 2561: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.91 rillig 2562: </pre>
2563: <p>What these four directories are for, and what they look like is
2564: explained below.</p>
1.148 asau 2565: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2566: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2567: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2568: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2569: the well-known subdirectories like <code class="filename">bin</code>,
2570: <code class="filename">include</code>, <code class="filename">lib</code>,
2571: <code class="filename">share</code> and
2572: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2573: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2574: <code class="filename">/var</code> in the base system. Some programs (especially
2575: games, network daemons) need write access to it during normal
2576: operation.</p></li>
1.128 wiz 2577: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2578: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2579: 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 2580: itself.</p></li>
2581: </ul></div>
1.148 asau 2582: <div class="sect1">
1.90 rillig 2583: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2584: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2585: </h2></div></div></div>
1.90 rillig 2586: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2587: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2588: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2589: <dt><span class="term"><code class="filename">bin</code></span></dt>
2590: <dd><p>Contains executable programs that are intended to be
2591: directly used by the end user.</p></dd>
2592: <dt><span class="term"><code class="filename">emul</code></span></dt>
2593: <dd><p>Contains files for the emulation layers of various other
2594: operating systems, especially for
2595: NetBSD.</p></dd>
2596: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2597: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2598: <dd><p>Contains
2599: the configuration files.</p></dd>
2600: <dt><span class="term"><code class="filename">include</code></span></dt>
2601: <dd><p>Contains headers for the C and C++ programming
2602: languages.</p></dd>
2603: <dt><span class="term"><code class="filename">info</code></span></dt>
2604: <dd><p>Contains GNU info files of various
2605: packages.</p></dd>
2606: <dt><span class="term"><code class="filename">lib</code></span></dt>
2607: <dd><p>Contains shared and static
2608: libraries.</p></dd>
2609: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2610: <dd><p>Contains data files that don't change after
2611: installation. Other data files belong into
2612: <code class="filename">${VARBASE}</code>.</p></dd>
2613: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2614: <dd><p>Contains programs that are not intended to be used by
2615: end users, such as helper programs or network
2616: daemons.</p></dd>
2617: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2618: <dd><p>Contains programs that are intended to be executed as
2619: CGI scripts by a web server.</p></dd>
2620: <dt><span class="term"><code class="filename">man</code> (the usual value of
2621: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2622: <dd><p>Contains brief
2623: documentation in form of manual pages.</p></dd>
2624: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2625: <dd><p>Contains programs that are intended to be used only by
2626: the super-user.</p></dd>
2627: <dt><span class="term"><code class="filename">share</code></span></dt>
2628: <dd><p>Contains platform-independent data files that don't
2629: change after installation.</p></dd>
2630: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2631: <dd><p>Contains documentation files provided by the
2632: packages.</p></dd>
2633: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2634: <dd><p>Contains example files provided by the packages. Among
2635: others, the original configuration files are saved here and copied to
2636: <code class="filename">${PKG_SYSCONFDIR}</code> during
2637: installation.</p></dd>
2638: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2639: <dd><p>Contains the original files for rc.d
2640: scripts.</p></dd>
2641: <dt><span class="term"><code class="filename">var</code> (the usual location of
2642: <code class="filename">${VARBASE}</code>)</span></dt>
2643: <dd><p>Contains files
2644: that may be modified after
2645: installation.</p></dd>
2646: </dl></div>
2647: </div>
1.148 asau 2648: <div class="sect1">
1.90 rillig 2649: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2650: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2651: </h2></div></div></div>
1.148 asau 2652: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2653: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2654: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2655: <dd><p>Contains
2656: information about the currently installed
2657: packages.</p></dd>
2658: <dt><span class="term"><code class="filename">games</code></span></dt>
2659: <dd><p>Contains highscore
2660: files.</p></dd>
2661: <dt><span class="term"><code class="filename">log</code></span></dt>
2662: <dd><p>Contains log files.</p></dd>
2663: <dt><span class="term"><code class="filename">run</code></span></dt>
2664: <dd><p>Contains informational files about daemons that are
2665: currently running.</p></dd>
2666: </dl></div>
2667: </div>
2668: </div>
1.148 asau 2669: <div class="chapter">
1.90 rillig 2670: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2671: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2672: <div class="toc">
2673: <p><b>Table of Contents</b></p>
1.210 leot 2674: <dl class="toc">
1.267 rillig 2675: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2676: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2677: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2678: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2679: <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>
2680: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2681: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2682: <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>
2683: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2684: <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 2685: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 2686: <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>
2687: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
2688: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2689: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2690: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2691: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2692: <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 2693: </dl>
2694: </div>
2695: <p>This section contains hints, tips & tricks on special things in
2696: pkgsrc that we didn't find a better place for in the previous chapters, and
2697: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2698: <div class="sect1">
1.75 rillig 2699: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2700: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2701: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2702: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2703: <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 2704: This is a general purpose list for most issues regarding
2705: pkgsrc, regardless of platform, e.g. soliciting user help
2706: for pkgsrc configuration, unexpected build failures, using
2707: particular packages, upgrading pkgsrc installations,
2708: questions regarding the pkgsrc release branches, etc. General announcements or
2709: proposals for changes that impact the pkgsrc user community,
2710: e.g. major infrastructure changes, new features, package
2711: removals, etc., may also be posted.</p></li>
1.289 leot 2712: <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 2713: A list where the results of pkgsrc bulk builds are sent and
2714: discussed.</p></li>
1.289 leot 2715: <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 2716: This list is for those who are interested in getting a
2717: commit message for every change committed to pkgsrc. It is
2718: also available in digest form, meaning one daily message
2719: containing all commit messages for changes to the package
2720: source tree in that 24 hour period.</p></li>
2721: </ul></div>
2722: <p>To subscribe, do:</p>
2723: <pre class="programlisting">
1.100 rillig 2724: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2725: </pre>
2726: <p>Archives for all these mailing lists are available from
1.289 leot 2727: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2728: </div>
1.148 asau 2729: <div class="sect1">
1.75 rillig 2730: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2731: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2732: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2733: a number of useful utilities for both users and developers of pkgsrc. This
1.233 sevan 2734: section attempts only to make the reader aware of some of the utilities and when
1.75 rillig 2735: they might be useful, and not to duplicate the documentation that comes
2736: with each package.</p>
2737: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.250 leot 2738: <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 2739: Symlinks for use by buildlink.</p></li></ul></div>
2740: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2741: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 leot 2742: <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 2743: Calculates various kinds of checksums (including SHA3).</p></li>
1.250 leot 2744: <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 2745: Compatibility library for pkgsrc tools.</p></li>
1.250 leot 2746: <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 2747: non-BSD systems due to lack of native mtree.</p></li>
1.250 leot 2748: <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 2749: Up-to-date replacement for
1.76 rillig 2750: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2751: systems where pkg_install is not present.</p></li>
2752: </ul></div>
2753: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2754: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 leot 2755: <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 2756: Create a binary package from an
1.110 hubertf 2757: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2758: save the old package.</p></li>
1.250 leot 2759: <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 2760: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2761: from multiple locations. It currently supports the following
2762: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.250 leot 2763: <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 2764: the best compiler flags to optimise code for your current
1.128 wiz 2765: CPU and compiler. </p></li>
1.75 rillig 2766: </ul></div>
2767: <p>Utilities for keeping track of installed packages, being up to date,
2768: etc:</p>
1.148 asau 2769: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 leot 2770: <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 2771: update tool similar to apt(1). Download, install, and upgrade
2772: binary packages easily.</p></li>
1.250 leot 2773: <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 2774: packages whose installed versions do not match the latest pkgsrc
2775: entries.</p></li>
1.250 leot 2776: <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 2777: dependency graphs of packages, to aid in choosing a strategy for
2778: updating.</p></li>
1.250 leot 2779: <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
2780: 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>
2781: <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 2782: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.250 leot 2783: <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 2784: does various checks on the complete pkgsrc system.</p></li>
1.250 leot 2785: <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 2786: packages you have installed.</p></li>
2787: </ul></div>
2788: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2789: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 leot 2790: <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 2791: making and maintaining patches for a package (includes pkgdiff,
2792: pkgvi, mkpatches, etc.).</p></li>
1.250 leot 2793: <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 2794: converting to pkgsrc.</p></li>
2795: </ul></div>
2796: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2797: utilities)</p>
1.148 asau 2798: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 leot 2799: <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 2800: packages in a chrooted area.</p></li>
1.250 leot 2801: <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 2802: kernel version for chrooted cross builds.</p></li>
2803: </ul></div>
2804: </div>
1.148 asau 2805: <div class="sect1">
1.75 rillig 2806: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2807: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219 rillig 2808: <p>To install packages from source as a non-root user, download
1.267 rillig 2809: 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 2810: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2811: --unprivileged</strong></span>.</p>
2812: <p>This will install the binary part of pkgsrc to
2813: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2814: into <code class="filename">~/pkg/etc</code>.</p>
2815: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75 rillig 2816: </div>
1.148 asau 2817: <div class="sect1">
1.75 rillig 2818: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2819: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 2820: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2821: enable this feature by adding the option
2822: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 2823: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 2824: distfile is found, pkgsrc will try to resume it.</p>
2825: <p>You can also
1.168 wiz 2826: use a different program than the platform default program by changing the
1.117 jnemeth 2827: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2828: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2829: by using the value manual. A value of custom disables the system defaults
2830: and dependency tracking for the fetch program. In that case you have to
2831: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2832: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2833: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 2834: <p>For example, if you want to use
1.117 jnemeth 2835: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 2836: like:</p>
2837: <pre class="programlisting">
1.223 rillig 2838: FETCH_USING= wget
1.1 grant 2839: </pre>
1.75 rillig 2840: </div>
1.148 asau 2841: <div class="sect1">
1.75 rillig 2842: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2843: <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 2844: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 2845: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 2846: you will have to add the following line into
1.110 hubertf 2847: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 2848: <pre class="programlisting">
1.103 wiz 2849: X11_TYPE=modular
1.1 grant 2850: </pre>
1.75 rillig 2851: </div>
1.148 asau 2852: <div class="sect1">
1.75 rillig 2853: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2854: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 2855: <p>If you are sitting behind a firewall which does not allow direct
2856: connections to Internet hosts (i.e. non-NAT), you may specify the
2857: relevant proxy hosts. This is done using an environment variable in the
2858: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 2859: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 2860: port 80 as the proxy port number. So the proxy environment variables
2861: are:</p>
2862: <pre class="programlisting">
1.100 rillig 2863: ftp_proxy=ftp://orpheus.amdahl.com:80/
2864: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 2865: </pre>
1.75 rillig 2866: </div>
1.148 asau 2867: <div class="sect1">
1.75 rillig 2868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2869: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 wiz 2870: <p>Some fetch tools are not prepared to support HTTPS by default
2871: (for example, the one in NetBSD 6.0), or the one installed by the
2872: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2873: dependency graph).</p>
2874: <p>Usually you won't notice, because distribution files are
2875: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2876: be often enough if you are following pkgsrc-current. In that case, set
2877: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2878: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2879: with HTTPS support by default. Of course, these tools need to be
2880: installed before you can use them this way.</p>
2881: </div>
2882: <div class="sect1">
2883: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2884: <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 2885: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 2886: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 2887: the first available command from the following list:</p>
1.148 asau 2888: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2889: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2890: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 2891: </ul></div>
2892: <p>On a default NetBSD installation, this will be
1.76 rillig 2893: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 2894: connections first, and falls back to active connections if the server
2895: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 2896: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 2897: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2898: <p>Having that option present will prevent
1.76 rillig 2899: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 2900: transfers.</p>
2901: </div>
1.148 asau 2902: <div class="sect1">
1.75 rillig 2903: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2904: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 2905: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 2906: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 2907: 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 2908: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 2909: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 2910: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 2911: resulting list to your machine at work/school and use it there. If you
1.311 leot 2912: 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 2913: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2914: URL:</p>
2915: <p>At home:</p>
2916: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2917: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2918: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2919: <p>At work:</p>
2920: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 2921: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 2922: home.</p>
2923: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 2924: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2925: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 2926: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 2927: directly by running:</p>
1.75 rillig 2928: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2929: <p>If you even decide to ignore
2930: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2931: by running:</p>
2932: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2933: </div>
1.148 asau 2934: <div class="sect1">
1.75 rillig 2935: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2936: <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 2937: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.250 leot 2938: <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 2939: package, you get the error from make that it doesn't know how to make
1.76 rillig 2940: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 2941: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 2942: the NetBSD base distribution on your machine. It is recommended to do
2943: that to format man pages.</p>
1.250 leot 2944: <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 2945: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 2946: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 2947: </div>
1.148 asau 2948: <div class="sect1">
1.75 rillig 2949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2950: <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 2951: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 2952: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 2953: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 2954: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2955: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 2956: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 2957: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 2958: -r</strong></span>).</p>
2959: </div>
1.148 asau 2960: <div class="sect1">
1.75 rillig 2961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2962: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 2963: <p>When installing packages as non-root user and using the just-in-time
1.311 leot 2964: <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 2965: password for each required package installed. To avoid this, the sudo
2966: package can be used, which does password caching over a limited time. To
2967: use it, install sudo (either as binary package or from
1.250 leot 2968: <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 2969: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 2970: <span class="emphasis"><em>after</em></span> the definition of the
2971: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 2972: <pre class="programlisting">
1.100 rillig 2973: .if exists(${LOCALBASE}/bin/sudo)
2974: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2975: .endif
1.1 grant 2976: </pre>
1.75 rillig 2977: </div>
1.148 asau 2978: <div class="sect1">
1.75 rillig 2979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2980: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 2981: <p>As the system administrator, you can choose where configuration files
2982: are installed. The default settings make all these files go into
1.76 rillig 2983: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 2984: be suboptimal depending on your expectations (e.g., a read-only,
2985: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2986: configuration of the provided packages).</p>
2987: <p>In order to change the defaults, you can modify the
2988: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 2989: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 2990: directory; some common examples include <code class="filename">/etc</code> or
2991: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 2992: <p>Furthermore, you can change this value on a per-package basis by
2993: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2994: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2995: package you would like to modify, that is, the contents of
2996: <code class="varname">PKGBASE</code>.</p>
2997: <p>Note that after changing these settings, you must rebuild and
2998: reinstall any affected packages.</p>
2999: </div>
1.148 asau 3000: <div class="sect1">
1.75 rillig 3001: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3002: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75 rillig 3003: <p>Please be aware that there can often be bugs in third-party software,
3004: and some of these bugs can leave a machine vulnerable to exploitation by
3005: attackers. In an effort to lessen the exposure, the NetBSD packages team
3006: maintains a database of known-exploits to packages which have at one time
3007: been included in pkgsrc. The database can be downloaded automatically, and
3008: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3009: do this, refer to the following two tools (installed as part of the
1.250 leot 3010: <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 3011: <div class="orderedlist"><ol class="orderedlist" type="1">
3012: <li class="listitem">
1.122 reed 3013: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3014: download a list of the security vulnerabilities information. This list
1.132 spz 3015: is kept up to date by the pkgsrc security team, and is distributed
3016: from the NetBSD ftp server:</p>
1.292 leot 3017: <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 3018: </li>
1.128 wiz 3019: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3020: current machine, checking each known vulnerability. If a
1.75 rillig 3021: vulnerable package is installed, it will be shown by output to stdout,
3022: including a description of the type of vulnerability, and a URL
3023: containing more information.</p></li>
3024: </ol></div>
1.233 sevan 3025: <p>Use of these tools is strongly recommended!
1.317 nia 3026: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, “Checking for security vulnerabilities in installed packages”</a> for instructions on how to automate checking and
1.233 sevan 3027: reporting.</p>
3028: <p>If this database is installed, pkgsrc builds will use it to
3029: perform a security check before building any package.</p>
1.75 rillig 3030: </div>
1.148 asau 3031: <div class="sect1">
1.75 rillig 3032: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3033: <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 3034: <p>When you add your own preferences to the
3035: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3036: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3037: environment variables to the <code class="filename">./configure</code>
1.311 leot 3038: 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 3039: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3040: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3041: package.</p>
3042: <p>Currently there is no solution to this problem. If you
3043: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3044: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3045: directory and then inspect any <code class="filename">Makefile</code> and
3046: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3047: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3048: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3049: programmers write so bad code that it only works for the
3050: specific combination of <code class="varname">CFLAGS</code> they have
3051: chosen.</p>
1.287 rillig 3052: <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>
3053: <pre class="programlisting">
3054: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3055: CFLAGS+= -Dpkgsrc___CFLAGS
3056: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3057: </pre>
3058: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3059: to see whether the above flags are passed to the actual build
3060: commands in general.</p>
3061: <p>To find out whether the flags are passed to individual compiler
3062: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3063: most cases, the flags from the original command lines (the lines starting
3064: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3065: (the lines starting with <code class="literal"><.></code>). If the flag is
3066: missing from the actual compiler command, it must have been removed by
1.299 rillig 3067: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75 rillig 3068: </div>
1.148 asau 3069: <div class="sect1">
1.80 rillig 3070: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3071: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3072: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3073: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3074: case that occurs often is that people only update pkgsrc in
3075: parts, because of performance reasons. Since pkgsrc is one large
3076: system, not a collection of many small systems, there are
3077: sometimes changes that only work when the whole pkgsrc tree is
3078: updated.</p></li>
1.148 asau 3079: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3080: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3081: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3082: files.</p></li>
1.148 asau 3083: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3084: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3085: verify this.</p></li>
1.218 rillig 3086: <li class="step"><p>If you are a package developer who wants to invest
1.267 rillig 3087: 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 3088: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3089: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3090: </ol></div>
3091: </div>
1.148 asau 3092: <div class="sect1">
1.88 wiz 3093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3094: <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 3095: <p>You have modified a file from pkgsrc, and someone else has
3096: modified that same file afterwards in the CVS repository. Both changes
3097: are in the same region of the file, so when you updated pkgsrc, the
3098: <code class="literal">cvs</code> command marked the conflicting changes in the
3099: file. Because of these markers, the file is no longer a valid
3100: <code class="filename">Makefile</code>.</p>
3101: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3102: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3103: -dP</strong></span> in that directory to download the current version.</p>
3104: </div>
1.75 rillig 3105: </div>
3106: </div>
1.148 asau 3107: <div class="part">
1.75 rillig 3108: <div class="titlepage"><div><div><h1 class="title">
3109: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3110: <div class="partintro">
1.77 rillig 3111: <div></div>
3112: <p>This part of the book deals with creating and
1.128 wiz 3113: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3114: guide on creating a new package. The remaining chapters are more
3115: like a reference manual for pkgsrc.</p>
1.75 rillig 3116: <div class="toc">
3117: <p><b>Table of Contents</b></p>
1.210 leot 3118: <dl class="toc">
1.267 rillig 3119: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299 rillig 3120: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91 rillig 3121: <dd><dl>
1.299 rillig 3122: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3123: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3124: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91 rillig 3125: <dd><dl>
1.299 rillig 3126: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3127: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3128: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3129: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3130: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91 rillig 3131: </dl></dd>
1.299 rillig 3132: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3133: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3134: <dd><dl>
3135: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3136: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3137: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3138: </dl></dd>
3139: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3140: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3141: </dl></dd>
1.299 rillig 3142: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106 rillig 3143: <dd><dl>
1.299 rillig 3144: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3145: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3146: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3147: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3148: <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 3149: <dd><dl>
1.299 rillig 3150: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3151: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106 rillig 3152: </dl></dd>
1.299 rillig 3153: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3154: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3155: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3156: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3157: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3158: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3159: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3160: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3161: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3162: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3163: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3164: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3165: </dl></dd>
3166: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3167: <dd><dl>
3168: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106 rillig 3169: <dd><dl>
1.299 rillig 3170: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
3171: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
3172: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
3173: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
1.106 rillig 3174: </dl></dd>
1.299 rillig 3175: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3176: <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 3177: </dl></dd>
1.299 rillig 3178: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3179: <dd><dl>
1.299 rillig 3180: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3181: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3182: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3183: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106 rillig 3184: <dd><dl>
1.299 rillig 3185: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3186: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3187: <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>
3188: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106 rillig 3189: </dl></dd>
3190: </dl></dd>
1.299 rillig 3191: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106 rillig 3192: <dd><dl>
1.299 rillig 3193: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3194: <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>
3195: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3196: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3197: </dl></dd>
1.299 rillig 3198: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106 rillig 3199: <dd><dl>
1.299 rillig 3200: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3201: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3202: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3203: </dl></dd>
3204: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3205: <dd><dl>
3206: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3207: <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 3208: <dd><dl>
1.299 rillig 3209: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3210: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133 wiz 3211: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3212: and
3213: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3214: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3215: </dl></dd>
1.299 rillig 3216: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3217: <dd><dl>
3218: <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>
3219: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3220: </dl></dd>
3221: </dl></dd>
3222: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106 rillig 3223: <dd><dl>
1.299 rillig 3224: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3225: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3226: <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>
3227: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3228: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3229: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3230: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3231: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3232: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106 rillig 3233: </dl></dd>
1.299 rillig 3234: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3235: <dd><dl>
3236: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3237: <dd><dl>
3238: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3239: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106 rillig 3240: </dl></dd>
1.299 rillig 3241: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106 rillig 3242: <dd><dl>
1.299 rillig 3243: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3244: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
3245: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
3246: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
3247: </dl></dd>
3248: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3249: <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>
3250: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3251: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3252: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3253: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3254: <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 3255: </dl></dd>
3256: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3257: <dd><dl>
3258: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3259: <dd><dl>
3260: <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>
3261: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3262: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3263: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3264: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3265: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3266: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3267: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3268: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3269: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3270: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3271: </dl></dd>
3272: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3273: <dd><dl>
3274: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3275: <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>
3276: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3277: </dl></dd>
3278: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3279: <dd><dl>
3280: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3281: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3282: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
3283: </dl></dd>
3284: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3285: <dd><dl>
3286: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3287: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 3288: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
3289: <dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
3290: <dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
3291: <dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
1.267 rillig 3292: </dl></dd>
3293: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3294: <dd><dl>
3295: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3296: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 3297: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3298: <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>
3299: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 3300: </dl></dd>
3301: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3302: <dd><dl>
3303: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3304: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3305: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3306: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3307: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 3308: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 3309: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
3310: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 3311: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
3312: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
3313: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
3314: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
3315: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
3316: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
3317: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 3318: emulation</a></span></dt>
1.318 nia 3319: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
3320: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.77 rillig 3321: </dl></dd>
1.267 rillig 3322: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3323: </dl></dd>
1.299 rillig 3324: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3325: <dd><dl>
3326: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3327: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3328: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3329: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3330: </dl></dd>
1.267 rillig 3331: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 3332: <dd><dl>
1.267 rillig 3333: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3334: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3335: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3336: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3337: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3338: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3339: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3340: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3341: </dl></dd>
3342: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75 rillig 3343: </dl>
3344: </div>
1.77 rillig 3345: </div>
1.148 asau 3346: <div class="chapter">
1.77 rillig 3347: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 3348: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3349: <p>
3350: To get help when developing pkgsrc, the definitive source is this
3351: document, the pkgsrc guide. If you don't find anything here,
3352: there are alternatives:
3353: </p>
3354: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3355: <li class="listitem">
3356: <p>
3357: The built-in pkgsrc help, which is available after bootstrapping
3358: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3359: help for any topic, such as a variable name like
3360: <code class="varname">BUILD_DEFS</code>, a make target like
3361: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3362: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
3363: <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>
3364: </li>
3365: <li class="listitem"><p>
1.278 rillig 3366: To see the value of a single variable, run <span class="command"><strong>bmake
3367: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3368: </p></li>
3369: <li class="listitem"><p>
3370: To see the values of the most common variables, run
3371: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3372: topic. To see the variables for a single topic, run
3373: <span class="command"><strong>bmake
3374: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3375: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3376: </p></li>
3377: <li class="listitem"><p>
1.267 rillig 3378: The tech-pkg mailing list, to which
3379: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3380: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3381: questions</a>.</p></li>
3382: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3383: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3384: or by using a specialized chat program such as
3385: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3386: Pick any user name and join the channel #pkgsrc.</p></li>
3387: </ul></div>
3388: </div>
3389: <div class="chapter">
3390: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 3391: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91 rillig 3392: <div class="toc">
3393: <p><b>Table of Contents</b></p>
1.210 leot 3394: <dl class="toc">
1.299 rillig 3395: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3396: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3397: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3398: <dd><dl>
3399: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3400: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3401: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3402: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3403: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3404: </dl></dd>
3405: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3406: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3407: <dd><dl>
3408: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3409: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3410: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91 rillig 3411: </dl></dd>
1.299 rillig 3412: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3413: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91 rillig 3414: </dl>
3415: </div>
1.299 rillig 3416: <p>Whenever you're preparing a package, there are a number of
3417: files involved which are described in the following
3418: sections.</p>
3419: <div class="sect1">
3420: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3421: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3422: </h2></div></div></div>
3423: <p>Building, installation and creation of a binary package are all
3424: controlled by the package's <code class="filename">Makefile</code>.
3425: The <code class="filename">Makefile</code> describes various things about
3426: a package, for example from where to get it, how to configure,
3427: build, and install it.</p>
3428: <p>A package <code class="filename">Makefile</code> contains several
3429: sections that describe the package.</p>
3430: <p>In the first section there are the following variables, which
3431: should appear exactly in the order given here. The order and
3432: grouping of the variables is mostly historical and has no further
3433: meaning.</p>
3434: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3435: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3436: distribution file to be downloaded from the package's
3437: website.</p></li>
3438: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3439: package, as used by pkgsrc. You need to provide it if
3440: <code class="varname">DISTNAME</code> (which is the default) is not a good
3441: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3442: provided (no distribution file is required). Usually it is the pkgsrc
3443: directory name together with the version number. It must match the
3444: regular expression
3445: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3446: starts with a letter or digit, and contains only letters, digits,
1.319 nia 3447: dashes, underscores, dots and plus signs.
3448: New packages should have entirely lower-case names, with the exception
3449: of some that must follow pre-existing conventions
3450: (e.g. R packages begin with <code class="varname">R-</code>).
3451: You can use the <code class="code">:tl</code> variable modifier to lower-case
3452: the package name.</p></li>
1.299 rillig 3453: <li class="listitem">
3454: <p><code class="varname">CATEGORIES</code> is a list of categories
3455: which the package fits in. You can choose any of the top-level
3456: directories of pkgsrc for it.</p>
3457: <p>Currently the following values are available for
3458: <code class="varname">CATEGORIES</code>. If more than
3459: one is used, they need to be separated by spaces:</p>
1.77 rillig 3460: <pre class="programlisting">
1.299 rillig 3461: archivers cross geography meta-pkgs security
3462: audio databases graphics misc shells
3463: benchmarks devel ham multimedia sysutils
3464: biology editors inputmethod net textproc
3465: cad emulators lang news time
3466: chat finance mail parallel wm
3467: comms fonts math pkgtools www
3468: converters games mbone print x11
1.77 rillig 3469: </pre>
3470: </li>
1.299 rillig 3471: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3472: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3473: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3474: and <code class="varname">DISTFILES</code> are discussed in detail in
3475: <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>
3476: </ul></div>
3477: <p>The second section contains information about separately
3478: downloaded patches, if any.
3479: </p>
3480: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3481: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3482: Name(s) of additional files that contain distribution patches.
3483: There is no default. pkgsrc will look for them at
3484: <code class="varname">PATCH_SITES</code>.
3485: They will automatically be uncompressed before patching if
3486: the names end with <code class="filename">.gz</code> or
3487: <code class="filename">.Z</code>.</p></li>
3488: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3489: Primary location(s) for distribution patch files (see
3490: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3491: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.311 leot 3492: 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 3493: help find the correct files to patch. It defaults to
3494: <span class="command"><strong>-p0</strong></span>.</p></li>
3495: </ul></div>
3496: <p>The third section contains the following variables.
3497: </p>
3498: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3499: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
3500: address of the person who feels responsible for this package,
3501: and who is most likely to look at problems or questions regarding
1.311 leot 3502: 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 3503: Other developers may contact the <code class="varname">MAINTAINER</code>
3504: before making changes to the package, but are not required to
3505: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3506: to yourself. If you really can't maintain the package for future
3507: updates, set it to
3508: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
3509: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
3510: of <code class="varname">MAINTAINER</code> when you do not want other
3511: developers to update or change the package without contacting
3512: you first. A package Makefile should contain one of
3513: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3514: not both. </p></li>
3515: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3516: find more information about the package.</p></li>
3517: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3518: description of the package (should not include the package
3519: name).</p></li>
3520: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3521: 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>
3522: </ul></div>
3523: <p>Other variables that affect the build:
3524: </p>
3525: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3526: <p><code class="varname">WRKSRC</code>: The directory where the
3527: interesting distribution files of the package are found. The
3528: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3529: works for most packages.</p>
3530: <p>If a package doesn't create a subdirectory for itself
3531: (most GNU software does, for instance), but extracts itself in
3532: the current directory, you should set
3533: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3534: <p>If a package doesn't create a subdirectory with the
3535: name of <code class="varname">DISTNAME</code> but some different name,
3536: set <code class="varname">WRKSRC</code> to point to the proper name in
3537: <code class="filename">${WRKDIR}</code>, for example
3538: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
3539: <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>
3540: <p>The name of the working directory created by pkgsrc is
3541: taken from the <code class="varname">WRKDIR_BASENAME</code>
3542: variable. By default, its value is
3543: <code class="filename">work</code>. If you want to use the same
3544: pkgsrc tree for building different kinds of binary packages,
3545: you can change the variable according to your needs. Two
3546: other variables handle common cases of setting
3547: <code class="varname">WRKDIR_BASENAME</code> individually. If
3548: <code class="varname">OBJHOSTNAME</code> is defined in
3549: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3550: the host's name is attached to the directory name. If
3551: <code class="varname">OBJMACHINE</code> is defined, the platform name
3552: is attached, which might look like
3553: <code class="filename">work.i386</code> or
3554: <code class="filename">work.sparc</code>.</p>
3555: </li></ul></div>
3556: <p>Please pay attention to the following gotchas:</p>
3557: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3558: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3559: installed in compressed form by the package. For packages using
3560: BSD-style makefiles which honor MANZ, there is
3561: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3562: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3563: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3564: below).</p></li>
3565: <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>
3566: </ul></div>
3567: </div>
1.148 asau 3568: <div class="sect1">
1.91 rillig 3569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 3570: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3571: </h2></div></div></div>
3572: <p>The <code class="filename">distinfo</code> file contains the message
3573: digest, or checksum, of each distfile needed for the package. This
3574: ensures that the distfiles retrieved from the Internet have not been
3575: corrupted during transfer or altered by a malign force to introduce
3576: a security hole. To provide maximum security, all distfiles are
3577: protected using three different message digest algorithms (SHA1,
3578: RMD160, SHA512), as well as the file size.</p>
3579: <p>The <code class="filename">distinfo</code> file also contains the
3580: checksums for all the patches found in the
3581: <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
3582: are only applied intentionally and that they don't accidentally change,
3583: e.g. when merging different changes together. They also make sure that
3584: new patches are actually added to CVS and old ones are removed.
3585: Too see whether the patches and the <code class="filename">distinfo</code> file
3586: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3587: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3588: <span class="command"><strong>make distinfo</strong></span> command.</p>
3589: <p>Some packages have different sets of distfiles depending on
3590: 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
3591: <code class="filename">distinfo</code> file and care should be taken when
3592: upgrading such a package to ensure distfile information is not
3593: lost.</p>
3594: </div>
3595: <div class="sect1">
3596: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3597: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3598: </h2></div></div></div>
3599: <p>Some packages don't work out-of-the box on the various
3600: platforms that are supported by pkgsrc. These packages need
3601: to be patched to make them work. The patch files can be
3602: found in the <code class="filename">patches/</code> directory.</p>
3603: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3604: applied to the files in <code class="varname">WRKSRC</code> directory after
3605: extracting them, in alphabetic order.</p>
1.148 asau 3606: <div class="sect2">
1.91 rillig 3607: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3608: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3609: <p>The <code class="filename">patch-*</code> files should be in
3610: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3611: problems. (To force patches to apply with fuzz you can set
3612: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3613: should contain only changes for a single file, and no file should be
3614: patched by more than one patch file. This helps to keep future
3615: modifications simple.</p>
3616: <p>Each patch file is structured as follows: In the first line,
3617: there is the RCS Id of the patch itself. The second line should be
3618: empty for aesthetic reasons. After that, there should be a comment for
3619: each change that the patch does. There are a number of standard
3620: cases:</p>
3621: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3622: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3623: mention the vulnerability ID (CAN, CVE).</p></li>
3624: <li class="listitem"><p>Patches that change source code should mention the
3625: platform and other environment (for example, the compiler) that the
3626: patch is needed for.</p></li>
3627: </ul></div>
3628: <p>The patch should be commented so that any
3629: developer who knows the code of the application can make some use of
3630: the patch. Special care should be taken for the upstream developers,
3631: since we generally want that they accept our patches, so we have less
3632: work in the future.</p>
1.91 rillig 3633: </div>
1.148 asau 3634: <div class="sect2">
1.91 rillig 3635: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3636: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3637: <p>One important thing to mention is to pay attention that no RCS
3638: IDs get stored in the patch files, as these will cause problems when
3639: later checked into the NetBSD CVS tree. Use the
3640: <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
3641: problems.</p>
3642: <p>For even more automation, we recommend using
3643: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
3644: whole set of patches. You just have to backup files before you
3645: edit them to <code class="filename">filename.orig</code>, e.g. with
3646: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3647: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3648: you upgrade a package this way, you can easily compare the new
3649: set of patches with the previously existing one with
3650: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3651: are replaced by new files, so carefully check if you want to take all
3652: the changes.</p>
3653: <p>When you have finished a package, remember to generate
3654: the checksums for the patch files by using the <span class="command"><strong>make
3655: 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>
3656: <p>When adding a patch that corrects a problem in the
3657: distfile (rather than e.g. enforcing pkgsrc's view of where
3658: man pages should go), send the patch as a bug report to the
3659: maintainer. This benefits non-pkgsrc users of the package,
3660: and usually makes it possible to remove the patch in future
3661: version.</p>
3662: <p>The file names of the patch files are usually of the form
3663: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3664: Many packages still use the previous convention
3665: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3666: but new patches should be of the form containing the filename.
3667: <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
3668: automatically.</p>
1.118 imil 3669: </div>
1.275 brook 3670: <div class="sect2">
3671: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3672: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3673: <p>If you want to share patches between multiple packages
3674: in pkgsrc, e.g. because they use the same distfiles, set
3675: <code class="varname">PATCHDIR</code> to the path where the patch files
3676: can be found, e.g.:</p>
3677: <pre class="programlisting">
3678: PATCHDIR= ../../editors/xemacs/patches
3679: </pre>
3680: <p>Patch files that are distributed by the author or other
3681: maintainers can be listed in
3682: <code class="varname">PATCHFILES</code>.</p>
3683: <p>If it is desired to store any patches that should not be
3684: committed into pkgsrc, they can be kept outside the pkgsrc
3685: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3686: directory tree there is expected to have the same
3687: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3688: patches are expected to be stored inside these dirs (also
3689: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3690: example, if you want to keep a private patch for
3691: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3692: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3693: files in the named directory are expected to be patch files,
3694: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3695: applied</em></span>.</p>
1.275 brook 3696: </div>
3697: <div class="sect2">
3698: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3699: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3700: <p>When fixing a portability issue in the code do not use
3701: preprocessor magic to check for the current operating system nor
3702: platform. Doing so hurts portability to other platforms because
3703: the OS-specific details are not abstracted appropriately.</p>
3704: <p>The general rule to follow is: instead of checking for the
3705: operating system the application is being built on, check for the
3706: specific <span class="emphasis"><em>features</em></span> you need. For example,
3707: instead of assuming that kqueue is available under NetBSD and
3708: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3709: kqueue support, add a check that detects kqueue itself —
3710: yes, this generally involves patching the
3711: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3712: that prevents some OSes from adopting interfaces from other OSes
3713: (e.g. Linux implementing kqueue), something that the above checks
3714: cannot take into account.</p>
3715: <p>Of course, checking for features generally involves more
3716: work on the developer's side, but the resulting changes are
3717: cleaner and there are chances they will work on many other
3718: platforms. Not to mention that there are higher chances of being
3719: later integrated into the mainstream sources. Remember:
3720: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3721: <p>Some typical examples:</p>
3722: <div class="table">
3723: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3724: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3725: <colgroup>
3726: <col>
3727: <col>
3728: <col>
3729: </colgroup>
3730: <thead><tr>
3731: <th>Where</th>
3732: <th>Incorrect</th>
3733: <th>Correct</th>
3734: </tr></thead>
3735: <tbody>
3736: <tr>
3737: <td>configure script</td>
3738: <td>
1.275 brook 3739: <pre class="programlisting">
1.299 rillig 3740: case ${target_os} in
3741: netbsd*) have_kvm=yes ;;
3742: *) have_kvm=no ;;
3743: esac
1.275 brook 3744: </pre>
1.299 rillig 3745: </td>
3746: <td>
1.275 brook 3747: <pre class="programlisting">
1.299 rillig 3748: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275 brook 3749: </pre>
1.299 rillig 3750: </td>
3751: </tr>
3752: <tr>
3753: <td>C source file</td>
3754: <td>
1.91 rillig 3755: <pre class="programlisting">
1.299 rillig 3756: #if defined(__NetBSD__)
3757: # include <sys/event.h>
3758: #endif
1.91 rillig 3759: </pre>
1.299 rillig 3760: </td>
3761: <td>
1.91 rillig 3762: <pre class="programlisting">
1.299 rillig 3763: #if defined(HAVE_SYS_EVENT_H)
3764: # include <sys/event.h>
3765: #endif
1.91 rillig 3766: </pre>
1.299 rillig 3767: </td>
3768: </tr>
3769: <tr>
3770: <td>C source file</td>
3771: <td>
1.91 rillig 3772: <pre class="programlisting">
1.299 rillig 3773: int
3774: monitor_file(...)
3775: {
3776: #if defined(__NetBSD__)
3777: int fd = kqueue();
3778: ...
3779: #else
3780: ...
3781: #endif
3782: }
1.91 rillig 3783: </pre>
1.299 rillig 3784: </td>
3785: <td>
1.91 rillig 3786: <pre class="programlisting">
1.299 rillig 3787: int
3788: monitor_file(...)
3789: {
3790: #if defined(HAVE_KQUEUE)
3791: int fd = kqueue();
3792: ...
3793: #else
3794: ...
3795: #endif
3796: }
1.91 rillig 3797: </pre>
1.299 rillig 3798: </td>
3799: </tr>
3800: </tbody>
3801: </table></div>
3802: </div>
3803: <br class="table-break">
3804: </div>
3805: <div class="sect2">
3806: <div class="titlepage"><div><div><h3 class="title">
3807: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3808: <p>Always, always, <span class="strong"><strong>always</strong></span>
3809: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3810: improvements you do to a package to the mainstream developers.
3811: This is the only way to get their attention on portability issues
3812: and to ensure that future versions can be built out-of-the box on
3813: NetBSD. Furthermore, any user that gets newer distfiles will get
3814: the fixes straight from the packaged code.</p>
3815: <p>This generally involves cleaning up the patches
3816: (because sometimes the patches that are
3817: added to pkgsrc are quick hacks), filing bug reports in the
3818: appropriate trackers for the projects and working with the
3819: mainstream authors to accept your changes. It is
3820: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3821: the packages in pkgsrc are kept simple and thus further changes
3822: can be done without much hassle.</p>
3823: <p>When you have done this, please add a URL to the upstream
3824: bug report to the patch comment.</p>
3825: <p>Support the idea of free software!</p>
3826: </div>
1.91 rillig 3827: </div>
1.299 rillig 3828: <div class="sect1">
3829: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3830: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3831: <div class="variablelist"><dl class="variablelist">
3832: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3833: <dd><p>A multi-line description of the piece of software. This should include
3834: any credits where they are due. Please bear in mind that others do not
3835: share your sense of humour (or spelling idiosyncrasies), and that others
3836: will read everything that you write here.</p></dd>
3837: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3838: <dd><p>This file governs the files that are installed on your
3839: system: all the binaries, manual pages, etc. There are other
3840: directives which may be entered in this file, to control the
3841: creation and deletion of directories, and the location of
3842: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3843: information.</p></dd>
3844: </dl></div>
3845: </div>
3846: <div class="sect1">
3847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3848: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3849: <div class="sect2">
3850: <div class="titlepage"><div><div><h3 class="title">
3851: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3852: <div class="variablelist"><dl class="variablelist">
3853: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3854: <dd>
1.311 leot 3855: <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 3856: First time after package extraction and before files are
3857: moved in place, the second time after the files to install
3858: are moved in place. This can be used to do any custom
3859: procedures not possible with @exec commands in
1.311 leot 3860: <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
3861: <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 3862: Please note that you can modify variables in it easily by using
3863: <code class="varname">FILES_SUBST</code> in the package's
3864: <code class="filename">Makefile</code>:</p>
1.91 rillig 3865: <pre class="programlisting">
1.299 rillig 3866: FILES_SUBST+= SOMEVAR="somevalue"
1.91 rillig 3867: </pre>
1.299 rillig 3868: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3869: <code class="filename">INSTALL</code>. By default, substitution is
3870: performed for <code class="varname">PREFIX</code>,
3871: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3872: <code class="varname">VARBASE</code>, and a few others, type
3873: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3874: complete list.</p>
3875: </dd>
3876: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3877: <dd><p>This script is executed before and after any files are removed. It is
3878: this script's responsibility to clean up any additional messy details
3879: around the package's installation, since all pkg_delete knows is how to
3880: delete the files created in the original distribution.
1.311 leot 3881: 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>
3882: 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 3883: The same methods to replace variables can be used as for
3884: the <code class="filename">INSTALL</code> file.</p></dd>
3885: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3886: <dd>
3887: <p>This file is displayed after installation of the package.
1.312 gdt 3888: While this was used often in the past, it has two
3889: problems: the display will be missed if many packages are
3890: intalled at once, and the person installing the package
3891: and the one using or configuring it may be different. It
3892: should therefore be used only in exceptional circumstances
3893: where lasting negative consequences would result from
3894: someone not reading it.</p>
3895: <p>MESSAGE should not be used for:</p>
3896: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3897: <li class="listitem"><p>exhortations to read the documentation</p></li>
3898: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
3899: <li class="listitem"><p>anything that should be explained in the
3900: installation/configuration documentation that should
3901: come with the package</p></li>
3902: </ul></div>
3903: <p>If the documentation provided by upstream needs
1.313 leot 3904: enhancing, create e.g. files/README.pkgsrc and install it
3905: in the package's documentation directory.
1.312 gdt 3906: </p>
3907: <p>Note that MESSAGE is shown for all operating
3908: systems and all init systems. If a MESSAGE is necessary,
1.313 leot 3909: it should be narrowed to only those operating systems and
1.312 gdt 3910: init systems to which it applies.</p>
3911: <p>Note that you can modify variables in it easily by using
1.299 rillig 3912: <code class="varname">MESSAGE_SUBST</code> in the package's
3913: <code class="filename">Makefile</code>:</p>
1.91 rillig 3914: <pre class="programlisting">
1.299 rillig 3915: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.91 rillig 3916: </pre>
1.299 rillig 3917: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
3918: <code class="filename">MESSAGE</code>. By default, substitution is
3919: performed for <code class="varname">PKGNAME</code>,
3920: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
3921: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3922: <code class="varname">PKG_SYSCONFDIR</code>,
3923: <code class="varname">ROOT_GROUP</code>, and
3924: <code class="varname">ROOT_USER</code>.</p>
3925: <p>You can display a different or additional files by
3926: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3927: default is <code class="filename">MESSAGE</code>, if the file
3928: exists.</p>
3929: </dd>
3930: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
3931: <dd>
3932: <p>This file is used by the alternatives framework.
3933: It creates, configures, and destroys generic wrappers used to
3934: run programs with similar interfaces.
3935: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3936: for more information.</p>
3937: <p>Each line of the file contains two filenames, first
3938: the wrapper and then the alternative provided by the package.
3939: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3940: </dd>
3941: </dl></div>
3942: </div>
3943: <div class="sect2">
3944: <div class="titlepage"><div><div><h3 class="title">
3945: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
3946: <div class="variablelist"><dl class="variablelist">
3947: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3948: <dd><p>This file contains arbitrary things that could
3949: also go into a <code class="filename">Makefile</code>, but its purpose is
3950: to be used by more than one package. This file should only be
3951: used when the packages that will use the file are known in
3952: advance. For other purposes it is often better to write a
3953: <code class="filename">*.mk</code> file and give it a good name that
3954: describes what it does.</p></dd>
3955: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3956: <dd><p>This file contains the dependency information
3957: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
3958: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3959: <dd><p>This file contains workarounds for compiler bugs
3960: and similar things. It is included automatically by the pkgsrc
3961: infrastructure, so you don't need an extra
3962: <code class="literal">.include</code> line for
3963: it.</p></dd>
3964: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3965: <dd><p>This file contains the code for the
3966: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
3967: selected by the user. If a package has only one or two options,
3968: it is equally acceptable to put the code directly into the
3969: <code class="filename">Makefile</code>.</p></dd>
3970: </dl></div>
3971: </div>
3972: <div class="sect2">
3973: <div class="titlepage"><div><div><h3 class="title">
3974: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
3975: <div class="variablelist"><dl class="variablelist">
3976: <dt><span class="term"><code class="filename">README*</code></span></dt>
3977: <dd><p>These files do not take place in the creation of
3978: a package and thus are purely informative to the package
3979: developer.</p></dd>
3980: <dt><span class="term"><code class="filename">TODO</code></span></dt>
3981: <dd><p>This file contains things that need to be done
3982: to make the package even
3983: better.</p></dd>
3984: </dl></div>
3985: </div>
3986: </div>
3987: <div class="sect1">
3988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3989: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
3990: </h2></div></div></div>
3991: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
3992: unpacked into the directory denoted by
3993: <code class="varname">WRKDIR</code>. It can be removed by running
3994: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
3995: directory is also used to keep various timestamp files.
3996: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
3997: The default is <code class="filename">${.CURDIR}/work</code>
3998: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
3999: if <code class="varname">OBJMACHINE</code> is set.</p>
1.91 rillig 4000: </div>
1.299 rillig 4001: <div class="sect1">
4002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4003: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
4004: </h2></div></div></div>
4005: <p>If you have any files that you wish to be placed in the package
4006: prior to configuration or building, you can place these files here
4007: and use a <span class="command"><strong>${CP}</strong></span> command in the
4008: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4009: <p>If you want to share files in this way with other
4010: packages, set the <code class="varname">FILESDIR</code> variable to point
4011: to the other package's <code class="filename">files</code> directory,
4012: e.g.:</p>
1.91 rillig 4013: <pre class="programlisting">
1.299 rillig 4014: FILESDIR= ../../editors/xemacs/files
1.91 rillig 4015: </pre>
4016: </div>
4017: </div>
1.148 asau 4018: <div class="chapter">
1.75 rillig 4019: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 4020: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75 rillig 4021: <div class="toc">
4022: <p><b>Table of Contents</b></p>
1.210 leot 4023: <dl class="toc">
1.299 rillig 4024: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4025: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4026: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4027: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4028: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4029: <dd><dl>
4030: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4031: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4032: </dl></dd>
4033: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4034: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4035: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4036: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4037: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4038: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4039: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4040: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4041: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4042: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4043: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4044: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75 rillig 4045: </dl>
4046: </div>
1.148 asau 4047: <div class="sect1">
1.75 rillig 4048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4049: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4050: <p>This chapter gives a detailed description on how a package is
4051: built. Building a package is separated into different
4052: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4053: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4054: described in the following sections. Each phase is split into
4055: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4056: containing phase, prefixed by one of <code class="varname">pre-</code>,
4057: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4058: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4059: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4060: <p>Never override the regular targets (like
4061: <code class="varname">fetch</code>), if you have to, override the
4062: <code class="varname">do-*</code> ones instead.</p>
4063: <p>The basic steps for building a program are always the same. First
4064: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4065: the local system and then extracted. After any pkgsrc-specific patches
4066: to compile properly are applied, the software can be configured, then
4067: built (usually by compiling), and finally the generated binaries, etc.
4068: can be put into place on the system.</p>
4069: <p>To get more details about what is happening at each step,
4070: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4071: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4072: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4073: </div>
4074: <div class="sect1">
4075: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4076: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4077: <p>Before outlining the process performed by the NetBSD package system in
4078: the next section, here's a brief discussion on where programs are
4079: installed, and which variables influence this.</p>
4080: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4081: where all files of the final program shall be installed. It is
4082: usually set to <code class="varname">LOCALBASE</code>
4083: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4084: for pkgs in the <code class="filename">cross</code> category. The value of
4085: <code class="varname">PREFIX</code> needs to be put
4086: into the various places in the program's source where paths to
4087: 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>
4088: <p>When choosing which of these variables to use,
4089: follow the following rules:</p>
1.148 asau 4090: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 4091: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4092: where the current pkg will be installed. When referring to a
4093: pkg's own installation path, use
4094: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
4095: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
4096: are installed. If you need to construct a -I or -L argument
4097: to the compiler to find includes and libraries installed by
4098: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
4099: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4100: installed all packages in <code class="filename">/usr/local</code>. As
4101: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4102: administrator, this variable is a misnomer.</p></li>
4103: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4104: distribution (from xsrc, etc.) is installed. When looking for
4105: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4106: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4107: <li class="listitem"><p>X11-based packages using imake must set
4108: <code class="varname">USE_IMAKE</code> to be installed correctly under
4109: <code class="varname">LOCALBASE</code>.</p></li>
4110: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.311 leot 4111: 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 4112: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4113: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4114: </ul></div>
4115: </div>
4116: <div class="sect1">
4117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4118: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4119: <p>When building a package, various directories are used to store
4120: source files, temporary files, pkgsrc-internal files, and so on. These
4121: directories are explained here.</p>
4122: <p>Some of the directory variables contain relative pathnames. There
4123: are two common base directories for these relative directories:
4124: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4125: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4126: inside the package itself.</p>
4127: <div class="variablelist"><dl class="variablelist">
4128: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4129: <dd><p>This is an absolute pathname that points to the pkgsrc
4130: root directory. Generally, you don't need
4131: it.</p></dd>
4132: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4133: <dd><p>This is an absolute pathname that points to the
4134: current package.</p></dd>
4135: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
4136: <dd><p>This is a pathname relative to
4137: <code class="varname">PKGSRCDIR</code> that points to the current
4138: package.</p></dd>
4139: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4140: <dd><p>This is an absolute pathname pointing to the directory
4141: where all work takes place. The distfiles are extracted to this
4142: directory. It also contains temporary directories and log files used by
4143: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4144: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4145: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4146: <dd><p>This is an absolute pathname pointing to the directory
4147: where the distfiles are extracted. It is usually a direct subdirectory
4148: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4149: that isn't hidden. This variable may be changed by a package
4150: <code class="filename">Makefile</code>.</p></dd>
4151: </dl></div>
4152: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4153: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4154: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4155: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4156: If users would like to have their pkgsrc trees behave in a
4157: read-only manner, then the value of
4158: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4159: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 4160: </div>
1.148 asau 4161: <div class="sect1">
1.75 rillig 4162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4163: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4164: <p>You can run a particular phase by typing <span class="command"><strong>make
4165: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
4166: phase. This will automatically run all phases that are required for this
4167: phase. The default phase is <code class="varname">build</code>, that is, when you
4168: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
4169: the package will be built, but not installed.</p>
1.75 rillig 4170: </div>
1.148 asau 4171: <div class="sect1">
1.75 rillig 4172: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4173: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4174: <p>The first step in building a package is to fetch the
4175: distribution files (distfiles) from the sites that are providing
4176: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4177: phase.</p>
1.148 asau 4178: <div class="sect2">
1.93 rillig 4179: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 4180: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4181: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4182: defines all URLs from where the distfile, whose name is
4183: derived from the <code class="varname">DISTNAME</code> variable, is
4184: fetched. The more complicated cases are described
4185: below.</p>
4186: <p>The variable <code class="varname">DISTFILES</code> specifies
4187: the list of distfiles that have to be fetched. Its value
4188: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4189: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4190: so that most packages don't need to define it at all.
4191: <code class="varname">EXTRACT_SUFX</code> is
4192: <code class="literal">.tar.gz</code> by default, but can be changed
4193: freely. Note that if your package requires additional
4194: distfiles to the default one, you cannot just append the
4195: additional filenames using the <code class="literal">+=</code>
4196: operator, but you have write for example:</p>
4197: <pre class="programlisting">
4198: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4199: </pre>
4200: <p>Each distfile is fetched from a list of sites, usually
4201: <code class="varname">MASTER_SITES</code>. If the package has multiple
4202: <code class="varname">DISTFILES</code> or multiple
4203: <code class="varname">PATCHFILES</code> from different sites, you can
4204: set
4205: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4206: to the list of URLs where the file
4207: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4208: (including the suffix) can be found.</p>
4209: <pre class="programlisting">
4210: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4211: DISTFILES+= foo-file.tar.gz
4212: SITES.foo-file.tar.gz= \
4213: https://www.somewhere.com/somehow/ \
4214: https://www.somewhereelse.com/mirror/somehow/
4215: </pre>
4216: <p>When actually fetching the distfiles, each item from
4217: <code class="varname">MASTER_SITES</code> or
4218: <code class="varname">SITES.*</code> gets the name of each distfile
4219: appended to it, without an intermediate slash. Therefore,
4220: all site values have to end with a slash or other separator
4221: character. This allows for example to set
4222: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4223: that gets the name of the distfile as a parameter. In this
4224: case, the definition would look like:</p>
4225: <pre class="programlisting">
4226: MASTER_SITES= https://www.example.com/download.cgi?file=
4227: </pre>
4228: <p> The exception to this rule are URLs starting with a dash.
4229: In that case the URL is taken as is, fetched and the result
4230: stored under the name of the distfile. You can use this style
4231: for the case when the download URL style does not match the
4232: above common case. For example, if permanent download URL is a
4233: redirector to the real download URL, or the download file name
4234: is offered by an HTTP Content-Disposition header. In the
4235: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4236: created instead of the default
4237: <code class="filename">v1.0.0.tar.gz</code>.</p>
4238: <pre class="programlisting">
4239: DISTNAME= foo-1.0.0
4240: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4241: </pre>
4242: <p>There are some predefined values for
4243: <code class="varname">MASTER_SITES</code>, which can be used in
4244: packages. The names of the variables should speak for
4245: themselves.</p>
4246: <table border="0" summary="Simple list" class="simplelist">
4247: <tr>
4248: <td>MASTER_SITE_APACHE</td>
4249: <td>MASTER_SITE_BACKUP</td>
4250: </tr>
4251: <tr>
4252: <td>MASTER_SITE_CRATESIO</td>
4253: <td>MASTER_SITE_CYGWIN</td>
4254: </tr>
4255: <tr>
4256: <td>MASTER_SITE_DEBIAN</td>
4257: <td>MASTER_SITE_FREEBSD</td>
4258: </tr>
4259: <tr>
4260: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4261: <td>MASTER_SITE_GENTOO</td>
4262: </tr>
4263: <tr>
4264: <td>MASTER_SITE_GITHUB</td>
4265: <td>MASTER_SITE_GNOME</td>
4266: </tr>
4267: <tr>
4268: <td>MASTER_SITE_GNU</td>
4269: <td>MASTER_SITE_GNUSTEP</td>
4270: </tr>
4271: <tr>
4272: <td>MASTER_SITE_HASKELL_HACKAGE</td>
4273: <td>MASTER_SITE_IFARCHIVE</td>
4274: </tr>
4275: <tr>
4276: <td>MASTER_SITE_KDE</td>
4277: <td>MASTER_SITE_MOZILLA</td>
4278: </tr>
4279: <tr>
4280: <td>MASTER_SITE_MOZILLA_ALL</td>
4281: <td>MASTER_SITE_MYSQL</td>
4282: </tr>
4283: <tr>
4284: <td>MASTER_SITE_NETLIB</td>
4285: <td>MASTER_SITE_OPENBSD</td>
4286: </tr>
4287: <tr>
4288: <td>MASTER_SITE_OPENOFFICE</td>
4289: <td>MASTER_SITE_OSDN</td>
4290: </tr>
4291: <tr>
4292: <td>MASTER_SITE_PERL_CPAN</td>
4293: <td>MASTER_SITE_PGSQL</td>
4294: </tr>
4295: <tr>
4296: <td>MASTER_SITE_PYPI</td>
4297: <td>MASTER_SITE_RUBYGEMS</td>
4298: </tr>
4299: <tr>
4300: <td>MASTER_SITE_R_CRAN</td>
4301: <td>MASTER_SITE_SOURCEFORGE</td>
4302: </tr>
1.85 jmmv 4303: <tr>
1.299 rillig 4304: <td>MASTER_SITE_SUNSITE</td>
4305: <td>MASTER_SITE_SUSE</td>
1.85 jmmv 4306: </tr>
4307: <tr>
1.299 rillig 4308: <td>MASTER_SITE_TEX_CTAN</td>
4309: <td>MASTER_SITE_XCONTRIB</td>
1.85 jmmv 4310: </tr>
4311: <tr>
1.299 rillig 4312: <td>MASTER_SITE_XEMACS</td>
4313: <td>MASTER_SITE_XORG</td>
4314: </tr>
4315: </table>
4316: <p>Some explanations for the less self-explaining ones:
4317: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
4318: 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
4319: 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>
4320: <p>If you choose one of these predefined sites, you may
4321: want to specify a subdirectory of that site. Since these
4322: macros may expand to more than one actual site, you
4323: <span class="emphasis"><em>must</em></span> use the following construct to
4324: specify a subdirectory:</p>
1.100 rillig 4325: <pre class="programlisting">
1.299 rillig 4326: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4327: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100 rillig 4328: </pre>
1.299 rillig 4329: <p>Note the trailing slash after the subdirectory
4330: name.</p>
4331: </div>
4332: <div class="sect2">
4333: <div class="titlepage"><div><div><h3 class="title">
4334: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4335: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4336: all the distfiles exist in a local directory
4337: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4338: user). If the files do not exist, they are fetched using
4339: commands of the form</p>
1.100 rillig 4340: <pre class="programlisting">
1.299 rillig 4341: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4342: </pre>
4343: <p>where <code class="literal">${site}</code> varies through
4344: several possibilities in turn: first,
4345: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4346: sites specified in either <code class="varname">SITES.file</code> if
4347: defined, else <code class="varname">MASTER_SITES</code> or
4348: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4349: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4350: all except the first and the last can be optionally sorted
4351: by the user, via setting either
4352: <code class="varname">MASTER_SORT_RANDOM</code>, and
4353: <code class="varname">MASTER_SORT_AWK</code> or
4354: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4355: <p> The specific command and arguments used depend on the
4356: <code class="varname">FETCH_USING</code> parameter. The example above is
4357: for <code class="literal">FETCH_USING=custom</code>.</p>
4358: <p>The distfiles mirror run by the NetBSD Foundation uses the
4359: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4360: distfiles, if they are freely distributable. Packages setting
4361: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4362: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4363: mirrored.</p>
1.85 jmmv 4364: </div>
4365: </div>
1.299 rillig 4366: <div class="sect1">
4367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4368: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4369: <p>After the distfile(s) are fetched, their checksum is
4370: generated and compared with the checksums stored in the
4371: distinfo file. If the checksums don't match, the build is
4372: aborted. This is to ensure the same distfile is used for
4373: building, and that the distfile wasn't changed, e.g. by some
4374: malign force, deliberately changed distfiles on the master
4375: distribution site or network lossage.</p>
1.75 rillig 4376: </div>
1.148 asau 4377: <div class="sect1">
1.75 rillig 4378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4379: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4380: <p>When the distfiles are present on the local system, they
4381: need to be extracted, as they usually come in the form of some
4382: compressed archive format.</p>
4383: <p>By default, all <code class="varname">DISTFILES</code> are
4384: extracted. If you only need some of them, you can set the
4385: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4386: files.</p>
4387: <p>Extracting the files is usually done by a little
4388: program, <code class="filename">mk/extract/extract</code>, which
4389: already knows how to extract various archive formats, so most
4390: likely you will not need to change anything here. But if you
4391: need, the following variables may help you:</p>
1.148 asau 4392: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4393: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4394: <dd><p>Use these variables to override the default
4395: options for an extract command, which are defined in
4396: <code class="filename">mk/extract/extract</code>.</p></dd>
4397: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4398: <dd><p>This variable can be set to
4399: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4400: (which is the default value), <code class="literal">pax</code>, or an
4401: absolute pathname pointing to the command with which tar
4402: archives should be extracted. It is preferred to choose bsdtar over gtar
4403: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 4404: </dl></div>
1.299 rillig 4405: <p>If the <code class="filename">extract</code> program doesn't
4406: serve your needs, you can also override the
4407: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4408: command used for extracting the files. This command is
4409: executed in the <code class="filename">${WRKSRC}</code>
4410: directory. During execution of this command, the shell
4411: variable <code class="varname">extract_file</code> holds the absolute
4412: pathname of the file that is going to be extracted.</p>
4413: <p>And if that still does not suffice, you can override the
4414: <code class="varname">do-extract</code> target in the package
4415: Makefile.</p>
1.75 rillig 4416: </div>
1.148 asau 4417: <div class="sect1">
1.75 rillig 4418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4419: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4420: <p>After extraction, all the patches named by the
4421: <code class="varname">PATCHFILES</code>, those present in the patches
4422: subdirectory of the package as well as in
4423: $LOCALPATCHES/$PKGPATH (e.g.
4424: <code class="filename">/usr/local/patches/graphics/png</code>) are
4425: applied. Patchfiles ending in <code class="filename">.Z</code> or
4426: <code class="filename">.gz</code> are uncompressed before they are
4427: applied, files ending in <code class="filename">.orig</code> or
4428: <code class="filename">.rej</code> are ignored. Any special options to
1.311 leot 4429: <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 4430: <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 4431: <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 4432: fail if the expected text from the patch context is not found in the
4433: patched file. If that happens, fix the patch file by comparing it
4434: with the actual text in the file to be patched.</p>
1.78 rillig 4435: </div>
1.148 asau 4436: <div class="sect1">
1.75 rillig 4437: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4438: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4439: <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>.
4440: </p>
1.75 rillig 4441: </div>
1.148 asau 4442: <div class="sect1">
1.75 rillig 4443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4444: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4445: <p>This phase creates wrapper programs for the compilers and
4446: linkers. The following variables can be used to tweak the
4447: wrappers.</p>
4448: <div class="variablelist"><dl class="variablelist">
4449: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4450: <dd><p>The command used to print progress
4451: messages. Does nothing by default. Set to
4452: <code class="literal">${ECHO}</code> to see the progress
4453: messages.</p></dd>
4454: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4455: <dd><p>This variable can be set to
4456: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4457: depending on whether you want additional information in the
4458: wrapper log file.</p></dd>
4459: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4460: <dd><p>This variable can be set to
4461: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4462: on whether the wrapper should use its cache, which will
4463: improve the speed. The default value is
4464: <code class="literal">yes</code>, but is forced to
4465: <code class="literal">no</code> if the platform does not support
4466: it.</p></dd>
4467: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4468: <dd><p>A list of reordering commands. A reordering
4469: command has the form
4470: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4471: It ensures that that
4472: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4473: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4474: </p></dd>
4475: </dl></div>
4476: </div>
4477: <div class="sect1">
4478: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4479: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4480: <p>Most pieces of software need information on the header
4481: files, system calls, and library routines which are available
4482: on the platform they run on. The process of determining this
4483: information is known as configuration, and is usually
4484: automated. In most cases, a script is supplied with the
4485: distfiles, and its invocation results in generation of header
4486: files, Makefiles, etc.</p>
4487: <p>If the package contains a configure script, this can be
4488: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4489: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4490: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.301 rillig 4491: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4492: <p>In the <code class="literal">do-configure</code> stage, a rough
4493: equivalent of the following command is run. See
4494: <code class="filename">mk/configure/configure.mk</code>, target
4495: <code class="literal">do-configure-script</code> for the exact
4496: definition.</p>
4497: <pre class="programlisting">
4498: .for dir in ${CONFIGURE_DIRS}
4499: cd ${WRKSRC} && cd ${dir} \
4500: && env ${CONFIGURE_ENV} \
4501: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299 rillig 4502: .endfor
1.100 rillig 4503: </pre>
1.299 rillig 4504: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4505: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4506: <code class="varname">WRKSRC</code>. In each of these directories, the
4507: configure script is run with the environment
4508: <code class="varname">CONFIGURE_ENV</code> and arguments
4509: <code class="varname">CONFIGURE_ARGS</code>. The variables
4510: <code class="varname">CONFIGURE_ENV</code>,
4511: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4512: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4513: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4514: package.</p>
4515: <p>If the program uses the Perl way of configuration (mainly Perl
4516: modules, but not only), i.e. a file called
4517: <code class="filename">Makefile.PL</code>, it should include
4518: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4519: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4520: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4521: <p>If the program uses an <code class="filename">Imakefile</code>
4522: for configuration, the appropriate steps can be invoked by
4523: setting <code class="varname">USE_IMAKE</code> to
4524: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4525: You can add variables to xmkmf's environment by adding them to the
4526: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4527: <p>If the program uses <code class="filename">cmake</code>
4528: for configuration, the appropriate steps can be invoked by
4529: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
4530: You can add variables to cmake's environment by adding them to the
4531: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
4532: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
4533: The top directory argument is given by the
4534: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
4535: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
4536: <p>If there is no configure step at all, set
4537: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 4538: </div>
1.148 asau 4539: <div class="sect1">
1.75 rillig 4540: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4541: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301 rillig 4542: <p>For building a package, a rough equivalent of the following
4543: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4544: <code class="literal">do-build</code> for the exact definition.</p>
1.97 rillig 4545: <pre class="programlisting">
1.301 rillig 4546: .for dir in ${BUILD_DIRS}
4547: cd ${WRKSRC} && cd ${dir} \
1.299 rillig 4548: && env ${MAKE_ENV} \
1.301 rillig 4549: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299 rillig 4550: -f ${MAKE_FILE} \
4551: ${BUILD_TARGET}
4552: .endfor
1.97 rillig 4553: </pre>
1.299 rillig 4554: <p><code class="varname">BUILD_DIRS</code> (default:
4555: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4556: <code class="varname">WRKSRC</code>. In each of these directories,
4557: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4558: <code class="varname">MAKE_ENV</code> and arguments
4559: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4560: <code class="varname">MAKE_ENV</code>,
4561: <code class="varname">BUILD_MAKE_FLAGS</code>,
4562: <code class="varname">MAKE_FILE</code> and
4563: <code class="varname">BUILD_TARGET</code> may all be changed by the
4564: package.</p>
4565: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4566: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4567: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4568: default value of <code class="varname">MAKE_FILE</code> is
4569: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4570: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4571: <p>If there is no build step at all, set
4572: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.97 rillig 4573: </div>
1.148 asau 4574: <div class="sect1">
1.97 rillig 4575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4576: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4577: <p>[TODO]</p>
1.75 rillig 4578: </div>
1.148 asau 4579: <div class="sect1">
1.75 rillig 4580: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4581: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4582: <p>Once the build stage has completed, the final step is to
4583: install the software in public directories, so users can
4584: access the programs and files.</p>
1.301 rillig 4585: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4586: of the following code is executed; see
4587: <code class="filename">mk/install/install.mk</code>, target
4588: <code class="literal">do-install</code> for the exact definition. Additionally,
4589: before and after this code, several consistency checks are run
4590: against the files-to-be-installed, see
4591: <code class="filename">mk/check/*.mk</code> for details.</p>
4592: <pre class="programlisting">
4593: .for dir in ${INSTALL_DIRS}
4594: cd ${WRKSRC} && cd ${dir} \
4595: && env ${INSTALL_ENV} ${MAKE_ENV} \
4596: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4597: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299 rillig 4598: .endfor
1.220 wiz 4599: </pre>
1.299 rillig 4600: <p>The variable's meanings are analogous to the ones in the
4601: <span class="emphasis"><em>build</em></span> phase.
4602: <code class="varname">INSTALL_DIRS</code> defaults to
4603: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4604: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4605: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4606: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4607: defined.</p>
4608: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4609: variables are useful. They are all variations of the
1.311 leot 4610: <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 4611: permissions preset. <code class="varname">INSTALL</code> is the plain
4612: install command. The specialized variants, together with their
4613: intended use, are:</p>
4614: <div class="variablelist"><dl class="variablelist">
4615: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4616: <dd><p>directories that contain
4617: binaries</p></dd>
4618: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4619: <dd><p>directories that contain
4620: scripts</p></dd>
4621: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4622: <dd><p>directories that contain shared and static
4623: libraries</p></dd>
4624: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4625: <dd><p>directories that contain data
4626: files</p></dd>
4627: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4628: <dd><p>directories that contain man
4629: pages</p></dd>
4630: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4631: <dd><p>directories that contain data files for games
4632: </p></dd>
4633: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4634: <dd><p>binaries that can be stripped from debugging
4635: symbols</p></dd>
4636: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4637: <dd><p>binaries that cannot be
4638: stripped</p></dd>
4639: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4640: <dd><p>game
4641: binaries</p></dd>
4642: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4643: <dd><p>shared and static
4644: libraries</p></dd>
4645: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4646: <dd><p>data files</p></dd>
4647: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4648: <dd><p>data files for
4649: games</p></dd>
4650: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4651: <dd><p>man pages</p></dd>
4652: </dl></div>
4653: <p>Some other variables are:</p>
4654: <div class="variablelist"><dl class="variablelist">
4655: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.311 leot 4656: <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 4657: when installing binaries. Any debugging sections and symbols present in
4658: binaries will be preserved.
4659: </p></dd>
4660: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4661: <dd><p>A list of directories relative to
4662: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4663: beginning of the <span class="emphasis"><em>install</em></span> phase.
4664: The package is supposed to create all needed directories itself
4665: before installing files to it and list all other directories here.
4666: </p></dd>
4667: </dl></div>
4668: <p>In the rare cases that a package shouldn't install anything,
4669: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4670: mostly relevant for packages in the <code class="filename">regress</code>
4671: category.</p>
1.75 rillig 4672: </div>
1.148 asau 4673: <div class="sect1">
1.75 rillig 4674: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4675: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4676: <p>Once the install stage has completed, a binary package of
4677: the installed files can be built. These binary packages can be
4678: used for quick installation without previous compilation, e.g. by
4679: the <span class="command"><strong>make bin-install</strong></span> or by using
4680: <span class="command"><strong>pkg_add</strong></span>.</p>
4681: <p>By default, the binary packages are created in
4682: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4683: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4684: one for each category in the <code class="varname">CATEGORIES</code>
4685: variable. <code class="varname">PACKAGES</code> defaults to
4686: <code class="filename">pkgsrc/packages</code>.</p>
1.75 rillig 4687: </div>
1.148 asau 4688: <div class="sect1">
1.75 rillig 4689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4690: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4691: <p>Once you're finished with a package, you can clean the work
4692: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4693: to clean the work directories of all dependencies too, use
4694: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 4695: </div>
1.148 asau 4696: <div class="sect1">
1.75 rillig 4697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4698: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148 asau 4699: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4700: <dt><span class="term">pre/post-*</span></dt>
4701: <dd>
4702: <p>For any of the main targets described in the previous
4703: section (configure, build, install, etc.), two auxiliary
4704: targets exist with
4705: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4706: prefix for the main target's name. These targets are
4707: invoked before and after the main target is called,
4708: allowing extra configuration or installation steps be
4709: performed from a package's Makefile, for example, which
4710: a program's configure script or install target
4711: omitted.</p>
4712: <p>About 5% of the pkgsrc packages define their custom
4713: post-extract target, another 5% define pre-configure, and 10%
4714: define post-install. The other pre/post-* targets are defined
4715: even less often.</p>
4716: </dd>
4717: <dt><span class="term">do-*</span></dt>
1.75 rillig 4718: <dd>
1.299 rillig 4719: <p>Should one of the main targets do the wrong thing,
4720: and should there be no variable to fix this, you can
4721: redefine it with the do-* target. (Note that redefining
4722: the target itself instead of the do-* target is a bad
4723: idea, as the pre-* and post-* targets won't be called
4724: anymore, etc.)</p>
4725: <p>About 15% of the pkgsrc packages override the default
4726: do-install, the other do-* targets are overridden even less
4727: often.</p>
1.75 rillig 4728: </dd>
1.299 rillig 4729: <dt><span class="term">reinstall</span></dt>
1.75 rillig 4730: <dd>
1.299 rillig 4731: <p>If you did a <span class="command"><strong>make install</strong></span> and
4732: you noticed some file was not installed properly, you
4733: can repeat the installation with this target, which will
4734: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4735: <p>This is the default value of
4736: <code class="varname">DEPENDS_TARGET</code> except in the case of
4737: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4738: package</strong></span>, where the defaults are
4739: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4740: respectively.</p>
1.75 rillig 4741: </dd>
1.299 rillig 4742: <dt><span class="term">deinstall</span></dt>
4743: <dd>
1.311 leot 4744: <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 4745: current directory, effectively de-installing the
4746: package. The following variables can be used to tune the
4747: behaviour:</p>
4748: <div class="variablelist"><dl class="variablelist">
4749: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.311 leot 4750: <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 4751: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4752: <dd><p>Remove all packages that require (depend on)
4753: the given package. This can be used to remove any
4754: packages that may have been pulled in by a given
4755: package, e.g. if <span class="command"><strong>make deinstall
4756: DEINSTALLDEPENDS=1</strong></span> is done in
4757: <code class="filename">pkgsrc/x11/kde</code>, this is
4758: likely to remove whole KDE. Works by adding
1.311 leot 4759: <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 4760: command line.</p></dd>
4761: </dl></div>
4762: </dd>
4763: <dt><span class="term">bin-install</span></dt>
4764: <dd><p>Install a binary package from local disk and via FTP
4765: from a list of sites (see the
4766: <code class="varname">BINPKG_SITES</code> variable), and do a
4767: <span class="command"><strong>make package</strong></span> if no binary package is
4768: available anywhere. The arguments given to
4769: <span class="command"><strong>pkg_add</strong></span> can be set via
4770: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4771: operation, etc.</p></dd>
4772: <dt><span class="term">install-clean</span></dt>
4773: <dd><p>This target removes the state files for the "install" and later
4774: phases so that the "install" target may be re-invoked. This can be
4775: used after editing the PLIST to install the package without
4776: rebuilding it.</p></dd>
4777: <dt><span class="term">build-clean</span></dt>
4778: <dd><p>This target removes the state files for the "build" and later
4779: phases so that the "build" target may be re-invoked.</p></dd>
4780: <dt><span class="term">update</span></dt>
4781: <dd>
4782: <p>This target causes the current package to be
4783: updated to the latest version. The package and all
4784: depending packages first get de-installed, then current
4785: versions of the corresponding packages get compiled and
4786: installed. This is similar to manually noting which
4787: packages are currently installed, then performing a
4788: series of <span class="command"><strong>make deinstall</strong></span> and
4789: <span class="command"><strong>make install</strong></span> (or whatever
4790: <code class="varname">UPDATE_TARGET</code> is set to) for these
4791: packages.</p>
4792: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4793: resume package updating in case a previous <span class="command"><strong>make
4794: update</strong></span> was interrupted for some reason.
4795: However, in this case, make sure you don't call
4796: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4797: list of dependent packages in <code class="varname">WRKDIR</code>.
4798: Otherwise, you lose the ability to automatically update
4799: the current package along with the dependent packages
4800: you have installed.</p>
4801: <p>Resuming an interrupted <span class="command"><strong>make
4802: update</strong></span> will only work as long as the package
4803: tree remains unchanged. If the source code for one of
4804: the packages to be updated has been changed, resuming
4805: <span class="command"><strong>make update</strong></span> will most certainly
4806: fail!</p>
4807: <p>The following variables can be used either on the
4808: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4809: alter the behaviour of <span class="command"><strong>make
4810: update</strong></span>:</p>
4811: <div class="variablelist"><dl class="variablelist">
4812: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4813: <dd><p>Install target to recursively use for the
4814: updated package and the dependent packages.
4815: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4816: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4817: <span class="command"><strong>make update</strong></span>. Other good
4818: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4819: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4820: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4821: endless loop!</p></dd>
4822: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4823: <dd><p>Don't clean up after updating. Useful if
4824: you want to leave the work sources of the updated
4825: packages around for inspection or other purposes.
4826: Be sure you eventually clean up the source tree
4827: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4828: or you may run into troubles with old source code
4829: still lying around on your next
4830: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4831: update</strong></span>.</p></dd>
4832: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4833: <dd><p>Deinstall each package before installing
4834: (making <code class="varname">DEPENDS_TARGET</code>). This
4835: may be necessary if the
4836: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4837: called after interrupting a running <span class="command"><strong>make
4838: update</strong></span>.</p></dd>
4839: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4840: <dd><p>Allows you to disable recursion and hardcode
4841: the target for packages. The default is
4842: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4843: facilitating a recursive update of prerequisite
4844: packages. Only set
4845: <code class="varname">DEPENDS_TARGET</code> if you want to
4846: disable recursive updates. Use
4847: <code class="varname">UPDATE_TARGET</code> instead to just
4848: set a specific target for each package to be
4849: installed during <span class="command"><strong>make update</strong></span>
4850: (see above).</p></dd>
4851: </dl></div>
4852: </dd>
4853: <dt><span class="term">clean-update</span></dt>
4854: <dd>
4855: <p>Clean the source tree for all packages that would
4856: get updated if <span class="command"><strong>make update</strong></span> was called
4857: from the current directory. This target should not be
4858: used if the current package (or any of its depending
4859: packages) have already been de-installed (e.g., after
4860: calling <span class="command"><strong>make update</strong></span>) or you may lose
4861: some packages you intended to update. As a rule of
4862: thumb: only use this target <span class="emphasis"><em>before</em></span>
4863: the first time you run <span class="command"><strong>make update</strong></span>
4864: and only if you have a dirty package tree (e.g., if you
4865: used <code class="varname">NOCLEAN</code>).</p>
4866: <p>If you are unsure about whether your tree is
4867: clean, you can either perform a <span class="command"><strong>make
4868: clean</strong></span> at the top of the tree, or use the
4869: following sequence of commands from the directory of the
4870: package you want to update (<span class="emphasis"><em>before</em></span>
4871: running <span class="command"><strong>make update</strong></span> for the first
4872: time, otherwise you lose all the packages you wanted to
4873: update!):</p>
4874: <pre class="screen">
4875: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
4876: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
4877: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
4878: </pre>
4879: <p>The following variables can be used either on the
4880: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
4881: <span class="command"><strong>make clean-update</strong></span>:</p>
4882: <div class="variablelist"><dl class="variablelist">
4883: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
4884: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
4885: reconstruct the list of directories to update for
4886: this package. Only use this if <span class="command"><strong>make
4887: update</strong></span> successfully installed all
4888: packages you wanted to update. Normally, this is
4889: done automatically on <span class="command"><strong>make
4890: update</strong></span>, but may have been suppressed by
4891: the <code class="varname">NOCLEAN</code> variable (see
4892: above).</p></dd>
4893: </dl></div>
4894: </dd>
4895: <dt><span class="term">replace</span></dt>
4896: <dd>
4897: <p>Update the installation of the current package. This
4898: differs from update in that it does not replace dependent
4899: 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
4900: target to work.</p>
4901: <p><span class="emphasis"><em>Be careful when using this
4902: target!</em></span> There are no guarantees that dependent
4903: packages will still work, in particular they will most
4904: certainly break if you <span class="command"><strong>make replace</strong></span> a
4905: library package whose shared library major version changed
4906: between your installed version and the new one. For this
4907: reason, this target is not officially supported and only
4908: recommended for advanced users.</p>
4909: </dd>
4910: <dt><span class="term">info</span></dt>
1.311 leot 4911: <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 4912: package. You can use this to check which version of a
4913: package is installed.</p></dd>
4914: <dt><span class="term">index</span></dt>
4915: <dd>
4916: <p>This is a top-level command, i.e. it should be used in
4917: the <code class="filename">pkgsrc</code> directory. It creates a
4918: database of all packages in the local pkgsrc tree, including
4919: dependencies, comment, maintainer, and some other useful
4920: information. Individual entries are created by running
4921: <span class="command"><strong>make describe</strong></span> in the packages'
4922: directories. This index file is saved as
4923: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
4924: verbose format by running <span class="command"><strong>make
4925: print-index</strong></span>. You can search in it with
4926: <span class="command"><strong>make search
4927: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
4928: extract a list of all packages that depend on a particular
4929: one by running <span class="command"><strong>make show-deps
4930: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
4931: <p>Running this command takes a very long time, some
4932: hours even on fast machines!</p>
4933: </dd>
4934: <dt><span class="term">readme</span></dt>
4935: <dd>
4936: <p>This target generates a
1.314 nia 4937: <code class="filename">index.html</code> file, which can be
1.299 rillig 4938: 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
4939: contain references to any packages which are in the
4940: <code class="varname">PACKAGES</code> directory on the local
4941: host. The generated files can be made to refer to URLs
4942: based on <code class="varname">FTP_PKG_URL_HOST</code> and
4943: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314 nia 4944: wanted to generate <code class="filename">index.html</code>
1.299 rillig 4945: files which pointed to binary packages on the local
4946: machine, in the directory
4947: <code class="filename">/usr/packages</code>, set
4948: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
4949: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
4950: <code class="varname">${PACKAGES}</code> directory and its
4951: subdirectories will be searched for all the binary
4952: packages.</p>
4953: <p>The target can be run at the toplevel or in category
4954: directories, in which case it descends recursively.</p>
4955: </dd>
4956: <dt><span class="term">readme-all</span></dt>
4957: <dd><p>This is a top-level command, run it in
4958: <code class="filename">pkgsrc</code>. Use this target to create a
4959: file <code class="filename">README-all.html</code> which contains a
4960: list of all packages currently available in the NetBSD
4961: Packages Collection, together with the category they belong
4962: to and a short description. This file is compiled from the
1.314 nia 4963: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299 rillig 4964: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
4965: readme</strong></span>.</p></dd>
4966: <dt><span class="term">cdrom-readme</span></dt>
4967: <dd><p>This is very much the same as the
4968: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
4969: used when generating a pkgsrc tree to be written to a
4970: CD-ROM. This target also produces
1.314 nia 4971: <code class="filename">index.html</code> files, and can be made
1.299 rillig 4972: to refer to URLs based on
4973: <code class="varname">CDROM_PKG_URL_HOST</code> and
4974: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
4975: <dt><span class="term">show-distfiles</span></dt>
4976: <dd><p>This target shows which distfiles and patchfiles
4977: are needed to build the package
4978: (<code class="varname">ALLFILES</code>, which contains all
4979: <code class="varname">DISTFILES</code> and
4980: <code class="varname">PATCHFILES</code>, but not
4981: <code class="filename">patches/*</code>).</p></dd>
4982: <dt><span class="term">show-downlevel</span></dt>
4983: <dd><p>This target shows nothing if the package is not
4984: installed. If a version of this package is installed,
4985: but is not the version provided in this version of
4986: pkgsrc, then a warning message is displayed. This target
4987: can be used to show which of your installed packages are
4988: downlevel, and so the old versions can be deleted, and
4989: the current ones added.</p></dd>
4990: <dt><span class="term">show-pkgsrc-dir</span></dt>
4991: <dd><p>This target shows the directory in the pkgsrc
4992: hierarchy from which the package can be built and
4993: installed. This may not be the same directory as the one
4994: from which the package was installed. This target is
4995: intended to be used by people who may wish to upgrade
4996: many packages on a single host, and can be invoked from
4997: the top-level pkgsrc Makefile by using the
4998: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
4999: <dt><span class="term">show-installed-depends</span></dt>
5000: <dd><p>This target shows which installed packages match
5001: the current package's <code class="varname">DEPENDS</code>. Useful
5002: if out of date dependencies are causing build
5003: problems.</p></dd>
5004: <dt><span class="term">print-build-depends-list</span></dt>
5005: <dd><p>This target shows the list of packages that the current package
5006: depends on for building.</p></dd>
5007: <dt><span class="term">print-run-depends-list</span></dt>
5008: <dd><p>This target shows the list of packages that the current package
5009: depends on for running.</p></dd>
5010: <dt><span class="term">check-shlibs</span></dt>
5011: <dd><p>After a package is installed, check all its
5012: binaries and (on ELF platforms) shared libraries to see
5013: if they find the shared libs they need. Run by default
5014: 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>
5015: <dt><span class="term">print-PLIST</span></dt>
5016: <dd>
5017: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5018: upgraded pkg, this prints out an attempt to generate a
5019: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5020: -newer work/.extract_done</strong></span>. An attempt is made
5021: to care for shared libs etc., but it is
5022: <span class="emphasis"><em>strongly</em></span> recommended to review the
5023: result before putting it into
5024: <code class="filename">PLIST</code>. On upgrades, it's useful to
5025: diff the output of this command against an already
5026: existing <code class="filename">PLIST</code> file.</p>
1.311 leot 5027: <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 5028: other methods that don't update file access times, be
5029: sure to add these files manually to your
5030: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5031: -newer</span>”</span> command used by this target won't catch
5032: them!</p>
5033: <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
5034: information on this target.</p>
5035: </dd>
5036: </dl></div>
5037: </div>
5038: </div>
5039: <div class="chapter">
5040: <div class="titlepage"><div><div><h2 class="title">
5041: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5042: <div class="toc">
5043: <p><b>Table of Contents</b></p>
5044: <dl class="toc">
5045: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5046: <dd><dl>
5047: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
5048: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
5049: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
5050: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
5051: </dl></dd>
5052: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5053: <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>
5054: </dl>
5055: </div>
5056: <p>When you find a package that is not yet in pkgsrc, you
5057: most likely have a URL from where you can download the source
5058: code. Starting with this URL, creating a package involves only a
5059: few steps.</p>
5060: <div class="procedure"><ol class="procedure" type="1">
5061: <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
5062: enable the basic quality checks.</p></li>
5063: <li class="step">
5064: <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
5065: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5066: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5067: <span class="command"><strong>mkpatches</strong></span>:</p>
5068: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5069: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5070: </li>
5071: <li class="step">
5072: <p>Choose one of the top-level directories as the category in
5073: which you want to place your package. You can also create a directory of
5074: your own (maybe called <code class="filename">local</code>). In that category
5075: directory, create another directory for your package and change into
5076: it:</p>
5077: <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>
5078: <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>
5079: </li>
5080: <li class="step">
5081: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
5082: you for a URL. Enter the URL of the distribution file (in most cases a
5083: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
5084: of your package are created automatically. The distribution file is
5085: extracted automatically to fill in some details in the
5086: <code class="filename">Makefile</code> that would otherwise have to be done
5087: manually:</p>
5088: <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>
5089: </li>
5090: <li class="step">
5091: <p>Examine the extracted files to determine the dependencies of
5092: your package. Ideally, this is mentioned in some
5093: <code class="filename">README</code> file, but things may differ. For each of
5094: these dependencies, look where it exists in pkgsrc, and if there is a
5095: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5096: line to your package <code class="filename">Makefile</code> which includes that
5097: file just before the last line. If the
5098: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5099: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5100: that the package's include files and libraries are provided.</p>
5101: <p>If you just need binaries from a package, add a
5102: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5103: version of the dependency and where it can be found in pkgsrc. This line
5104: should be placed in the third paragraph. If the dependency is only
5105: needed for building the package, but not when using it, use
5106: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5107: instead of <code class="varname">DEPENDS</code>.
5108: The difference between <code class="varname">TOOL_DEPENDS</code> and
5109: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5110: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
5111: packages, i.e. packages for the architecture where the package
5112: is built;
5113: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
5114: packages, i.e. packages for the architecture for which the package
5115: is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
5116: to specify a dependency used only for testing the resulting package
5117: built, using the upstream project's included test suite.
5118: Your package may then look like this:</p>
5119: <pre class="programlisting">
5120: [...]
5121:
5122: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5123: DEPENDS+= screen-[0-9]*:../../misc/screen
5124: DEPENDS+= screen>=4.0:../../misc/screen
5125:
5126: [...]
5127:
5128: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5129: .include "../../devel/glib2/buildlink3.mk"
5130: .include "../../mk/bsd.pkg.mk"
5131: </pre>
5132: </li>
5133: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5134: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5135: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5136: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5137: additional explanations.</p></li>
5138: <li class="step"><p>In many cases the package is not yet ready to build. You can
5139: 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
5140: over there, you can hopefully continue here.</p></li>
5141: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5142: directory from the extracted files. Besides these files, a lot of cache
5143: files and other system information has been saved in the working
5144: directory, which may become wrong after you edited the
5145: <code class="filename">Makefile</code>.</p></li>
5146: <li class="step">
5147: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5148: 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>
5149: <p>If the extracted files from the package need to be fixed, run multiple rounds of these commands:</p>
5150: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>make</code></strong>
5151: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5152: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
5153: <code class="prompt">$</code> <strong class="userinput"><code>make mps</code></strong>
5154: <code class="prompt">$</code> <strong class="userinput"><code>make clean</code></strong></pre>
5155: </li>
5156: <li class="step"><p>When the package builds fine, the next step is to install
5157: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5158: everything works.</p></li>
5159: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5160: contains a list of the files that are installed by the package, is
5161: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5162: >PLIST</strong></span> to generate a probably correct list. Check
5163: the file using your preferred text editor to see if the list of
5164: files looks plausible.</p></li>
5165: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5166: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5167: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5168: had been registered in the database of installed files, but with an
5169: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5170: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5171: registered with the list of files from
5172: <code class="filename">PLIST</code>.</p></li>
5173: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
5174: package from the set of installed files.</p></li>
5175: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5176: from above again in a single step, making sure that the PLIST is correct
5177: and the whole package is created as intended.</p></li>
5178: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything left to do.</p></li>
5179: <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>
5180: </ol></div>
5181: <div class="sect1">
5182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5183: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5184: <div class="sect2">
5185: <div class="titlepage"><div><div><h3 class="title">
5186: <a name="creating.perl-module"></a>14.1.1. Perl modules</h3></div></div></div>
5187: <p>Simple Perl modules are handled automatically by
5188: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
5189: </div>
5190: <div class="sect2">
5191: <div class="titlepage"><div><div><h3 class="title">
5192: <a name="creating.python-module"></a>14.1.2. Python modules and programs</h3></div></div></div>
5193: <p>Python modules and programs packages are easily created using a
5194: set of predefined variables.</p>
5195: <p>
5196: If some Python versions are not supported by the software, set the
5197: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5198: that are not supported, e.g.
5199: </p>
5200: <pre class="programlisting">
5201: PYTHON_VERSIONS_INCOMPATIBLE= 27
5202: </pre>
5203: <p>
5204: If the packaged software is a Python module, include one of
5205: <code class="filename">../../lang/python/egg.mk</code>,
5206: <code class="filename">../../lang/python/distutils.mk</code>, or
5207: <code class="filename">../../lang/python/extension.mk</code>.</p>
5208: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
5209: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
5210: If the packaged software is using setuptools, you only need
5211: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
5212: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
5213: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>,
5214: so pkgsrc will use this framework.
5215: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>;
5216: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
5217: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
5218: to the name of the script.</p>
5219: <p>Either way, the package directory should be called
5220: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5221: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5222: </p>
5223: <pre class="programlisting">
5224: DISTNAME= foopymodule-1.2.10
5225: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5226: </pre>
5227: <p>If it is an application, include
5228: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5229: In order to correctly set the path to the Python interpreter, use the
5230: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5231: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5232: For example:
5233: </p>
5234: <pre class="programlisting">
5235: REPLACE_PYTHON= *.py
5236: </pre>
5237: <p>Some Python modules have separate distributions for Python-2.x
5238: and Python-3.x support. In pkgsrc this is handled by the
5239: <code class="filename">versioned_dependencies.mk</code> file. Set
5240: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
5241: packages that should be depended upon and include
5242: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
5243: then the pkgsrc infrastructure will depend on the appropriate package
5244: version. For example:
5245: </p>
5246: <pre class="programlisting">
5247: PYTHON_VERSIONED_DEPENDENCIES=dialog
5248: </pre>
5249: <p>
5250: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
5251: of supported packages.</p>
5252: </div>
5253: <div class="sect2">
5254: <div class="titlepage"><div><div><h3 class="title">
5255: <a name="creating.R-package"></a>14.1.3. R packages</h3></div></div></div>
5256: <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>
5257: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
5258: 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>.
5259: Individual packages (and optionally their dependencies) may be created
5260: and updated. R packages generally follow the same form, and most of
5261: the relevant information needed is contained in a
5262: <code class="filename">DESCRIPTION</code> file as part of each R package on
5263: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5264: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5265: creates or updates a package in the canonical form. The resulting
5266: package should be reviewed for correctness.</p>
5267: </div>
5268: <div class="sect2">
5269: <div class="titlepage"><div><div><h3 class="title">
5270: <a name="creating.TeX-package"></a>14.1.4. TeXlive packages</h3></div></div></div>
5271: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
5272: <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>
5273: <p>If the TeXlive package name is not known, it may be useful to
5274: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5275: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5276: 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
5277: archive</a>.</p>
5278: <p>If the TeXlive package name is known, download the files from
5279: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5280: archive</a>. For package <code class="filename">foo</code>, you will need
5281: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5282: also have associated documentation packages, so download
5283: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5284: should be placed in the appropriate category directory, which is often
5285: but not always <code class="filename">print</code>. Then run the following
5286: command in the category directory.</p>
5287: <pre class="programlisting">
5288: texlive2pkg foo.tar.xz foo.doc.tar.xz
5289: </pre>
5290: <p>This will create two packages, <code class="filename">tex-foo</code> and
5291: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5292: are correct.</p>
5293: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5294: currently does not include version information in package filenames
5295: and changes their contents periodically when updates occur.
5296: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5297: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5298: main one and the corresponding documentation, upload the distfiles
5299: with the following command in each package directory.</p>
5300: <pre class="programlisting">
5301: make upload-distfiles
5302: </pre>
5303: </div>
5304: </div>
5305: <div class="sect1">
5306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5307: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5308: <div class="sect2">
5309: <div class="titlepage"><div><div><h3 class="title">
5310: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5311: <div class="sect3">
5312: <div class="titlepage"><div><div><h4 class="title">
5313: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5314: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5315: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5316: pkgsrc. As the description says it has to do with the web, the obvious
5317: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5318: <pre class="programlisting">
5319: <code class="prompt">$</code> mkdir www/nvu
5320: <code class="prompt">$</code> cd www/nvu
5321: </pre>
5322: <p>The web site says that the sources are available as a tar file, so
5323: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5324: <pre class="programlisting">
5325: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5326: </pre>
5327: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5328: below the <code class="varname">DISTNAME</code> line, as the package name should
5329: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5330: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5331: <code class="varname">COMMENT</code> fields. Then the package
5332: <code class="filename">Makefile</code> looked like that:</p>
5333: <pre class="programlisting">
5334: # $NetBSD $
5335: #
5336:
5337: DISTNAME= nvu-1.0-sources
5338: PKGNAME= nvu-1.0
5339: CATEGORIES= www
5340: MASTER_SITES= http://cvs.nvu.com/download/
5341: EXTRACT_SUFX= .tar.bz2
5342:
5343: MAINTAINER= rillig@NetBSD.org
5344: HOMEPAGE= http://cvs.nvu.com/
5345: COMMENT= Web Authoring System
5346:
5347: # url2pkg-marker (please do not remove this line.)
5348: .include "../../mk/bsd.pkg.mk"
5349: </pre>
5350: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5351: this is a workaround to prevent CVS expanding to the filename of the
5352: guide.</p>
5353: <p>Then, I quit the editor and watched pkgsrc downloading a large
5354: source archive:</p>
5355: <pre class="programlisting">
5356: url2pkg> Running "make makesum" ...
5357: => Required installed package digest>=20010302: digest-20060826 found
5358: => Fetching nvu-1.0-sources.tar.bz2
5359: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5360: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5361: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5362: url2pkg> Running "make extract" ...
5363: => Required installed package digest>=20010302: digest-20060826 found
5364: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5365: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5366: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5367: ===> Installing dependencies for nvu-1.0
5368: ===> Overriding tools for nvu-1.0
5369: ===> Extracting for nvu-1.0
5370: url2pkg> Adjusting the Makefile.
5371:
5372: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5373:
5374: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5375: </pre>
5376: </div>
5377: <div class="sect3">
5378: <div class="titlepage"><div><div><h4 class="title">
5379: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5380: <p>Now that the package has been extracted, let's see what's inside
5381: it. The package has a <code class="filename">README.txt</code>, but that only
5382: says something about mozilla, so it's probably useless for seeing what
5383: dependencies this package has. But since there is a GNU configure script
5384: in the package, let's hope that it will complain about everything it
5385: needs.</p>
5386: <pre class="programlisting">
5387: <code class="prompt">$</code> bmake
5388: => Required installed package digest>=20010302: digest-20060826 found
5389: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5390: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5391: ===> Patching for nvu-1.0
5392: ===> Creating toolchain wrappers for nvu-1.0
5393: ===> Configuring for nvu-1.0
5394: [...]
5395: configure: error: Perl 5.004 or higher is required.
5396: [...]
5397: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5398: [...]
5399: </pre>
5400: <p>That worked quite well. So I opened the package Makefile in my
5401: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5402: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5403: package have changed now, and since a perl wrapper is automatically
5404: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5405: from scratch.</p>
5406: <pre class="programlisting">
5407: <code class="prompt">$</code> bmake clean
5408: ===> Cleaning for nvu-1.0
5409: <code class="prompt">$</code> bmake
5410: [...]
5411: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5412: GNU Make. You will not be able to build Mozilla without GNU Make.
5413: [...]
5414: </pre>
5415: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5416: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5417: <pre class="programlisting">
5418: [...]
5419: checking for GTK - version >= 1.2.0... no
5420: *** Could not run GTK test program, checking why...
5421: [...]
5422: </pre>
5423: <p>Now to the other dependencies. The first question is: Where is the
5424: GTK package hidden in pkgsrc?</p>
5425: <pre class="programlisting">
5426: <code class="prompt">$</code> echo ../../*/gtk*
5427: [many packages ...]
5428: <code class="prompt">$</code> echo ../../*/gtk
5429: ../../x11/gtk
5430: <code class="prompt">$</code> echo ../../*/gtk2
5431: ../../x11/gtk2
5432: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5433: ../../x11/gtk2/buildlink3.mk
5434: </pre>
5435: <p>The first try was definitely too broad. The second one had exactly
5436: one result, which is very good. But there is one pitfall with GNOME
5437: packages. Before GNOME 2 had been released, there were already many
5438: GNOME 1 packages in pkgsrc. To be able to continue to use these
5439: packages, the GNOME 2 packages were imported as separate packages, and
5440: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5441: whether this was the case here, and indeed it was.</p>
5442: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5443: file, adding the dependency is very easy. I just inserted an
5444: <code class="literal">.include</code> line before the last line of the package
5445: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5446: <pre class="programlisting">
5447: [...]
5448: .include "../../x11/gtk2/buildlink3.mk"
5449: .include "../../mk/bsd.pkg.mk
5450: </pre>
5451: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5452: was:</p>
1.75 rillig 5453: <pre class="programlisting">
1.299 rillig 5454: [...]
5455: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5456: checking for GTK - version >= 1.2.0... no
5457: *** Could not run GTK test program, checking why...
5458: *** The test program failed to compile or link. See the file config.log for the
5459: *** exact error that occured. This usually means GTK was incorrectly installed
5460: *** or that you have moved GTK since it was installed. In the latter case, you
5461: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5462: configure: error: Test for GTK failed.
5463: [...]
1.222 sevan 5464: </pre>
1.299 rillig 5465: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5466: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5467: told me that this package really wanted to have the GNOME 1 version of
5468: GTK. If the package had looked for GTK2, it would have looked for
5469: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5470: So I changed the <code class="literal">x11/gtk2</code> to
5471: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5472: and tried again.</p>
1.119 mishka 5473: <pre class="programlisting">
1.299 rillig 5474: [...]
5475: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5476: In file included from xpidl.c:42:
5477: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5478: In file included from xpidl.c:42:
5479: xpidl.h:132: error: parse error before "IDL_ns"
5480: [...]
1.222 sevan 5481: </pre>
1.299 rillig 5482: <p>The package still does not find all of its dependencies. Now the
5483: question is: Which package provides the
5484: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119 mishka 5485: <pre class="programlisting">
1.299 rillig 5486: <code class="prompt">$</code> echo ../../*/*idl*
5487: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5488: <code class="prompt">$</code> echo ../../*/*IDL*
5489: ../../net/libIDL
1.222 sevan 5490: </pre>
1.299 rillig 5491: <p>Let's take the one from the second try. So I included the
5492: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5493: again. But the error didn't change. After digging through some of the
5494: code, I concluded that the build process of the package was broken and
5495: couldn't have ever worked, but since the Mozilla source tree is quite
5496: large, I didn't want to fix it. So I added the following to the package
5497: <code class="filename">Makefile</code> and tried again:</p>
1.197 wiz 5498: <pre class="programlisting">
1.299 rillig 5499: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5500: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.222 sevan 5501: </pre>
1.299 rillig 5502: <p>The latter line is needed because the package expects the library
5503: <code class="filename">libIDL.so</code>, but only
5504: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5505: wrapper to rewrite that on the fly.</p>
5506: <p>The next problem was related to a recent change of the FreeType
5507: 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>
5508: which patch files were relevant for this issue and copied them to the
5509: <code class="filename">patches</code> directory. Then I retried, fixed the
5510: patches so that they applied cleanly and retried again. This time,
5511: everything worked.</p>
1.197 wiz 5512: </div>
1.299 rillig 5513: <div class="sect3">
5514: <div class="titlepage"><div><div><h4 class="title">
5515: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87 wiz 5516: <pre class="programlisting">
1.299 rillig 5517: <code class="prompt">$</code> bmake CHECK_FILES=no install
5518: [...]
5519: <code class="prompt">$</code> bmake print-PLIST >PLIST
5520: <code class="prompt">$</code> bmake deinstall
5521: <code class="prompt">$</code> bmake install
1.222 sevan 5522: </pre>
1.299 rillig 5523: </div>
5524: </div>
1.75 rillig 5525: </div>
5526: </div>
1.148 asau 5527: <div class="chapter">
1.75 rillig 5528: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 5529: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 5530: <div class="toc">
5531: <p><b>Table of Contents</b></p>
1.210 leot 5532: <dl class="toc">
1.299 rillig 5533: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5534: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5535: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5536: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5537: <dd><dl>
5538: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5539: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5540: <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>
5541: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.75 rillig 5542: </dl></dd>
5543: </dl>
5544: </div>
1.299 rillig 5545: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5546: each of which forms a well-defined part of the pkgsrc system. Using
1.311 leot 5547: 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 5548: like pkgsrc requires some discipline to keep the code correct and
5549: understandable.</p>
5550: <p>The basic ingredients for <code class="filename">Makefile</code>
5551: programming are variables and shell
5552: commands. Among these shell commands may even be more complex ones
1.311 leot 5553: 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 5554: as intended it is necessary to quote all variables correctly when they
5555: are used.</p>
5556: <p>This chapter describes some patterns that appear quite often in
5557: <code class="filename">Makefile</code>s, including the pitfalls that come along
5558: with them.</p>
1.148 asau 5559: <div class="sect1">
1.75 rillig 5560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5561: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5562: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5563: <p>When you are creating a file as a
5564: target of a rule, always write the data to a temporary file first
5565: and finally rename that file. Otherwise there might occur an error
5566: in the middle of generating the file, and when the user runs
1.311 leot 5567: <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 5568: regenerated properly. Example:</p>
1.75 rillig 5569: <pre class="programlisting">
1.299 rillig 5570: wrong:
5571: @echo "line 1" > ${.TARGET}
5572: @echo "line 2" >> ${.TARGET}
5573: @false
5574:
5575: correct:
5576: @echo "line 1" > ${.TARGET}.tmp
5577: @echo "line 2" >> ${.TARGET}.tmp
5578: @false
5579: @mv ${.TARGET}.tmp ${.TARGET}
1.100 rillig 5580: </pre>
1.299 rillig 5581: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5582: <code class="filename">wrong</code> will exist, although there was an error
5583: message in the first run. On the other hand, running <span class="command"><strong>make
5584: correct</strong></span> gives an error message twice, as expected.</p>
1.311 leot 5585: <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 5586: <code class="literal">${.TARGET}</code> in case of error, but this only
5587: happens when it is interrupted, for example by pressing
5588: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.311 leot 5589: 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 5590: </li></ul></div>
5591: </div>
5592: <div class="sect1">
5593: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5594: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5595: <p><code class="filename">Makefile</code> variables contain strings that
5596: can be processed using the five operators <code class="code">=</code>,
5597: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.311 leot 5598: <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 5599: page.</p>
5600: <p>When a variable's value is parsed from a
5601: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5602: the backslash character <code class="code">\</code> are handled specially. If a
5603: backslash is the last character in a line, that backslash is removed
5604: from the line and the line continues with the next line of the file.</p>
5605: <p>The <code class="code">#</code> character starts a comment that reaches
5606: until the end of the line. To get an actual <code class="code">#</code> character,
5607: such as in a URL, write <code class="code">\#</code> instead.</p>
5608: <p>The evaluation of variables either happens immediately or lazy.
5609: It happens immediately when the variable occurs on the right-hand
5610: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5611: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5612: In the other cases, it is evaluated lazily.</p>
5613: <p>Some of the modifiers split the string into words and then
5614: operate on the words, others operate on the string as a whole. When a
5615: string is split into words, double quotes and single quotes are
1.311 leot 5616: 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 5617: <div class="sect2">
5618: <div class="titlepage"><div><div><h3 class="title">
5619: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5620: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5621: <li class="listitem"><p>All variable names starting with an underscore
5622: are reserved for use by the pkgsrc infrastructure. They shall
5623: not be used by packages.</p></li>
5624: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5625: lowercase variable names for the iteration
5626: variables.</p></li>
5627: <li class="listitem"><p>All list variables should have a plural name,
5628: such as <code class="varname">PKG_OPTIONS</code> or
5629: <code class="varname">DISTFILES</code>.</p></li>
5630: </ul></div>
5631: </div>
5632: </div>
5633: <div class="sect1">
5634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5635: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5636: <div class="sect2">
5637: <div class="titlepage"><div><div><h3 class="title">
5638: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5639: <p>When adding a string that possibly contains whitespace or quotes to
5640: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5641: modifier.</p>
5642: <p>When adding another list to a list (example 2), it must not be
5643: quoted, since its elements are already quoted.</p>
1.75 rillig 5644: <pre class="programlisting">
1.299 rillig 5645: STRING= foo * bar `date`
5646: LIST= # empty
5647: ANOTHER_LIST= a=b c=d
5648:
5649: LIST+= ${STRING:Q} # 1
5650: LIST+= ${ANOTHER_LIST} # 2
1.100 rillig 5651: </pre>
1.299 rillig 5652: </div>
5653: <div class="sect2">
5654: <div class="titlepage"><div><div><h3 class="title">
5655: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5656: <p>Echoing a string containing special characters needs special
5657: work.</p>
1.75 rillig 5658: <pre class="programlisting">
1.299 rillig 5659: STRING= foo bar < > * `date` $$HOME ' "
5660: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5661:
5662: all:
5663: echo ${STRING} # 1
5664: echo ${STRING:Q} # 2
5665: printf '%s\n' ${STRING:Q}'' # 3
5666: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.100 rillig 5667: </pre>
1.299 rillig 5668: <p>Example 1 leads to a syntax error in the shell, as the characters
5669: are just copied.</p>
5670: <p>Example 2 quotes the string so that the shell interprets it
5671: correctly. But the echo command may additionally interpret strings with a
5672: leading dash or those containing backslashes.</p>
1.311 leot 5673: <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 5674: interprets the format string, but not the next argument. The trailing
5675: single quotes handle the case when the string is empty. In that case, the
5676: :Q modifier would result in an empty string too, which would then be
1.311 leot 5677: 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 5678: but other programs may care.</p>
5679: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5680: need to be quoted because the quoting has already been done
5681: when adding elements to the list.</p>
1.75 rillig 5682: </div>
1.148 asau 5683: <div class="sect2">
1.75 rillig 5684: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 5685: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5686: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5687: GNU-style configure script (especially those that call other configure
5688: scripts), it must not have leading or trailing whitespace, since
5689: otherwise the configure script gets confused. To trim leading and
5690: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5691: following example:</p>
1.75 rillig 5692: <pre class="programlisting">
1.299 rillig 5693: CPPFLAGS= # empty
5694: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5695: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 grant 5696:
1.299 rillig 5697: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 grant 5698:
1.299 rillig 5699: all:
5700: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5701: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5702: </pre>
5703: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5704: trailing whitespace because the <code class="code">+=</code> operator always adds a
5705: space.</p>
5706: </div>
5707: <div class="sect2">
5708: <div class="titlepage"><div><div><h3 class="title">
5709: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5710: <p>When a possibly empty variable is used in a shell program, it may
5711: lead to a syntax error.</p>
5712: <pre class="programlisting">
5713: EGFILES= # empty
1.87 wiz 5714:
1.299 rillig 5715: install-examples: # produces a syntax error in the shell
5716: for egfile in ${EGFILES}; do \
5717: echo "Installing $$egfile"; \
5718: done
5719: </pre>
5720: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.311 leot 5721: <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 5722: To fix this syntax error, use one of the snippets below.</p>
5723: <pre class="programlisting">
5724: EMPTY= # empty
1.87 wiz 5725:
1.299 rillig 5726: install-examples:
5727: for egfile in ${EGFILES} ""; do \
5728: [ -n "$$egfile" ] || continue; \
5729: echo "Installing $$egfile"; \
5730: done
5731: </pre>
5732: <p>In this case, an empty string is appended to the iteration list (to
5733: prevent the syntax error) and filtered out later.</p>
5734: <pre class="programlisting">
5735: EGFILES= # empty
1.87 wiz 5736:
1.299 rillig 5737: install-examples:
5738: .for egfile in ${EGFILES}
5739: echo "Installing ${egfile}"
5740: .endfor
1.100 rillig 5741: </pre>
1.299 rillig 5742: <p>If one of the filenames contains special characters, it should be
5743: enclosed in single or double quotes.</p>
5744: <p>To have a shell command test whether a make variable is empty, use
5745: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5746: </div>
5747: </div>
5748: </div>
5749: <div class="chapter">
5750: <div class="titlepage"><div><div><h2 class="title">
5751: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5752: <div class="toc">
5753: <p><b>Table of Contents</b></p>
5754: <dl class="toc">
5755: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5756: <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>
5757: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5758: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5759: </dl>
1.75 rillig 5760: </div>
1.299 rillig 5761: <p>Many packages have the ability to be built to support different
5762: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5763: in pkgsrc that provides generic handling of those options that
5764: determine different ways in which the packages can be built. It's
5765: possible for the user to specify exactly which sets of options will be
5766: built into a package or to allow a set of global default options
5767: apply.</p>
5768: <p>There are two broad classes of behaviors that one might want to
5769: control via options. One is whether some particular feature is
5770: enabled in a program that will be built anyway, often by including or
5771: not including a dependency on some other package. The other is
5772: whether or not an additional program will be built as part of the
5773: package. Generally, it is better to make a split package for such
5774: additional programs instead of using options, because it enables
5775: binary packages to be built which can then be added separately. For
5776: example, the foo package might have minimal dependencies (those
5777: packages without which foo doesn't make sense), and then the foo-gfoo
5778: package might include the GTK frontend program gfoo. This is better
5779: than including a gtk option to foo that adds gfoo, because either that
5780: option is default, in which case binary users can't get foo without
5781: gfoo, or not default, in which case they can't get gfoo. With split
5782: packages, they can install foo without having GTK, and later decide to
5783: install gfoo (pulling in GTK at that time). This is an advantage to
5784: source users too, avoiding the need for rebuilds.</p>
5785: <p>Plugins with widely varying dependencies should usually be split
5786: instead of options.</p>
5787: <p>It is often more work to maintain split packages, especially if
5788: the upstream package does not support this. The decision of split
5789: vs. option should be made based on the likelihood that users will want
5790: or object to the various pieces, the size of the dependencies that are
5791: included, and the amount of work.</p>
5792: <p>A further consideration is licensing. Non-free parts, or parts
5793: that depend on non-free dependencies (especially plugins) should
5794: almost always be split if feasible.</p>
5795: <div class="sect1">
5796: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5797: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5798: <p>Global default options are listed in
5799: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5800: that should be built into every package if that option is supported.
5801: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 5802: </div>
1.148 asau 5803: <div class="sect1">
1.75 rillig 5804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5805: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5806: </h2></div></div></div>
5807: <p>The following example shows how
5808: <code class="filename">bsd.options.mk</code> should be used
5809: by the hypothetical ``wibble'' package, either in the package
5810: <code class="filename">Makefile</code>, or in a file,
5811: e.g. <code class="filename">options.mk</code>, that is included by the
5812: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 5813: <pre class="programlisting">
1.299 rillig 5814: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5815: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5816: PKG_OPTIONS_OPTIONAL_GROUPS= database
5817: PKG_OPTIONS_GROUP.database= mysql pgsql
5818: PKG_SUGGESTED_OPTIONS= wibble-foo
5819: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5820: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5821:
5822: .include "../../mk/bsd.prefs.mk"
5823:
5824: # this package was previously named wibble2
5825: .if defined(PKG_OPTIONS.wibble2)
5826: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5827: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5828: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5829: .endif
5830:
5831: .include "../../mk/bsd.options.mk"
5832:
5833: # Package-specific option-handling
1.100 rillig 5834:
1.299 rillig 5835: ###
5836: ### FOO support
5837: ###
5838: .if !empty(PKG_OPTIONS:Mwibble-foo)
5839: CONFIGURE_ARGS+= --enable-foo
5840: .endif
1.100 rillig 5841:
1.299 rillig 5842: ###
5843: ### LDAP support
5844: ###
5845: .if !empty(PKG_OPTIONS:Mldap)
5846: . include "../../databases/openldap-client/buildlink3.mk"
5847: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5848: .endif
1.100 rillig 5849:
1.299 rillig 5850: ###
5851: ### database support
5852: ###
5853: .if !empty(PKG_OPTIONS:Mmysql)
5854: . include "../../mk/mysql.buildlink3.mk"
5855: .endif
5856: .if !empty(PKG_OPTIONS:Mpgsql)
5857: . include "../../mk/pgsql.buildlink3.mk"
5858: .endif
5859: </pre>
5860: <p>The first section contains the information about which build
5861: options are supported by the package, and any default options settings
5862: if needed.</p>
5863: <div class="orderedlist"><ol class="orderedlist" type="1">
5864: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.311 leot 5865: <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 5866: options. It should be set to
5867: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5868: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5869: at the point where the options are processed.</p></li>
5870: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
5871: build options supported by the package.</p></li>
5872: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
5873: list of names of groups of mutually exclusive options. The options in
5874: each group are listed in
5875: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5876: The most specific setting of any option from the group takes
5877: precedence over all other options in the group. Options from the
5878: groups will be automatically added to
5879: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
5880: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
5881: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5882: packages will fail if no option from the group is
5883: selected.</p></li>
5884: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
5885: of names of sets of options. At least one option from each set must
5886: be selected. The options in each set are listed in
5887: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5888: Options from the sets will be automatically added to
5889: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5890: fail if no option from the set is selected.</p></li>
5891: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
5892: build options which are enabled by default.</p></li>
5893: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
5894: of
5895: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
5896: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
5897: their option counterparts. Pairs should be added with
5898: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
5899: warning will be issued if the user uses a legacy
5900: variable.</p></li>
5901: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
5902: of
5903: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
5904: pairs that map options that have been renamed to their new
5905: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
5906: the listing of global legacy options. A warning will be issued if
5907: the user uses a legacy option.</p></li>
5908: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
5909: options implied by deprecated variables used. This can be used for
5910: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5911: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5912: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
5913: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
5914: a list of warnings about deprecated variables or options used, and
5915: what to use instead.</p></li>
5916: </ol></div>
5917: <p>A package should never modify
5918: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5919: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5920: To suggest a default set of options, use
5921: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5922: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5923: including <code class="filename">bsd.options.mk</code>. If none of
5924: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5925: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5926: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5927: happen with platform-specific options if none of them is supported on
5928: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5929: empty list and the package is otherwise treated as not using the
5930: options framework.</p>
5931: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5932: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5933: build options, properly filtered to remove unsupported and duplicate
5934: options.</p>
5935: <p>The remaining sections contain the logic that is specific to
5936: each option. The correct way to check for an option is to check
5937: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5938: <pre class="programlisting">
5939: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100 rillig 5940: </pre>
1.75 rillig 5941: </div>
1.299 rillig 5942: <div class="sect1">
5943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5944: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
5945: <p>Options that enable similar features in different packages (like
5946: optional support for a library) should use a common name in all
5947: packages that support it (like the name of the library). If another
5948: package already has an option with the same meaning, use the same
5949: name.</p>
5950: <p>Options that enable features specific to one package, where it's
5951: unlikely that another (unrelated) package has the same (or a similar)
5952: optional feature, should use a name prefixed with
5953: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5954: <p>If a group of related packages share an optional feature
5955: specific to that group, prefix it with the name of the
5956: <span class="quote">“<span class="quote">main</span>”</span> package
5957: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5958: <p>For new options, add a line to
5959: <code class="filename">mk/defaults/options.description</code>. Lines have two
5960: fields, separated by tab. The first field is the option name, the
5961: second its description. The description should be a whole sentence
5962: (starting with an uppercase letter and ending with a period) that
5963: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5964: support.</span>”</span> The file is sorted by option names.</p>
5965: </div>
5966: <div class="sect1">
5967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5968: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
5969: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
5970: different dependencies based on the options with which the package was
5971: built. For querying these options, the file
5972: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5973: typical example looks like this:</p>
1.87 wiz 5974: <pre class="programlisting">
1.299 rillig 5975: pkgbase := libpurple
5976: .include "../../mk/pkg-build-options.mk"
5977:
5978: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5979: ...
5980: .endif
1.229 sevan 5981: </pre>
1.299 rillig 5982: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5983: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5984: options of the libpurple package, which can then be queried like
5985: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5986: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5987: details.</p>
1.75 rillig 5988: </div>
5989: </div>
1.148 asau 5990: <div class="chapter">
1.75 rillig 5991: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 5992: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 5993: <div class="toc">
5994: <p><b>Table of Contents</b></p>
1.210 leot 5995: <dl class="toc">
1.299 rillig 5996: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
5997: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
5998: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75 rillig 5999: </dl>
6000: </div>
1.299 rillig 6001: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6002: by pkgsrc and also for individual packages to define what commands
6003: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6004: or for later run-time of an installed packaged (such as
6005: <code class="varname">DEPENDS</code>).
6006: If the native system provides an adequate tool, then in many cases, a pkgsrc
6007: package will not be used.</p>
6008: <p>When building a package, the replacement tools are
6009: made available in a directory (as symlinks or wrapper scripts)
6010: that is early in the executable search path. Just like the buildlink
6011: system, this helps with consistent builds.</p>
6012: <p>A tool may be needed to help build a specific package. For example,
6013: perl, GNU make (gmake) or yacc may be needed.</p>
6014: <p>Also a tool may be needed, for example, because the native system's supplied
6015: tool may be inefficient for building a package with pkgsrc.
6016: For example, a package may need GNU awk, bison (instead of
6017: yacc) or a better sed.</p>
6018: <p>The tools used by a package can be listed by running
6019: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 6020: <div class="sect1">
1.75 rillig 6021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6022: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6023: <p>The default set of tools used by pkgsrc is defined in
6024: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6025: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6026: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6027: These can be seen by running:
6028: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6029: <p>If a package needs a specific program to build
6030: then the <code class="varname">USE_TOOLS</code> variable can be used
6031: to define the tools needed.</p>
1.75 rillig 6032: </div>
1.299 rillig 6033: <div class="sect1">
6034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6035: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6036: <p>In the following examples, the :run means that it is needed at
6037: run-time (and becomes a DEPENDS).
6038: The default is a build dependency which can be set with
6039: :build. (So in this example, it is the same as gmake:build
6040: and pkg-config:build.)</p>
1.75 rillig 6041: <pre class="programlisting">
1.299 rillig 6042: USE_TOOLS+= gmake perl:run pkg-config
1.1 grant 6043: </pre>
1.299 rillig 6044: <p>When using the tools framework, a
6045: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6046: which contains the full path to the appropriate tool. For example,
6047: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6048: on Linux systems.</p>
6049: <p>If you always need a pkgsrc version of the
6050: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6051: </p>
1.75 rillig 6052: </div>
1.299 rillig 6053: <div class="sect1">
6054: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6055: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6056: <p>When improving or porting pkgsrc to a new platform, have a look
6057: at (or create) the corresponding platform specific make file fragment under
6058: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6059: the name of the common tools. For example:</p>
1.75 rillig 6060: <pre class="programlisting">
1.299 rillig 6061: .if exists(/usr/bin/bzcat)
6062: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6063: .elif exists(/usr/bin/bzip2)
6064: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6065: .endif
6066:
6067: TOOLS_PLATFORM.true?= true # shell builtin
1.1 grant 6068: </pre>
1.75 rillig 6069: </div>
6070: </div>
1.299 rillig 6071: <div class="chapter">
6072: <div class="titlepage"><div><div><h2 class="title">
6073: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6074: <div class="toc">
6075: <p><b>Table of Contents</b></p>
6076: <dl class="toc">
6077: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6078: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6079: <dd><dl>
6080: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6081: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6082: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6083: and
6084: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6085: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6086: </dl></dd>
6087: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
6088: <dd><dl>
6089: <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>
6090: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
6091: </dl></dd>
6092: </dl>
1.75 rillig 6093: </div>
1.299 rillig 6094: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6095: are seen by a package's configure and build processes. This is implemented
6096: in a two step process:</p>
6097: <div class="orderedlist"><ol class="orderedlist" type="1">
6098: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6099: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6100: of <code class="varname">WRKDIR</code>.</p></li>
6101: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6102: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6103: <code class="option">-L${LOCALBASE}/lib</code> into references to
6104: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6105: native compiler on some operating systems look like GCC, so that
6106: packages that expect GCC won't require modifications to build with
6107: those native compilers.</p></li>
6108: </ol></div>
6109: <p>This normalizes the environment in which a package is built so that the
6110: package may be built consistently despite what other software may be
6111: installed. Please note that the normal system header and library paths,
6112: e.g. <code class="filename">/usr/include</code>,
6113: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6114: designed to insulate the package build from non-system-supplied
6115: software.</p>
1.148 asau 6116: <div class="sect1">
1.75 rillig 6117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6118: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6119: <p>The process of converting packages to use the buildlink3
6120: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6121: The things to keep in mind are:</p>
1.128 wiz 6122: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299 rillig 6123: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6124: instead of the actual toolchain. Some packages are tricky,
6125: and the only way to know for sure is the check
6126: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6127: wrappers are being invoked.</p></li>
6128: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6129: the package Makefile, e.g. Java VMs, standalone shells,
6130: etc., because the code to symlink files into
6131: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6132: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6133: </p></li>
6134: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6135: <code class="filename">buildlink3.mk</code> files that you list in a
6136: package's Makefile are added as dependencies for that package.
6137: </p></li>
6138: </ol></div>
6139: <p>If a dependency on a particular package is required for its libraries and
6140: headers, then we replace:</p>
6141: <pre class="programlisting">
6142: DEPENDS+= foo>=1.1.0:../../category/foo
6143: </pre>
6144: <p>with</p>
6145: <pre class="programlisting">
6146: .include "../../category/foo/buildlink3.mk"
6147: </pre>
6148: <p>The buildlink3.mk files usually define the required dependencies.
6149: If you need a newer version of the dependency when using buildlink3.mk
6150: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 6151: <pre class="programlisting">
1.299 rillig 6152: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6153: .include "../../category/foo/buildlink3.mk"
1.1 grant 6154: </pre>
1.299 rillig 6155: <p>There are several <code class="filename">buildlink3.mk</code>
6156: files in <code class="filename">pkgsrc/mk</code>
6157: that handle special package issues:</p>
6158: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6159: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6160: the native or a pkgsrc Berkeley DB implementation based on
6161: the values of <code class="varname">BDB_ACCEPTED</code> and
6162: <code class="varname">BDB_DEFAULT</code>.</p></li>
6163: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6164: comes with neither Curses nor NCurses, this will take care
6165: 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>
6166: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6167: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6168: adding a dependency on Heimdal or MIT-krb5 for packages that
6169: require a Kerberos 5 implementation.</p></li>
6170: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6171: system-provided Motif installation or adds a dependency on
6172: <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
6173: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6174: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6175: to choose which Motif version will be used.</p></li>
6176: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6177: system-provided GNU readline or editline (libedit) installation,
6178: 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>,
6179: <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
6180: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6181: If your package really needs GNU readline library, its Makefile
6182: should include <code class="filename">devel/readline/buildlink3.mk</code>
6183: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6184: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6185: variables that may be used by packages that use the
6186: Open Sound System (OSS) API.</p></li>
6187: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6188: any of the Postgres versions in the variable
6189: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6190: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6191: the file for more information.</p></li>
6192: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6193: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
6194: 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>
6195: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6196: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6197: library.</p></li>
6198: </ul></div>
6199: <p>The comments in those <code class="filename">buildlink3.mk</code>
6200: files provide a more complete
6201: description of how to use them properly.</p>
1.75 rillig 6202: </div>
1.148 asau 6203: <div class="sect1">
1.75 rillig 6204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6205: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6206: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6207: included by Makefiles to indicate the need to compile and link
6208: against header files and libraries provided by the package. A
6209: <code class="filename">buildlink3.mk</code> file should always provide
6210: enough information to add the correct type of dependency
6211: relationship and include any other
6212: <code class="filename">buildlink3.mk</code> files that it needs to find
6213: headers and libraries that it needs in turn.</p>
6214: <p>To generate an initial <code class="filename">buildlink3.mk</code>
6215: 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>
6216: package is highly recommended. For most packages, the following
6217: command will generate a good starting point for
6218: <code class="filename">buildlink3.mk</code> files:</p>
6219: <pre class="screen">
6220: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6221: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6222: </pre>
1.148 asau 6223: <div class="sect2">
1.75 rillig 6224: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6225: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6226: <p>The following real-life example
6227: <code class="filename">buildlink3.mk</code> is taken
6228: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 6229: <pre class="programlisting">
1.299 rillig 6230: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
6231:
6232: BUILDLINK_TREE+= tiff
6233:
6234: .if !defined(TIFF_BUILDLINK3_MK)
6235: TIFF_BUILDLINK3_MK:=
6236:
6237: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6238: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6239: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6240:
6241: .include "../../devel/zlib/buildlink3.mk"
6242: .include "../../graphics/jpeg/buildlink3.mk"
6243: .endif # TIFF_BUILDLINK3_MK
6244:
6245: BUILDLINK_TREE+= -tiff
1.1 grant 6246: </pre>
1.299 rillig 6247: <p>The header and footer manipulate
6248: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6249: <code class="filename">buildlink3.mk</code> files and is used to track
6250: the dependency tree.</p>
6251: <p>The main section is protected from multiple inclusion
6252: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6253: added. Several important variables are set in the section:</p>
6254: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6255: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6256: is the dependency version recorded in the installed
1.299 rillig 6257: package; this should always be set using
6258: <span class="command"><strong>+=</strong></span> to ensure that
6259: we're appending to any pre-existing list of values. This
1.300 wiz 6260: variable should be set to the last version of the
1.299 rillig 6261: package that had an backwards-incompatible API change.
6262: </p></li>
6263: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6264: is the location of the <em class="replaceable"><code>pkg</code></em>
6265: pkgsrc directory.</p></li>
6266: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6267: (not shown above) controls whether we use
6268: <code class="varname">BUILD_DEPENDS</code> or
6269: <code class="varname">DEPENDS</code> to add the dependency on
6270: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6271: selected by setting
6272: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6273: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
6274: used.</p></li>
6275: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6276: and
6277: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6278: (not shown above) are lists of subdirectories of
6279: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6280: to add to the header and library search paths. These
6281: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6282: respectively.</p></li>
6283: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6284: (not shown above) is the list of preprocessor flags to add
6285: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6286: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6287: should be avoided and instead be handled using
6288: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6289: above.</p></li>
6290: </ul></div>
6291: <p>The following variables are all optionally defined within
6292: this second section (protected against multiple inclusion) and
6293: control which package files are symlinked into
6294: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6295: transformed during the symlinking:</p>
6296: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6297: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6298: (not shown above) is a shell glob pattern relative to
6299: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6300: to be symlinked into
6301: <code class="filename">${BUILDLINK_DIR}</code>,
6302: e.g. <code class="filename">include/*.h</code>.</p></li>
6303: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6304: (not shown above) is a shell pipeline that
6305: outputs to stdout a list of files relative to
6306: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6307: The resulting files are to be symlinked
6308: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6309: this takes the <code class="filename">+CONTENTS</code> of a
6310: <em class="replaceable"><code>pkg</code></em> and filters it through
6311: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6312: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6313: (not shown above) is a filter command that filters
6314: <code class="filename">+CONTENTS</code> input into a list of files
6315: relative to
6316: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6317: on stdout. By default,
6318: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6319: outputs the contents of the <code class="filename">include</code>
6320: and <code class="filename">lib</code> directories in the package
6321: <code class="filename">+CONTENTS</code>.</p></li>
6322: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6323: (not shown above) is a list of sed arguments used to
6324: transform the name of the source filename into a
6325: destination filename, e.g. <span class="command"><strong>-e
6326: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6327: </ul></div>
6328: <p>This section can additionally include any
6329: <code class="filename">buildlink3.mk</code> needed for
6330: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6331: Including these <code class="filename">buildlink3.mk</code> files
6332: means that the headers and libraries for these
6333: dependencies are also symlinked into
6334: <code class="filename">${BUILDLINK_DIR}</code>
6335: whenever the <em class="replaceable"><code>pkg</code></em>
6336: <code class="filename">buildlink3.mk</code>
6337: file is included. Dependencies are only added for directly
6338: include <code class="filename">buildlink3.mk</code> files.</p>
6339: <p>When providing a <code class="filename">buildlink3.mk</code> and
6340: including other <code class="filename">buildlink3.mk</code> files in it,
6341: please only add necessary ones, i.e., those whose libraries or
6342: header files are automatically exposed when the package is
6343: use.</p>
6344: <p>In particular, if only an executable
6345: (<code class="filename">bin/foo</code>) is linked against a library, that
6346: library does not need to be propagated in the
6347: <code class="filename">buildlink3.mk</code> file.</p>
6348: <p>The following steps should help you decide if a
6349: <code class="filename">buildlink3.mk</code> file needs to be included:
6350: </p>
6351: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6352: <li class="listitem"><p>Look at the installed header files: What
6353: headers do they include? The packages providing these files
6354: must be buildlinked.</p></li>
6355: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6356: libraries and look against what other libraries they link.
6357: Some of the packages providing these probably need to be
6358: buildlinked; however, it's not automatic, since e.g. GTK on
6359: some systems pulls in the X libraries, so they will show up in
6360: the <code class="filename">ldd</code> output, while on others (like OS
6361: X) it won't. <code class="filename">ldd</code> output can thus only be
6362: used as a hint.</p></li>
6363: </ul></div>
6364: <p>
6365: </p>
6366: </div>
1.148 asau 6367: <div class="sect2">
1.75 rillig 6368: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6369: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6370: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6371: and
6372: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6373: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300 wiz 6374: <p>Both variables set lower bounds for a version of this package.
6375: The two variables differ in that one describes source
1.299 rillig 6376: compatibility (API) and the other binary compatibility (ABI).
6377: The difference is that a change in the API breaks compilation of
6378: programs while changes in the ABI stop compiled programs from
6379: running.</p>
1.300 wiz 6380: <p>The
6381: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6382: variable in a <code class="filename">buildlink3.mk</code> should be
6383: changed very rarely. (One possible scenario: If all packages
6384: using this package need a higher version than defined in the
6385: <code class="filename">buildlink3.mk</code>,
1.299 rillig 6386: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6387: could be updated to that higher version.)</p>
6388: <p>On the other hand, changes to
1.299 rillig 6389: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6390: are more common. The variable will need to be updated every
6391: time the major version of one of its shared libraries is changed,
6392: or any other change where a binary built against the previous
6393: version of the package will not run against the new version any
6394: longer.</p>
6395: <p>In such a case, the package's
1.299 rillig 6396: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6397: must be increased to require the new package version. Then the
6398: <code class="varname">PKGREVISION</code> of all packages
6399: <em class="replaceable"><code>foo</code></em> that depend on this package need
6400: to be increased, and if they have
6401: <code class="filename">buildlink3.mk</code> files,
6402: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6403: in their <code class="filename">buildlink3.mk</code> files must be
6404: increased to the new version as well. This is required so that a
6405: package will pull in the versions of the packages that use the
6406: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6407: uniquely identify the packages built against the new ABI. The
6408: <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
6409: help with these updates.</p>
6410: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6411: about dependencies on other packages, including the
6412: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299 rillig 6413: <p>Please take careful consideration before adjusting
6414: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6415: or
6416: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6417: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6418: cause unneeded package deletions and rebuilds. In many cases,
6419: new versions of packages work just fine with older
6420: dependencies.</p>
1.299 rillig 6421: <p>Also it is not needed to set
6422: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6423: when it is identical to
6424: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 6425: </div>
6426: </div>
1.148 asau 6427: <div class="sect1">
1.75 rillig 6428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6429: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6430: <p>Some packages in pkgsrc install headers and libraries that
6431: coincide with headers and libraries present in the base system.
6432: Aside from a <code class="filename">buildlink3.mk</code> file, these
6433: packages should also include a <code class="filename">builtin.mk</code>
6434: file that includes the necessary checks to decide whether using
6435: the built-in software or the pkgsrc software is
6436: appropriate.</p>
6437: <p>The only requirements of a builtin.mk file for
6438: <em class="replaceable"><code>pkg</code></em> are:</p>
6439: <div class="orderedlist"><ol class="orderedlist" type="1">
6440: <li class="listitem"><p>It should set
6441: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6442: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6443: after it is included.</p></li>
6444: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6445: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6446: which is already set before the
6447: <code class="filename">builtin.mk</code> file is included.</p></li>
6448: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6449: is <span class="emphasis"><em>very</em></span> important and takes careful
6450: attention to <code class="filename">Makefile</code> coding.</p></li>
6451: </ol></div>
6452: <div class="sect2">
6453: <div class="titlepage"><div><div><h3 class="title">
6454: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6455: <p>The following is the recommended template for builtin.mk
6456: files:</p>
1.75 rillig 6457: <pre class="programlisting">
1.299 rillig 6458: .if !defined(IS_BUILTIN.foo)
6459: #
6460: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6461: # genuinely exists in the system or not.
6462: #
6463: IS_BUILTIN.foo?= no
1.100 rillig 6464:
1.299 rillig 6465: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6466: # version can be determined.
6467: #
6468: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6469: BUILTIN_PKG.foo?= foo-1.0
6470: . endif
6471: .endif # IS_BUILTIN.foo
1.100 rillig 6472:
1.299 rillig 6473: .if !defined(USE_BUILTIN.foo)
6474: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6475: . if defined(BUILTIN_PKG.foo)
6476: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6477: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6478: USE_BUILTIN.foo!= \
6479: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6480: && ${ECHO} "yes" || ${ECHO} "no"
6481: . endif
6482: . endfor
6483: . endif
6484: .endif # USE_BUILTIN.foo
1.100 rillig 6485:
1.299 rillig 6486: CHECK_BUILTIN.foo?= no
6487: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6488: #
6489: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6490: # "yes" or "no".
6491: #
6492: .endif # CHECK_BUILTIN.foo
1.75 rillig 6493: </pre>
1.299 rillig 6494: <p>The first section sets
6495: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6496: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6497: in the base system. This should not be a base system software
6498: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6499: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6500: included as part of the base system. This variable is only
6501: used internally within the <code class="filename">builtin.mk</code>
6502: file.</p>
6503: <p>The second section sets
6504: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6505: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6506: system if it exists (if
6507: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6508: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6509: within the <code class="filename">builtin.mk</code> file.</p>
6510: <p>The third section sets
6511: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6512: and is <span class="emphasis"><em>required</em></span> in all
6513: <code class="filename">builtin.mk</code> files. The code in this
6514: section must make the determination whether the built-in
6515: software is adequate to satisfy the dependencies listed in
6516: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6517: This is typically done by comparing
6518: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6519: against each of the dependencies in
6520: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6521: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6522: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6523: end of the <code class="filename">builtin.mk</code> file. Note that
6524: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6525: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6526: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6527: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6528: that the built-in version of the software is similar enough to
6529: be used as a replacement.</p>
6530: <p>The last section is guarded by
6531: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6532: and includes code that uses the value of
6533: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6534: set in the previous section. This typically includes, e.g.,
6535: adding additional dependency restrictions and listing additional
6536: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6537: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6538: </div>
6539: <div class="sect2">
6540: <div class="titlepage"><div><div><h3 class="title">
6541: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
6542: <p>When building packages, it's possible to choose whether to set
6543: a global preference for using either the built-in (native)
6544: version or the pkgsrc version of software to satisfy a
6545: dependency. This is controlled by setting
6546: <code class="varname">PREFER_PKGSRC</code> and
6547: <code class="varname">PREFER_NATIVE</code>. These variables take values
6548: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
6549: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
6550: use the pkgsrc versions of software, while
6551: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
6552: built-in versions. Preferences are determined by the most
6553: specific instance of the package in either
6554: <code class="varname">PREFER_PKGSRC</code> or
6555: <code class="varname">PREFER_NATIVE</code>. If a package is specified
6556: in neither or in both variables, then
6557: <code class="varname">PREFER_PKGSRC</code> has precedence over
6558: <code class="varname">PREFER_NATIVE</code>. For example, to require
6559: using pkgsrc versions of software for all but the most basic
6560: bits on a NetBSD system, you can set:</p>
1.75 rillig 6561: <pre class="programlisting">
1.299 rillig 6562: PREFER_PKGSRC= yes
6563: PREFER_NATIVE= getopt skey tcp_wrappers
6564: </pre>
6565: <p>A package <span class="emphasis"><em>must</em></span> have a
6566: <code class="filename">builtin.mk</code>
6567: file to be listed in <code class="varname">PREFER_NATIVE</code>,
6568: otherwise it is simply ignored in that list.</p>
1.305 bacon 6569: <p><code class="varname">PREFER_PKGSRC</code> and
6570: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
6571: to ensure that the bootstrap process does not use inapropriate
6572: native tools as dependencies for core packages.
6573:
6574: </p>
6575: <pre class="screen">
6576: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
6577: </pre>
6578: <p>
6579:
1.299 rillig 6580: Switching between settings globally at a later date can introduce
6581: complications with dependency resolution. This is caused by packages
1.305 bacon 6582: built with the opposite preference being installed alongside each
6583: other. Hence, any changes to these variables after bootstrap will
6584: necessitate rebuilding all packages depending on one whose preference
6585: has been changed. This is not trivial and should be avoided.</p>
6586: <p>When using pkgsrc on Linux systems, there is high risk of
6587: "leakage", where programs installed by pkgsrc may inadvertently use a
6588: command or library not installed by pkgsrc, e.g. those installed by
6589: yum or apt. Such foreign dependencies may be installed, removed, or
6590: upgraded to a version incompatible with the pkgsrc package at any
6591: time, causing pkgsrc packages to subsequently malfunction. Pkgsrc
6592: cannot prevent this, as it has no control over other package managers.
6593: Another potential problem is that under Redhat Enterprise and related
6594: Linux systems, yum packages are only patched and never upgraded, so
6595: eventually they may become too outdated for use by pkgsrc. Even
6596: intentionally using foreign dependencies, not considered leakage, can
6597: lead to these problems, so it is generally discouraged. In order to
6598: minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
6599: This ensures that pkgsrc is aware of any changes to dependency packages
6600: and can rebuild or upgrade the entire dependency tree as needed. This
6601: default can be overridden by setting --prefer-pkgsrc to "no" or a list of
6602: packages, or by setting --prefer-native to "yes".</p>
1.75 rillig 6603: </div>
1.107 rillig 6604: </div>
1.75 rillig 6605: </div>
1.148 asau 6606: <div class="chapter">
1.75 rillig 6607: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 6608: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75 rillig 6609: <div class="toc">
6610: <p><b>Table of Contents</b></p>
1.210 leot 6611: <dl class="toc">
1.299 rillig 6612: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6613: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6614: <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>
6615: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6616: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6617: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6618: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6619: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6620: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75 rillig 6621: </dl>
6622: </div>
1.299 rillig 6623: <p>The <code class="filename">PLIST</code> file contains a package's
6624: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6625: the package (relative to the <code class="filename">${PREFIX}</code>
6626: directory it's been installed in) plus some additional statements
1.311 leot 6627: - 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 6628: This chapter addresses some issues that need attention when
6629: dealing with the <code class="filename">PLIST</code> file (or files, see
6630: below!).</p>
1.148 asau 6631: <div class="sect1">
1.75 rillig 6632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6633: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6634: <p>Be sure to add a RCS ID line as the first thing in any
6635: <code class="filename">PLIST</code> file you write:</p>
6636: <pre class="programlisting">
6637: @comment $NetBSD $
6638: </pre>
6639: <p>An artificial space has been added between NetBSD and $, this is a
6640: workaround here to prevent CVS expanding to the filename of the guide. When
6641: adding the RCS ID the space should be omitted.</p>
1.75 rillig 6642: </div>
1.148 asau 6643: <div class="sect1">
1.75 rillig 6644: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6645: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6646: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6647: to output a PLIST that matches any new files since the package
6648: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6649: more information on this target.</p>
1.75 rillig 6650: </div>
1.148 asau 6651: <div class="sect1">
1.75 rillig 6652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6653: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6654: </h2></div></div></div>
6655: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6656: of AWK patterns and actions that are used to filter the output of
6657: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6658: scripting you like to it, but be careful with quoting.</p>
6659: <p>For example, to get all files inside the
6660: <code class="filename">libdata/foo</code> directory removed from the
6661: resulting PLIST:</p>
1.88 wiz 6662: <pre class="programlisting">
1.299 rillig 6663: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.100 rillig 6664: </pre>
1.300 wiz 6665: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6666: evaluated after the file list and directory list are sorted.
6667: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6668: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6669: list and directory list are sorted.</p>
1.299 rillig 6670: </div>
6671: <div class="sect1">
6672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6673: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6674: <p>A number of variables are substituted automatically in
6675: PLISTs when a package is installed on a system. This includes the
6676: following variables:</p>
6677: <div class="variablelist"><dl class="variablelist">
6678: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6679: <dd>
6680: <p>Some packages like emacs and perl embed information
6681: about which architecture they were built on into the
6682: pathnames where they install their files. To handle this
6683: case, PLIST will be preprocessed before actually used, and
6684: the symbol
6685: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6686: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6687: same is done if the string
6688: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6689: PLIST somewhere - use this on packages that have GNU
6690: autoconf-created configure scripts.</p>
6691: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6692: <h3 class="title">Legacy note</h3>
6693: <p>There used to be a symbol
6694: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6695: was replaced by the output of <span class="command"><strong>uname
6696: -m</strong></span>, but that's no longer supported and has
6697: been removed.</p>
6698: </div>
6699: </dd>
6700: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6701: <dd>
6702: <p>Some packages want to embed the OS name and version
6703: into some paths. To do this, use these variables in the
6704: <code class="filename">PLIST</code>:
6705: </p>
6706: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6707: <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>
6708: <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>
6709: <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>
6710: </ul></div>
6711: </dd>
6712: </dl></div>
6713: <p>For a list of values which are replaced by
6714: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6715: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6716: <code class="varname">PLIST_SUBST</code> should help.</p>
6717: <p>If you want to change other variables not listed above, you
6718: can add variables and their expansions to this variable in the
6719: 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 6720: <pre class="programlisting">
1.299 rillig 6721: PLIST_SUBST+= SOMEVAR="somevalue"
1.100 rillig 6722: </pre>
1.299 rillig 6723: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6724: in the <code class="filename">PLIST</code> with
6725: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6726: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6727: the common case of conditionally including some
6728: <code class="filename">PLIST</code> entries. It can be done by adding
6729: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6730: setting the corresponding <code class="varname">PLIST.foo</code> variable
6731: to <code class="literal">yes</code> if the entry should be included.
6732: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6733: in the <code class="filename">PLIST</code> with either
6734: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6735: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6736: For example, in <code class="filename">Makefile</code>:</p>
1.174 asau 6737: <pre class="programlisting">
1.299 rillig 6738: PLIST_VARS+= foo
6739: .if <em class="replaceable"><code>condition</code></em>
6740: PLIST.foo= yes
6741: .else
1.174 asau 6742: </pre>
1.299 rillig 6743: <p>And then in <code class="filename">PLIST</code>:</p>
1.81 rillig 6744: <pre class="programlisting">
1.299 rillig 6745: @comment $NetBSD $
6746: bin/bar
6747: man/man1/bar.1
6748: ${PLIST.foo}bin/foo
6749: ${PLIST.foo}man/man1/foo.1
6750: ${PLIST.foo}share/bar/foo.data
1.100 rillig 6751: </pre>
1.299 rillig 6752: <p>An artificial space has been added between NetBSD and $, this is a
6753: workaround here to prevent CVS expanding to the filename of the guide. When
1.309 gutterid 6754: adding the RCS ID the space should be omitted.</p>
1.81 rillig 6755: </div>
1.299 rillig 6756: <div class="sect1">
6757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6758: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6759: <p>Man pages should be installed in compressed form if
6760: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6761: and uncompressed otherwise. To handle this in the
6762: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6763: appended/removed automatically for man pages according to
6764: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6765: or not, see above for details. This modification of the
6766: <code class="filename">PLIST</code> file is done on a copy of it, not
6767: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 6768: </div>
1.148 asau 6769: <div class="sect1">
1.75 rillig 6770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6771: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6772: </h2></div></div></div>
6773: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6774: in generating the binary package, set the variable
6775: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.311 leot 6776: 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 6777: important. The default for <code class="varname">PLIST_SRC</code> is
6778: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 6779: </div>
1.148 asau 6780: <div class="sect1">
1.75 rillig 6781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6782: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6783: <p>Some packages decide to install a different set of files based on
6784: the operating system being used. These differences can be
6785: automatically handled by using the following files:</p>
6786: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6787: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6788: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6789: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6790: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6791: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6792: </ul></div>
1.75 rillig 6793: </div>
1.148 asau 6794: <div class="sect1">
1.75 rillig 6795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6796: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6797: <p>Some packages decide to generate hard-to-guess file names
6798: during installation that are hard to wire down.</p>
6799: <p>In such cases, you can set the
6800: <code class="varname">GENERATE_PLIST</code> variable to shell code
6801: terminated (with a semicolon) that will output PLIST entries which
6802: will be appended to the PLIST</p>
6803: <p>You can find one example in editors/xemacs:</p>
6804: <pre class="programlisting">
6805: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6806: </pre>
6807: <p>which will append something like
6808: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6809: <code class="filename">PLIST</code>.
6810: </p>
1.75 rillig 6811: </div>
1.148 asau 6812: <div class="sect1">
1.75 rillig 6813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6814: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6815: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6816: multiple (and unrelated) packages install files. These
6817: directories were problematic because you had to add special
6818: tricks in the PLIST to conditionally remove them, or have some
6819: centralized package handle them.</p>
6820: <p>In pkgsrc, it is now easy: Each package should create
6821: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6822: will remove any directories left empty after uninstalling a
6823: package.</p>
6824: <p>If a package needs an empty directory to work, create
6825: the directory during installation as usual, and also add an
6826: entry to the PLIST:
6827:
6828: </p>
6829: <pre class="programlisting">
6830: @pkgdir path/to/empty/directory
6831: </pre>
6832: <p>
6833:
6834: or take a look at <code class="varname">MAKE_DIRS</code> and
6835: <code class="varname">OWN_DIRS</code>.
1.88 wiz 6836: </p>
1.75 rillig 6837: </div>
1.299 rillig 6838: </div>
6839: <div class="chapter">
6840: <div class="titlepage"><div><div><h2 class="title">
6841: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6842: <div class="toc">
6843: <p><b>Table of Contents</b></p>
6844: <dl class="toc">
6845: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6846: <dd><dl>
6847: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6848: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6849: </dl></dd>
6850: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6851: <dd><dl>
6852: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6853: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
6854: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
6855: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
6856: </dl></dd>
6857: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6858: <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>
6859: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6860: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6861: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6862: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6863: <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>
6864: </dl>
6865: </div>
6866: <p>This chapter describes the framework known as
6867: <code class="literal">pkginstall</code>, whose key features are:</p>
6868: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6869: <li class="listitem"><p>Generic installation and manipulation of directories and files
6870: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6871: <li class="listitem"><p>Automatic handling of configuration files during installation,
6872: provided that packages are correctly designed.</p></li>
6873: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6874: <li class="listitem"><p>Registration of system users and groups.</p></li>
6875: <li class="listitem"><p>Registration of system shells.</p></li>
6876: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6877: </ul></div>
6878: <p>The following sections inspect each of the above points in detail.</p>
6879: <p>You may be thinking that many of the things described here could be
6880: easily done with simple code in the package's post-installation target
6881: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6882: as the code in them is only executed when building from source. Machines
6883: using binary packages could not benefit from it at all (as the code itself
6884: could be unavailable). Therefore, the only way to achieve any of the items
6885: described above is by means of the installation scripts, which are
6886: automatically generated by pkginstall.</p>
1.148 asau 6887: <div class="sect1">
1.75 rillig 6888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6889: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6890: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6891: of files and directories that belong to a package. The names used in it
6892: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6893: which means that it cannot register files outside this directory (absolute
6894: path names are not allowed). Despite this restriction, some packages need
6895: to install files outside this location; e.g., under
6896: <code class="filename">${VARBASE}</code> or
6897: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6898: is to create such files during installation time by using
6899: installation scripts.</p>
6900: <p>The generic installation scripts are shell scripts that can
6901: contain arbitrary code. The list of scripts to execute is taken from
6902: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6903: <code class="filename">INSTALL</code>. A similar variable exists for package
6904: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6905: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6906: commands, so they have the potential to create and manage files
6907: anywhere in the file system.</p>
6908: <p>Using these general installation files is not recommended, but
6909: may be needed in some special cases. One reason for avoiding them is
6910: that the user has to trust the packager that there is no unwanted or
6911: simply erroneous code included in the installation script. Also,
6912: previously there were many similar scripts for the same functionality,
6913: and fixing a common error involved finding and changing all of
6914: them.</p>
6915: <p>The pkginstall framework offers another, standardized way. It
6916: provides generic scripts to abstract the manipulation of such files
6917: and directories based on variables set in the package's
6918: <code class="filename">Makefile</code>. The rest of this section describes
6919: these variables.</p>
6920: <div class="sect2">
6921: <div class="titlepage"><div><div><h3 class="title">
6922: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
6923: <p>The following variables can be set to request the creation of
6924: directories anywhere in the file system:</p>
6925: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6926: <li class="listitem">
6927: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
6928: contain a list of directories that should be created and should attempt
6929: to be destroyed by the installation scripts. The difference between
6930: the two is that the latter prompts the administrator to remove any
6931: directories that may be left after deinstallation (because they were
6932: not empty), while the former does not. Example:</p>
6933: <pre class="programlisting">
6934: MAKE_DIRS+= ${VARBASE}/foo/private
6935: </pre>
6936: </li>
6937: <li class="listitem">
6938: <p><code class="varname">MAKE_DIRS_PERMS</code> and
6939: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
6940: which directories should be created and should attempt to be destroyed
6941: by the installation scripts. Each tuple holds the following values,
6942: separated by spaces: the directory name, its owner, its group and its
6943: numerical mode. For example:</p>
6944: <pre class="programlisting">
6945: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
6946: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
6947: </pre>
6948: <p>The difference between the two is exactly the same as their
6949: non-<code class="varname">PERMS</code> counterparts.</p>
6950: </li>
6951: </ul></div>
1.75 rillig 6952: </div>
1.299 rillig 6953: <div class="sect2">
6954: <div class="titlepage"><div><div><h3 class="title">
6955: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
6956: <p>Creating non-empty files outside the installation prefix is tricky
6957: because the <code class="filename">PLIST</code> forces all files to be inside it.
6958: To overcome this problem, the only solution is to extract the file in the
6959: known place (i.e., inside the installation prefix) and copy it to the
6960: appropriate location during installation (done by the installation scripts
6961: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
6962: file</em></span> in the following paragraphs, which describe the variables
6963: that can be used to automatically and consistently handle files outside the
6964: installation prefix:</p>
6965: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6966: <li class="listitem">
6967: <p><code class="varname">CONF_FILES</code> and
6968: <code class="varname">REQD_FILES</code> are pairs of master and target files.
6969: During installation time, the master file is copied to the target one
6970: if and only if the latter does not exist. Upon deinstallation, the
6971: target file is removed provided that it was not modified by the
6972: installation.</p>
6973: <p>The difference between the two is that the latter prompts the
6974: administrator to remove any files that may be left after
6975: deinstallation (because they were not empty), while the former does
6976: not.</p>
6977: </li>
6978: <li class="listitem">
6979: <p><code class="varname">CONF_FILES_PERMS</code> and
6980: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
6981: files as well as their target locations. For each of them, it also
6982: specifies their owner, their group and their numeric permissions, in
6983: this order. For example:</p>
1.88 wiz 6984: <pre class="programlisting">
1.299 rillig 6985: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
6986: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100 rillig 6987: </pre>
1.299 rillig 6988: <p>The difference between the two is exactly the same as their
6989: non-<code class="varname">PERMS</code> counterparts.</p>
6990: </li>
6991: </ul></div>
6992: </div>
1.75 rillig 6993: </div>
1.148 asau 6994: <div class="sect1">
1.75 rillig 6995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6996: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
6997: <p>Configuration files are special in the sense that they are installed
6998: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
6999: need special treatment during installation (most of which is automated by
7000: pkginstall). The main concept you must bear in mind is that files marked
7001: as configuration files are automatically copied to the right place (somewhere
7002: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
7003: and only if</em></span> they didn't exist before. Similarly, they will not
7004: be removed if they have local modifications. This ensures that
7005: administrators never lose any custom changes they may have made.</p>
7006: <div class="sect2">
7007: <div class="titlepage"><div><div><h3 class="title">
7008: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7009: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7010: specifies where configuration files shall be installed. Its contents are
7011: set based upon the following variables:</p>
7012: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7013: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7014: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
7015: be overridden by the user to point to his preferred location (e.g.,
7016: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7017: Packages must not use it directly.</p></li>
7018: <li class="listitem">
7019: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7020: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7021: for the package being built shall be installed. The definition of this
7022: variable only makes sense in the package's
7023: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7024: <p>As an example, consider the Apache package,
7025: <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
7026: configuration files under the
7027: <code class="filename">httpd/</code> subdirectory of
7028: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7029: Makefile.</p>
7030: </li>
7031: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7032: variable that holds this package's configuration directory (if
7033: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7034: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7035: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7036: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7037: directory where the configuration files for the package identified by
7038: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7039: </ul></div>
7040: <p>Based on the above variables, pkginstall determines the value of
7041: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
7042: variable that can be used within a package to refer to its configuration
7043: directory. The algorithm used to set its value is basically the
7044: following:</p>
7045: <div class="orderedlist"><ol class="orderedlist" type="1">
7046: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7047: its value is used.</p></li>
7048: <li class="listitem"><p>If the previous variable is not defined but
7049: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7050: <code class="filename">Makefile</code>, the resulting value is
7051: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7052: <li class="listitem"><p>Otherwise, it is set to
7053: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7054: </ol></div>
7055: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
7056: 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
7057: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
7058: be created with OWN_DIRS or MAKE_DIRS.</p>
7059: </div>
7060: <div class="sect2">
7061: <div class="titlepage"><div><div><h3 class="title">
7062: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7063: <p>Given that pkgsrc (and users!) expect configuration files to be in a
7064: known place, you need to teach each package where it shall install its
7065: files. In some cases you will have to patch the package Makefiles to
7066: achieve it. If you are lucky, though, it may be as easy as passing an
7067: extra flag to the configuration script; this is the case of GNU Autoconf-
7068: generated files:</p>
1.75 rillig 7069: <pre class="programlisting">
1.299 rillig 7070: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100 rillig 7071: </pre>
1.299 rillig 7072: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
7073: for</em></span> its configuration files, not where they will be originally
7074: installed (although the difference is never explicit,
7075: unfortunately).</p>
1.75 rillig 7076: </div>
1.299 rillig 7077: <div class="sect2">
7078: <div class="titlepage"><div><div><h3 class="title">
7079: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
7080: <p>As said before, pkginstall automatically handles configuration files.
7081: This means that <span class="strong"><strong>the packages themselves must not
7082: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7083: directly</strong></span>. Bad news is that many software installation scripts
7084: will, out of the box, mess with the contents of that directory. So what is
7085: the correct procedure to fix this issue?</p>
7086: <p>You must teach the package (usually by manually patching it) to
7087: install any configuration files under the examples hierarchy,
7088: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7089: <code class="filename">PLIST</code> registers them and the administrator always
7090: has the original copies available.</p>
7091: <p>Once the required configuration files are in place (i.e., under the
7092: examples hierarchy), the pkginstall framework can use them as master copies
7093: during the package installation to update what is in
7094: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7095: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
7096: 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
7097: about their syntax and their purpose. Here is an example, taken from the
7098: <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 7099: <pre class="programlisting">
1.299 rillig 7100: EGDIR= ${PREFIX}/share/doc/mutt/samples
7101: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.100 rillig 7102: </pre>
1.299 rillig 7103: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
7104: package and has no meaning outside it.</p>
1.75 rillig 7105: </div>
1.299 rillig 7106: <div class="sect2">
7107: <div class="titlepage"><div><div><h3 class="title">
7108: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
7109: <p>The automatic copying of config files can be toggled by setting the
7110: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7111: installation.</p>
1.88 wiz 7112: </div>
1.75 rillig 7113: </div>
1.148 asau 7114: <div class="sect1">
1.75 rillig 7115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7116: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7117: <p>System startup scripts are special files because they must be
7118: installed in a place known by the underlying OS, usually outside the
7119: 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
7120: can be used. However, pkginstall provides a special mechanism to handle
7121: these files.</p>
7122: <p>In order to provide system startup scripts, the package has
7123: to:</p>
7124: <div class="orderedlist"><ol class="orderedlist" type="1">
7125: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7126: the <code class="literal">.sh</code> suffix appended. Considering the
7127: <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
7128: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
7129: <li class="listitem">
7130: <p>Tell pkginstall to handle it, appending the name of the script,
7131: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7132: Continuing the previous example:</p>
7133: <pre class="programlisting">
7134: RCD_SCRIPTS+= cupsd
7135: </pre>
7136: </li>
7137: </ol></div>
7138: <p>Once this is done, pkginstall will do the following steps for each
7139: script in an automated fashion:</p>
7140: <div class="orderedlist"><ol class="orderedlist" type="1">
7141: <li class="listitem"><p>Process the file found in the files directory applying all the
7142: substitutions described in the <code class="filename">FILES_SUBST</code>
7143: variable.</p></li>
7144: <li class="listitem"><p>Copy the script from the files directory to the examples
7145: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
7146: that this master file must be explicitly registered in the
7147: <code class="filename">PLIST</code>.</p></li>
7148: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7149: from the examples hierarchy into the system-wide startup scripts
7150: directory.</p></li>
7151: </ol></div>
7152: <div class="sect2">
7153: <div class="titlepage"><div><div><h3 class="title">
7154: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7155: <p>The automatic copying of config files can be toggled by setting the
7156: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7157: installation. Note that the scripts will be always copied inside the
7158: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7159: matter what the value of this variable is.</p>
1.75 rillig 7160: </div>
7161: </div>
1.299 rillig 7162: <div class="sect1">
7163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7164: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7165: <p>If a package needs to create special users and/or groups during
7166: installation, it can do so by using the pkginstall framework.</p>
7167: <p>Users can be created by adding entries to the
7168: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7169: syntax:</p>
7170: <pre class="programlisting">
7171: user:group
7172: </pre>
7173: <p>Further specification of user details may be done by setting
7174: per-user variables.
7175: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7176: numeric UID for the user.
7177: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7178: user's description or comment.
7179: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7180: user's home directory, and defaults to
7181: <code class="filename">/nonexistent</code> if not specified.
7182: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7183: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7184: not specified.</p>
7185: <p>Similarly, groups can be created by adding entries to the
7186: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7187: <pre class="programlisting">
7188: group
7189: </pre>
7190: <p>The numeric GID of the group may be set by defining
7191: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7192: <p>If a package needs to create the users and groups at an earlier
7193: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7194: <code class="literal">configure</code>,<code class="literal">build</code>, or
7195: <code class="literal">pre-install</code> to indicate the phase before which the
7196: users and groups are created. In this case, the numeric UIDs and GIDs
7197: of the created users and groups are automatically hardcoded into the
7198: final installation scripts.</p>
1.75 rillig 7199: </div>
1.148 asau 7200: <div class="sect1">
1.75 rillig 7201: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7202: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7203: <p>Packages that install system shells should register them in the shell
7204: database, <code class="filename">/etc/shells</code>, to make things easier to the
7205: administrator. This must be done from the installation scripts to keep
7206: binary packages working on any system. pkginstall provides an easy way to
7207: accomplish this task.</p>
7208: <p>When a package provides a shell interpreter, it has to set the
7209: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7210: add some hooks to the installation scripts to handle it. Consider the
7211: 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>
7212: <pre class="programlisting">
7213: PKG_SHELL= ${PREFIX}/bin/zsh
7214: </pre>
7215: <div class="sect2">
7216: <div class="titlepage"><div><div><h3 class="title">
7217: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7218: <p>The automatic registration of shell interpreters can be disabled by
7219: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7220: environment variable to <code class="literal">NO</code>.</p>
7221: </div>
1.75 rillig 7222: </div>
1.148 asau 7223: <div class="sect1">
1.75 rillig 7224: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7225: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7226: <p>Packages that install X11 fonts should update the database files
7227: that index the fonts within each fonts directory. This can easily be
7228: accomplished within the pkginstall framework.</p>
7229: <p>When a package installs X11 fonts, it must list the directories in
7230: which fonts are installed in the
7231: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7232: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7233: <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
7234: installation scripts to run the appropriate commands to update the fonts
7235: database files within each of those directories. For convenience, if the
7236: directory path is relative, it is taken to be relative to the package's
7237: 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 7238: <pre class="programlisting">
1.299 rillig 7239: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75 rillig 7240: </pre>
1.299 rillig 7241: <div class="sect2">
7242: <div class="titlepage"><div><div><h3 class="title">
7243: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7244: <p>The automatic update of fonts databases can be disabled by
7245: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7246: environment variable to <code class="literal">NO</code>.</p>
1.75 rillig 7247: </div>
7248: </div>
7249: </div>
1.148 asau 7250: <div class="chapter">
1.75 rillig 7251: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 7252: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75 rillig 7253: <div class="toc">
7254: <p><b>Table of Contents</b></p>
1.210 leot 7255: <dl class="toc">
1.267 rillig 7256: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75 rillig 7257: <dd><dl>
1.267 rillig 7258: <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>
7259: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7260: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7261: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7262: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7263: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7264: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7265: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7266: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7267: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7268: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7269: </dl></dd>
7270: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7271: <dd><dl>
7272: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7273: <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>
7274: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7275: </dl></dd>
7276: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7277: <dd><dl>
7278: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7279: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7280: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
7281: </dl></dd>
7282: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7283: <dd><dl>
7284: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7285: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 7286: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
7287: <dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
7288: <dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
7289: <dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
1.267 rillig 7290: </dl></dd>
7291: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7292: <dd><dl>
7293: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7294: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 7295: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7296: <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>
7297: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 7298: </dl></dd>
7299: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7300: <dd><dl>
7301: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7302: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7303: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7304: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7305: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 7306: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 7307: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
7308: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 7309: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
7310: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
7311: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
7312: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
7313: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
7314: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
7315: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 7316: emulation</a></span></dt>
1.318 nia 7317: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
7318: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.75 rillig 7319: </dl></dd>
1.267 rillig 7320: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7321: </dl>
7322: </div>
1.148 asau 7323: <div class="sect1">
1.75 rillig 7324: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 7325: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78 rillig 7326: <p>One appealing feature of pkgsrc is that it runs on many
1.218 rillig 7327: different platforms. As a result, it is important to ensure,
7328: where possible, that packages in pkgsrc are portable. This
7329: chapter mentions some particular details you should pay
7330: attention to while working on pkgsrc.</p>
1.148 asau 7331: <div class="sect2">
1.78 rillig 7332: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7333: <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 7334: </h3></div></div></div>
1.78 rillig 7335: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7336: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7337: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7338: want to use those variables in the preprocessor directives of
1.311 leot 7339: <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 7340: <code class="literal">.for</code>), you need to include the file
7341: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7342: loads the user preferences.</p>
1.78 rillig 7343: <p>But note that some variables may not be completely defined
1.219 rillig 7344: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7345: included, as they may contain references to variables that are
7346: not yet defined. In shell commands (the lines in
7347: <code class="filename">Makefile</code> that are indented with a tab) this
7348: is no problem, since variables are only expanded when they are
7349: used. But in the preprocessor directives mentioned above and in
7350: dependency lines (of the form <code class="literal">target:
7351: dependencies</code>) the variables are expanded at load
7352: time.</p>
1.148 asau 7353: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7354: <h3 class="title">Note</h3>
1.218 rillig 7355: <p>To check whether a variable can be used at load time,
7356: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78 rillig 7357: </div>
7358: </div>
1.148 asau 7359: <div class="sect2">
1.78 rillig 7360: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7361: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88 wiz 7362: <p>Occasionally, packages require interaction from the user,
7363: and this can be in a number of ways:</p>
1.148 asau 7364: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7365: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7366: interaction such as entering username/password or accepting a
7367: license on a web page.</p></li>
1.128 wiz 7368: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7369: passwords.</p></li>
1.128 wiz 7370: <li class="listitem"><p>help to configure the package before it is built</p></li>
7371: <li class="listitem"><p>help during the build process</p></li>
7372: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7373: </ul></div>
1.218 rillig 7374: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7375: variable to define which stages need interaction. This should be
7376: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7377: <pre class="programlisting">
1.100 rillig 7378: INTERACTIVE_STAGE= configure install
1.222 sevan 7379: </pre>
1.88 wiz 7380: <p>The user can then decide to skip this package by setting the
1.218 rillig 7381: <code class="varname">BATCH</code> variable. Packages that require interaction
7382: are also excluded from bulk builds.</p>
1.75 rillig 7383: </div>
1.148 asau 7384: <div class="sect2">
1.75 rillig 7385: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7386: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222 sevan 7387: <p>Authors of software can choose the licence under which software
7388: can be copied. The Free Software Foundation has declared some
7389: licenses "Free", and the Open Source Initiative has a definition of
7390: "Open Source".</p>
7391: <p>By default, pkgsrc allows packages with Free or Open Source
7392: licenses to be built. To allow packages with other licenses to be
7393: built as well, the pkgsrc user needs to add these licenses to the
7394: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7395: that this variable only affects which packages may be
7396: <span class="emphasis"><em>built</em></span>, while the license terms often also
7397: restrict the actual use of the package and its redistribution.</p>
1.98 wiz 7398: <p>One might want to only install packages with a BSD license,
1.218 rillig 7399: or the GPL, and not the other. The free licenses are added to the
1.222 sevan 7400: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.121 jnemeth 7401: user can override the default by setting the
7402: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222 sevan 7403: of "+=". The licenses accepted by default are defined in the
7404: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7405: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78 rillig 7406: <p>The license tag mechanism is intended to address
1.87 wiz 7407: copyright-related issues surrounding building, installing and
7408: using a package, and not to address redistribution issues (see
7409: <code class="varname">RESTRICTED</code> and
1.222 sevan 7410: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121 jnemeth 7411: Packages with redistribution restrictions should set these
7412: tags.</p>
1.98 wiz 7413: <p>Denoting that a package may be copied according to a
7414: particular license is done by placing the license in
1.87 wiz 7415: <code class="filename">pkgsrc/licenses</code> and setting the
7416: <code class="varname">LICENSE</code> variable to a string identifying the
1.250 leot 7417: 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 7418: <pre class="programlisting">
1.100 rillig 7419: LICENSE= xv-license
1.222 sevan 7420: </pre>
1.87 wiz 7421: <p>When trying to build, the user will get a notice that the
1.98 wiz 7422: package is covered by a license which has not been placed in the
7423: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7424: <pre class="programlisting">
1.100 rillig 7425: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7426: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7427: ===> To view the license, enter "/usr/bin/make show-license".
7428: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7429: ===> ACCEPTABLE_LICENSES+=xv-license
7430: *** Error code 1
1.222 sevan 7431: </pre>
1.110 hubertf 7432: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7433: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7434: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7435: convey to pkgsrc that it should not in the future fail because of
7436: that license:</p>
1.78 rillig 7437: <pre class="programlisting">
1.100 rillig 7438: ACCEPTABLE_LICENSES+=xv-license
1.222 sevan 7439: </pre>
7440: <p>The use of <code class="varname">LICENSE=shareware</code>,
7441: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7442: is deprecated because it does not crisply refer to a particular
7443: license text. Another problem with such usage is that it does not
7444: enable a user to tell pkgsrc to proceed for a single package
7445: without also telling pkgsrc to proceed for all packages with that
7446: tag.</p>
7447: <div class="sect3">
7448: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7449: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154 rodent 7450: <p>When adding a package with a new license, the following steps
7451: are required:</p>
7452: <div class="orderedlist"><ol class="orderedlist" type="1">
7453: <li class="listitem">
1.284 rillig 7454: <p>Check whether the license qualifies as Free or Open Source by
7455: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7456: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222 sevan 7457: Open Source Initiative</a>. If this is the case, the filename in
7458: <code class="filename">pkgsrc/licenses/</code> does not need the
7459: <code class="filename">-license</code> suffix, and the license name should be
7460: added to:</p>
1.154 rodent 7461: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7462: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7463: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7464: <li class="listitem"><p>default_acceptable_licenses in
7465: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154 rodent 7466: </ul></div>
7467: </li>
1.284 rillig 7468: <li class="listitem"><p>The license text should be added to
7469: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7470: licenses can be seen in this directory.</p></li>
1.154 rodent 7471: </ol></div>
1.222 sevan 7472: </div>
7473: <div class="sect3">
7474: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7475: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98 wiz 7476: <p>When the license changes (in a way other than formatting),
1.222 sevan 7477: make sure that the new license has a different name (e.g.,
1.98 wiz 7478: append the version number if it exists, or the date). Just
7479: because a user told pkgsrc to build programs under a previous
7480: version of a license does not mean that pkgsrc should build
1.99 rillig 7481: programs under the new licenses. The higher-level point is that
1.98 wiz 7482: pkgsrc does not evaluate licenses for reasonableness; the only
7483: test is a mechanistic test of whether a particular text has been
1.222 sevan 7484: approved by either of two bodies (FSF or OSI).</p>
7485: </div>
1.75 rillig 7486: </div>
1.148 asau 7487: <div class="sect2">
1.75 rillig 7488: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7489: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75 rillig 7490: <p>Some licenses restrict how software may be re-distributed.
1.222 sevan 7491: By declaring the restrictions, package tools can
1.98 wiz 7492: automatically refrain from e.g. placing binary packages on FTP
7493: sites.</p>
1.222 sevan 7494: <p>There are four possible restrictions, which are
1.98 wiz 7495: the cross product of sources (distfiles) and binaries not being
7496: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7497: language in any license, and because non-Free licenses tend to be
7498: different from each other, pkgsrc adopts a definition of FTP and
1.222 sevan 7499: CD-ROM.
7500:
7501: "FTP" means making the source or binary file available over the
7502: Internet at no charge.
7503:
7504: "CD-ROM" means making the source or binary available on some kind of
7505: media, together with other source and binary packages, which is sold
7506: for a distribution charge.
1.98 wiz 7507: </p>
7508: <p>In order to encode these restrictions, the package system
1.87 wiz 7509: defines five make variables that can be set to note these
7510: restrictions:</p>
1.148 asau 7511: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7512: <li class="listitem">
1.75 rillig 7513: <p><code class="varname">RESTRICTED</code></p>
7514: <p>This variable should be set whenever a restriction
1.87 wiz 7515: exists (regardless of its kind). Set this variable to a
1.98 wiz 7516: string containing the reason for the restriction. It should
7517: be understood that those wanting to understand the restriction
7518: will have to read the license, and perhaps seek advice of
7519: counsel.</p>
1.75 rillig 7520: </li>
1.128 wiz 7521: <li class="listitem">
1.75 rillig 7522: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7523: <p>Binaries may not be placed on CD-ROM containing other
7524: binary packages, for which a distribution charge may be made.
7525: In this case, set this variable to
7526: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7527: </li>
1.128 wiz 7528: <li class="listitem">
1.75 rillig 7529: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7530: <p>Binaries may not made available on the Internet without
7531: charge. In this case, set this variable to
7532: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7533: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7534: </li>
1.128 wiz 7535: <li class="listitem">
1.75 rillig 7536: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7537: <p>Distfiles may not be placed on CD-ROM, together with
7538: other distfiles, for which a fee may be charged. In this
7539: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7540: </p>
1.75 rillig 7541: </li>
1.128 wiz 7542: <li class="listitem">
1.75 rillig 7543: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7544: <p>Distfiles may not made available via FTP at no charge.
7545: In this case, set this variable to
7546: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7547: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7548: </li>
7549: </ul></div>
1.222 sevan 7550: <p>Please note that packages will be removed from pkgsrc when the
7551: distfiles are not distributable and cannot be obtained for a period
7552: of one full quarter branch. Packages with manual/interactive fetch
7553: must have a maintainer and it is his/her responsibility to ensure
7554: this.</p>
1.75 rillig 7555: </div>
1.148 asau 7556: <div class="sect2">
1.75 rillig 7557: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7558: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290 gutterid 7559: <p>Your package may depend on some other package being present,
7560: and there are various ways of expressing this dependency.
7561: pkgsrc supports the <code class="varname">DEPENDS</code>,
7562: <code class="varname">BUILD_DEPENDS</code>,
7563: <code class="varname">TOOL_DEPENDS</code>, and
7564: <code class="varname">TEST_DEPENDS</code> definitions, the
1.88 wiz 7565: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7566: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7567: to handle dependencies, and which uses the variables named above.
1.299 rillig 7568: 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 7569: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7570: definition registers that pre-requisite in the binary package so it
7571: will be pulled in when the binary package is later installed, whilst
7572: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7573: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7574: dependency that is only needed for building or testing the resulting
1.299 rillig 7575: 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 7576: <p>This means that if you only need a package present whilst
1.290 gutterid 7577: you are building or testing, it should be noted as a
7578: <code class="varname">TOOL_DEPENDS</code>,
7579: <code class="varname">BUILD_DEPENDS</code>, or
7580: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.269 leot 7581: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7582: packages, i.e. packages for the architecture where the package
7583: is built;
7584: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290 gutterid 7585: packages, i.e., packages for the architecture for which the package
1.269 leot 7586: is built.</p>
1.290 gutterid 7587: <p>The format for a <code class="varname">DEPENDS</code>,
7588: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7589: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75 rillig 7590: <pre class="programlisting">
1.100 rillig 7591: <pre-req-package-name>:../../<category>/<pre-req-package>
1.222 sevan 7592: </pre>
1.128 wiz 7593: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7594: may include any of the wildcard version numbers recognized by
1.311 leot 7595: <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 7596: <div class="orderedlist"><ol class="orderedlist" type="1">
7597: <li class="listitem">
1.75 rillig 7598: <p>If your package needs another package's binaries or
1.160 wiz 7599: libraries to build and run, and if that package has a
1.87 wiz 7600: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7601: <pre class="programlisting">
1.100 rillig 7602: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7603: </pre>
1.75 rillig 7604: </li>
1.128 wiz 7605: <li class="listitem">
1.160 wiz 7606: <p>If your package needs another package's binaries or
7607: libraries only for building, and if that package has a
7608: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7609: <pre class="programlisting">
7610: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7611: </pre>
1.160 wiz 7612: <p>but set
7613: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7614: to make it a build dependency only. This case is rather
7615: rare.</p>
7616: </li>
7617: <li class="listitem">
1.132 spz 7618: <p>If your package needs binaries from another package to build,
1.269 leot 7619: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75 rillig 7620: <pre class="programlisting">
1.269 leot 7621: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222 sevan 7622: </pre>
1.75 rillig 7623: </li>
1.269 leot 7624: <li class="listitem"><p>If your package needs static libraries to link against, header
7625: files to include, etc. from another package to build,
7626: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132 spz 7627: <li class="listitem"><p>If your package needs a library with which to link and
7628: there is no <code class="filename">buildlink3.mk</code> file
7629: available, create one. Using
7630: <code class="varname">DEPENDS</code> won't be sufficient because the
7631: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7632: <li class="listitem">
1.132 spz 7633: <p>If your package needs some executable to be able to run
7634: correctly and if there's no
7635: <code class="filename">buildlink3.mk</code> file, this is specified
7636: using the <code class="varname">DEPENDS</code> variable. The
1.250 leot 7637: <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 7638: be able to execute the latex binary from the tex-latex-bin package
1.132 spz 7639: when it runs, and that is specified:</p>
1.75 rillig 7640: <pre class="programlisting">
1.242 wiz 7641: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222 sevan 7642: </pre>
1.132 spz 7643: </li>
1.290 gutterid 7644: <li class="listitem"><p>If your package includes a test suite that has extra
7645: dependencies only required for this purpose (frequently this
7646: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7647: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132 spz 7648: <li class="listitem">
7649: <p>You can use wildcards in package dependencies. Note that
7650: such wildcard dependencies are retained when creating binary
7651: packages. The dependency is checked when installing the binary
7652: package and any package which matches the pattern will be
7653: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7654: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7655: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7656: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7657: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7658: <p>Wildcards can also be used to specify that a package
1.87 wiz 7659: will only build against a certain minimum version of a
7660: pre-requisite:</p>
1.75 rillig 7661: <pre class="programlisting">
1.132 spz 7662: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.222 sevan 7663: </pre>
1.132 spz 7664: <p>This means that the package will build using version 6.0
7665: of ImageMagick or newer. Such a dependency may be warranted
7666: if, for example, the command line options of an executable
7667: have changed.</p>
7668: <p>If you need to depend on minimum versions of libraries,
1.298 wiz 7669: set
7670: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7671: to the appropriate pattern before including its
7672: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7673: <pre class="programlisting">
7674: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7675: .include "../../graphics/jpeg/buildlink3.mk"
7676: </pre>
1.75 rillig 7677: <p>For security fixes, please update the package
1.267 rillig 7678: 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 7679: information.</p>
1.75 rillig 7680: </li>
7681: </ol></div>
7682: <p>If your package needs files from another package to build,
1.87 wiz 7683: add the relevant distribution files to
7684: <code class="varname">DISTFILES</code>, so they will be extracted
1.250 leot 7685: 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 7686: (It relies on the jpeg sources being present in source form
7687: during the build.)</p>
1.75 rillig 7688: </div>
1.148 asau 7689: <div class="sect2">
1.75 rillig 7690: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7691: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7692: <p>Your package may conflict with other packages a user might
1.87 wiz 7693: already have installed on his system, e.g. if your package
1.88 wiz 7694: installs the same set of files as another package in the pkgsrc
1.190 wiz 7695: tree or has the same <code class="varname">PKGNAME</code>.</p>
1.255 leot 7696: <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>
7697: 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>
7698: install the same shared library, thus you set in
7699: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7700: <pre class="programlisting">
7701: CONFLICTS= Xaw-Xpm-[0-9]*
7702: </pre>
7703: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7704: <pre class="programlisting">
7705: CONFLICTS= libXaw3d-[0-9]*
7706: </pre>
1.311 leot 7707: <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 7708: that conflict with existing packages and abort. However, in many
7709: situations this is too late in the process. Binary package managers
7710: will not know about the conflict until they attempt to install the
7711: package after already downloading it and all its dependencies.
7712: Users may also waste time building a package and its dependencies
7713: only to find out at the end that it conflicts with another package
7714: they have installed.</p>
7715: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7716: should be added in all cases where it is known that packages conflict
7717: with each other. These <code class="varname">CONFLICTS</code> entries are
1.311 leot 7718: 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 7719: managers to inform users that packages cannot be installed onto
7720: the target system.</p>
1.75 rillig 7721: </div>
1.148 asau 7722: <div class="sect2">
1.75 rillig 7723: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7724: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7725: <p>There are several reasons why a package might be
1.88 wiz 7726: instructed to not build under certain circumstances. If the
1.87 wiz 7727: package builds and runs on most platforms, the exceptions
1.193 dholland 7728: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7729: the package builds and runs on a small handful of platforms,
7730: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7731: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7732: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7733: (OS-version-platform) that can use glob-style
7734: wildcards.</p>
7735: <p>If a package is not appropriate for some platforms (as
1.225 maya 7736: opposed to merely broken), a different set of variables should be
1.193 dholland 7737: used as this affects failure reporting and statistics.
7738: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7739: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 dholland 7740: the package is appropriate for only a small handful of platforms
7741: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7742: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7743: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7744: (OS-version-platform) that can use glob-style
7745: wildcards.</p>
1.88 wiz 7746: <p>Some packages are tightly bound to a specific version of an
1.250 leot 7747: 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 7748: backwards compatible with other versions of the OS, and should be
7749: uploaded to a version specific directory on the FTP server. Mark
7750: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7751: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7752: the package system internals, but may be used in the
7753: future.</p>
1.75 rillig 7754: <p>If the package should be skipped (for example, because it
1.87 wiz 7755: provides functionality already provided by the system), set
1.88 wiz 7756: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7757: the package should fail because some preconditions are not met,
7758: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7759: message.</p>
1.75 rillig 7760: </div>
1.148 asau 7761: <div class="sect2">
1.75 rillig 7762: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7763: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7764: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7765: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7766: be set in the package Makefile. This will be carried into any
7767: binary package that is made from this pkgsrc entry. A
1.128 wiz 7768: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.311 leot 7769: 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 7770: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7771: </div>
1.148 asau 7772: <div class="sect2">
1.75 rillig 7773: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7774: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7775: <p>When a vulnerability is found, this should be noted in
1.320 wiz 7776: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>.
7777: Entries in that file consist of three parts:</p>
7778: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7779: <li class="listitem"><p>package version pattern</p></li>
7780: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
7781: <li class="listitem"><p>URL providing additional information about the issue</p></li>
7782: </ul></div>
7783: <p>For the package version pattern please always use `<' to
7784: mark an upper bound (not `<='!). This will avoid possible
7785: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
7786: related to security fixes. Lower bounds can be added too, using
7787: '>' or '>='. For example,
1.321 ! wiz 7788: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.320 wiz 7789: versions 1.0 (included) to 1.2 (excluded) of
7790: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
7791: issue.</p>
7792: <p>Entries should always be added at the bottom of the file.</p>
7793: <p>When fixing packages, please modify the upper bound of the
7794: corresponding entry. To continue the previous example, if a fix
7795: was backported to version 1.1nb2, change the previous pattern to
1.321 ! wiz 7796: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.320 wiz 7797: <p>To locally test a package version pattern against a
7798: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
7799: pmatch</strong></span> command.</p>
7800: <p>The URL should be as permanent as possible and provide as
7801: much information about the issue as possible. CVE entries are
7802: preferred.</p>
7803: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.138 wiz 7804: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7805: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7806: <code class="varname">PKGREVISION</code> should be increased (this is of
7807: course not necessary if the problem is fixed by using a newer
7808: release of the software), and the pattern in the
7809: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7810: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7811: branch, be sure to submit a pullup request!</p>
1.75 rillig 7812: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7813: semi-automatically by a weekly cron job.</p>
1.320 wiz 7814: <p>In case a security issue is disputed, please contact
7815: pkgsrc-security@NetBSD.org.</p>
1.75 rillig 7816: </div>
1.148 asau 7817: <div class="sect2">
1.75 rillig 7818: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7819: <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 7820: <p>When making fixes to an existing package it can be useful
1.87 wiz 7821: to change the version number in <code class="varname">PKGNAME</code>. To
7822: avoid conflicting with future versions by the original author, a
1.128 wiz 7823: <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 7824: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7825: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7826: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7827: <pre class="programlisting">
1.100 rillig 7828: DISTNAME= foo-17.42
7829: PKGREVISION= 9
1.222 sevan 7830: </pre>
1.75 rillig 7831: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7832: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7833: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7834: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7835: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7836: <p>When a new release of the package is released, the
1.87 wiz 7837: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7838: minor release of the above package, things should be like:</p>
1.75 rillig 7839: <pre class="programlisting">
1.100 rillig 7840: DISTNAME= foo-17.43
1.222 sevan 7841: </pre>
1.87 wiz 7842: <p><code class="varname">PKGREVISION</code> should be incremented for any
7843: non-trivial change in the resulting binary package. Without a
7844: <code class="varname">PKGREVISION</code> bump, someone with the previous
7845: version installed has no way of knowing that their package is out
7846: of date. Thus, changes without increasing
7847: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7848: trivial that no reasonable person would want to upgrade", and this
7849: is the rough test for when increasing
7850: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7851: changes that do not merit increasing
7852: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 7853: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7854: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284 rillig 7855: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7856: comments in Makefile.</p></li>
7857: <li class="listitem"><p>Changing build variables if the resulting binary
7858: package is the same.</p></li>
7859: <li class="listitem"><p>Changing
7860: <code class="filename">DESCR</code>.</p></li>
7861: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7862: default options don't change.</p></li>
1.100 rillig 7863: </ul></div>
1.87 wiz 7864: <p>Examples of changes that do merit an increase to
7865: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 7866: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7867: <li class="listitem"><p>Security fixes</p></li>
7868: <li class="listitem"><p>Changes or additions to a patch
7869: file</p></li>
7870: <li class="listitem"><p>Changes to the
7871: <code class="filename">PLIST</code></p></li>
7872: <li class="listitem"><p>A dependency is changed or
7873: renamed.</p></li>
1.100 rillig 7874: </ul></div>
1.78 rillig 7875: <p>PKGREVISION must also be incremented when dependencies have ABI
7876: changes.</p>
1.75 rillig 7877: </div>
1.148 asau 7878: <div class="sect2">
1.79 rillig 7879: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7880: <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 7881: <p>When you want to replace the same text in multiple files, or
7882: multiple times in the same file, it is cumbersome to maintain a patch
7883: file for this. This is where the SUBST framework steps in. It provides an
7884: easy-to-use interface for replacing text in files. It just needs the
7885: following information:</p>
7886: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7887: <li class="listitem"><p>In which phase of the package build cycle should the
7888: replacement happen?</p></li>
7889: <li class="listitem"><p>In which files should the replacement
1.287 rillig 7890: happen?</p></li>
1.295 rillig 7891: <li class="listitem"><p>Which text should be replaced with
7892: what?</p></li>
1.287 rillig 7893: </ul></div>
7894: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295 rillig 7895: variables. A minimal example is:</p>
7896: <pre class="programlisting">
7897: SUBST_CLASSES+= paths
7898: SUBST_STAGE.paths= pre-configure
7899: SUBST_FILES.paths= src/*.c
7900: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
7901: </pre>
7902: <p>Translated into English, it means: In the pre-configure stage (that
7903: is, after applying the patches from the patches/ directory and before
7904: running the configure script and the portability check), replace the text
7905: <code class="literal">/usr/local</code> with the content of the variable
7906: <code class="varname">PREFIX</code>.</p>
7907: <p>Each SUBST block starts by appending an identifier to
7908: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
7909: identifier can be chosen freely by the package. If there should ever be
7910: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
7911: early, so don't worry about name collisions.</p>
7912: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
7913: SUBST block are parameterized using this identifier. In the remainder of
7914: this section, these parameterized variables are written as
7915: <code class="varname">SUBST_STAGE.*</code>.</p>
7916: <pre class="programlisting">
7917: SUBST_CLASSES+= paths
7918: SUBST_STAGE.paths= pre-configure
7919: SUBST_MESSAGE.paths= Fixing absolute paths.
7920: SUBST_FILES.paths= src/*.c
7921: SUBST_FILES.paths+= scripts/*.sh
7922: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
7923: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
7924: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
7925: </pre>
7926: <p>To get a complete picture about the SUBST substitutions, run
7927: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
7928: expected, run pkglint on the package, which detects several typical
7929: mistakes surrounding the SUBST blocks. For any questions that might
7930: remain after this, have a look at
7931: <code class="filename">mk/subst.mk</code>.</p>
7932: <div class="sect3">
7933: <div class="titlepage"><div><div><h4 class="title">
7934: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
7935: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
7936: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
7937: <code class="literal">pre-configure</code> is used most often, by far. The most
7938: popular stages are, in chronological order:</p>
7939: <div class="variablelist"><dl class="variablelist">
7940: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
7941: <dd>
7942: <p>The substitutions are applied immediately after the
7943: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
7944: package will leave no traces of the original files.</p>
7945: <p>When the substitution applies to files for which there is also a
7946: patch in the <code class="filename">patches/</code> directory, this means that the
7947: patches will be computed based on the result of the substitution. When
7948: these patches are sent to the upstream maintainer later, to be fixed in
7949: the upstream package, these patches may no longer match what the upstream
7950: author is used to. Because of this, <code class="literal">pre-configure</code> is
7951: often a better choice.</p>
7952: </dd>
7953: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
7954: <dd>
7955: <p>The substitutions are applied after the patches from the
7956: <code class="filename">patches/</code> directory. This makes it possible to run
7957: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
7958: 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>
7959: <p>When updating the patches, it is helpful to explicitly separate the
7960: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
7961: configure</strong></span>, and to only edit the patches between these commands.
7962: Otherwise the substitutions from the SUBST block will end up in the patch
7963: file. When this happens in really obvious ways, pkglint will complain
7964: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
7965: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
7966: can only detect these really obvious
7967: cases.</p>
7968: </dd>
7969: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
7970: <dd><p>This stage should only be used if the package defines a
7971: <code class="literal">pre-configure</code> action itself, and the substitution must
7972: happen after that. Typical examples are packages that use the
7973: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
7974: script from
7975: <code class="filename">configure.ac</code>.</p></dd>
7976: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
7977: <dd><p>This stage is used to fix up any mistakes by the
7978: configure stage.</p></dd>
7979: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
7980: <dd><p>This stage should only be used for substitutions that are
7981: clearly related to building the package, not for fixing the
7982: configuration. Substitutions for pathnames (such as replacing
7983: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
7984: user names (such as replacing <code class="literal">@MY_USER@</code> with the
7985: actual username) belong in pre-configure or post-configure
7986: instead.</p></dd>
7987: <dt><span class="term"><code class="literal">post-build</code></span></dt>
7988: <dd>
7989: <p>Just as with pre-build, this stage should only be used
7990: for substitutions that are clearly related to building the package, not
7991: for fixing the configuration. Substitutions for pathnames (such as
7992: replacing <code class="filename">/usr/local</code> with
7993: <code class="literal">${PREFIX}</code>) or user names (such as replacing
7994: <code class="literal">@MY_USER@</code> with the actual username) belong in
7995: pre-configure or post-configure instead.</p>
7996: <p>A typical use is to update pkg-config files to include the rpath
7997: compiler options.</p>
7998: </dd>
7999: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8000: <dd><p>In general, the install phase should be as simple as
8001: possible. As with the pre-build and post-build stages, it should not be
8002: used to fix pathnames or user names, these belong in pre-configure
8003: instead. There are only few legitimate use cases for applying
8004: substitutions in this stage.</p></dd>
8005: </dl></div>
8006: </div>
8007: <div class="sect3">
8008: <div class="titlepage"><div><div><h4 class="title">
1.296 rillig 8009: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295 rillig 8010: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8011: filename patterns. These patterns are relative to
8012: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8013: A typical example is:</p>
8014: <pre class="programlisting">
8015: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8016: </pre>
8017: <p>The above patterns, especially the last, are quite broad. The SUBST
8018: implementation checks that each filename pattern that is mentioned here
8019: has an effect. For example, if none of the
8020: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8021: and substituted, that filename pattern is redundant and should be left
1.296 rillig 8022: out. By default, the SUBST framework will complain with an error message.
8023: If the text to be substituted occurs in some of the files from a single
8024: pattern, but not in all of them, that is totally ok, and the SUBST
1.295 rillig 8025: framework will only print an INFO message for those files.</p>
8026: <p>If there is a good reason for having redundant filename patterns,
1.296 rillig 8027: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295 rillig 8028: <p>Another popular way of choosing the files for the substitutions is
8029: via a shell command, like this:</p>
8030: <pre class="programlisting">
1.296 rillig 8031: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.295 rillig 8032: SUBST_FILES.path= ${C_FILES_CMD:sh}
8033: </pre>
8034: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8035: freely chosen and independent of the SUBST framework.</p>
8036: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8037: lists each file individually. Thereby chances are higher that there are
8038: filename patterns in which no substitution happens. Since the SUBST
8039: framework cannot know whether the filename patterns in
8040: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8041: Makefile (where any redundant filename pattern would be suspicious) or
8042: been generated by a shell command (in which redundant filename patterns
8043: are more likely and to be expected), it will complain about these
8044: redundant filename patterns. Therefore, SUBST blocks that use a shell
8045: command to generate the list of filename patterns often need to set
8046: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8047: </div>
8048: <div class="sect3">
8049: <div class="titlepage"><div><div><h4 class="title">
8050: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8051: <p>In most cases, the substitutions are given using one or more
1.311 leot 8052: <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 8053: <pre class="programlisting">
8054: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8055: </pre>
8056: <p>Each of the sed commands needs to be preceded by the
8057: <code class="literal">-e</code> option and should be specified on a line of its
8058: own, to avoid hiding short sed commands at the end of a line.</p>
8059: <p>Since the sed commands often contain shell metacharacters as the
8060: separator (the <code class="literal">|</code> in the above example), it is common
8061: to enclose them in single quotes.</p>
8062: <p>A common substitution is to replace placeholders of the form
8063: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8064: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8065: <pre class="programlisting">
8066: SUBST_VARS.path= PREFIX
8067: </pre>
8068: <p>This type of substitutions is typically done by the GNU configure
1.296 rillig 8069: scripts during the do-configure stage, but in some cases these need to be
8070: overridden. The same pattern is also used when a package defines patches
8071: that replace previously hard-coded paths like
8072: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8073: placeholder first, which then gets substituted by the actual
8074: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8075: cases, it works equally well to just use the SUBST framework to directly
8076: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8077: thereby omitting the intermediate patch file.</p>
1.295 rillig 8078: <p>If the above is not flexible enough, it is possible to not use sed
8079: at all for the substitution but to specify an entirely different command,
8080: like this:</p>
1.87 wiz 8081: <pre class="programlisting">
1.295 rillig 8082: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8083: </pre>
8084: <p>This is used for the few remaining packages in which the
8085: distributed files use Windows-style line endings that need to be
8086: converted to UNIX-style line endings.</p>
8087: </div>
8088: <div class="sect3">
8089: <div class="titlepage"><div><div><h4 class="title">
8090: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8091: <p>When a SUBST block is applied during a package build, a message is
8092: logged. The default message is fine for most purposes but can be
8093: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8094: message.</p>
8095: </div>
1.79 rillig 8096: </div>
1.75 rillig 8097: </div>
1.148 asau 8098: <div class="sect1">
1.75 rillig 8099: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8100: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 8101: <div class="sect2">
1.75 rillig 8102: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8103: <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 8104: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8105: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8106: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8107: with the name of each file to download as an argument, expecting
8108: it to output the URL of the directory from which to download
1.250 leot 8109: 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 8110: example of this usage.</p>
1.75 rillig 8111: <p>If the download can't be automated, because the user must
1.87 wiz 8112: submit personal information to apply for a password, or must pay
8113: for the source, or whatever, you can set
8114: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8115: displayed to the user before aborting the build. Example:</p>
8116: <pre class="programlisting">
1.100 rillig 8117: FETCH_MESSAGE= "Please download the files"
8118: FETCH_MESSAGE+= " "${DISTFILES:Q}
8119: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222 sevan 8120: </pre>
1.75 rillig 8121: </div>
1.148 asau 8122: <div class="sect2">
1.75 rillig 8123: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8124: <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 8125: <p>Sometimes authors of a software package make some
1.87 wiz 8126: modifications after the software was released, and they put up a
8127: new distfile without changing the package's version number. If a
8128: package is already in pkgsrc at that time, the checksum will
8129: no longer match. The contents of the new distfile should be
8130: compared against the old one before changing anything, to make
8131: sure the distfile was really updated on purpose, and that
8132: no trojan horse or so crept in.
1.97 rillig 8133: Please mention that the distfiles were compared and what was found
1.159 rodent 8134: in your commit message.</p>
1.220 wiz 8135: <p>Then, the correct way to work around this is to set
8136: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8137: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8138: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8139: a variable prefix). All <code class="varname">DISTFILES</code> and
1.93 rillig 8140: <code class="varname">PATCHFILES</code> for this package will be put in that
1.267 rillig 8141: 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 8142: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220 wiz 8143: including the <code class="filename">nbX</code> suffix) or a date stamp can
8144: be appended, like
8145: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284 rillig 8146: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8147: name does not contain a version and the distfile is apt to change. In
8148: cases where the likelihood of this is very small,
8149: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8150: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8151: distfile name changes, even if a package is being moved or
8152: renamed.</p>
1.159 rodent 8153: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8154: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8155: path in the filenames.
1.159 rodent 8156: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8157: Furthermore, a mail to the package's authors seems appropriate
8158: telling them that changing distfiles after releases without
8159: changing the file names is not good practice.</p>
1.75 rillig 8160: </div>
1.199 tnn 8161: <div class="sect2">
8162: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8163: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284 rillig 8164: <p>Helper methods exist for packages hosted on github.com which
8165: will often have distfile names that clash with other packages, for
8166: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8167: from below:</p>
1.199 tnn 8168: <div class="sect3">
8169: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8170: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284 rillig 8171: <p>If your distfile URL looks similar to
1.303 bacon 8172: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284 rillig 8173: then you are packaging a tagged release.</p>
1.199 tnn 8174: <pre class="programlisting">
1.303 bacon 8175: DISTNAME= example-1.0
1.200 tnn 8176: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8177: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8178: GITHUB_TAG= v${PKGVERSION_NOREV}
1.199 tnn 8179: EXTRACT_SUFX= .zip
8180: </pre>
8181: </div>
8182: <div class="sect3">
8183: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8184: <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>
8185: <p>If your distfile looks similar to
8186: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8187: release, then set the package version to 0.0.0.N, where N is the number
8188: of commits to the repository, and set GITHUB_TAG to the commit hash.
8189: This will (almost) ensure that the first tagged release will have a
8190: version greater than this one so that package upgrades will function
8191: properly.</p>
8192: <pre class="programlisting">
8193: DISTNAME= example-0.0.0.347
8194: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8195: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8196: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8197: </pre>
8198: </div>
8199: <div class="sect3">
8200: <div class="titlepage"><div><div><h4 class="title">
8201: <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>
8202: <p>If your distfile looks similar to
8203: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8204: then include the last release version and the commit count since that
8205: release in the package version and set GITHUB_TAG to the commit hash.
8206: The latest release and commit count are shown in the output of
8207: "git describe --tags":
8208: </p>
8209: <pre class="screen">
8210: # git clone https://github.com/username/example
8211: # cd example
8212: # git describe --tags
8213: 1.2.3-5-g988881a
8214: </pre>
1.199 tnn 8215: <pre class="programlisting">
1.303 bacon 8216: DISTNAME= example-1.2.3.5
8217: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8218: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8219: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222 sevan 8220: </pre>
1.199 tnn 8221: </div>
8222: <div class="sect3">
8223: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8224: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284 rillig 8225: <p>If your distfile URL looks similar to
1.303 bacon 8226: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284 rillig 8227: then you are packaging a release.</p>
1.199 tnn 8228: <pre class="programlisting">
8229: DISTNAME= offensive-1.6
1.200 tnn 8230: PKGNAME= ${DISTNAME:S/offensive/proper/}
8231: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8232: GITHUB_PROJECT= example
1.200 tnn 8233: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8234: EXTRACT_SUFX= .zip
1.222 sevan 8235: </pre>
1.199 tnn 8236: </div>
8237: </div>
1.75 rillig 8238: </div>
1.148 asau 8239: <div class="sect1">
1.75 rillig 8240: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8241: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 8242: <div class="sect2">
1.75 rillig 8243: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8244: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8245: <p>pkgsrc supports many different machines, with different
1.87 wiz 8246: object formats like a.out and ELF, and varying abilities to do
8247: shared library and dynamic loading at all. To accompany this,
8248: varying commands and options have to be passed to the
8249: compiler, linker, etc. to get the Right Thing, which can be
8250: pretty annoying especially if you don't have all the machines
8251: at your hand to test things. The
1.250 leot 8252: <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 8253: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8254: both static and dynamic libraries from a set of source files,
8255: thus being platform-independent.</p>
8256: <p>Here's how to use libtool in a package in seven simple
8257: steps:</p>
1.128 wiz 8258: <div class="orderedlist"><ol class="orderedlist" type="1">
8259: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8260: Makefile.</p></li>
1.128 wiz 8261: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8262: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8263: add it to the definition of <code class="varname">CC</code>, if only
8264: libraries are being built in a given Makefile. This one command
8265: will build both PIC and non-PIC library objects, so you need not
8266: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8267: <li class="listitem">
1.75 rillig 8268: <p>For the linking of the library, remove any
1.128 wiz 8269: <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
8270: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8271: <pre class="programlisting">
1.100 rillig 8272: ${LIBTOOL} --mode=link \
8273: ${CC} -o ${.TARGET:.a=.la} \
8274: ${OBJS:.o=.lo} \
8275: -rpath ${PREFIX}/lib \
8276: -version-info major:minor
1.222 sevan 8277: </pre>
1.75 rillig 8278: <p>Note that the library is changed to have a
1.87 wiz 8279: <code class="filename">.la</code> extension, and the objects are
8280: changed to have a <code class="filename">.lo</code>
8281: extension. Change <code class="varname">OBJS</code> as
8282: necessary. This automatically creates all of the
8283: <code class="filename">.a</code>,
8284: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8285: necessary) in the build directory. Be sure to include
1.128 wiz 8286: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8287: minor are zero, as libtool will otherwise strip off the
8288: shared library version.</p>
1.75 rillig 8289: <p>From the libtool manual:</p>
8290: <pre class="programlisting">
1.100 rillig 8291: So, libtool library versions are described by three integers:
1.69 rillig 8292:
1.100 rillig 8293: CURRENT
8294: The most recent interface number that this library implements.
1.69 rillig 8295:
1.100 rillig 8296: REVISION
8297: The implementation number of the CURRENT interface.
1.69 rillig 8298:
1.100 rillig 8299: AGE
8300: The difference between the newest and oldest interfaces that
8301: this library implements. In other words, the library implements
8302: all the interface numbers in the range from number `CURRENT -
8303: AGE' to `CURRENT'.
1.1 grant 8304:
1.100 rillig 8305: If two libraries have identical CURRENT and AGE numbers, then the
8306: dynamic linker chooses the library with the greater REVISION number.
1.222 sevan 8307: </pre>
1.128 wiz 8308: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8309: different results for a.out and ELF (excluding symlinks)
8310: in only one case. An ELF library of the form
1.128 wiz 8311: <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 8312: will have a symlink of
1.128 wiz 8313: <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 8314: on an a.out platform. This is handled
8315: automatically.</p>
1.128 wiz 8316: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8317: directory of the library being built.</p>
1.76 rillig 8318: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8319: <code class="filename">.la</code> file, the other files will be
8320: added automatically.</p>
1.75 rillig 8321: </li>
1.128 wiz 8322: <li class="listitem">
1.76 rillig 8323: <p>When linking shared object (<code class="filename">.so</code>)
1.311 leot 8324: 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 8325: shared libraries, use <span class="quote">“<span class="quote">-module
8326: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8327: tacked on.</p>
1.76 rillig 8328: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8329: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8330: </li>
1.128 wiz 8331: <li class="listitem">
1.75 rillig 8332: <p>When linking programs that depend on these libraries
1.87 wiz 8333: <span class="emphasis"><em>before</em></span> they are installed, preface
1.311 leot 8334: 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 8335: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8336: libraries (static or shared), but please be aware that
8337: libtool will not allow you to specify a relative path in
1.128 wiz 8338: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8339: expects you to change that argument to be the
8340: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8341: <pre class="programlisting">
1.100 rillig 8342: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222 sevan 8343: </pre>
1.75 rillig 8344: <p>should be changed to:</p>
8345: <pre class="programlisting">
1.100 rillig 8346: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222 sevan 8347: </pre>
1.75 rillig 8348: <p>and it will do the right thing with the libraries.</p>
8349: </li>
1.128 wiz 8350: <li class="listitem">
1.311 leot 8351: <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>
8352: 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 8353: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8354: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8355: <pre class="programlisting">
1.126 jakllsch 8356: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222 sevan 8357: </pre>
1.76 rillig 8358: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8359: shared library, any needed symlinks, and run
1.311 leot 8360: <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 8361: </li>
1.128 wiz 8362: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8363: the <code class="filename">.la</code>
8364: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8365: </ol></div>
8366: </div>
1.148 asau 8367: <div class="sect2">
1.75 rillig 8368: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8369: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8370: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8371: package Makefile. This will override the package's own libtool
8372: in most cases. For older libtool using packages, libtool is
8373: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8374: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8375: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8376: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8377: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8378: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8379: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8380: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8381: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8382: libraries built and installed, then use
8383: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8384: <p>If your package makes use of the platform-independent library
1.87 wiz 8385: for loading dynamic shared objects, that comes with libtool
8386: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8387: <p>Some packages use libtool incorrectly so that the package
8388: may not work or build in some circumstances. Some of the more
8389: common errors are:</p>
1.148 asau 8390: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8391: <li class="listitem">
1.75 rillig 8392: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8393: executable or library. This in itself isn't a problem if one of two things
8394: has been done:</p>
1.128 wiz 8395: <div class="orderedlist"><ol class="orderedlist" type="1">
8396: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8397: <code class="filename">libfoo.la</code>, not
8398: <code class="filename">foo.la</code></p></li>
1.128 wiz 8399: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8400: </ol></div>
8401: </li>
1.128 wiz 8402: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8403: The function lt_dlinit() should be called and the macro
8404: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8405: executables.</p></li>
1.75 rillig 8406: </ul></div>
8407: </div>
1.148 asau 8408: <div class="sect2">
1.75 rillig 8409: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8410: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8411: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8412: to regenerate the configure script and Makefile.in makefile
8413: templates, then they should be executed in a pre-configure
8414: target.</p>
1.75 rillig 8415: <p>For packages that need only autoconf:</p>
8416: <pre class="programlisting">
1.100 rillig 8417: AUTOCONF_REQD= 2.50 # if default version is not good enough
8418: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8419: ...
1.1 grant 8420:
1.100 rillig 8421: pre-configure:
8422: cd ${WRKSRC} && autoconf
1.1 grant 8423:
1.100 rillig 8424: ...
1.222 sevan 8425: </pre>
1.75 rillig 8426: <p>and for packages that need automake and autoconf:</p>
8427: <pre class="programlisting">
1.100 rillig 8428: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8429: USE_TOOLS+= automake # use "automake14" for automake-1.4
8430: ...
8431:
8432: pre-configure:
8433: set -e; cd ${WRKSRC}; \
8434: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8435:
1.100 rillig 8436: ...
1.222 sevan 8437: </pre>
1.75 rillig 8438: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8439: require GNU Make.</p>
1.75 rillig 8440: <p>There are times when the configure process makes
1.87 wiz 8441: additional changes to the generated files, which then causes
8442: the build process to try to re-execute the automake sequence.
8443: This is prevented by touching various files in the configure
8444: stage. If this causes problems with your package you can set
8445: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8446: Makefile.</p>
1.75 rillig 8447: </div>
8448: </div>
1.148 asau 8449: <div class="sect1">
1.75 rillig 8450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8451: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148 asau 8452: <div class="sect2">
1.87 wiz 8453: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8454: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8455: <p>Compilers for the C, C++, and Fortran languages comes with
8456: the NetBSD base system. By default, pkgsrc assumes that a package
8457: is written in C and will hide all other compilers (via the wrapper
1.299 rillig 8458: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8459: <p>To declare which language's compiler a package needs, set
8460: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 8461: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8462: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8463: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8464: written in C++, usually need a C compiler for the configure
8465: phase.</p>
8466: </div>
1.148 asau 8467: <div class="sect2">
1.87 wiz 8468: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8469: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87 wiz 8470: <p>If a program is written in Java, use the Java framework in
8471: pkgsrc. The package must include
8472: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8473: provides the following variables:</p>
1.148 asau 8474: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8475: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8476: dependency on the JDK is added. If
1.128 wiz 8477: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8478: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8479: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8480: JDK.</p></li>
1.128 wiz 8481: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8482: a package needs a Java2 implementation. The supported values
1.128 wiz 8483: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8484: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8485: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8486: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8487: above. This variable is not set by default.</p></li>
1.130 wiz 8488: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8489: automatically set to the runtime location of the used Java
8490: implementation dependency. It may be used to set
8491: <code class="varname">JAVA_HOME</code> to a good value if the program
8492: needs this variable to be defined.
8493: </p></li>
1.87 wiz 8494: </ul></div>
8495: </div>
1.148 asau 8496: <div class="sect2">
1.87 wiz 8497: <div class="titlepage"><div><div><h3 class="title">
1.320 wiz 8498: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
8499: <p>If a program is written in Go and has any dependencies on
8500: other Go modules, have the package include
8501: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8502: <div class="orderedlist"><ol class="orderedlist" type="1">
8503: <li class="listitem"><p>Generate a list of those dependencies with
8504: <span class="command"><strong>make clean && make patch && make show-go-modules >
8505: go-modules.mk</strong></span>.</p></li>
8506: <li class="listitem">
8507: <p>Prepend </p>
8508: <pre class="programlisting">.include
8509: "go-modules.mk"</pre>
8510: <p> to any other
8511: </p>
8512: <pre class="programlisting">.include</pre>
8513: <p>s.</p>
8514: </li>
8515: <li class="listitem"><p>Incorporate these modules in
8516: <code class="filename">distinfo</code> with <span class="command"><strong>make
8517: makesum</strong></span>.</p></li>
8518: </ol></div>
8519: </div>
8520: <div class="sect2">
8521: <div class="titlepage"><div><div><h3 class="title">
8522: <a name="perl-scripts"></a>21.4.4. Packages containing Perl scripts</h3></div></div></div>
1.318 nia 8523: <p>If your package contains interpreted Perl scripts, add
1.128 wiz 8524: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8525: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8526: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8527: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8528: that you want adjusted. Every occurrence of
8529: <code class="filename">*/bin/perl</code> in a she-bang line will be
8530: replaced with the full path to the perl executable.</p>
1.87 wiz 8531: <p>If a particular version of perl is needed, set the
8532: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8533: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.318 nia 8534: <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 8535: about handling perl modules.</p>
8536: </div>
1.148 asau 8537: <div class="sect2">
1.87 wiz 8538: <div class="titlepage"><div><div><h3 class="title">
1.320 wiz 8539: <a name="shell-scripts"></a>21.4.5. Packages containing shell scripts</h3></div></div></div>
1.147 wiz 8540: <p><code class="varname">REPLACE_SH</code>,
8541: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8542: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.309 gutterid 8543: hash bangs in files. Please use the appropriate one, preferring
1.147 wiz 8544: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183 wiz 8545: Each should contain a list of scripts, relative to
8546: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8547: occurrence of the matching shell in a she-bang line will be
8548: replaced with the full path to the shell executable.
1.147 wiz 8549: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8550: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8551: </div>
1.148 asau 8552: <div class="sect2">
1.147 wiz 8553: <div class="titlepage"><div><div><h3 class="title">
1.320 wiz 8554: <a name="other-programming-languages"></a>21.4.6. Other programming languages</h3></div></div></div>
1.87 wiz 8555: <p>Currently, there is no special handling for other languages
8556: in pkgsrc. If a compiler package provides a
8557: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8558: just add a (build) dependency on the appropriate compiler
8559: package.</p>
8560: </div>
8561: </div>
1.148 asau 8562: <div class="sect1">
1.87 wiz 8563: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8564: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8565: <p>The most common failures when building a package are that
8566: some platforms do not provide certain header files, functions or
8567: libraries, or they provide the functions in a library that the
8568: original package author didn't know. To work around this, you
8569: can rewrite the source code in most cases so that it does not
8570: use the missing functions or provides a replacement function.</p>
1.148 asau 8571: <div class="sect2">
1.77 rillig 8572: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8573: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8574: <p>If a package already comes with a GNU configure script, the
8575: preferred way to fix the build failure is to change the
8576: configure script, not the code. In the other cases, you can
8577: utilize the C preprocessor, which defines certain macros
8578: depending on the operating system and hardware architecture it
8579: compiles for. These macros can be queried using for example
8580: <code class="varname">#if defined(__i386)</code>. Almost every operating
8581: system, hardware architecture and compiler has its own macro.
8582: For example, if the macros <code class="varname">__GNUC__</code>,
8583: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8584: are all defined, you know that you are using NetBSD on an i386
8585: compatible CPU, and your compiler is GCC.</p>
8586: <p>The list of the following macros for hardware and
8587: operating system depends on the compiler that is used. For
8588: example, if you want to conditionally compile code on Solaris,
8589: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8590: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8591: <div class="sect3">
1.75 rillig 8592: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8593: <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 8594: <p>To distinguish between 4.4 BSD-derived systems and the
8595: rest of the world, you should use the following code.</p>
8596: <pre class="programlisting">
1.100 rillig 8597: #include <sys/param.h>
8598: #if (defined(BSD) && BSD >= 199306)
8599: /* BSD-specific code goes here */
8600: #else
8601: /* non-BSD-specific code goes here */
8602: #endif
1.75 rillig 8603: </pre>
1.77 rillig 8604: <p>If this distinction is not fine enough, you can also test
8605: for the following macros.</p>
1.75 rillig 8606: <pre class="programlisting">
1.151 obache 8607: Cygwin __CYGWIN__
8608: DragonFly __DragonFly__
1.100 rillig 8609: FreeBSD __FreeBSD__
1.151 obache 8610: Haiku __HAIKU__
1.100 rillig 8611: Interix __INTERIX
8612: IRIX __sgi (TODO: get a definite source for this)
8613: Linux linux, __linux, __linux__
1.193 dholland 8614: Mac OS X __APPLE__
1.151 obache 8615: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8616: Minix3 __minix
1.100 rillig 8617: NetBSD __NetBSD__
8618: OpenBSD __OpenBSD__
8619: Solaris sun, __sun
1.75 rillig 8620: </pre>
8621: </div>
1.148 asau 8622: <div class="sect3">
1.75 rillig 8623: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8624: <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 8625: <pre class="programlisting">
1.100 rillig 8626: i386 i386, __i386, __i386__
8627: MIPS __mips
8628: SPARC sparc, __sparc
1.75 rillig 8629: </pre>
8630: </div>
1.148 asau 8631: <div class="sect3">
1.75 rillig 8632: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8633: <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 8634: <pre class="programlisting">
1.100 rillig 8635: GCC __GNUC__ (major version), __GNUC_MINOR__
8636: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8637: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8638: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8639: </pre>
8640: </div>
8641: </div>
1.148 asau 8642: <div class="sect2">
1.78 rillig 8643: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8644: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8645: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8646: combinations of compiler version and architecture and almost
8647: always relation to optimisation being enabled. Common symptoms
8648: are gcc internal errors or never finishing compiling a
1.78 rillig 8649: file.</p>
8650: <p>Typically, a workaround involves testing the
8651: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8652: optimisation for that combination of file,
1.198 tnn 8653: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8654: <p>This used to be a big problem in the past, but is rarely
8655: needed now as compiler technology has matured. If you still need
8656: to add a compiler specific workaround, please do so in the file
8657: <code class="filename">hacks.mk</code> and describe the symptom and
8658: compiler version as detailed as possible.</p>
1.78 rillig 8659: </div>
1.148 asau 8660: <div class="sect2">
1.78 rillig 8661: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 8662: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8663: <p>Compilation sometimes fails with an error message like this:</p>
8664: <pre class="programlisting">
8665: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8666: fatal error: pango/pango.h: No such file or directory
8667: </pre>
8668: <p>The proper way to fix this problem depends on the type of the
8669: header, which is described in the following sections.</p>
8670: <div class="sect3">
8671: <div class="titlepage"><div><div><h4 class="title">
8672: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8673: <p>If the header name looks like it comes from a different package,
8674: that other package should be included via the buildlink3
8675: framework.</p>
8676: <p>First, look whether the header is somewhere in the buildlink3
8677: directory below <code class="varname">WRKDIR</code>. In the above case of
8678: the missing Pango header:</p>
8679: <pre class="programlisting">
8680: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8681: </pre>
8682: <p>In the case of Pango, the output is:</p>
8683: <pre class="programlisting">
8684: work/.buildlink/include/pango-1.0/pango/pango.h
8685: </pre>
8686: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8687: in the <code class="filename">.buildlink</code> directory, it would have been
8688: found automatically. There is an extra <code class="filename">pango-1.0</code>
8689: path component though, which means that the compiler command line must
8690: contain an option of the form
8691: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8692: most cases this option is generated by the configure script, which can be examined using:</p>
8693: <pre class="programlisting">
8694: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8695: -I/usr/pkg/include/pango-1.0
8696: -I/usr/pkg/include/pango-1.0
8697: -I/usr/pkg/include/pango-1.0
8698: -I/usr/pkg/include/pango-1.0
8699: -I/usr/pkg/include/pango-1.0
8700: </pre>
8701: <p>This looks good. These options are transformed by the buildlink
8702: wrapper to refer to the correct path inside
8703: <code class="filename">work/.buildlink</code>.</p>
8704: <p>Since the compilation fails though, examine the compiler command
8705: lines in <code class="filename">work/.work.log</code> to see whether the
8706: <code class="literal">-I</code> option is included in the particular command
8707: line.</p>
8708: <p>To further analyze the situation, run <span class="command"><strong>bmake
8709: build-env</strong></span>, which sets up an interactive, realistic environment
8710: including all the pkgsrc wrapper commands and environment variables. From
8711: there, try to compile some simple example programs that use the
8712: header.</p>
8713: </div>
8714: <div class="sect3">
8715: <div class="titlepage"><div><div><h4 class="title">
8716: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8717: <p>If the name of the header seems to come from the package itself,
8718: and if the build is run with parallel jobs, the package may have some
8719: undeclared dependencies between the <code class="filename">.c</code> and the
8720: <code class="filename">.h</code> files, and a C file is compiled before its
8721: required header is generated.</p>
8722: <p>To see whether the build runs with parallel jobs, run
8723: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8724: like this:</p>
8725: <pre class="programlisting">
8726: usr MAKE_JOBS= 7
8727: pkg MAKE_JOBS_SAFE # undefined
8728: def _MAKE_JOBS_N= 7
8729: </pre>
8730: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8731: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8732: package could have disabled parallel builds by setting
8733: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8734: in this case it hasn't.</p>
8735: <p>To see whether the build failure is caused by parallel builds,
8736: first save the exact error message and a bit of context, maybe you need
8737: it later for reporting a bug. Next, run:</p>
8738: <pre class="programlisting">
8739: MAKE_JOBS_SAFE=no bmake clean build
8740: </pre>
8741: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8742: report</a> against the pkgsrc package, including the exact error
8743: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8744: </div>
1.288 rillig 8745: <div class="sect3">
8746: <div class="titlepage"><div><div><h4 class="title">
8747: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
8748: <p>Pkgsrc does not work reliably if any of
8749: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
8750: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
8751: bootstrap program prevents installing pkgsrc in symlink-based
8752: directories. Existing pkgsrc installations are not checked for symlinks
8753: though.</p>
8754: <p>The "No such file or directory" error messages are a typical
8755: symptom of symlinks, and it's quite difficult to find out that this is
8756: the actual cause.</p>
8757: </div>
8758: <div class="sect3">
8759: <div class="titlepage"><div><div><h4 class="title">
8760: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
8761: <p>When building a hierarchy of packages, it may happen that one
8762: package is built and then pkgsrc is updated. This situation can provoke
8763: various hard to diagnose build errors. To clean up the situation:</p>
8764: <pre class="programlisting">
8765: <code class="prompt">$</code> (cd ../../ && test -f mk/bsd.pkg.mk && rm -rf */*/work)
8766: </pre>
8767: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
8768: this command in the wrong directory.)</p>
8769: <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
8770: that directory as well.</p>
8771: </div>
8772: <div class="sect3">
8773: <div class="titlepage"><div><div><h4 class="title">
8774: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
8775: <p>On platforms other than BSD, third-party packages are installed in
8776: <code class="filename">/usr/include</code>, together with the base system. This
8777: means that pkgsrc cannot distinguish between headers provided by the base
8778: system (which it needs) and headers from third-party packages (which are
8779: often included in pkgsrc as well). This can lead to subtle version
8780: mismatches.</p>
8781: <p>In pkgsrc installations that have been active for several years, it
8782: may happen that some files are manually deleted. To exclude this unlikely
8783: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
8784: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
8785: check/fix dependencies.</p>
8786: <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>
8787: for contact information. Be prepared to describe what you have tried so
8788: far and what any error messages were.</p>
8789: </div>
1.287 rillig 8790: </div>
8791: <div class="sect2">
8792: <div class="titlepage"><div><div><h3 class="title">
8793: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.128 wiz 8794: </h3></div></div></div>
1.92 rillig 8795: <p>This error message often means that a package did not
1.78 rillig 8796: link to a shared library it needs. The following functions are
8797: known to cause this error message over and over.</p>
8798: <div class="informaltable">
1.216 tnn 8799: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78 rillig 8800: <colgroup>
8801: <col>
8802: <col>
8803: <col>
8804: </colgroup>
8805: <thead><tr>
8806: <th>Function</th>
8807: <th>Library</th>
8808: <th>Affected platforms</th>
8809: </tr></thead>
8810: <tbody>
8811: <tr>
8812: <td>accept, bind, connect</td>
8813: <td>-lsocket</td>
8814: <td>Solaris</td>
8815: </tr>
8816: <tr>
8817: <td>crypt</td>
8818: <td>-lcrypt</td>
8819: <td>DragonFly, NetBSD</td>
8820: </tr>
8821: <tr>
8822: <td>dlopen, dlsym</td>
8823: <td>-ldl</td>
8824: <td>Linux</td>
8825: </tr>
8826: <tr>
8827: <td>gethost*</td>
8828: <td>-lnsl</td>
8829: <td>Solaris</td>
8830: </tr>
8831: <tr>
8832: <td>inet_aton</td>
8833: <td>-lresolv</td>
8834: <td>Solaris</td>
8835: </tr>
8836: <tr>
8837: <td>nanosleep, sem_*, timer_*</td>
8838: <td>-lrt</td>
8839: <td>Solaris</td>
8840: </tr>
8841: <tr>
8842: <td>openpty</td>
8843: <td>-lutil</td>
8844: <td>Linux</td>
8845: </tr>
8846: </tbody>
8847: </table>
8848: </div>
8849: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8850: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8851: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8852: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8853: bmake</strong></span>.</p>
1.148 asau 8854: <div class="sect3">
1.92 rillig 8855: <div class="titlepage"><div><div><h4 class="title">
1.287 rillig 8856: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8857: <p>When you are using the SunPro compiler, there is another
8858: possibility. That compiler cannot handle the following code:</p>
8859: <pre class="programlisting">
1.100 rillig 8860: extern int extern_func(int);
1.93 rillig 8861:
1.100 rillig 8862: static inline int
8863: inline_func(int x)
8864: {
1.92 rillig 8865: return extern_func(x);
1.100 rillig 8866: }
1.93 rillig 8867:
1.100 rillig 8868: int main(void)
8869: {
1.92 rillig 8870: return 0;
1.100 rillig 8871: }
1.92 rillig 8872: </pre>
8873: <p>It generates the code for <code class="function">inline_func</code> even if
8874: that function is never used. This code then refers to
8875: <code class="function">extern_func</code>, which can usually not be resolved. To
8876: solve this problem you can try to tell the package to disable inlining
8877: of functions.</p>
8878: </div>
1.87 wiz 8879: </div>
1.148 asau 8880: <div class="sect2">
1.87 wiz 8881: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 8882: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87 wiz 8883: <p>Sometimes packages fail to build because the compiler runs
8884: into an operating system specific soft limit. With the
8885: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204 wiz 8886: to unlimit the resources. Currently, the allowed values are any combination of
8887: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8888: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.87 wiz 8889: Setting this variable is similar to running the shell builtin
1.110 hubertf 8890: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8891: segment size or maximum stack size of a process, respectively, to
8892: their hard limits.</p>
1.78 rillig 8893: </div>
1.75 rillig 8894: </div>
1.148 asau 8895: <div class="sect1">
1.75 rillig 8896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8897: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 8898: <div class="sect2">
1.75 rillig 8899: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8900: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8901: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8902: with some operating systems cannot create more than one
8903: directory at a time. As such, you should call
8904: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8905: <pre class="programlisting">
1.100 rillig 8906: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8907: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222 sevan 8908: </pre>
1.128 wiz 8909: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8910: dir2</code></span>”</span> to the
1.87 wiz 8911: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8912: automatically do the right thing.</p>
1.75 rillig 8913: </div>
1.148 asau 8914: <div class="sect2">
1.75 rillig 8915: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8916: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8917: <p>In general, documentation should be installed into
1.87 wiz 8918: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8919: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8920: includes the version number of the package).</p>
1.84 wiz 8921: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8922: directory where HTML documentation is installed with the
1.128 wiz 8923: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8924: is needed because otherwise the documentation ends up in
8925: <code class="filename">${PREFIX}/share/doc/html</code> or other
8926: places.</p>
8927: <p>An exception to the above is that library API documentation
1.250 leot 8928: 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 8929: browsers (devhelp) should be left at their default location, which
8930: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8931: documentation can be recognized from files ending in
8932: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8933: (It is also acceptable to install such files in
8934: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8935: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8936: <code class="filename">.devhelp*</code> file must be directly in that
8937: directory then, no additional subdirectory level is allowed in
8938: this case. This is usually achieved by using
1.128 wiz 8939: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8940: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8941: though.)</p>
1.75 rillig 8942: </div>
1.148 asau 8943: <div class="sect2">
1.75 rillig 8944: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8945: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8946: <p>Certain packages, most of them in the games category, install
1.87 wiz 8947: a score file that allows all users on the system to record their
8948: highscores. In order for this to work, the binaries need to be
8949: installed setgid and the score files owned by the appropriate
1.142 wiz 8950: group and/or owner (traditionally the "games" user/group). Set
8951: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8952: following variables, documented in more detail in
8953: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 8954: behaviour: <code class="varname">GAMEDATAMODE</code>,
8955: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210 leot 8956: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8957: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8958: <code class="varname">GAMEDATA_PERMS</code> and
8959: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8960: <p>An example that illustrates some of the variables described above is
8961: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8962: used to properly set directory permissions of the directory where the
8963: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8964: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8965: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8966: binary:</p>
8967: <pre class="programlisting">
1.223 rillig 8968: USE_GAMESGROUP= yes
1.210 leot 8969:
1.223 rillig 8970: BUILD_DEFS+= VARBASE
1.210 leot 8971:
1.223 rillig 8972: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8973: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8974: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222 sevan 8975: </pre>
1.210 leot 8976: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8977: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8978: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8979: needed to be accessed by setgid games and
8980: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114 jmcneill 8981: <p>A package should therefore never hard code file ownership or
1.210 leot 8982: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8983: or alternatively on <code class="varname">INSTALL_GAME</code>,
8984: <code class="varname">INSTALL_GAME_DATA</code> and
8985: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75 rillig 8986: </div>
1.148 asau 8987: <div class="sect2">
1.75 rillig 8988: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8989: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8990: <p><code class="varname">DESTDIR</code> support means that a package
8991: installs into a staging directory, not the final location of the
8992: files. Then a binary package is created which can be used for
8993: installation as usual. There are two ways: Either the package must
1.128 wiz 8994: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8995: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 8996: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8997: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224 leot 8998: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8999: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145 wiz 9000: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9001: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 9002: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9003: the inclusion.</p></li>
1.128 wiz 9004: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 9005: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 9006: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 9007: automatically. Many manual rules and pre/post-install often are
9008: incorrect; fix them.</p></li>
1.128 wiz 9009: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 9010: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 9011: <li class="listitem"><p>In general, packages should support
1.103 wiz 9012: <code class="varname">UNPRIVILEGED</code> to be able to use
9013: DESTDIR.</p></li>
9014: </ul></div>
9015: </div>
1.148 asau 9016: <div class="sect2">
1.103 wiz 9017: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9018: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 9019: <p>Your package may also contain scripts with hardcoded paths to
1.318 nia 9020: other interpreters besides (or as well as) Perl. To correct the
1.87 wiz 9021: full pathname to the script interpreter, you need to set the
9022: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 9023: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 9024: <pre class="programlisting">
1.100 rillig 9025: REPLACE_INTERPRETER+= tcl
9026: REPLACE.tcl.old= .*/bin/tclsh
9027: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9028: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9029: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222 sevan 9030: </pre>
1.148 asau 9031: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9032: <h3 class="title">Note</h3>
9033: <p>Before March 2006, these variables were called
1.87 wiz 9034: <code class="varname">_REPLACE.*</code> and
9035: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 9036: </div>
9037: </div>
1.148 asau 9038: <div class="sect2">
1.75 rillig 9039: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9040: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.75 rillig 9041: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 9042: the Makefile fragment
9043: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 9044: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 9045: configuration for such modules as well as various hooks to tune
9046: this configuration. See comments in this file for
9047: details.</p>
1.75 rillig 9048: <p>Perl5 modules will install into different places depending
1.87 wiz 9049: on the version of perl used during the build process. To
9050: address this, pkgsrc will append lines to the
9051: <code class="filename">PLIST</code> corresponding to the files listed in
9052: the installed <code class="filename">.packlist</code> file generated by
9053: most perl5 modules. This is invoked by defining
9054: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 9055: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9056: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9057: e.g.:</p>
1.75 rillig 9058: <pre class="programlisting">
1.153 wiz 9059: PERL5_PACKLIST= auto/Pg/.packlist
1.222 sevan 9060: </pre>
1.153 wiz 9061: <p>The perl5 config variables
9062: <code class="varname">installarchlib</code>,
9063: <code class="varname">installscript</code>,
9064: <code class="varname">installvendorbin</code>,
9065: <code class="varname">installvendorscript</code>,
9066: <code class="varname">installvendorarch</code>,
9067: <code class="varname">installvendorlib</code>,
9068: <code class="varname">installvendorman1dir</code>, and
9069: <code class="varname">installvendorman3dir</code> represent those
9070: locations in which components of perl5 modules may be installed,
9071: provided as variable with uppercase and prefixed with
9072: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9073: and may be used by perl5 packages that don't have a packlist.
9074: These variables are also substituted for in the
9075: <code class="filename">PLIST</code> as uppercase prefixed with
9076: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 9077: </div>
1.148 asau 9078: <div class="sect2">
1.75 rillig 9079: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9080: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 9081: <p>Some packages install info files or use the
1.128 wiz 9082: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 9083: commands. <code class="varname">INFO_FILES</code> should be defined in
9084: the package Makefile so that <code class="filename">INSTALL</code> and
9085: <code class="filename">DEINSTALL</code> scripts will be generated to
9086: handle registration of the info files in the Info directory
1.128 wiz 9087: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 9088: files registration is either provided by the system, or by a
9089: special purpose package automatically added as dependency if
9090: needed.</p>
1.75 rillig 9091: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 9092: <code class="filename">${PREFIX}</code> where info files are primarily
9093: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 9094: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 9095: <p>The info files for the package should be listed in the
1.87 wiz 9096: package <code class="filename">PLIST</code>; however any split info files
9097: need not be listed.</p>
1.128 wiz 9098: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9099: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 9100: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 9101: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 9102: should be noted with the <code class="varname">TEXINFO_REQD</code>
9103: variable in the package <code class="filename">Makefile</code>. By
9104: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 9105: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 9106: does not match the required minimum, a build dependency on the
1.250 leot 9107: <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 9108: be added automatically.</p>
1.75 rillig 9109: <p>The build and installation process of the software provided
1.87 wiz 9110: by the package should not use the
1.110 hubertf 9111: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 9112: info files is the task of the package
9113: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 9114: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 9115: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 9116: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9117: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 9118: in <code class="varname">PATH</code>.</p>
1.110 hubertf 9119: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 9120: no effect except the logging of a message. The script overriding
1.110 hubertf 9121: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 9122: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 9123: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 9124: </div>
1.148 asau 9125: <div class="sect2">
1.75 rillig 9126: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9127: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 9128: <p>All packages that install manual pages should install them
1.87 wiz 9129: into the same directory, so that there is one common place to look
9130: for them. In pkgsrc, this place is
9131: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9132: should be used in packages. The default for
9133: <code class="varname">PKGMANDIR</code> is
1.128 wiz 9134: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9135: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 9136: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9137: <h3 class="title">Note</h3>
1.87 wiz 9138: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9139: is far from complete.</p>
1.75 rillig 9140: </div>
1.81 rillig 9141: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 9142: <code class="filename">man/</code> as the top level directory for the man
9143: page file entries, and the pkgsrc framework will convert as
9144: needed. In all other places, the correct
9145: <code class="varname">PKGMANDIR</code> must be used.</p>
9146: <p>Packages that are
9147: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 9148: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 9149: <code class="filename">./configure</code>
9150: --mandir switch to set where the man pages should be installed.
9151: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9152: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9153: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9154: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 9155: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 9156: Or if the <code class="filename">./configure</code> script uses
9157: a non-standard use of --mandir, you can set
9158: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299 rillig 9159: <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 9160: information on installation of compressed manual pages.</p>
1.75 rillig 9161: </div>
1.148 asau 9162: <div class="sect2">
1.75 rillig 9163: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9164: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9165: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9166: the fonts database in the directory where they get installed at
9167: installation and deinstallation time. This can be automatically
9168: done by using the pkginstall framework.</p>
1.75 rillig 9169: <p>You can list the directories where fonts are installed in the
1.87 wiz 9170: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9171: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 9172: <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 9173: Also make sure that the database file
9174: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9175: <p>Note that you should not create new directories for fonts;
1.87 wiz 9176: instead use the standard ones to avoid that the user needs to
9177: manually configure his X server to find them.</p>
1.75 rillig 9178: </div>
1.148 asau 9179: <div class="sect2">
1.75 rillig 9180: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9181: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9182: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9183: registered in system-wide catalogs (like DTDs, sub-catalogs,
9184: etc.), you need to take some extra steps:</p>
1.128 wiz 9185: <div class="orderedlist"><ol class="orderedlist" type="1">
9186: <li class="listitem"><p>Include
1.87 wiz 9187: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9188: your <code class="filename">Makefile</code>, which takes care of
9189: registering those files in system-wide catalogs at
9190: installation and deinstallation time.</p></li>
1.128 wiz 9191: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9192: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9193: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9194: any XML catalogs installed by the package.</p></li>
1.128 wiz 9195: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9196: to be added to the SGML catalog. These come in groups of
9197: three strings; see xmlcatmgr(1) for more information
9198: (specifically, arguments recognized by the 'add' action).
9199: Note that you will normally not use this variable.</p></li>
1.128 wiz 9200: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9201: to be added to the XML catalog. These come in groups of three
9202: strings; see xmlcatmgr(1) for more information (specifically,
9203: arguments recognized by the 'add' action). Note that you will
9204: normally not use this variable.</p></li>
1.75 rillig 9205: </ol></div>
9206: </div>
1.148 asau 9207: <div class="sect2">
1.75 rillig 9208: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9209: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9210: <p>If a package provides extensions to the MIME database by
1.87 wiz 9211: installing <code class="filename">.xml</code> files inside
9212: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9213: need to take some extra steps to ensure that the database is kept
9214: consistent with respect to these new files:</p>
1.128 wiz 9215: <div class="orderedlist"><ol class="orderedlist" type="1">
9216: <li class="listitem"><p>Include
1.87 wiz 9217: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9218: (avoid using the <code class="filename">buildlink3.mk</code> file from
9219: this same directory, which is reserved for inclusion from
9220: other <code class="filename">buildlink3.mk</code> files). It takes
9221: care of rebuilding the MIME database at installation and
9222: deinstallation time, and disallows any access to it directly
9223: from the package.</p></li>
1.128 wiz 9224: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9225: <code class="filename">share/mime</code> directory,
9226: <span class="emphasis"><em>except</em></span> for files saved under
9227: <code class="filename">share/mime/packages</code>. The former are
9228: handled automatically by
9229: the update-mime-database program, but the latter are
9230: package-dependent and must be removed by the package that
9231: installed them in the first place.</p></li>
1.128 wiz 9232: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9233: from the PLIST. They will be handled by the shared-mime-info
9234: package.</p></li>
1.75 rillig 9235: </ol></div>
9236: </div>
1.148 asau 9237: <div class="sect2">
1.75 rillig 9238: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9239: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.93 rillig 9240: <p>If a package uses intltool during its build, add
9241: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9242: which forces it to use the intltool package provided by pkgsrc,
9243: instead of the one bundled with the distribution file.</p>
1.75 rillig 9244: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9245: latest available version; this way, the package benefits of any
9246: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9247: </div>
1.148 asau 9248: <div class="sect2">
1.75 rillig 9249: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9250: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9251: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9252: the startup directory by default, but you can enable it, by adding
9253: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9254: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9255: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9256: it will automatically remove the scripts when the package is
9257: deinstalled.</p>
1.75 rillig 9258: </div>
1.148 asau 9259: <div class="sect2">
1.75 rillig 9260: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9261: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9262: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9263: the <code class="filename">ls-R</code> database of the tree needs to be
9264: updated.</p>
1.148 asau 9265: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9266: <h3 class="title">Note</h3>
1.125 wiz 9267: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9268: packages should install files
1.125 wiz 9269: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9270: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9271: </div>
1.128 wiz 9272: <div class="orderedlist"><ol class="orderedlist" type="1">
9273: <li class="listitem"><p>Include
1.125 wiz 9274: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9275: takes care of rebuilding the <code class="filename">ls-R</code>
9276: database at installation and deinstallation time.</p></li>
1.128 wiz 9277: <li class="listitem">
1.75 rillig 9278: <p>If your package installs files into a texmf
1.87 wiz 9279: tree other than the one
1.125 wiz 9280: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9281: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9282: trees that need database update.</p>
1.75 rillig 9283: <p>If your package also installs font map files that need
1.110 hubertf 9284: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9285: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9286: set <code class="varname">TEX_MAP_FILES</code> and/or
9287: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9288: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9289: be run automatically at installation/deinstallation to
9290: enable/disable font map files for TeX output
9291: drivers.</p>
1.75 rillig 9292: </li>
1.128 wiz 9293: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9294: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9295: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9296: </ol></div>
9297: </div>
1.148 asau 9298: <div class="sect2">
1.85 jmmv 9299: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9300: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.87 wiz 9301: emulation</h3></div></div></div>
9302: <p>There are some packages that provide libraries and
9303: executables for running binaries from a one operating system
9304: on a different one (if the latter supports it). One example
9305: is running Linux binaries on NetBSD.</p>
1.250 leot 9306: <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 9307: helps in extracting and packaging Linux rpm packages.</p>
9308: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9309: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9310: if all libraries for each installed executable can be found by
9311: the dynamic linker. Since the standard dynamic linker is run,
9312: this fails for emulation packages, because the libraries used
9313: by the emulation are not in the standard directories.</p>
9314: </div>
1.299 rillig 9315: <div class="sect2">
9316: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9317: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.299 rillig 9318: <p>If a package installs images under the
9319: <code class="filename">share/icons/hicolor</code> and/or updates the
9320: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9321: database, you need to take some extra steps to make sure that the
9322: shared theme directory is handled appropriately and that the cache
9323: database is rebuilt:</p>
9324: <div class="orderedlist"><ol class="orderedlist" type="1">
9325: <li class="listitem"><p>Include
9326: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9327: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9328: entry that refers to the theme cache.</p></li>
9329: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9330: directories from the <code class="filename">share/icons/hicolor</code>
9331: hierarchy because they will be handled automatically.</p></li>
9332: </ol></div>
9333: <p>The best way to verify that the PLIST is correct with
9334: respect to the last two points is to regenerate it using
9335: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9336: </div>
9337: <div class="sect2">
9338: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9339: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.299 rillig 9340: <p>If a package installs <code class="filename">.desktop</code> files
9341: under <code class="filename">share/applications</code> and these include
9342: MIME information (MimeType key), you need to take extra steps to
9343: ensure that they are registered into the MIME database:</p>
9344: <div class="orderedlist"><ol class="orderedlist" type="1">
9345: <li class="listitem"><p>Include
9346: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9347: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9348: <code class="filename">share/applications/mimeinfo.cache</code> file.
9349: It will be handled automatically.</p></li>
9350: </ol></div>
9351: <p>The best way to verify that the PLIST is correct with
9352: respect to the last point is to regenerate it using <span class="command"><strong>make
9353: print-PLIST</strong></span>.</p>
9354: </div>
9355: </div>
9356: <div class="sect1">
9357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9358: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9359: <p>In some cases one does not have the time to solve a problem
9360: immediately. In this case, one can plainly mark a package as broken. For
9361: this, one just sets the variable <code class="varname">BROKEN</code> to the
9362: reason why the package is broken (similar to the
9363: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9364: the package will immediately be shown this message, and the build
9365: will not be even tried.</p>
9366: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9367: intervals.</p>
9368: </div>
9369: </div>
9370: <div class="chapter">
9371: <div class="titlepage"><div><div><h2 class="title">
9372: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9373: <div class="toc">
9374: <p><b>Table of Contents</b></p>
9375: <dl class="toc">
9376: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9377: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9378: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9379: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9380: </dl>
9381: </div>
9382: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9383: site</a>:</p>
9384: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9385: environment, an intuitive and attractive desktop for users, and the
9386: GNOME development platform, an extensive framework for building
9387: applications that integrate into the rest of the desktop.</p></blockquote></div>
9388: <p>pkgsrc provides a seamless way to automatically build and install
9389: a complete GNOME environment <span class="emphasis"><em>under many different
9390: platforms</em></span>. We can say with confidence that pkgsrc is one of
9391: the most advanced build and packaging systems for GNOME due to its
9392: included technologies buildlink3, the wrappers and tools framework and
9393: automatic configuration file management. Lots of efforts are put into
9394: achieving a completely clean deinstallation of installed software
9395: components.</p>
9396: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9397: the above also means that great efforts are put into making GNOME work
1.316 cirnatda 9398: under this operating system.</p>
1.299 rillig 9399: <p>This chapter is aimed at pkgsrc developers and other people
9400: interested in helping our GNOME porting and packaging efforts. It
9401: provides instructions on how to manage the existing packages and some
9402: important information regarding their internals.</p>
9403: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9404: <h3 class="title">We need your help!</h3>
9405: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9406: and GNOME and are willing to learn new exciting stuff, please jump
9407: straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9408: work</a> list! There is still a long way to go to get a
9409: fully-functional GNOME desktop under NetBSD and we need your help to
9410: achieve it!</p>
9411: </div>
9412: <div class="sect1">
9413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9414: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9415: <p>pkgsrc includes three GNOME-related meta packages:</p>
9416: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9417: <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
9418: the core GNOME desktop environment. It only includes the necessary
9419: bits to get it to boot correctly, although it may lack important
9420: functionality for daily operation. The idea behind this package is
9421: to let end users build their own configurations on top of this one,
9422: first installing this meta package to achieve a functional setup and
9423: then adding individual applications.</p></li>
9424: <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
9425: complete installation of the GNOME platform and desktop as defined
9426: by the GNOME project; this is based on the components distributed in
9427: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9428: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9429: official FTP server. Developer-only tools found in those
9430: directories are not installed unless required by some other
9431: component to work properly. Similarly, packages from the bindings
9432: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9433: in unless required as a dependency for an end-user component. This
9434: 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>
9435: <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>:
9436: Installs all the tools required to build a GNOME component when
9437: fetched from the CVS repository. These are required to let the
9438: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9439: </ul></div>
9440: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9441: sorted in a way that eases updates: a package may depend on other
9442: packages listed before it but not on any listed after it. It is very
9443: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9444: change it to alphabetical sorting!</em></span></p>
9445: </div>
9446: <div class="sect1">
9447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9448: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9449: <p>Almost all GNOME applications are written in C and use a common
9450: set of tools as their build system. Things get different with the new
9451: bindings to other languages (such as Python), but the following will
9452: give you a general idea on the minimum required tools:</p>
9453: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9454: <li class="listitem">
9455: <p>Almost all GNOME applications use the GNU Autotools as their
9456: build system. As a general rule you will need to tell this to your
9457: package:</p>
9458: <pre class="programlisting">
9459: GNU_CONFIGURE=yes
9460: USE_LIBTOOL=yes
9461: USE_TOOLS+=gmake
9462: </pre>
9463: </li>
9464: <li class="listitem">
9465: <p>If the package uses pkg-config to detect dependencies, add this
9466: tool to the list of required utilities:</p>
9467: <pre class="programlisting">
9468: USE_TOOLS+=pkg-config
9469: </pre>
9470: <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
9471: the end of the build process to ensure that you did not miss to
9472: specify any dependency in your package and that the version
9473: requirements are all correct.</p>
9474: </li>
9475: <li class="listitem"><p>If the package uses intltool, be sure to add
9476: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9477: to handle dependencies and to force the package to use the latest
9478: available version.</p></li>
9479: <li class="listitem">
9480: <p>If the package uses gtk-doc (a documentation generation
9481: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9482: tool is rather big and the distfile should come with pregenerated
9483: documentation anyway; if it does not, it is a bug that you ought to
9484: report. For such packages you should disable gtk-doc (unless it is
9485: the default):</p>
9486: <pre class="programlisting">
9487: CONFIGURE_ARGS+=--disable-gtk-doc
9488: </pre>
9489: <p>The default location of installed HTML files
9490: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9491: and should not be changed unless the package insists on installing
9492: them somewhere else. Otherwise programs as
9493: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9494: do that with an entry similar to:</p>
9495: <pre class="programlisting">
9496: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9497: </pre>
9498: </li>
9499: </ul></div>
9500: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9501: files under the installation prefix to maintain databases. In this
9502: context, shared means that those exact same directories and files are
9503: used among several different packages, leading to conflicts in the
9504: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9505: handle the most common cases, so you have to forget about using
9506: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9507: omitting shared files from them. If you find yourself doing those,
9508: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9509: <p>The following table lists the common situations that result in
9510: using shared directories or files. For each of them, the appropriate
9511: solution is given. After applying the solution be sure to
9512: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9513: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9514: <div class="table">
9515: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9516: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9517: <colgroup>
9518: <col>
9519: <col>
9520: </colgroup>
9521: <thead><tr>
9522: <th>If the package...</th>
9523: <th>Then...</th>
9524: </tr></thead>
9525: <tbody>
9526: <tr>
9527: <td>Installs icons under the
9528: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9529: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.318 nia 9530: <td>See <a class="xref" href="#hicolor-theme" title="21.6.16. Packages installing hicolor icons">Section 21.6.16, “Packages installing hicolor icons”</a>.</td>
1.299 rillig 9531: </tr>
9532: <tr>
9533: <td>Installs files under
9534: <code class="filename">share/mime/packages</code>.</td>
1.318 nia 9535: <td>See <a class="xref" href="#mime-database" title="21.6.11. Packages installing extensions to the MIME database">Section 21.6.11, “Packages installing extensions to the MIME database”</a>.</td>
1.299 rillig 9536: </tr>
9537: <tr>
9538: <td>Installs <code class="filename">.desktop</code> files under
9539: <code class="filename">share/applications</code> and these include MIME
9540: information.</td>
1.318 nia 9541: <td>See <a class="xref" href="#desktop-files" title="21.6.17. Packages installing desktop files">Section 21.6.17, “Packages installing desktop files”</a>.</td>
1.299 rillig 9542: </tr>
9543: </tbody>
9544: </table></div>
1.75 rillig 9545: </div>
1.299 rillig 9546: <br class="table-break">
1.75 rillig 9547: </div>
1.148 asau 9548: <div class="sect1">
1.87 wiz 9549: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 9550: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9551: <p>When seeing GNOME as a whole, there are two kinds of
9552: updates:</p>
9553: <div class="variablelist"><dl class="variablelist">
9554: <dt><span class="term">Major update</span></dt>
9555: <dd>
9556: <p>Given that there is still a very long way for GNOME 3 (if it
9557: ever appears), we consider a major update one that goes from a
9558: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9559: where <code class="literal">Y</code> is even and greater than
9560: <code class="literal">X</code>. These are hard to achieve because they
9561: introduce lots of changes in the components' code and almost all
9562: GNOME distfiles are updated to newer versions. Some of them can
9563: even break API and ABI compatibility with the previous major
9564: version series. As a result, the update needs to be done all at
9565: once to minimize breakage.</p>
9566: <p>A major update typically consists of around 80 package
9567: updates and the addition of some new ones.</p>
9568: </dd>
9569: <dt><span class="term">Minor update</span></dt>
9570: <dd>
9571: <p>We consider a minor update one that goes from a
9572: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9573: one where <code class="literal">Y</code> is greater than
9574: <code class="literal">X</code>. These are easy to achieve because they do
9575: not update all GNOME components, can be done in an incremental way
9576: and do not break API nor ABI compatibility.</p>
9577: <p>A minor update typically consists of around 50 package
9578: updates, although the numbers here may vary a lot.</p>
9579: </dd>
9580: </dl></div>
9581: <p>In order to update the GNOME components in pkgsrc to a new stable
9582: release (either major or minor), the following steps should be
9583: followed:</p>
9584: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128 wiz 9585: <li class="listitem">
1.299 rillig 9586: <p>Get a list of all the tarballs that form the new release by
9587: using the following commands. These will leave the full list of the
9588: components' distfiles into the <code class="filename">list.txt</code>
9589: file:</p>
9590: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9591: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9592: awk '{ print $9 }' >list.txt</code></strong>
9593: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9594: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9595: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.75 rillig 9596: </li>
1.299 rillig 9597: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9598: bump their version to the release you are updating them to. The
9599: three meta packages should be always consistent with versioning.
9600: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9601: in them.</p></li>
1.128 wiz 9602: <li class="listitem">
1.299 rillig 9603: <p>For each meta package, update all its
9604: <code class="varname">DEPENDS</code> lines to match the latest versions as
9605: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9606: newer version (even if found in the FTP) because the meta packages
9607: are supposed to list the exact versions that form a specific GNOME
9608: release. Exceptions are permitted here if a newer version solves a
9609: serious issue in the overall desktop experience; these typically
9610: come in the form of a revision bump in pkgsrc, not in newer versions
9611: from the developers.</p>
9612: <p>Packages not listed in the <code class="filename">list.txt</code> file
9613: should be updated to the latest version available (if found in
9614: pkgsrc). This is the case, for example, of the dependencies on the
9615: 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 9616: </li>
1.128 wiz 9617: <li class="listitem">
1.299 rillig 9618: <p>Generate a patch from the modified meta packages and extract the
9619: list of "new" lines. This will provide you an outline on what
9620: packages need to be updated in pkgsrc and in what order:</p>
9621: <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 9622: </li>
1.299 rillig 9623: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9624: installed packages and start over from scratch at this point.</p></li>
9625: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9626: of <code class="filename">todo.txt</code> and update the packages listed in
9627: it in order. For major desktop updates none of these should be
9628: committed until the entire set is completed because there are chances
9629: of breaking not-yet-updated packages.</p></li>
9630: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9631: the tree one by one with appropriate log messages. At the end,
9632: commit the three meta package updates and all the corresponding
9633: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9634: <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>
9635: </ol></div>
9636: </div>
9637: <div class="sect1">
9638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9639: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9640: <p>GNOME is a very big component in pkgsrc which approaches 100
9641: packages. Please, it is very important that you always, always,
9642: <span class="strong"><strong>always</strong></span> feed back any portability
9643: 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
9644: their attention on portability issues and to ensure that future versions
9645: can be built out-of-the box on NetBSD. The less custom patches in
9646: pkgsrc, the easier further updates are. Those developers in charge of
9647: issuing major GNOME updates will be grateful if you do that.</p>
1.315 cirnatda 9648: <p>The most common places to report bugs are the <a class="ulink" href="https://gitlab.gnome.org/GNOME" target="_top">GNOME's GitLab</a> and the <a class="ulink" href="https://gitlab.freedesktop.org/explore/groups" target="_top">freedesktop.org's
9649: GitLab</a>. Not all components use these to track bugs, but most
1.299 rillig 9650: of them do. Do not be short on your reports: always provide detailed
9651: explanations of the current failure, how it can be improved to achieve
1.315 cirnatda 9652: maximum portability and, if at all possible, provide a patch against the
9653: main Git branch. The more verbose you are, the higher chances of your
9654: patch being accepted.</p>
1.299 rillig 9655: <p>Also, please avoid using preprocessor magic to fix portability
9656: issues. While the FreeBSD GNOME people are doing a great job in porting
9657: GNOME to their operating system, the official GNOME sources are now
9658: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9659: and similar macros. This hurts portability. Please see our patching
9660: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9661: details.</p>
9662: </div>
1.75 rillig 9663: </div>
1.148 asau 9664: <div class="chapter">
1.75 rillig 9665: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9666: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75 rillig 9667: <div class="toc">
9668: <p><b>Table of Contents</b></p>
1.210 leot 9669: <dl class="toc">
1.267 rillig 9670: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9671: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9672: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9673: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9674: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9675: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9676: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9677: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9678: </dl>
9679: </div>
1.148 asau 9680: <div class="sect1">
1.75 rillig 9681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9682: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9683: <p>Our policy is that we accept binaries only from pkgsrc
9684: developers to guarantee that the packages don't contain any
9685: trojan horses etc. This is not to annoy anyone but rather to
9686: protect our users! You're still free to put up your home-made
9687: binary packages and tell the world where to get them. NetBSD
9688: developers doing bulk builds and wanting to upload them please
1.267 rillig 9689: 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 9690: builds)</i></a>.</p>
1.75 rillig 9691: </div>
1.148 asau 9692: <div class="sect1">
1.75 rillig 9693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9694: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9695: <p>First, check that your package is complete, compiles and
1.299 rillig 9696: 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 9697: 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 9698: archive that contains all files that make up the package.
1.87 wiz 9699: Finally, send this package to the pkgsrc bug tracking system,
1.311 leot 9700: 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 9701: that, go to the web page
1.289 leot 9702: <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 9703: which contains some instructions and a link to a form where you
9704: can submit packages. The
1.250 leot 9705: <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 9706: also available as a substitute for either of the above two tools.
9707: </p>
1.87 wiz 9708: <p>In the form of the problem report, the category should be
1.128 wiz 9709: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9710: and version number, and the description field should contain a
9711: short description of your package (contents of the COMMENT
9712: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9713: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9714: <p>If you want to submit several packages, please send a
9715: separate PR for each one, it's easier for us to track things
9716: that way.</p>
9717: <p>Alternatively, you can also import new packages into
1.128 wiz 9718: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.289 leot 9719: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
1.75 rillig 9720: for details.</p>
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="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9725: <p>Please note all package additions, updates, moves, and
1.93 rillig 9726: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9727: important to keep this file up to date and conforming to the
9728: existing format, because it will be used by scripts to
1.289 leot 9729: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9730: sites. Additionally, check the
1.76 rillig 9731: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9732: for the package you updated or removed, in case it was mentioned
9733: there.</p>
9734: <p>When the <code class="varname">PKGREVISION</code> of a package is
9735: bumped, the change should appear in
1.93 rillig 9736: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9737: related or otherwise relevant. Mass bumps that result from a
9738: dependency being updated should not be mentioned. In all other
9739: cases it's the developer's decision.</p>
9740: <p>There is a make target that helps in creating proper
1.110 hubertf 9741: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9742: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9743: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9744: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9745: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9746: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9747: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9748: For new packages, or package moves or removals, set the
9749: <code class="varname">CTYPE</code> variable on the command line to "Added",
9750: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9751: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9752: not the same as your NetBSD login name. The target also automatically
9753: removes possibly existing entries for the package in the
9754: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9755: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9756: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9757: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9758: makes the cvs commands use the main repository.
9759: </p>
1.75 rillig 9760: </div>
1.148 asau 9761: <div class="sect1">
1.75 rillig 9762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9763: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243 wiz 9764: <p>For several years, there have been mirrors of pkgsrc in
9765: fossil, git, and hg. Standard practise when using these tools is to
9766: make the first line of a commit message function as a summary that
9767: can be read without the rest, such as is commonly done with "git log
9768: --oneline". For this reason, we have the following guidelines for
9769: pkgsrc commit messages:</p>
9770: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9771: <li class="listitem"><p>Start the commit message with a line that explains the
1.244 wiz 9772: big picture in 65 characters or less. When a commit is for one
1.243 wiz 9773: package, include the name of the package. For updates, include the
9774: version to which it is updated.</p></li>
9775: <li class="listitem"><p>Leave the next line empty.</p></li>
9776: <li class="listitem"><p>Then come the details for the commit (changes in that
9777: package, reason for a change) and any relevant PRs. Wrap this
9778: section.</p></li>
9779: </ul></div>
9780: <p>Here is an example:
9781: </p>
9782: <pre class="programlisting">
9783: libxslt: update to 1.0.30
9784:
9785: Changes since 1.0.29:
9786: ...
9787: </pre>
9788: <p>
9789: </p>
9790: <p>Here is another example:
9791: </p>
9792: <pre class="programlisting">
9793: mk/bsd.pkg.mk: enable SSP by default on NetBSD
9794:
9795: (rationale)
9796: </pre>
9797: <p>
9798: </p>
9799: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
9800: allowed on the pkgsrc repository to change commit messages.</p>
9801: </div>
9802: <div class="sect1">
9803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9804: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9805: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9806: access to the pkgsrc repository.</p>
9807: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9808: Start by adding the directory and then files in the directory. Don't
9809: forget to add the new package to the category's
9810: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9811: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9812: <pre class="programlisting">
9813: <code class="prompt">$</code> cd .../pkgsrc/category
9814: <code class="prompt">$</code> cvs add pkgname
9815: <code class="prompt">$</code> cd pkgname
9816: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9817: <code class="prompt">$</code> cvs add patches/p*
9818: <code class="prompt">$</code> cvs status | less
1.141 wiz 9819: <code class="prompt">$</code> cvs commit
1.140 wiz 9820: <code class="prompt">$</code> cd ..
9821: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9822: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 9823: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 9824: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 9825: </pre>
1.87 wiz 9826: <p>The commit message of the initial import should include part of the
1.76 rillig 9827: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9828: what the package is/does.</p>
1.140 wiz 9829: <p>Also mention the new package in
9830: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9831: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9832: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9833: </div>
1.148 asau 9834: <div class="sect1">
1.75 rillig 9835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9836: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9837: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9838: changes between old and new versions into the commit log when updating
1.87 wiz 9839: a package. There are various reasons for this:</p>
1.148 asau 9840: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9841: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9842: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9843: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9844: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9845: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9846: repository is very useful for people who read the pkgsrc-changes mailing
9847: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9848: the package.</p></li>
1.75 rillig 9849: </ul></div>
1.87 wiz 9850: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9851: has been released, it should not automatically be upgraded in the CVS
9852: repository. We prefer to be conservative in the packages that are
9853: included in pkgsrc - development or beta packages are not really the
9854: best thing for most places in which pkgsrc is used. Please use your
9855: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9856: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9857: </div>
1.148 asau 9858: <div class="sect1">
1.75 rillig 9859: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9860: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122 reed 9861: <p>Renaming packages is not recommended.</p>
1.290 gutterid 9862: <p>When renaming packages, be sure to fix any references to the old name
1.122 reed 9863: in other Makefiles, options, buildlink files, etc.</p>
1.282 leot 9864: <p>
1.290 gutterid 9865: Also, when renaming a package, please add
1.282 leot 9866: the package name and version pattern(s) of the previous package
9867: to <code class="varname">SUPERSEDES</code>.
1.122 reed 9868: This may be repeated for multiple renames.
9869: The new package would be an exact replacement.
1.282 leot 9870: Example:
1.122 reed 9871: </p>
1.282 leot 9872: <pre class="programlisting">
9873: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
9874: SUPERSEDES+= optcomp-[0-9]*
9875: </pre>
1.128 wiz 9876: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9877: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9878: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9879: not be an exact replacement but is a suggestion for the replaced
9880: functionality.</p>
9881: </div>
1.148 asau 9882: <div class="sect1">
1.122 reed 9883: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9884: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122 reed 9885: <p>It is preferred that packages are not renamed or moved, but if needed
9886: please follow these steps.
9887: </p>
1.128 wiz 9888: <div class="orderedlist"><ol class="orderedlist" type="1">
9889: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9890: <li class="listitem">
1.75 rillig 9891: <p>Remove all CVS dirs.</p>
1.87 wiz 9892: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9893: <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 9894: <p>and use that for further work.</p>
1.75 rillig 9895: </li>
1.128 wiz 9896: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9897: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9898: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9899: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9900: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9901: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9902: for doing an update using pkgsrc building; for example, it can
1.311 leot 9903: 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 9904: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9905: new <code class="varname">PKGPATH</code> for that moved package. Note that
9906: it may have multiple matches, so the tool should also check on the
9907: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9908: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9909: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9910: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9911: place.</p></li>
1.128 wiz 9912: <li class="listitem">
1.75 rillig 9913: <p>Check if any package depends on it:
9914: </p>
9915: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9916: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9917: </li>
1.128 wiz 9918: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9919: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9920: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9921: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9922: <li class="listitem">
1.75 rillig 9923: <p>Commit the changed and removed files:</p>
9924: <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 9925: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9926: </li>
9927: </ol></div>
9928: </div>
9929: </div>
1.148 asau 9930: <div class="chapter">
1.75 rillig 9931: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9932: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9933: <p>This section contains the answers to questions that may
9934: arise when you are writing a package. If you don't find your
9935: question answered here, first have a look in the other chapters,
9936: and if you still don't have the answer, ask on the
9937: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 9938: <div class="qandaset">
1.289 leot 9939: <a name="devfaq.qandaset"></a><dl>
1.267 rillig 9940: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9941: MAKEFLAGS, .MAKEFLAGS and
9942: MAKE_FLAGS?</a>
9943: </dt>
1.267 rillig 9944: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9945: MAKE, GMAKE and
9946: MAKE_PROGRAM?</a>
9947: </dt>
1.267 rillig 9948: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9949: CC, PKG_CC and
9950: PKGSRC_COMPILER?</a>
9951: </dt>
1.267 rillig 9952: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9953: BUILDLINK_LDFLAGS,
9954: BUILDLINK_LDADD and
9955: BUILDLINK_LIBS?</a>
9956: </dt>
1.267 rillig 9957: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9958: VARNAME=BUILDLINK_PREFIX.foo
9959: say it's empty?</a>
9960: </dt>
1.267 rillig 9961: <dt>24.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9962: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9963: don't understand the := inside
9964: it.</a>
9965: </dt>
1.267 rillig 9966: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9967: developers?</a>
9968: </dt>
1.267 rillig 9969: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9970: documentation?</a>
9971: </dt>
1.289 leot 9972: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill.
9973: What shall I do?</a>
1.92 rillig 9974: </dt>
1.75 rillig 9975: </dl>
1.148 asau 9976: <table border="0" style="width: 100%;">
9977: <colgroup>
1.75 rillig 9978: <col align="left" width="1%">
1.128 wiz 9979: <col>
1.148 asau 9980: </colgroup>
1.75 rillig 9981: <tbody>
1.148 asau 9982: <tr class="question">
1.75 rillig 9983: <td align="left" valign="top">
1.289 leot 9984: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75 rillig 9985: </td>
9986: <td align="left" valign="top"><p>What is the difference between
9987: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9988: <code class="varname">MAKE_FLAGS</code>?</p></td>
9989: </tr>
9990: <tr class="answer">
1.91 rillig 9991: <td align="left" valign="top"></td>
1.75 rillig 9992: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.311 leot 9993: 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 9994: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9995: the <code class="varname">MAKE_PROGRAM</code> when building the
9996: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9997: </tr>
1.148 asau 9998: <tr class="question">
1.75 rillig 9999: <td align="left" valign="top">
1.289 leot 10000: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75 rillig 10001: </td>
10002: <td align="left" valign="top"><p>What is the difference between
10003: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10004: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10005: </tr>
10006: <tr class="answer">
1.91 rillig 10007: <td align="left" valign="top"></td>
1.75 rillig 10008: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.311 leot 10009: <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 10010: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
10011: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
10012: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
10013: Make program that is used for building the
10014: package.</p></td>
10015: </tr>
1.148 asau 10016: <tr class="question">
1.75 rillig 10017: <td align="left" valign="top">
1.289 leot 10018: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75 rillig 10019: </td>
10020: <td align="left" valign="top"><p>What is the difference between
10021: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10022: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10023: </tr>
10024: <tr class="answer">
1.91 rillig 10025: <td align="left" valign="top"></td>
1.75 rillig 10026: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
10027: compiler, which can be configured by the pkgsrc user.
10028: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
10029: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
10030: path to a compiler, but the type of compiler that should be
1.76 rillig 10031: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 10032: information about the latter variable.</p></td>
10033: </tr>
1.148 asau 10034: <tr class="question">
1.75 rillig 10035: <td align="left" valign="top">
1.289 leot 10036: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.75 rillig 10037: </td>
10038: <td align="left" valign="top"><p>What is the difference between
10039: <code class="varname">BUILDLINK_LDFLAGS</code>,
10040: <code class="varname">BUILDLINK_LDADD</code> and
10041: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
10042: </tr>
10043: <tr class="answer">
1.91 rillig 10044: <td align="left" valign="top"></td>
1.75 rillig 10045: <td align="left" valign="top"><p>[FIXME]</p></td>
10046: </tr>
1.148 asau 10047: <tr class="question">
1.75 rillig 10048: <td align="left" valign="top">
1.289 leot 10049: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.75 rillig 10050: </td>
1.110 hubertf 10051: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 10052: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10053: say it's empty?</p></td>
10054: </tr>
10055: <tr class="answer">
1.91 rillig 10056: <td align="left" valign="top"></td>
1.75 rillig 10057: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 10058: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10059: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 10060: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 10061: command.</p></td>
10062: </tr>
1.148 asau 10063: <tr class="question">
1.78 rillig 10064: <td align="left" valign="top">
1.289 leot 10065: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.78 rillig 10066: </td>
10067: <td align="left" valign="top"><p>What does
1.220 wiz 10068: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10069: don't understand the <code class="code">:=</code> inside
1.78 rillig 10070: it.</p></td>
10071: </tr>
10072: <tr class="answer">
1.91 rillig 10073: <td align="left" valign="top"></td>
1.220 wiz 10074: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
10075: assignment operator, although it looks like it.
1.78 rillig 10076: Instead, it is a degenerate form of
1.220 wiz 10077: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.311 leot 10078: 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 10079: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78 rillig 10080: case of <code class="varname">MASTER_SITE_*</code>,
10081: <em class="replaceable"><code>old_string</code></em> is the empty string and
10082: <em class="replaceable"><code>new_string</code></em> is
1.220 wiz 10083: <code class="code">package/</code>. That's where the
10084: <code class="code">:</code> and the <code class="code">=</code> fall
1.78 rillig 10085: together.</p></td>
10086: </tr>
1.148 asau 10087: <tr class="question">
1.78 rillig 10088: <td align="left" valign="top">
1.289 leot 10089: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.78 rillig 10090: </td>
10091: <td align="left" valign="top"><p>Which mailing lists are there for package
10092: developers?</p></td>
10093: </tr>
10094: <tr class="answer">
1.91 rillig 10095: <td align="left" valign="top"></td>
1.148 asau 10096: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289 leot 10097: <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 10098: <dd><p>This is a list for technical discussions related
10099: to pkgsrc development, e.g. soliciting feedback for changes to
10100: pkgsrc infrastructure, proposed new features, questions related
10101: to porting pkgsrc to a new platform, advice for maintaining a
10102: package, patches that affect many packages, help requests moved
10103: from pkgsrc-users when an infrastructure bug is found,
10104: etc.</p></dd>
1.289 leot 10105: <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 10106: <dd><p>All bug reports in category "pkg" sent with
1.311 leot 10107: <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 10108: directly; use one of the other mailing
10109: lists.</p></dd>
10110: </dl></div></td>
10111: </tr>
1.148 asau 10112: <tr class="question">
1.80 rillig 10113: <td align="left" valign="top">
1.289 leot 10114: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.80 rillig 10115: </td>
10116: <td align="left" valign="top"><p>Where is the pkgsrc
10117: documentation?</p></td>
10118: </tr>
10119: <tr class="answer">
1.91 rillig 10120: <td align="left" valign="top"></td>
1.80 rillig 10121: <td align="left" valign="top">
10122: <p>There are many places where you can find
10123: documentation about pkgsrc:</p>
1.148 asau 10124: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10125: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 10126: of chapters that explain large parts of pkgsrc, but some
10127: chapters tend to be outdated. Which ones they are is hard to
10128: say.</p></li>
1.289 leot 10129: <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 10130: about certain features, announcements of new parts of the pkgsrc
10131: infrastructure and sometimes even announcements that a certain
10132: feature has been marked as obsolete. The benefit here is that
10133: each message has a date appended to it.</p></li>
1.128 wiz 10134: <li class="listitem"><p>Many of the files in the
1.80 rillig 10135: <code class="filename">mk/</code> directory start with a comment that
10136: describes the purpose of the file and how it can be used by the
1.92 rillig 10137: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 10138: documentation is to run <span class="command"><strong>bmake
1.92 rillig 10139: help</strong></span>.</p></li>
1.128 wiz 10140: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 10141: information, but they tend to be highly abbreviated, especially
10142: for actions that occur often. Some contain a detailed
10143: description of what has changed, but they are geared towards the
10144: other pkgsrc developers, not towards an average pkgsrc user.
10145: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10146: don't know what has been before, these messages may not be worth
10147: too much to you.</p></li>
1.128 wiz 10148: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10149: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 10150: mind of the developer who wrote the code. To get this
1.110 hubertf 10151: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 10152: to see who has written it and ask on the
10153: <code class="literal">tech-pkg</code> mailing list, so that others can
10154: find your questions later (see above). To be sure that the
10155: developer in charge reads the mail, you may CC him or
10156: her.</p></li>
10157: </ul></div>
1.299 rillig 10158: </td>
10159: </tr>
10160: <tr class="question">
10161: <td align="left" valign="top">
10162: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
10163: </td>
10164: <td align="left" valign="top"><p>I have a little time to kill.
10165: What shall I do?</p></td>
10166: </tr>
10167: <tr class="answer">
10168: <td align="left" valign="top"></td>
10169: <td align="left" valign="top">
10170: <p>This is not really an FAQ yet, but here's the answer
10171: anyway.</p>
1.148 asau 10172: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 10173: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
10174: <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
10175: will tell you about newer versions of installed packages that are
10176: available, but not yet updated in pkgsrc.</p></li>
10177: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10178: — it contains a list of suggested new packages and a list of
10179: cleanups and enhancements for pkgsrc that would be nice to
10180: have.</p></li>
10181: <li class="listitem"><p>Review packages for which review was requested on
10182: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10183: mailing list.</p></li>
1.85 jmmv 10184: </ul></div>
1.299 rillig 10185: </td>
1.85 jmmv 10186: </tr>
10187: </tbody>
1.299 rillig 10188: </table>
1.85 jmmv 10189: </div>
10190: </div>
1.75 rillig 10191: </div>
1.148 asau 10192: <div class="part">
1.75 rillig 10193: <div class="titlepage"><div><div><h1 class="title">
10194: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10195: <div class="partintro">
1.75 rillig 10196: <div></div>
10197: <p>This part of the guide deals with everything
10198: from the infrastructure that is behind the interfaces described
10199: in the developer's guide. A casual package maintainer should not
10200: need anything from this part.</p>
10201: <div class="toc">
10202: <p><b>Table of Contents</b></p>
1.210 leot 10203: <dl class="toc">
1.299 rillig 10204: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10205: <dd><dl>
1.299 rillig 10206: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10207: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10208: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.75 rillig 10209: <dd><dl>
1.299 rillig 10210: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10211: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.75 rillig 10212: </dl></dd>
1.299 rillig 10213: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10214: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10215: <dd><dl>
1.299 rillig 10216: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10217: <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 10218: </dl></dd>
1.299 rillig 10219: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10220: <dd><dl>
1.299 rillig 10221: <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>
10222: <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 10223: </dl></dd>
10224: </dl></dd>
1.299 rillig 10225: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 10226: <dd><dl>
1.299 rillig 10227: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10228: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10229: <dd><dl>
1.299 rillig 10230: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10231: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10232: </dl></dd>
10233: </dl></dd>
1.299 rillig 10234: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10235: <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 10236: </dl>
10237: </div>
10238: </div>
1.148 asau 10239: <div class="chapter">
1.75 rillig 10240: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10241: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10242: <div class="toc">
10243: <p><b>Table of Contents</b></p>
1.210 leot 10244: <dl class="toc">
1.299 rillig 10245: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10246: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10247: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81 rillig 10248: <dd><dl>
1.299 rillig 10249: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10250: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81 rillig 10251: </dl></dd>
1.299 rillig 10252: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10253: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10254: <dd><dl>
1.299 rillig 10255: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10256: <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 10257: </dl></dd>
1.299 rillig 10258: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10259: <dd><dl>
1.299 rillig 10260: <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>
10261: <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 10262: </dl></dd>
10263: </dl>
10264: </div>
10265: <p>The pkgsrc infrastructure consists of many small Makefile
10266: fragments. Each such fragment needs a properly specified
10267: interface. This chapter explains how such an interface looks
10268: like.</p>
1.148 asau 10269: <div class="sect1">
1.75 rillig 10270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10271: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10272: <p>Whenever a variable is defined in the pkgsrc
10273: infrastructure, the location and the way of definition provide
10274: much information about the intended use of that variable.
10275: Additionally, more documentation may be found in a header
10276: comment or in this pkgsrc guide.</p>
10277: <p>A special file is
10278: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10279: variables that are intended to be user-defined. They are either
10280: defined using the <code class="literal">?=</code> operator or they are
10281: left undefined because defining them to anything would
1.128 wiz 10282: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10283: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10284: file.</p>
10285: <p>Outside this file, the following conventions apply:
10286: Variables that are defined using the <code class="literal">?=</code>
10287: operator may be overridden by a package.</p>
10288: <p>Variables that are defined using the <code class="literal">=</code>
10289: operator may be used read-only at run-time.</p>
10290: <p>Variables whose name starts with an underscore must not be
10291: accessed outside the pkgsrc infrastructure at all. They may
10292: change without further notice.</p>
1.148 asau 10293: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10294: <h3 class="title">Note</h3>
10295: <p>These conventions are currently not applied
10296: consistently to the complete pkgsrc
10297: infrastructure.</p>
10298: </div>
10299: </div>
1.148 asau 10300: <div class="sect1">
1.81 rillig 10301: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10302: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10303: <p>All variables that contain lists of things should default
10304: to being empty. Two examples that do not follow this rule are
10305: <code class="varname">USE_LANGUAGES</code> and
10306: <code class="varname">DISTFILES</code>. These variables cannot simply be
10307: modified using the <code class="literal">+=</code> operator in package
10308: <code class="filename">Makefile</code>s (or other files included by
10309: them), since there is no guarantee whether the variable is
10310: already set or not, and what its value is. In the case of
1.128 wiz 10311: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10312: the default value and just define it as in the following
10313: example.</p>
10314: <pre class="programlisting">
1.100 rillig 10315: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10316: </pre>
10317: <p>Because of the selection of this default value, the same
10318: value appears in many package Makefiles. Similarly for
10319: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10320: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10321: doesn't stand out. Nevertheless it is mentioned in many
10322: files.</p>
10323: </div>
1.148 asau 10324: <div class="sect1">
1.81 rillig 10325: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10326: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.148 asau 10327: <div class="sect2">
1.75 rillig 10328: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10329: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.75 rillig 10330: <p>Variable evaluation takes place either at load time or at
10331: runtime, depending on the context in which they occur. The
10332: contexts where variables are evaluated at load time are:</p>
1.148 asau 10333: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10334: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10335: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10336: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10337: <code class="literal">.for</code>,</p></li>
1.128 wiz 10338: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10339: </ul></div>
10340: <p>A special exception are references to the iteration
10341: variables of <code class="literal">.for</code> loops, which are expanded
10342: inline, no matter in which context they appear.</p>
10343: <p>As the values of variables may change during load time,
10344: care must be taken not to evaluate them by accident. Typical
10345: examples for variables that should not be evaluated at load time
10346: are <code class="varname">DEPENDS</code> and
10347: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10348: clear, here is an example:</p>
10349: <pre class="programlisting">
1.100 rillig 10350: CONFIGURE_ARGS= # none
10351: CFLAGS= -O
10352: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10353:
1.100 rillig 10354: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10355:
1.100 rillig 10356: CFLAGS+= -Wall
1.222 sevan 10357: </pre>
1.75 rillig 10358: <p>This code shows how the use of the <code class="literal">:=</code>
10359: operator can quickly lead to unexpected results. The first
10360: paragraph is fairly common code. The second paragraph evaluates
10361: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10362: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10363: <code class="literal">-Wall</code> is appended to the
10364: <code class="varname">CFLAGS</code>, but this addition will not appear in
10365: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10366: paragraphs from above typically occur in completely unrelated
10367: files.</p>
10368: </div>
1.148 asau 10369: <div class="sect2">
1.75 rillig 10370: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10371: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.75 rillig 10372: <p>After all the files have been loaded, the values of the
10373: variables cannot be changed anymore. Variables that are used in
10374: the shell commands are expanded at this point.</p>
10375: </div>
10376: </div>
1.148 asau 10377: <div class="sect1">
1.75 rillig 10378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10379: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10380: <p>There are many ways in which the definition and use of a
1.218 rillig 10381: variable can be restricted in order to detect bugs and violations
10382: of the (mostly unwritten) policies. A package can be checked with
10383: <code class="literal">pkglint -Wall</code> to see whether it meets these
10384: rules.</p>
1.78 rillig 10385: </div>
1.148 asau 10386: <div class="sect1">
1.78 rillig 10387: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10388: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10389: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10390: of the following classes. Cases where a file falls into more
10391: than one class should be avoided as it often leads to subtle
10392: bugs.</p>
1.148 asau 10393: <div class="sect2">
1.75 rillig 10394: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10395: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10396: <p>In a traditional imperative programming language some of
1.76 rillig 10397: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10398: procedures. They take some input parameters and—after
10399: inclusion—provide a result in output parameters. Since all
1.76 rillig 10400: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10401: care must be taken not to use parameter names that have already
10402: another meaning. For example, <code class="varname">PKGNAME</code> is a
10403: bad choice for a parameter name.</p>
10404: <p>Procedures are completely evaluated at preprocessing time.
10405: That is, when calling a procedure all input parameters must be
10406: completely resolvable. For example,
10407: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10408: parameter since it is very likely that further text will be
10409: added after calling the procedure, which would effectively apply
10410: the procedure to only a part of the variable. Also, references
1.218 rillig 10411: to other variables will be modified after calling the
1.75 rillig 10412: procedure.</p>
10413: <p>A procedure can declare its output parameters either as
10414: suitable for use in preprocessing directives or as only
10415: available at runtime. The latter alternative is for variables
10416: that contain references to other runtime variables.</p>
10417: <p>Procedures shall be written such that it is possible to
10418: call the procedure more than once. That is, the file must not
10419: contain multiple-inclusion guards.</p>
10420: <p>Examples for procedures are
1.76 rillig 10421: <code class="filename">mk/bsd.options.mk</code> and
10422: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10423: that the parameters are evaluated at load time, they should be
10424: assigned using the <code class="literal">:=</code> operator, which should
10425: be used only for this purpose.</p>
10426: </div>
1.148 asau 10427: <div class="sect2">
1.75 rillig 10428: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10429: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10430: <p>Action files take some input parameters and may define
10431: runtime variables. They shall not define loadtime variables.
10432: There are action files that are included implicitly by the
10433: pkgsrc infrastructure, while other must be included
10434: explicitly.</p>
10435: <p>An example for action files is
1.76 rillig 10436: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10437: </div>
10438: </div>
1.148 asau 10439: <div class="sect1">
1.81 rillig 10440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10441: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10442: <p>Package <code class="filename">Makefile</code>s usually consist of
10443: a set of variable definitions, and include the file
10444: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10445: Before that, they may also include various other
10446: <code class="filename">*.mk</code> files if they need to query the
10447: availability of certain features like the type of compiler or
10448: the X11 implementation. Due to the heavy use of preprocessor
10449: directives like <code class="literal">.if</code> and
10450: <code class="literal">.for</code>, the order in which the files are loaded
10451: matters.</p>
10452: <p>This section describes at which point the various files
10453: are loaded and gives reasons for that order.</p>
1.148 asau 10454: <div class="sect2">
1.81 rillig 10455: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10456: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10457: </h3></div></div></div>
10458: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10459: is to define some essential variables like
10460: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10461: <code class="varname">MACHINE_ARCH</code>.</p>
10462: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10463: 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 10464: After that, those variables
1.81 rillig 10465: that have not been overridden by the user are loaded from
10466: <code class="filename">mk/defaults/mk.conf</code>.</p>
10467: <p>After the user settings, the system settings and platform
10468: settings are loaded, which may override the user
10469: settings.</p>
10470: <p>Then, the tool definitions are loaded. The tool wrappers
10471: are not yet in effect. This only happens when building a
10472: package, so the proper variables must be used instead of the
10473: direct tool names.</p>
10474: <p>As the last steps, some essential variables from the
10475: wrapper and the package system flavor are loaded, as well as the
10476: variables that have been cached in earlier phases of a package
10477: build.</p>
10478: </div>
1.148 asau 10479: <div class="sect2">
1.81 rillig 10480: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10481: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10482: </h3></div></div></div>
1.81 rillig 10483: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10484: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10485: loaded, which fill default values for those variables that have
1.93 rillig 10486: not been defined by the package. These variables may later
1.81 rillig 10487: be used even in unrelated files.</p>
10488: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10489: provides the target <code class="literal">error-check</code> that is added
10490: as a special dependency to all other targets that use
10491: <code class="varname">DELAYED_ERROR_MSG</code> or
10492: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10493: <p>Then, the package-specific hacks from
10494: <code class="filename">hacks.mk</code> are included.</p>
10495: <p>Then, various other files follow. Most of them don't have
10496: any dependencies on what they need to have included before or
10497: after them, though some do.</p>
10498: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10499: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10500: restricts the use of these variables to all the files that have
10501: been included before. Appearances in later files will be
10502: silently ignored.</p>
10503: <p>Then, the files for the main targets are included, in the
10504: order of later execution, though the actual order should not
10505: matter.</p>
10506: <p>At last, some more files are included that don't set any
10507: interesting variables but rather just define make targets to be
10508: executed.</p>
10509: </div>
10510: </div>
1.75 rillig 10511: </div>
1.148 asau 10512: <div class="chapter">
1.75 rillig 10513: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10514: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.75 rillig 10515: <div class="toc">
10516: <p><b>Table of Contents</b></p>
1.210 leot 10517: <dl class="toc">
1.299 rillig 10518: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10519: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10520: <dd><dl>
1.299 rillig 10521: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10522: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10523: </dl></dd>
10524: </dl>
10525: </div>
10526: <p>The pkgsrc infrastructure consists of a large codebase,
10527: and there are many corners where every little bit of a file is
10528: well thought out, making pkgsrc likely to fail as soon as
10529: anything is changed near those parts. To prevent most changes
10530: from breaking anything, a suite of regression tests should go
10531: along with every important part of the pkgsrc infrastructure.
10532: This chapter describes how regression tests work in pkgsrc and
10533: how you can add new tests.</p>
1.148 asau 10534: <div class="sect1">
1.75 rillig 10535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10536: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.250 leot 10537: <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 10538: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10539: can simply run that command, which will run all tests in the
1.283 rillig 10540: <code class="filename">regress/</code> directory.</p>
1.75 rillig 10541: </div>
1.148 asau 10542: <div class="sect1">
1.75 rillig 10543: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10544: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.283 rillig 10545: <p>Every directory in the <code class="filename">regress/</code>
10546: directory that contains a file called <code class="filename">spec</code>
1.75 rillig 10547: is considered a regression test. This file is a shell program
1.110 hubertf 10548: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10549: The following functions can be overridden to suit your
10550: needs.</p>
1.148 asau 10551: <div class="sect2">
1.75 rillig 10552: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10553: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.218 rillig 10554: <p>These functions do not take any parameters. Although they
10555: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.289 leot 10556: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218 rillig 10557: question</a> for details.</p>
1.148 asau 10558: <div class="variablelist"><dl class="variablelist">
1.218 rillig 10559: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75 rillig 10560: <dd><p>This function prepares the environment for the
10561: test. By default it does nothing.</p></dd>
1.218 rillig 10562: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10563: <dd>
10564: <p>This function runs the actual test. By default,
1.75 rillig 10565: it calls <code class="varname">TEST_MAKE</code> with the arguments
10566: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10567: error messages into the file
1.218 rillig 10568: <code class="varname">TEST_OUTFILE</code>.</p>
10569: <p>When defining this function, make sure that all output that
10570: needs to be checked is written to the correct output file.
10571: Example:</p>
10572: <pre class="programlisting">
10573: do_test() {
1.223 rillig 10574: echo "Example output"
1.218 rillig 10575: } 1>$TEST_OUTFILE 2>&1
10576: </pre>
10577: </dd>
10578: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10579: <dd>
10580: <p>This function is run after the test and is
1.75 rillig 10581: typically used to compare the actual output from the one that is
10582: expected. It can make use of the various helper functions from
1.218 rillig 10583: the next section. Example:</p>
10584: <pre class="programlisting">
10585: check_result() {
1.223 rillig 10586: exit_status 0
10587: output_require "Example"
10588: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10589: output_prohibit "no such file or directory"
1.283 rillig 10590: regress_fail "expected $expected but got $actual for input $input"
1.218 rillig 10591: }
10592: </pre>
10593: </dd>
10594: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75 rillig 10595: <dd><p>This function cleans everything up after the
10596: test has been run. By default it does nothing.</p></dd>
10597: </dl></div>
10598: </div>
1.148 asau 10599: <div class="sect2">
1.75 rillig 10600: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10601: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.148 asau 10602: <div class="variablelist"><dl class="variablelist">
1.283 rillig 10603: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10604: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218 rillig 10605: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75 rillig 10606: <dd><p>This function compares the exitcode of the
1.218 rillig 10607: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75 rillig 10608: If they differ, the test will fail.</p></dd>
1.218 rillig 10609: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10610: <dd>
10611: <p>This function checks for each of its parameters
10612: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75 rillig 10613: extended regular expression. If it does not, the test will
1.218 rillig 10614: fail. Example:</p>
10615: <pre class="programlisting">
1.219 rillig 10616: output_require "looks fine"
10617: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218 rillig 10618: </pre>
10619: </dd>
1.292 leot 10620: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75 rillig 10621: <dd><p>This function checks for each of its parameters
1.110 hubertf 10622: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10623: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10624: If any of the regular expressions matches, the test will
10625: fail.</p></dd>
10626: </dl></div>
10627: </div>
10628: </div>
10629: </div>
1.148 asau 10630: <div class="chapter">
1.75 rillig 10631: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10632: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10633: <div class="toc">
10634: <p><b>Table of Contents</b></p>
1.299 rillig 10635: <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 10636: </div>
10637: <p>The pkgsrc system has already been ported to many
10638: operating systems, hardware architectures and compilers. This
10639: chapter explains the necessary steps to make pkgsrc even more
10640: portable.</p>
1.148 asau 10641: <div class="sect1">
1.75 rillig 10642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10643: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10644: <p>To port pkgsrc to a new operating system (called
10645: <code class="literal">MyOS</code> in this example), you need to touch the
10646: following files:</p>
1.148 asau 10647: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10648: <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 10649: <dd><p>This file contains some basic definitions, for
10650: example the name of the C
10651: compiler.</p></dd>
1.76 rillig 10652: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10653: <dd><p>Insert code that defines the variables
10654: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10655: <code class="varname">LOWER_OS_VERSION</code>,
10656: <code class="varname">LOWER_VENDOR</code>,
10657: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10658: <code class="varname">APPEND_ELF</code>, and the other variables that
10659: appear in this file.</p></dd>
1.93 rillig 10660: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10661: <dd><p>This file contains the platform-specific
10662: definitions that are used by pkgsrc. Start by copying one of the
10663: other files and edit it to your
10664: needs.</p></dd>
1.93 rillig 10665: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10666: <dd><p>This file defines the paths to all the tools
10667: that are needed by one or the other package in pkgsrc, as well
10668: as by pkgsrc itself. Find out where these tools are on your
10669: platform and add them.</p></dd>
10670: </dl></div>
10671: <p>Now, you should be able to build some basic packages, like
1.250 leot 10672: <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 10673: </div>
10674: </div>
10675: </div>
1.148 asau 10676: <div class="appendix">
10677: <div class="titlepage"><div><div><h1 class="title">
10678: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10679: <div class="toc">
10680: <p><b>Table of Contents</b></p>
1.210 leot 10681: <dl class="toc">
1.75 rillig 10682: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10683: <dd><dl>
10684: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10685: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10686: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287 rillig 10687: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 10688: </dl></dd>
10689: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10690: </dl>
10691: </div>
10692: <p>We checked to find a piece of software that wasn't in the packages
10693: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10694: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10695: present in the tree is beyond us, but it's useful for the purposes of
10696: this exercise.</p>
1.148 asau 10697: <div class="sect1">
1.75 rillig 10698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10699: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10700: <div class="sect2">
1.75 rillig 10701: <div class="titlepage"><div><div><h3 class="title">
10702: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10703: <pre class="programlisting">
1.100 rillig 10704: # $NetBSD$
10705: #
1.1 grant 10706:
1.100 rillig 10707: DISTNAME= bison-1.25
10708: CATEGORIES= devel
1.286 rillig 10709: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 grant 10710:
1.136 dholland 10711: MAINTAINER= pkgsrc-users@NetBSD.org
1.289 leot 10712: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.100 rillig 10713: COMMENT= GNU yacc clone
1.1 grant 10714:
1.100 rillig 10715: GNU_CONFIGURE= yes
1.152 wiz 10716: INFO_FILES= yes
1.1 grant 10717:
1.100 rillig 10718: .include "../../mk/bsd.pkg.mk"
1.1 grant 10719: </pre>
1.75 rillig 10720: </div>
1.148 asau 10721: <div class="sect2">
1.75 rillig 10722: <div class="titlepage"><div><div><h3 class="title">
10723: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10724: <pre class="programlisting">
1.100 rillig 10725: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.311 leot 10726: 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 10727: of the NetBSD source tree is beyond me.
1.1 grant 10728: </pre>
1.75 rillig 10729: </div>
1.148 asau 10730: <div class="sect2">
1.75 rillig 10731: <div class="titlepage"><div><div><h3 class="title">
10732: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10733: <pre class="programlisting">
1.100 rillig 10734: @comment $NetBSD$
10735: bin/bison
10736: man/man1/bison.1.gz
10737: share/bison.simple
10738: share/bison.hairy
1.1 grant 10739: </pre>
1.75 rillig 10740: </div>
1.148 asau 10741: <div class="sect2">
1.75 rillig 10742: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 10743: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75 rillig 10744: <p>The NetBSD package system comes with
1.250 leot 10745: <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 10746: which helps to check the contents of these
10747: files. After installation it is quite easy to use, just change to the
1.286 rillig 10748: directory of the package you wish to examine and run
1.110 hubertf 10749: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10750: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286 rillig 10751: ERROR: Makefile: Each package must define its LICENSE.
10752: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10753: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10754: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10755: 1 error, 2 warnings and 1 note found.
10756: (Run "pkglint -e" to show explanations.)
10757: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287 rillig 10758: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75 rillig 10759: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285 rillig 10760: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75 rillig 10761: -Wall</strong></span> for a very thorough check.</p>
10762: </div>
10763: </div>
1.148 asau 10764: <div class="sect1">
1.75 rillig 10765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10766: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10767: <p>Create the directory where the package lives,
10768: plus any auxiliary directories:</p>
10769: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10770: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10771: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10772: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10773: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299 rillig 10774: <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 10775: then continue with fetching the distfile:</p>
10776: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10777: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10778: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10779: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10780: ftp: Error retrieving file: 500 Internal error
10781:
10782: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10783: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10784: ftp: Error retrieving file: 500 Internal error
10785:
10786: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10787: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10788: Successfully retrieved file.</pre>
10789: <p>Generate the checksum of the distfile into
1.76 rillig 10790: <code class="filename">distinfo</code>:</p>
1.88 wiz 10791: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10792: <p>Now compile:</p>
10793: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10794: >> Checksum OK for bison-1.25.tar.gz.
10795: ===> Extracting for bison-1.25
10796: ===> Patching for bison-1.25
10797: ===> Ignoring empty patch directory
10798: ===> Configuring for bison-1.25
10799: creating cache ./config.cache
10800: checking for gcc... cc
10801: checking whether we are using GNU C... yes
10802: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10803: checking how to run the C preprocessor... cc -E
10804: checking for minix/config.h... no
10805: checking for POSIXized ISC... no
10806: checking whether cross-compiling... no
10807: checking for ANSI C header files... yes
10808: checking for string.h... yes
10809: checking for stdlib.h... yes
10810: checking for memory.h... yes
10811: checking for working const... yes
10812: checking for working alloca.h... no
10813: checking for alloca... yes
10814: checking for strerror... yes
10815: updating cache ./config.cache
10816: creating ./config.status
10817: creating Makefile
10818: ===> Building for bison-1.25
10819: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
10820: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
10821: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
10822: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
10823: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 10824: 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 10825: 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
10826: 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
10827: 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
10828: 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
10829: 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
10830: 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
10831: 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
10832: 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
10833: 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
10834: 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
10835: 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
10836: 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
10837: 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
10838: 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
10839: 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
10840: 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
10841: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10842: rm -f bison.s1
1.75 rillig 10843: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10844: <p>Everything seems OK, so install the files:</p>
10845: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10846: >> Checksum OK for bison-1.25.tar.gz.
10847: ===> Installing for bison-1.25
10848: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10849: rm -f /usr/pkg/bin/bison
10850: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10851: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10852: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10853: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10854: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10855: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10856: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10857: ===> Registering installation for bison-1.25</pre>
10858: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10859: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10860: binary package, do this now:</p>
10861: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10862: >> Checksum OK for bison-1.25.tar.gz.
10863: ===> Building package for bison-1.25
10864: Creating package bison-1.25.tgz
10865: Registering depends:.
1.75 rillig 10866: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10867: <p>Now that you don't need the source and object files
10868: any more, clean up:</p>
10869: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10870: ===> Cleaning for bison-1.25</pre>
10871: </div>
10872: </div>
1.148 asau 10873: <div class="appendix">
10874: <div class="titlepage"><div><div><h1 class="title">
10875: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 10876: <div class="toc">
10877: <p><b>Table of Contents</b></p>
1.210 leot 10878: <dl class="toc">
1.75 rillig 10879: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10880: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10881: </dl>
10882: </div>
1.148 asau 10883: <div class="sect1">
1.75 rillig 10884: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10885: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10886: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10887: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10888: => figlet221.tar.gz doesn't seem to exist on this system.
10889: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10890: => [172219 bytes]
10891: Connected to ftp.plig.net.
10892: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10893: 331 Guest login ok, send your complete e-mail address as password.
10894: 230-You are user #5 of 500 simultaneous users allowed.
10895: 230-
1.68 rillig 10896: 230- ___ _ _ _
10897: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10898: 230- | _| _| . |_| . | | | . |_| . | _| . |
10899: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10900: 230- |_| |_| |___| |___|
10901: 230-
10902: 230-** Welcome to ftp.plig.org **
10903: 230-
10904: 230-Please note that all transfers from this FTP site are logged. If you
10905: 230-do not like this, please disconnect now.
10906: 230-
1.120 snj 10907: 230-This archive is available via
1.1 grant 10908: 230-
10909: 230-HTTP: http://ftp.plig.org/
10910: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10911: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10912: 230-
10913: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10914: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10915: 230-
10916: 230-
10917: 230 Logged in anonymously.
10918: Remote system type is UNIX.
10919: Using binary mode to transfer files.
10920: 200 Type okay.
10921: 250 "/pub" is new cwd.
10922: 250-"/pub/figlet" is new cwd.
10923: 250-
10924: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10925: 250-
1.75 rillig 10926: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10927: 250-
10928: 250-The official FIGlet web page is:
1.75 rillig 10929: 250- http://www.figlet.org/
1.1 grant 10930: 250-
10931: 250-If you have questions, please mailto:info@figlet.org. If you want to
10932: 250-contribute a font or something else, you can email us.
1.68 rillig 10933: 250
1.1 grant 10934: 250 "/pub/figlet/program" is new cwd.
10935: 250 "/pub/figlet/program/unix" is new cwd.
10936: local: figlet221.tar.gz remote: figlet221.tar.gz
10937: 502 Unimplemented command.
10938: 227 Entering Passive Mode (195,40,6,41,246,104)
10939: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10940: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10941: 226 Transfer completed.
10942: 172219 bytes received in 00:02 (75.99 KB/s)
10943: 221 Goodbye.
10944: => Checksum OK for figlet221.tar.gz.
10945: ===> Extracting for figlet-2.2.1nb2
10946: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10947: ===> Patching for figlet-2.2.1nb2
10948: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10949: ===> Overriding tools for figlet-2.2.1nb2
10950: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10951: ===> Configuring for figlet-2.2.1nb2
10952: ===> Building for figlet-2.2.1nb2
10953: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10954: chmod a+x figlet
10955: gcc -O2 -o chkfont chkfont.c
10956: => Unwrapping files-to-be-installed.
1.14 xtraeme 10957: <code class="prompt">#</code>
1.75 rillig 10958: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10959: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10960: ===> Installing for figlet-2.2.1nb2
10961: install -d -o root -g wheel -m 755 /usr/pkg/bin
10962: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10963: mkdir -p /usr/pkg/share/figlet
10964: cp figlet /usr/pkg/bin
10965: cp chkfont /usr/pkg/bin
10966: chmod 555 figlist showfigfonts
10967: cp figlist /usr/pkg/bin
10968: cp showfigfonts /usr/pkg/bin
10969: cp fonts/*.flf /usr/pkg/share/figlet
10970: cp fonts/*.flc /usr/pkg/share/figlet
10971: cp figlet.6 /usr/pkg/man/man6
10972: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10973: <code class="prompt">#</code></pre>
10974: </div>
1.148 asau 10975: <div class="sect1">
1.75 rillig 10976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10977: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10978: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10979: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10980: ===> Packaging figlet-2.2.1nb2
10981: ===> Building binary package for figlet-2.2.1nb2
10982: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10983: Using SrcDir value of /usr/pkg
1.68 rillig 10984: Registering depends:.
1.75 rillig 10985: <code class="prompt">#</code></pre>
10986: </div>
10987: </div>
1.148 asau 10988: <div class="appendix">
10989: <div class="titlepage"><div><div><h1 class="title">
10990: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 10991: <div class="toc">
10992: <p><b>Table of Contents</b></p>
1.210 leot 10993: <dl class="toc">
1.128 wiz 10994: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10995: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10996: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10997: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10998: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261 leot 10999: <code class="filename">stable</code>,
1.128 wiz 11000: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11001: source packages</a></span></dt>
11002: </dl>
11003: </div>
11004: <p>As in other big projects, the directory layout of pkgsrc
11005: is quite complex for newbies. This chapter explains where you
11006: find things on the FTP server. The base directory on
1.110 hubertf 11007: <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 11008: On other servers it may be different, but inside this directory,
11009: everything should look the same, no matter on which server you
11010: are. This directory contains some subdirectories, which are
11011: explained below.</p>
1.148 asau 11012: <div class="sect1">
1.76 rillig 11013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11014: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 11015: <p>The directory <code class="filename">distfiles</code> contains lots
11016: of archive files from all pkgsrc packages, which are mirrored
11017: here. The subdirectories are called after their package names
11018: and are used when the distributed files have names that don't
11019: explicitly contain a version number or are otherwise too generic
11020: (for example <code class="filename">release.tar.gz</code>).</p>
11021: </div>
1.148 asau 11022: <div class="sect1">
1.76 rillig 11023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11024: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 11025: <p>This directory contains things that individual pkgsrc
11026: developers find worth publishing.</p>
11027: </div>
1.148 asau 11028: <div class="sect1">
1.76 rillig 11029: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11030: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 11031: <p>This directory contains binary packages for the various
11032: platforms that are supported by pkgsrc.
11033: 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 11034: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 11035: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 11036: operating system for which the packages have been built. The
1.110 hubertf 11037: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 11038: command, so it may differ from the one you are used to
11039: hear.</p></li>
1.128 wiz 11040: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 11041: architecture of the platform for which the packages have been
1.110 hubertf 11042: built. It also includes the <code class="varname">ABI</code> (Application
11043: Binary Interface) for platforms that have several of
11044: them.</p></li>
1.128 wiz 11045: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 11046: the operating system. For version numbers that change often (for
11047: example NetBSD-current), the often-changing part should be
11048: replaced with an <code class="literal">x</code>, for example
11049: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 11050: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 11051: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 11052: for a stable branch, or <code class="literal">head</code> for packages
11053: built from the HEAD branch. The latter should only be used when
11054: the packages are updated on a regular basis. Otherwise the date
11055: from checking out pkgsrc should be appended, for example
11056: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 11057: </ul></div>
11058: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11059: can quickly click through the directories on the
11060: server and find the best binary packages for their machines. Since they
11061: usually know the operating system and the hardware architecture, OPSYS
11062: and ARCH are placed first. After these choices, they can select the
11063: best combination of OSVERSION and TAG together, since it is usually the
11064: case that packages stay compatible between different version of the
11065: operating system.</p>
11066: <p>In each of these directories, there is a
11067: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 11068: <code class="filename">All</code> which contains all binary packages.
11069: Besides that, there are various category directories that
11070: contain symbolic links to the real binary packages.</p>
11071: </div>
1.148 asau 11072: <div class="sect1">
1.76 rillig 11073: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11074: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 11075: <p>Here are the reports from bulk builds, for those who want
11076: to fix packages that didn't build on some of the platforms. The
1.128 wiz 11077: 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 11078: </div>
1.148 asau 11079: <div class="sect1">
1.108 rillig 11080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 11081: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.261 leot 11082: <code class="filename">stable</code>,
1.126 jakllsch 11083: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11084: source packages</h2></div></div></div>
1.128 wiz 11085: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 11086: that is the files that define how to create binary packages from
11087: source archives.</p>
1.262 leot 11088: <p>Each of the <code class="filename">current</code>,
11089: <code class="filename">stable</code> and
11090: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11091: directories share the same structure. They each contain a
11092: <code class="filename">pkgsrc</code> directory and
11093: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76 rillig 11094: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11095: snapshot of the CVS repository, which is updated regularly. The
1.262 leot 11096: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11097: as the directory, ready to be downloaded as a whole.</p>
11098: <p>The <code class="filename">current</code> directory contains files
11099: related to the HEAD branch of the CVS repository.
11100: In this directory there is an additional file called
11101: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11102: all pkgsrc <code class="filename">README</code>s with information about
11103: categories and packages.
11104: </p>
11105: <p>The <code class="filename">stable</code> directory is a symlink to
11106: the latest
11107: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11108: </p>
11109: <p>The
11110: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11111: directories contain files related to the
11112: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11113: stable branch of the CVS repository. In these directories there is
11114: an additional file called
11115: <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 11116: which contains the state of pkgsrc when it was branched.</p>
11117: </div>
1.75 rillig 11118: </div>
1.148 asau 11119: <div class="appendix">
11120: <div class="titlepage"><div><div><h1 class="title">
1.267 rillig 11121: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
11122: <p>
11123: The following list contains all help topics that are available
11124: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11125: </p>
1.269 leot 11126: <table border="0" summary="Simple list" class="simplelist">
11127: <tr>
11128: <td>#!</td>
11129: <td>-lintl</td>
11130: </tr>
11131: <tr>
1.320 wiz 11132: <td>32bit</td>
1.269 leot 11133: <td>64bit</td>
1.320 wiz 11134: </tr>
11135: <tr>
1.269 leot 11136: <td>ABI</td>
1.320 wiz 11137: <td>ACCEPTABLE_LICENSES</td>
1.269 leot 11138: </tr>
11139: <tr>
11140: <td>ACROREAD_FONTPATH</td>
1.320 wiz 11141: <td>ADDITIONAL</td>
1.269 leot 11142: </tr>
11143: <tr>
11144: <td>AFAIK</td>
1.320 wiz 11145: <td>AIX</td>
1.269 leot 11146: </tr>
11147: <tr>
11148: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.320 wiz 11149: <td>ALL_ENV</td>
1.269 leot 11150: </tr>
11151: <tr>
1.320 wiz 11152: <td>ALSA_PC</td>
1.315 cirnatda 11153: <td>ALTERNATIVES_SRC</td>
1.311 leot 11154: </tr>
11155: <tr>
11156: <td>AMANDA_TMP</td>
1.315 cirnatda 11157: <td>AMANDA_USER</td>
1.292 leot 11158: </tr>
11159: <tr>
1.311 leot 11160: <td>AMANDA_VAR</td>
1.315 cirnatda 11161: <td>APACHE_GROUP</td>
1.274 rillig 11162: </tr>
11163: <tr>
1.311 leot 11164: <td>APACHE_MODULE_NAME</td>
1.315 cirnatda 11165: <td>APACHE_MODULE_SRC</td>
1.269 leot 11166: </tr>
11167: <tr>
1.311 leot 11168: <td>APACHE_MODULE_SRCDIR</td>
1.315 cirnatda 11169: <td>APACHE_PKG_PREFIX</td>
1.269 leot 11170: </tr>
11171: <tr>
1.311 leot 11172: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.315 cirnatda 11173: <td>APACHE_SUEXEC_DOCROOT</td>
1.269 leot 11174: </tr>
11175: <tr>
1.311 leot 11176: <td>APACHE_USER</td>
1.315 cirnatda 11177: <td>APPEND_ABI</td>
1.269 leot 11178: </tr>
11179: <tr>
1.311 leot 11180: <td>APPEND_ELF</td>
1.315 cirnatda 11181: <td>ARLA_CACHE</td>
1.269 leot 11182: </tr>
11183: <tr>
1.311 leot 11184: <td>AUDIT_PACKAGES_FLAGS</td>
1.315 cirnatda 11185: <td>AUTOCONF_REQD</td>
1.269 leot 11186: </tr>
11187: <tr>
1.311 leot 11188: <td>AUTOMAKE_OVERRIDE</td>
1.315 cirnatda 11189: <td>AUTOMAKE_REQD</td>
1.269 leot 11190: </tr>
11191: <tr>
1.311 leot 11192: <td>AUTO_MKDIRS</td>
1.315 cirnatda 11193: <td>BDB185_DEFAULT</td>
1.269 leot 11194: </tr>
11195: <tr>
1.311 leot 11196: <td>BDBBASE</td>
1.315 cirnatda 11197: <td>BDB_ACCEPTED</td>
1.269 leot 11198: </tr>
11199: <tr>
1.311 leot 11200: <td>BDB_DEFAULT</td>
1.315 cirnatda 11201: <td>BDB_LIBS</td>
1.269 leot 11202: </tr>
11203: <tr>
1.311 leot 11204: <td>BDB_TYPE</td>
1.315 cirnatda 11205: <td>BINCIMAP_GROUP</td>
1.269 leot 11206: </tr>
11207: <tr>
1.312 gdt 11208: <td>BINCIMAP_USER</td>
1.315 cirnatda 11209: <td>BIND_DIR</td>
1.312 gdt 11210: </tr>
11211: <tr>
1.311 leot 11212: <td>BIND_GROUP</td>
1.315 cirnatda 11213: <td>BIND_USER</td>
1.269 leot 11214: </tr>
11215: <tr>
1.311 leot 11216: <td>BINOWN</td>
1.315 cirnatda 11217: <td>BINPKG_SITES</td>
1.269 leot 11218: </tr>
11219: <tr>
1.311 leot 11220: <td>BIN_INSTALL_FLAGS</td>
1.315 cirnatda 11221: <td>BISON_PKGDATADIR</td>
1.303 bacon 11222: </tr>
11223: <tr>
1.320 wiz 11224: <td>BLAS</td>
1.311 leot 11225: <td>BLAS_ACCEPTED</td>
1.320 wiz 11226: </tr>
11227: <tr>
11228: <td>BLAS_C_INTERFACE</td>
11229: <td>BLAS_INCLUDES</td>
11230: </tr>
11231: <tr>
11232: <td>BLAS_INDEX64</td>
1.315 cirnatda 11233: <td>BLAS_LIBS</td>
1.269 leot 11234: </tr>
11235: <tr>
1.311 leot 11236: <td>BLAS_TYPE</td>
1.315 cirnatda 11237: <td>BOOTSTRAP_DEPENDS</td>
1.292 leot 11238: </tr>
11239: <tr>
1.311 leot 11240: <td>BOOTSTRAP_SETUPTOOLS</td>
1.315 cirnatda 11241: <td>BROKEN</td>
1.269 leot 11242: </tr>
11243: <tr>
1.311 leot 11244: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.315 cirnatda 11245: <td>BROKEN_ON_PLATFORM</td>
1.269 leot 11246: </tr>
11247: <tr>
1.311 leot 11248: <td>BSDSRCDIR</td>
1.315 cirnatda 11249: <td>BSDXSRCDIR</td>
1.269 leot 11250: </tr>
11251: <tr>
1.311 leot 11252: <td>BSD_MAKE_ENV</td>
1.315 cirnatda 11253: <td>BUILDLINK_AUTO_DIRS</td>
1.269 leot 11254: </tr>
11255: <tr>
1.311 leot 11256: <td>BUILDLINK_AUTO_VARS</td>
1.315 cirnatda 11257: <td>BUILDLINK_CFLAGS</td>
1.269 leot 11258: </tr>
11259: <tr>
1.311 leot 11260: <td>BUILDLINK_CONTENTS_FILTER</td>
1.269 leot 11261: <td>BUILDLINK_CPPFLAGS</td>
11262: </tr>
11263: <tr>
1.320 wiz 11264: <td>BUILDLINK_DEPMETHOD</td>
1.269 leot 11265: <td>BUILDLINK_FILES</td>
1.320 wiz 11266: </tr>
11267: <tr>
1.303 bacon 11268: <td>BUILDLINK_FILES_CMD</td>
1.320 wiz 11269: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.269 leot 11270: </tr>
11271: <tr>
1.303 bacon 11272: <td>BUILDLINK_LDFLAGS</td>
1.320 wiz 11273: <td>BUILDLINK_LIBS</td>
1.269 leot 11274: </tr>
11275: <tr>
1.303 bacon 11276: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.320 wiz 11277: <td>BUILDLINK_PKGNAME</td>
1.269 leot 11278: </tr>
11279: <tr>
1.303 bacon 11280: <td>BUILDLINK_PREFIX</td>
1.320 wiz 11281: <td>BUILDLINK_RPATHDIRS</td>
1.269 leot 11282: </tr>
11283: <tr>
1.303 bacon 11284: <td>BUILDLINK_TREE</td>
1.320 wiz 11285: <td>BUILD_DEFS</td>
1.269 leot 11286: </tr>
11287: <tr>
1.303 bacon 11288: <td>BUILD_DEFS_EFFECTS</td>
1.320 wiz 11289: <td>BUILD_DEPENDS</td>
1.269 leot 11290: </tr>
11291: <tr>
1.303 bacon 11292: <td>BUILD_DIRS</td>
1.320 wiz 11293: <td>BUILD_ENV_SHELL</td>
1.269 leot 11294: </tr>
11295: <tr>
1.303 bacon 11296: <td>BUILD_MAKE_CMD</td>
1.320 wiz 11297: <td>BUILD_MAKE_FLAGS</td>
1.269 leot 11298: </tr>
11299: <tr>
1.303 bacon 11300: <td>BUILD_TARGET</td>
1.320 wiz 11301: <td>BUILTIN_FIND_FILES</td>
1.269 leot 11302: </tr>
11303: <tr>
1.303 bacon 11304: <td>BUILTIN_FIND_FILES_VAR</td>
1.320 wiz 11305: <td>BUILTIN_FIND_GREP</td>
1.269 leot 11306: </tr>
11307: <tr>
1.303 bacon 11308: <td>BUILTIN_FIND_HEADERS</td>
1.320 wiz 11309: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.269 leot 11310: </tr>
11311: <tr>
1.309 gutterid 11312: <td>BUILTIN_FIND_PKGCONFIG</td>
1.320 wiz 11313: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.309 gutterid 11314: </tr>
11315: <tr>
1.303 bacon 11316: <td>BUILTIN_PKG</td>
1.320 wiz 11317: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.269 leot 11318: </tr>
11319: <tr>
1.303 bacon 11320: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.320 wiz 11321: <td>BUILTIN_VERSION_SCRIPT</td>
1.269 leot 11322: </tr>
11323: <tr>
1.303 bacon 11324: <td>BUILTIN_X11_TYPE</td>
1.320 wiz 11325: <td>BUILTIN_X11_VERSION</td>
1.269 leot 11326: </tr>
11327: <tr>
1.303 bacon 11328: <td>CACTI_GROUP</td>
1.320 wiz 11329: <td>CACTI_USER</td>
1.269 leot 11330: </tr>
11331: <tr>
1.303 bacon 11332: <td>CANNA_GROUP</td>
1.320 wiz 11333: <td>CANNA_USER</td>
1.269 leot 11334: </tr>
11335: <tr>
1.303 bacon 11336: <td>CAT</td>
1.320 wiz 11337: <td>CBLAS_LIBS</td>
1.269 leot 11338: </tr>
11339: <tr>
11340: <td>CCACHE_BASE</td>
1.303 bacon 11341: <td>CCACHE_DIR</td>
1.269 leot 11342: </tr>
11343: <tr>
11344: <td>CCACHE_LOGFILE</td>
1.303 bacon 11345: <td>CC_VERSION</td>
1.269 leot 11346: </tr>
11347: <tr>
11348: <td>CC_VERSION_STRING</td>
1.303 bacon 11349: <td>CDRECORD_CONF</td>
1.269 leot 11350: </tr>
11351: <tr>
11352: <td>CDROM_PKG_URL_DIR</td>
1.303 bacon 11353: <td>CDROM_PKG_URL_HOST</td>
1.269 leot 11354: </tr>
11355: <tr>
1.320 wiz 11356: <td>CHECKOUT_DATE</td>
1.303 bacon 11357: <td>CHECK_COMPILER</td>
1.320 wiz 11358: </tr>
11359: <tr>
1.315 cirnatda 11360: <td>CHECK_FAKEHOME</td>
1.320 wiz 11361: <td>CHECK_FILES</td>
1.311 leot 11362: </tr>
11363: <tr>
1.315 cirnatda 11364: <td>CHECK_FILES_SKIP</td>
1.320 wiz 11365: <td>CHECK_FILES_STRICT</td>
1.292 leot 11366: </tr>
11367: <tr>
1.315 cirnatda 11368: <td>CHECK_HEADERS</td>
1.320 wiz 11369: <td>CHECK_HEADERS_SKIP</td>
1.274 rillig 11370: </tr>
11371: <tr>
1.315 cirnatda 11372: <td>CHECK_INTERPRETER</td>
1.320 wiz 11373: <td>CHECK_INTERPRETER_SKIP</td>
1.269 leot 11374: </tr>
11375: <tr>
1.315 cirnatda 11376: <td>CHECK_PERMS</td>
1.320 wiz 11377: <td>CHECK_PERMS_AUTOFIX</td>
1.269 leot 11378: </tr>
11379: <tr>
1.315 cirnatda 11380: <td>CHECK_PERMS_SKIP</td>
1.320 wiz 11381: <td>CHECK_PORTABILITY</td>
1.269 leot 11382: </tr>
11383: <tr>
1.315 cirnatda 11384: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.320 wiz 11385: <td>CHECK_PORTABILITY_SKIP</td>
1.269 leot 11386: </tr>
11387: <tr>
1.315 cirnatda 11388: <td>CHECK_RELRO</td>
1.320 wiz 11389: <td>CHECK_RELRO_SKIP</td>
1.269 leot 11390: </tr>
11391: <tr>
1.315 cirnatda 11392: <td>CHECK_RELRO_SUPPORTED</td>
1.320 wiz 11393: <td>CHECK_SHLIBS</td>
1.269 leot 11394: </tr>
11395: <tr>
1.315 cirnatda 11396: <td>CHECK_SHLIBS_BLACKLIST</td>
1.320 wiz 11397: <td>CHECK_SHLIBS_SKIP</td>
1.269 leot 11398: </tr>
11399: <tr>
1.315 cirnatda 11400: <td>CHECK_SHLIBS_SUPPORTED</td>
1.320 wiz 11401: <td>CHECK_SSP</td>
1.269 leot 11402: </tr>
11403: <tr>
1.315 cirnatda 11404: <td>CHECK_SSP_SKIP</td>
1.320 wiz 11405: <td>CHECK_SSP_SUPPORTED</td>
1.269 leot 11406: </tr>
11407: <tr>
1.315 cirnatda 11408: <td>CHECK_STRIPPED</td>
1.320 wiz 11409: <td>CHECK_STRIPPED_SKIP</td>
1.269 leot 11410: </tr>
11411: <tr>
1.315 cirnatda 11412: <td>CHECK_WRKREF</td>
1.320 wiz 11413: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.269 leot 11414: </tr>
11415: <tr>
1.315 cirnatda 11416: <td>CHECK_WRKREF_SKIP</td>
1.320 wiz 11417: <td>CLAMAV_DBDIR</td>
1.269 leot 11418: </tr>
11419: <tr>
1.315 cirnatda 11420: <td>CLAMAV_GROUP</td>
1.320 wiz 11421: <td>CLAMAV_USER</td>
1.269 leot 11422: </tr>
11423: <tr>
1.315 cirnatda 11424: <td>CLANGBASE</td>
1.320 wiz 11425: <td>CLEANDEPENDS</td>
1.269 leot 11426: </tr>
11427: <tr>
1.315 cirnatda 11428: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.320 wiz 11429: <td>CMAKE_INSTALL_NAME_DIR</td>
1.269 leot 11430: </tr>
11431: <tr>
1.315 cirnatda 11432: <td>CMAKE_INSTALL_PREFIX</td>
1.320 wiz 11433: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.269 leot 11434: </tr>
11435: <tr>
1.315 cirnatda 11436: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.320 wiz 11437: <td>CMAKE_PREFIX_PATH</td>
1.269 leot 11438: </tr>
11439: <tr>
1.305 bacon 11440: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.320 wiz 11441: <td>COMMON_LISP_DOCFILES</td>
11442: </tr>
11443: <tr>
11444: <td>COMMON_LISP_EXAMPLES</td>
11445: <td>COMMON_LISP_EXTRAFILES</td>
11446: </tr>
11447: <tr>
11448: <td>COMMON_LISP_PACKAGES</td>
11449: <td>COMMON_LISP_SYSTEM</td>
1.292 leot 11450: </tr>
11451: <tr>
1.305 bacon 11452: <td>COMPILER_RPATH_FLAG</td>
1.269 leot 11453: <td>COMPILER_USE_SYMLINKS</td>
11454: </tr>
11455: <tr>
1.305 bacon 11456: <td>CONFIGURE_ARGS</td>
1.269 leot 11457: <td>CONFIGURE_DIRS</td>
11458: </tr>
11459: <tr>
1.305 bacon 11460: <td>CONFIGURE_ENV</td>
1.287 rillig 11461: <td>CONFIGURE_ENV_SHELL</td>
1.269 leot 11462: </tr>
11463: <tr>
1.305 bacon 11464: <td>CONFIGURE_HAS_INFODIR</td>
1.269 leot 11465: <td>CONFIGURE_HAS_MANDIR</td>
11466: </tr>
11467: <tr>
1.305 bacon 11468: <td>CONFIGURE_SCRIPT</td>
1.269 leot 11469: <td>CONFIG_SHELL</td>
11470: </tr>
11471: <tr>
1.305 bacon 11472: <td>CONFIG_SHELL_FLAGS</td>
1.269 leot 11473: <td>CONF_FILES</td>
11474: </tr>
11475: <tr>
1.305 bacon 11476: <td>CONF_FILES_MODE</td>
1.269 leot 11477: <td>CONF_FILES_PERMS</td>
11478: </tr>
11479: <tr>
1.305 bacon 11480: <td>CONSERVER_DEFAULTHOST</td>
1.269 leot 11481: <td>CONSERVER_DEFAULTPORT</td>
11482: </tr>
11483: <tr>
1.305 bacon 11484: <td>CP</td>
1.269 leot 11485: <td>CPP</td>
11486: </tr>
11487: <tr>
1.305 bacon 11488: <td>CPP_PRECOMP_FLAGS</td>
1.269 leot 11489: <td>CREATE_WRKDIR_SYMLINK</td>
11490: </tr>
11491: <tr>
1.305 bacon 11492: <td>CROSSBASE</td>
1.269 leot 11493: <td>CTFCONVERT</td>
11494: </tr>
11495: <tr>
1.305 bacon 11496: <td>CTF_FILES_SKIP</td>
1.269 leot 11497: <td>CTF_SUPPORTED</td>
11498: </tr>
11499: <tr>
1.305 bacon 11500: <td>CTYPE</td>
1.269 leot 11501: <td>CUPS_GROUP</td>
11502: </tr>
11503: <tr>
1.305 bacon 11504: <td>CUPS_SYSTEM_GROUPS</td>
1.269 leot 11505: <td>CUPS_USER</td>
11506: </tr>
11507: <tr>
1.305 bacon 11508: <td>CURSES_DEFAULT</td>
1.269 leot 11509: <td>CURSES_TYPE</td>
1.292 leot 11510: </tr>
11511: <tr>
1.320 wiz 11512: <td>CVS_EXTRACTDIR</td>
11513: <td>CVS_MODULE</td>
11514: </tr>
11515: <tr>
11516: <td>CVS_PROJECT</td>
11517: <td>CVS_REPOSITORIES</td>
11518: </tr>
11519: <tr>
11520: <td>CVS_ROOT</td>
11521: <td>CVS_ROOT_GNU</td>
11522: </tr>
11523: <tr>
11524: <td>CVS_ROOT_NONGNU</td>
11525: <td>CVS_ROOT_SOURCEFORGE</td>
11526: </tr>
11527: <tr>
11528: <td>CVS_TAG</td>
1.273 brook 11529: <td>CXX</td>
1.320 wiz 11530: </tr>
11531: <tr>
1.315 cirnatda 11532: <td>CYRUS_GROUP</td>
1.320 wiz 11533: <td>CYRUS_IDLE</td>
1.311 leot 11534: </tr>
11535: <tr>
1.315 cirnatda 11536: <td>CYRUS_USER</td>
1.320 wiz 11537: <td>DAEMONTOOLS_GROUP</td>
1.269 leot 11538: </tr>
11539: <tr>
1.315 cirnatda 11540: <td>DAEMONTOOLS_LOG_USER</td>
1.320 wiz 11541: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.269 leot 11542: </tr>
11543: <tr>
1.315 cirnatda 11544: <td>DARWIN_REQUIRES_FILTER</td>
1.320 wiz 11545: <td>DBUS_GROUP</td>
1.269 leot 11546: </tr>
11547: <tr>
1.315 cirnatda 11548: <td>DBUS_USER</td>
1.320 wiz 11549: <td>DEFANG_GROUP</td>
1.309 gutterid 11550: </tr>
11551: <tr>
1.315 cirnatda 11552: <td>DEFANG_USER</td>
1.320 wiz 11553: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.269 leot 11554: </tr>
11555: <tr>
1.315 cirnatda 11556: <td>DEFAULT_DISTFILES</td>
1.320 wiz 11557: <td>DEFAULT_IRC_SERVER</td>
1.269 leot 11558: </tr>
11559: <tr>
1.315 cirnatda 11560: <td>DEFAULT_SERIAL_DEVICE</td>
1.320 wiz 11561: <td>DEF_UMASK</td>
1.269 leot 11562: </tr>
11563: <tr>
1.315 cirnatda 11564: <td>DEINSTALLDEPENDS</td>
1.320 wiz 11565: <td>DEINSTALL_SRC</td>
1.269 leot 11566: </tr>
11567: <tr>
1.315 cirnatda 11568: <td>DEINSTALL_TEMPLATES</td>
1.320 wiz 11569: <td>DELAYED_ERROR_MSG</td>
1.269 leot 11570: </tr>
11571: <tr>
1.315 cirnatda 11572: <td>DELAYED_WARNING_MSG</td>
1.320 wiz 11573: <td>DEPENDS</td>
1.269 leot 11574: </tr>
11575: <tr>
1.315 cirnatda 11576: <td>DEPENDS_TARGET</td>
1.320 wiz 11577: <td>DEPENDS_TYPE</td>
1.269 leot 11578: </tr>
11579: <tr>
1.315 cirnatda 11580: <td>DESTDIR</td>
1.320 wiz 11581: <td>DESTDIR_VARNAME</td>
1.269 leot 11582: </tr>
11583: <tr>
1.315 cirnatda 11584: <td>DIALER_GROUP</td>
1.320 wiz 11585: <td>DIGEST_REQD</td>
1.269 leot 11586: </tr>
11587: <tr>
1.315 cirnatda 11588: <td>DISTDIR</td>
1.320 wiz 11589: <td>DISTFILES</td>
1.269 leot 11590: </tr>
11591: <tr>
1.315 cirnatda 11592: <td>DISTINFO_FILE</td>
1.320 wiz 11593: <td>DISTNAME</td>
1.269 leot 11594: </tr>
11595: <tr>
1.315 cirnatda 11596: <td>DIST_PATH</td>
1.320 wiz 11597: <td>DIST_SUBDIR</td>
1.269 leot 11598: </tr>
11599: <tr>
1.315 cirnatda 11600: <td>DJBDNS_AXFR_USER</td>
1.320 wiz 11601: <td>DJBDNS_CACHE_USER</td>
1.269 leot 11602: </tr>
11603: <tr>
1.315 cirnatda 11604: <td>DJBDNS_DJBDNS_GROUP</td>
1.320 wiz 11605: <td>DJBDNS_LOG_USER</td>
1.269 leot 11606: </tr>
11607: <tr>
1.315 cirnatda 11608: <td>DJBDNS_RBL_USER</td>
1.320 wiz 11609: <td>DJBDNS_TINY_USER</td>
1.269 leot 11610: </tr>
11611: <tr>
1.315 cirnatda 11612: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.320 wiz 11613: <td>DL_AUTO_VARS</td>
1.269 leot 11614: </tr>
11615: <tr>
1.315 cirnatda 11616: <td>DL_CFLAGS</td>
1.320 wiz 11617: <td>DL_LDFLAGS</td>
1.269 leot 11618: </tr>
11619: <tr>
1.315 cirnatda 11620: <td>DL_LIBS</td>
1.320 wiz 11621: <td>DNS</td>
1.269 leot 11622: </tr>
11623: <tr>
1.315 cirnatda 11624: <td>DOCOWN</td>
1.320 wiz 11625: <td>DOWNLOADED_DISTFILE</td>
1.269 leot 11626: </tr>
11627: <tr>
1.315 cirnatda 11628: <td>DT_LAYOUT</td>
1.320 wiz 11629: <td>DYNAMIC_SITES_CMD</td>
1.269 leot 11630: </tr>
11631: <tr>
1.315 cirnatda 11632: <td>DYNAMIC_SITES_SCRIPT</td>
1.320 wiz 11633: <td>ECHO</td>
1.269 leot 11634: </tr>
11635: <tr>
1.315 cirnatda 11636: <td>ECHO_N</td>
1.320 wiz 11637: <td>ELK_GUI</td>
1.269 leot 11638: </tr>
11639: <tr>
1.315 cirnatda 11640: <td>EMACS_TYPE</td>
1.320 wiz 11641: <td>EMULDIR</td>
1.269 leot 11642: </tr>
11643: <tr>
1.315 cirnatda 11644: <td>EMULSUBDIR</td>
1.320 wiz 11645: <td>EMULSUBDIRSLASH</td>
1.269 leot 11646: </tr>
11647: <tr>
1.315 cirnatda 11648: <td>EMUL_ARCH</td>
1.320 wiz 11649: <td>EMUL_DISTRO</td>
1.269 leot 11650: </tr>
11651: <tr>
1.315 cirnatda 11652: <td>EMUL_EXEC_FMT</td>
1.320 wiz 11653: <td>EMUL_IS_NATIVE</td>
1.269 leot 11654: </tr>
11655: <tr>
1.315 cirnatda 11656: <td>EMUL_MODULES</td>
1.320 wiz 11657: <td>EMUL_OPSYS</td>
1.269 leot 11658: </tr>
11659: <tr>
1.315 cirnatda 11660: <td>EMUL_PKG_FMT</td>
1.320 wiz 11661: <td>EMUL_PLATFORM</td>
1.269 leot 11662: </tr>
11663: <tr>
1.315 cirnatda 11664: <td>EMUL_PLATFORMS</td>
1.320 wiz 11665: <td>EMUL_PREFER</td>
1.269 leot 11666: </tr>
11667: <tr>
1.315 cirnatda 11668: <td>EMUL_REQD</td>
1.320 wiz 11669: <td>EMUL_TYPE</td>
1.269 leot 11670: </tr>
11671: <tr>
1.315 cirnatda 11672: <td>ERROR_MSG</td>
1.320 wiz 11673: <td>EXIM_GROUP</td>
1.269 leot 11674: </tr>
11675: <tr>
1.315 cirnatda 11676: <td>EXIM_USER</td>
1.320 wiz 11677: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.269 leot 11678: </tr>
11679: <tr>
1.315 cirnatda 11680: <td>EXTRACTOR</td>
1.320 wiz 11681: <td>EXTRACT_CMD</td>
1.269 leot 11682: </tr>
11683: <tr>
1.315 cirnatda 11684: <td>EXTRACT_CMD_DEFAULT</td>
1.320 wiz 11685: <td>EXTRACT_DIR</td>
1.269 leot 11686: </tr>
11687: <tr>
1.315 cirnatda 11688: <td>EXTRACT_ELEMENTS</td>
1.320 wiz 11689: <td>EXTRACT_ENV</td>
1.269 leot 11690: </tr>
11691: <tr>
1.315 cirnatda 11692: <td>EXTRACT_ONLY</td>
1.320 wiz 11693: <td>EXTRACT_OPTS</td>
1.269 leot 11694: </tr>
11695: <tr>
1.315 cirnatda 11696: <td>EXTRACT_SUFX</td>
1.320 wiz 11697: <td>EXTRACT_USING</td>
1.269 leot 11698: </tr>
11699: <tr>
1.315 cirnatda 11700: <td>FAIL</td>
1.320 wiz 11701: <td>FAILOVER_FETCH</td>
1.269 leot 11702: </tr>
11703: <tr>
1.315 cirnatda 11704: <td>FAIL_MSG</td>
1.320 wiz 11705: <td>FAKE_NCURSES</td>
1.292 leot 11706: </tr>
11707: <tr>
1.315 cirnatda 11708: <td>FAM</td>
1.320 wiz 11709: <td>FAM_ACCEPTED</td>
1.269 leot 11710: </tr>
11711: <tr>
1.315 cirnatda 11712: <td>FAM_DEFAULT</td>
1.320 wiz 11713: <td>FAM_SERVER</td>
1.269 leot 11714: </tr>
11715: <tr>
1.315 cirnatda 11716: <td>FCPATH</td>
1.320 wiz 11717: <td>FEATURE_CPPFLAGS</td>
1.269 leot 11718: </tr>
11719: <tr>
1.315 cirnatda 11720: <td>FEATURE_LDFLAGS</td>
1.320 wiz 11721: <td>FEATURE_LIBS</td>
1.269 leot 11722: </tr>
11723: <tr>
1.315 cirnatda 11724: <td>FETCH_AFTER_ARGS</td>
1.320 wiz 11725: <td>FETCH_BEFORE_ARGS</td>
1.269 leot 11726: </tr>
11727: <tr>
1.315 cirnatda 11728: <td>FETCH_CMD</td>
1.320 wiz 11729: <td>FETCH_OUTPUT_ARGS</td>
1.269 leot 11730: </tr>
11731: <tr>
1.315 cirnatda 11732: <td>FETCH_PROXY</td>
1.320 wiz 11733: <td>FETCH_RESUME_ARGS</td>
1.269 leot 11734: </tr>
11735: <tr>
1.315 cirnatda 11736: <td>FETCH_TIMEOUT</td>
1.320 wiz 11737: <td>FETCH_USE_IPV4_ONLY</td>
1.269 leot 11738: </tr>
11739: <tr>
1.315 cirnatda 11740: <td>FETCH_USING</td>
1.320 wiz 11741: <td>FILES_SUBST</td>
1.303 bacon 11742: </tr>
11743: <tr>
1.315 cirnatda 11744: <td>FILES_SUBST_SED</td>
1.320 wiz 11745: <td>FIX_SYSTEM_HEADERS</td>
1.269 leot 11746: </tr>
11747: <tr>
1.315 cirnatda 11748: <td>FLUXBOX_USE_GNOME</td>
1.320 wiz 11749: <td>FLUXBOX_USE_KDE</td>
1.269 leot 11750: </tr>
11751: <tr>
1.315 cirnatda 11752: <td>FLUXBOX_USE_XFT</td>
1.320 wiz 11753: <td>FLUXBOX_USE_XINERAMA</td>
1.269 leot 11754: </tr>
11755: <tr>
1.320 wiz 11756: <td>FONTDIR</td>
1.295 rillig 11757: <td>FONTS_DIRS</td>
1.274 rillig 11758: </tr>
11759: <tr>
1.305 bacon 11760: <td>FONTS_VERBOSE</td>
1.295 rillig 11761: <td>FOO_HACKS_MK</td>
1.292 leot 11762: </tr>
11763: <tr>
1.320 wiz 11764: <td>FOSSIL_EXTRACTDIR</td>
11765: <td>FOSSIL_REPO</td>
11766: </tr>
11767: <tr>
11768: <td>FOSSIL_REPOSITORIES</td>
11769: <td>FOSSIL_VERSION</td>
11770: </tr>
11771: <tr>
1.305 bacon 11772: <td>FOX_USE_XUNICODE</td>
1.295 rillig 11773: <td>FREEWNN_GROUP</td>
1.269 leot 11774: </tr>
11775: <tr>
1.305 bacon 11776: <td>FREEWNN_USER</td>
1.295 rillig 11777: <td>FTP_PKG_URL_DIR</td>
1.269 leot 11778: </tr>
11779: <tr>
1.305 bacon 11780: <td>FTP_PKG_URL_HOST</td>
1.295 rillig 11781: <td>GAMEDATAMODE</td>
1.269 leot 11782: </tr>
11783: <tr>
1.305 bacon 11784: <td>GAMEDATA_PERMS</td>
1.295 rillig 11785: <td>GAMEDIRMODE</td>
1.269 leot 11786: </tr>
11787: <tr>
1.305 bacon 11788: <td>GAMEDIR_PERMS</td>
1.295 rillig 11789: <td>GAMEGRP</td>
1.269 leot 11790: </tr>
11791: <tr>
1.305 bacon 11792: <td>GAMEMODE</td>
1.295 rillig 11793: <td>GAMEOWN</td>
1.269 leot 11794: </tr>
11795: <tr>
1.305 bacon 11796: <td>GAMES_GROUP</td>
1.295 rillig 11797: <td>GAMES_USER</td>
1.269 leot 11798: </tr>
11799: <tr>
1.305 bacon 11800: <td>GCC</td>
1.295 rillig 11801: <td>GCCBASE</td>
1.269 leot 11802: </tr>
11803: <tr>
1.305 bacon 11804: <td>GCC_REQD</td>
1.295 rillig 11805: <td>GCC_VERSION_SUFFIX</td>
1.269 leot 11806: </tr>
11807: <tr>
1.305 bacon 11808: <td>GEM_BUILD</td>
1.295 rillig 11809: <td>GEM_CLEANBUILD</td>
1.269 leot 11810: </tr>
11811: <tr>
1.305 bacon 11812: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.295 rillig 11813: <td>GEM_DOCDIR</td>
1.269 leot 11814: </tr>
11815: <tr>
1.305 bacon 11816: <td>GEM_EXTSDIR</td>
1.295 rillig 11817: <td>GEM_HOME</td>
1.292 leot 11818: </tr>
11819: <tr>
1.305 bacon 11820: <td>GEM_KEEPBUILD</td>
1.295 rillig 11821: <td>GEM_LIBDIR</td>
1.269 leot 11822: </tr>
11823: <tr>
1.305 bacon 11824: <td>GEM_NAME</td>
1.295 rillig 11825: <td>GEM_PATH</td>
1.269 leot 11826: </tr>
11827: <tr>
1.312 gdt 11828: <td>GEM_PLUGINSDIR</td>
1.305 bacon 11829: <td>GEM_SPECFILE</td>
1.269 leot 11830: </tr>
11831: <tr>
1.312 gdt 11832: <td>GENERATE_PLIST</td>
1.316 cirnatda 11833: <td>GHC</td>
1.269 leot 11834: </tr>
11835: <tr>
1.316 cirnatda 11836: <td>GHOSTSCRIPT_REQD</td>
1.312 gdt 11837: <td>GITHUB_PROJECT</td>
1.292 leot 11838: </tr>
11839: <tr>
1.316 cirnatda 11840: <td>GITHUB_RELEASE</td>
1.315 cirnatda 11841: <td>GITHUB_SUBMODULES</td>
1.311 leot 11842: </tr>
11843: <tr>
1.316 cirnatda 11844: <td>GITHUB_TAG</td>
1.313 leot 11845: <td>GITHUB_TYPE</td>
1.269 leot 11846: </tr>
11847: <tr>
1.320 wiz 11848: <td>GITLAB_PROJECT</td>
11849: <td>GITLAB_TAG</td>
11850: </tr>
11851: <tr>
11852: <td>GITLAB_TYPE</td>
11853: <td>GIT_BRANCH</td>
11854: </tr>
11855: <tr>
11856: <td>GIT_ENV</td>
11857: <td>GIT_EXTRACTDIR</td>
11858: </tr>
11859: <tr>
11860: <td>GIT_REPO</td>
11861: <td>GIT_REPOSITORIES</td>
11862: </tr>
11863: <tr>
11864: <td>GIT_REVISION</td>
11865: <td>GIT_TAG</td>
11866: </tr>
11867: <tr>
1.316 cirnatda 11868: <td>GNU</td>
1.313 leot 11869: <td>GNU_CONFIGURE</td>
1.269 leot 11870: </tr>
11871: <tr>
1.316 cirnatda 11872: <td>GNU_CONFIGURE_INFODIR</td>
1.313 leot 11873: <td>GNU_CONFIGURE_MANDIR</td>
1.269 leot 11874: </tr>
11875: <tr>
1.316 cirnatda 11876: <td>GNU_CONFIGURE_QUIET</td>
1.313 leot 11877: <td>GNU_CONFIGURE_STRICT</td>
1.269 leot 11878: </tr>
11879: <tr>
1.316 cirnatda 11880: <td>GODEP_REDIRECTS</td>
1.313 leot 11881: <td>GO_BUILD_PATTERN</td>
1.276 leot 11882: </tr>
11883: <tr>
1.316 cirnatda 11884: <td>GO_DEPS</td>
1.313 leot 11885: <td>GO_DIST_BASE</td>
1.269 leot 11886: </tr>
11887: <tr>
1.316 cirnatda 11888: <td>GO_MODULE_FILES</td>
1.313 leot 11889: <td>GO_SRCPATH</td>
1.269 leot 11890: </tr>
11891: <tr>
1.316 cirnatda 11892: <td>GO_VERSION_DEFAULT</td>
1.313 leot 11893: <td>GROUP_SPECIFIC_PKGS</td>
1.269 leot 11894: </tr>
11895: <tr>
1.316 cirnatda 11896: <td>GRUB_NETWORK_CARDS</td>
1.313 leot 11897: <td>GRUB_PRESET_COMMAND</td>
1.311 leot 11898: </tr>
11899: <tr>
1.316 cirnatda 11900: <td>GRUB_SCAN_ARGS</td>
1.313 leot 11901: <td>GZIP</td>
1.269 leot 11902: </tr>
11903: <tr>
1.320 wiz 11904: <td>HASKELL_COMPILER</td>
1.316 cirnatda 11905: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.320 wiz 11906: </tr>
11907: <tr>
1.312 gdt 11908: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.320 wiz 11909: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.269 leot 11910: </tr>
11911: <tr>
1.312 gdt 11912: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.320 wiz 11913: <td>HAS_CONFIGURE</td>
1.292 leot 11914: </tr>
11915: <tr>
1.312 gdt 11916: <td>HEADER_TEMPLATES</td>
1.320 wiz 11917: <td>HG_REPO</td>
11918: </tr>
11919: <tr>
11920: <td>HG_REPOSITORIES</td>
11921: <td>HG_TAG</td>
1.269 leot 11922: </tr>
11923: <tr>
1.316 cirnatda 11924: <td>HOMEPAGE</td>
1.313 leot 11925: <td>HOST_PKGTOOLS_ARGS</td>
1.269 leot 11926: </tr>
11927: <tr>
1.316 cirnatda 11928: <td>HOST_SPECIFIC_PKGS</td>
1.313 leot 11929: <td>HOWL_GROUP</td>
1.305 bacon 11930: </tr>
11931: <tr>
1.316 cirnatda 11932: <td>HOWL_USER</td>
1.313 leot 11933: <td>ICCBASE</td>
1.269 leot 11934: </tr>
11935: <tr>
1.316 cirnatda 11936: <td>ICECAST_CHROOTDIR</td>
1.313 leot 11937: <td>ICON_THEMES</td>
1.269 leot 11938: </tr>
11939: <tr>
1.316 cirnatda 11940: <td>IDOBASE</td>
1.313 leot 11941: <td>IGNORE_CCACHE</td>
1.269 leot 11942: </tr>
11943: <tr>
1.316 cirnatda 11944: <td>IGNORE_INFO_DIRS</td>
1.313 leot 11945: <td>IGNORE_INTERACTIVE_FETCH</td>
1.269 leot 11946: </tr>
11947: <tr>
1.316 cirnatda 11948: <td>IMAKE</td>
1.313 leot 11949: <td>IMAKEOPTS</td>
1.269 leot 11950: </tr>
11951: <tr>
1.316 cirnatda 11952: <td>IMAKE_MAKE</td>
1.313 leot 11953: <td>IMAKE_MANINSTALL</td>
1.269 leot 11954: </tr>
11955: <tr>
1.316 cirnatda 11956: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.313 leot 11957: <td>IMDICTDIR</td>
1.269 leot 11958: </tr>
11959: <tr>
1.316 cirnatda 11960: <td>INCOMPAT_CURSES</td>
1.313 leot 11961: <td>INFO_DIR</td>
1.269 leot 11962: </tr>
11963: <tr>
1.316 cirnatda 11964: <td>INFO_FILES</td>
1.313 leot 11965: <td>INFO_FILES_VERBOSE</td>
1.269 leot 11966: </tr>
11967: <tr>
1.316 cirnatda 11968: <td>INFO_MSG</td>
1.313 leot 11969: <td>INIT_SYSTEM</td>
1.287 rillig 11970: </tr>
11971: <tr>
1.316 cirnatda 11972: <td>INN_DATA_DIR</td>
1.313 leot 11973: <td>INN_GROUP</td>
1.269 leot 11974: </tr>
11975: <tr>
1.316 cirnatda 11976: <td>INN_USER</td>
1.313 leot 11977: <td>INSTALLATION_DIRS</td>
1.269 leot 11978: </tr>
11979: <tr>
1.316 cirnatda 11980: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.313 leot 11981: <td>INSTALL_ENV</td>
1.269 leot 11982: </tr>
11983: <tr>
1.316 cirnatda 11984: <td>INSTALL_SH_OVERRIDE</td>
1.313 leot 11985: <td>INSTALL_SRC</td>
1.269 leot 11986: </tr>
11987: <tr>
1.316 cirnatda 11988: <td>INSTALL_TEMPLATES</td>
1.313 leot 11989: <td>INSTALL_UNSTRIPPED</td>
1.269 leot 11990: </tr>
11991: <tr>
1.316 cirnatda 11992: <td>IRCD_HYBRID_IRC_GROUP</td>
1.313 leot 11993: <td>IRCD_HYBRID_IRC_USER</td>
1.269 leot 11994: </tr>
11995: <tr>
1.316 cirnatda 11996: <td>IRCD_HYBRID_MAXCONN</td>
1.313 leot 11997: <td>IRCD_HYBRID_NICLEN</td>
1.269 leot 11998: </tr>
11999: <tr>
1.316 cirnatda 12000: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.313 leot 12001: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.269 leot 12002: </tr>
12003: <tr>
1.316 cirnatda 12004: <td>IRCD_HYBRID_TOPICLEN</td>
1.313 leot 12005: <td>IRIX</td>
1.269 leot 12006: </tr>
12007: <tr>
1.316 cirnatda 12008: <td>IRRD_USE_PGP</td>
1.313 leot 12009: <td>JABBERD_GROUP</td>
1.269 leot 12010: </tr>
12011: <tr>
1.316 cirnatda 12012: <td>JABBERD_LOGDIR</td>
1.313 leot 12013: <td>JABBERD_PIDDIR</td>
1.292 leot 12014: </tr>
12015: <tr>
1.316 cirnatda 12016: <td>JABBERD_SPOOLDIR</td>
1.313 leot 12017: <td>JABBERD_USER</td>
1.311 leot 12018: </tr>
12019: <tr>
1.316 cirnatda 12020: <td>JAKARTA_HOME</td>
1.320 wiz 12021: <td>JAVA_APP_PATH</td>
12022: </tr>
12023: <tr>
12024: <td>JAVA_APP_TARGETS</td>
1.313 leot 12025: <td>JAVA_BINPREFIX</td>
1.269 leot 12026: </tr>
12027: <tr>
1.316 cirnatda 12028: <td>JAVA_CLASSPATH</td>
1.313 leot 12029: <td>JAVA_HOME</td>
1.269 leot 12030: </tr>
12031: <tr>
1.316 cirnatda 12032: <td>JAVA_LD_LIBRARY_PATH</td>
1.313 leot 12033: <td>JAVA_NAME</td>
1.269 leot 12034: </tr>
12035: <tr>
1.316 cirnatda 12036: <td>JAVA_UNLIMIT</td>
1.313 leot 12037: <td>JAVA_WRAPPERS</td>
1.269 leot 12038: </tr>
12039: <tr>
1.316 cirnatda 12040: <td>JPEG_ACCEPTED</td>
1.313 leot 12041: <td>JPEG_DEFAULT</td>
1.269 leot 12042: </tr>
12043: <tr>
1.316 cirnatda 12044: <td>KERBEROS</td>
1.313 leot 12045: <td>KERMIT_SUID_UUCP</td>
1.269 leot 12046: </tr>
12047: <tr>
1.316 cirnatda 12048: <td>KJS_USE_PCRE</td>
1.313 leot 12049: <td>KNEWS_DOMAIN_FILE</td>
1.292 leot 12050: </tr>
12051: <tr>
1.316 cirnatda 12052: <td>KNEWS_DOMAIN_NAME</td>
1.313 leot 12053: <td>KRB5_ACCEPTED</td>
1.271 brook 12054: </tr>
12055: <tr>
1.316 cirnatda 12056: <td>KRB5_DEFAULT</td>
1.313 leot 12057: <td>LANGUAGES</td>
1.269 leot 12058: </tr>
12059: <tr>
1.320 wiz 12060: <td>LAPACKE_LIBS</td>
1.316 cirnatda 12061: <td>LAPACK_LIBS</td>
1.269 leot 12062: </tr>
12063: <tr>
1.320 wiz 12064: <td>LATEX2HTML_ICONPATH</td>
1.316 cirnatda 12065: <td>LDCONFIG_ADD_CMD</td>
1.269 leot 12066: </tr>
12067: <tr>
1.320 wiz 12068: <td>LDCONFIG_REMOVE_CMD</td>
1.316 cirnatda 12069: <td>LEAFNODE_DATA_DIR</td>
1.269 leot 12070: </tr>
12071: <tr>
1.320 wiz 12072: <td>LEAFNODE_GROUP</td>
1.316 cirnatda 12073: <td>LEAFNODE_USER</td>
1.320 wiz 12074: </tr>
12075: <tr>
1.313 leot 12076: <td>LIBDVDCSS_HOMEPAGE</td>
1.320 wiz 12077: <td>LIBDVDCSS_MASTER_SITES</td>
1.270 leot 12078: </tr>
12079: <tr>
1.313 leot 12080: <td>LIBRSVG_TYPE</td>
1.320 wiz 12081: <td>LIBTOOL</td>
1.269 leot 12082: </tr>
12083: <tr>
1.313 leot 12084: <td>LIBTOOLIZE_PLIST</td>
1.320 wiz 12085: <td>LIBTOOL_M4_OVERRIDE</td>
1.292 leot 12086: </tr>
12087: <tr>
1.313 leot 12088: <td>LIBUSB_TYPE</td>
1.320 wiz 12089: <td>LICENSE</td>
1.269 leot 12090: </tr>
12091: <tr>
1.313 leot 12092: <td>LINKER_RPATH_FLAG</td>
1.320 wiz 12093: <td>LINK_RPATH_FLAG</td>
1.311 leot 12094: </tr>
12095: <tr>
1.320 wiz 12096: <td>LINUX_BASE_NODEPS</td>
12097: <td>LINUX_BASE_PREFERRED</td>
12098: </tr>
12099: <tr>
12100: <td>LINUX_BASE_REQUIRED</td>
1.312 gdt 12101: <td>LINUX_LOCALES</td>
1.269 leot 12102: </tr>
12103: <tr>
1.316 cirnatda 12104: <td>LOCALBASE</td>
1.312 gdt 12105: <td>LOCALBASE_LOCKTYPE</td>
1.269 leot 12106: </tr>
12107: <tr>
1.316 cirnatda 12108: <td>LOCALPATCHES</td>
1.312 gdt 12109: <td>LOVE_DATA</td>
1.269 leot 12110: </tr>
12111: <tr>
1.316 cirnatda 12112: <td>LOVE_GAME</td>
1.312 gdt 12113: <td>LOVE_VERSION</td>
1.269 leot 12114: </tr>
12115: <tr>
1.320 wiz 12116: <td>LP32PLATFORMS</td>
1.316 cirnatda 12117: <td>LP64PLATFORMS</td>
1.320 wiz 12118: </tr>
12119: <tr>
1.312 gdt 12120: <td>MACHINE_PLATFORM</td>
1.320 wiz 12121: <td>MAILAGENT_DOMAIN</td>
1.269 leot 12122: </tr>
12123: <tr>
1.312 gdt 12124: <td>MAILAGENT_EMAIL</td>
1.320 wiz 12125: <td>MAILAGENT_FQDN</td>
1.269 leot 12126: </tr>
12127: <tr>
1.312 gdt 12128: <td>MAILAGENT_ORGANIZATION</td>
1.320 wiz 12129: <td>MAJORDOMO_HOMEDIR</td>
1.269 leot 12130: </tr>
12131: <tr>
1.320 wiz 12132: <td>MAJOR_OS_VERSION</td>
1.313 leot 12133: <td>MAKEINFO_ARGS</td>
1.269 leot 12134: </tr>
12135: <tr>
1.316 cirnatda 12136: <td>MAKE_DIRS</td>
1.313 leot 12137: <td>MAKE_DIRS_PERMS</td>
1.269 leot 12138: </tr>
12139: <tr>
1.316 cirnatda 12140: <td>MAKE_ENV</td>
1.313 leot 12141: <td>MAKE_FILE</td>
1.269 leot 12142: </tr>
12143: <tr>
1.316 cirnatda 12144: <td>MAKE_FLAGS</td>
1.313 leot 12145: <td>MAKE_JOBS</td>
1.269 leot 12146: </tr>
12147: <tr>
1.316 cirnatda 12148: <td>MAKE_JOBS_SAFE</td>
1.313 leot 12149: <td>MAKE_PROGRAM</td>
1.303 bacon 12150: </tr>
12151: <tr>
1.316 cirnatda 12152: <td>MANCOMPRESSED_IF_MANZ</td>
1.313 leot 12153: <td>MANINSTALL</td>
1.269 leot 12154: </tr>
12155: <tr>
1.316 cirnatda 12156: <td>MANZ</td>
1.313 leot 12157: <td>MASTER_SITES</td>
1.269 leot 12158: </tr>
12159: <tr>
1.316 cirnatda 12160: <td>MASTER_SITE_BACKUP</td>
1.313 leot 12161: <td>MASTER_SITE_LOCAL</td>
1.269 leot 12162: </tr>
12163: <tr>
1.316 cirnatda 12164: <td>MASTER_SITE_MOZILLA</td>
1.313 leot 12165: <td>MASTER_SITE_OVERRIDE</td>
1.269 leot 12166: </tr>
12167: <tr>
1.316 cirnatda 12168: <td>MASTER_SITE_PERL_CPAN</td>
1.313 leot 12169: <td>MASTER_SORT</td>
1.269 leot 12170: </tr>
12171: <tr>
1.316 cirnatda 12172: <td>MASTER_SORT_RANDOM</td>
1.313 leot 12173: <td>MASTER_SORT_REGEX</td>
1.269 leot 12174: </tr>
12175: <tr>
1.316 cirnatda 12176: <td>MECAB_CHARSET</td>
1.313 leot 12177: <td>MEDIATOMB_GROUP</td>
1.269 leot 12178: </tr>
12179: <tr>
1.316 cirnatda 12180: <td>MEDIATOMB_USER</td>
1.313 leot 12181: <td>MIPSPROBASE</td>
1.269 leot 12182: </tr>
12183: <tr>
1.316 cirnatda 12184: <td>MIREDO_GROUP</td>
1.313 leot 12185: <td>MIREDO_USER</td>
1.269 leot 12186: </tr>
12187: <tr>
1.316 cirnatda 12188: <td>MISSING_FEATURES</td>
1.313 leot 12189: <td>MKDIR</td>
1.269 leot 12190: </tr>
12191: <tr>
1.316 cirnatda 12192: <td>MLDONKEY_GROUP</td>
1.313 leot 12193: <td>MLDONKEY_HOME</td>
1.269 leot 12194: </tr>
12195: <tr>
1.316 cirnatda 12196: <td>MLDONKEY_USER</td>
1.313 leot 12197: <td>MONOTONE_GROUP</td>
1.269 leot 12198: </tr>
12199: <tr>
1.316 cirnatda 12200: <td>MONOTONE_USER</td>
1.313 leot 12201: <td>MOTIFBASE</td>
1.269 leot 12202: </tr>
12203: <tr>
1.316 cirnatda 12204: <td>MOTIF_TYPE</td>
1.313 leot 12205: <td>MOTIF_TYPE_DEFAULT</td>
1.269 leot 12206: </tr>
12207: <tr>
1.316 cirnatda 12208: <td>MPI_TYPE</td>
1.313 leot 12209: <td>MSGFMT_STRIP_MSGCTXT</td>
1.311 leot 12210: </tr>
12211: <tr>
1.316 cirnatda 12212: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.313 leot 12213: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.269 leot 12214: </tr>
12215: <tr>
1.320 wiz 12216: <td>MUST</td>
1.316 cirnatda 12217: <td>MV</td>
1.320 wiz 12218: </tr>
12219: <tr>
1.312 gdt 12220: <td>MYSQL_CHARSET</td>
1.320 wiz 12221: <td>MYSQL_DATADIR</td>
1.269 leot 12222: </tr>
12223: <tr>
1.312 gdt 12224: <td>MYSQL_EXTRA_CHARSET</td>
1.320 wiz 12225: <td>MYSQL_GROUP</td>
1.269 leot 12226: </tr>
12227: <tr>
1.315 cirnatda 12228: <td>MYSQL_USER</td>
1.320 wiz 12229: <td>MYSQL_VERSION</td>
1.269 leot 12230: </tr>
12231: <tr>
1.315 cirnatda 12232: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.320 wiz 12233: <td>MYSQL_VERSIONS_ALL</td>
1.309 gutterid 12234: </tr>
12235: <tr>
1.312 gdt 12236: <td>MYSQL_VERSION_DEFAULT</td>
1.320 wiz 12237: <td>NAGIOSCMD_GROUP</td>
1.269 leot 12238: </tr>
12239: <tr>
1.312 gdt 12240: <td>NAGIOSDIR</td>
1.320 wiz 12241: <td>NAGIOS_GROUP</td>
1.269 leot 12242: </tr>
12243: <tr>
1.312 gdt 12244: <td>NAGIOS_USER</td>
1.320 wiz 12245: <td>NATIVE_APPEND_ABI</td>
1.269 leot 12246: </tr>
12247: <tr>
1.312 gdt 12248: <td>NATIVE_APPEND_ELF</td>
1.320 wiz 12249: <td>NATIVE_EXEC_FMT</td>
1.269 leot 12250: </tr>
12251: <tr>
1.312 gdt 12252: <td>NATIVE_MACHINE_PLATFORM</td>
1.320 wiz 12253: <td>NATIVE_OBJECT_FMT</td>
1.269 leot 12254: </tr>
12255: <tr>
1.312 gdt 12256: <td>NBPAX_PROGRAM_PREFIX</td>
1.320 wiz 12257: <td>NETBSD_LOGIN_NAME</td>
1.269 leot 12258: </tr>
12259: <tr>
1.312 gdt 12260: <td>NMH_EDITOR</td>
1.320 wiz 12261: <td>NMH_MTA</td>
1.293 rillig 12262: </tr>
12263: <tr>
1.312 gdt 12264: <td>NMH_PAGER</td>
1.320 wiz 12265: <td>NOLOGIN</td>
1.269 leot 12266: </tr>
12267: <tr>
1.312 gdt 12268: <td>NOTE</td>
1.320 wiz 12269: <td>NOT_FOR_PLATFORM</td>
1.269 leot 12270: </tr>
12271: <tr>
1.312 gdt 12272: <td>NOT_PAX_ASLR_SAFE</td>
1.320 wiz 12273: <td>NOT_PAX_MPROTECT_SAFE</td>
1.269 leot 12274: </tr>
12275: <tr>
1.312 gdt 12276: <td>NO_BUILD</td>
1.320 wiz 12277: <td>NO_CHECKSUM</td>
1.269 leot 12278: </tr>
12279: <tr>
1.312 gdt 12280: <td>NO_CONFIGURE</td>
1.320 wiz 12281: <td>NO_SKIP</td>
1.269 leot 12282: </tr>
12283: <tr>
1.312 gdt 12284: <td>NS_PREFERRED</td>
1.320 wiz 12285: <td>NULLMAILER_GROUP</td>
1.269 leot 12286: </tr>
12287: <tr>
1.312 gdt 12288: <td>NULLMAILER_USER</td>
1.320 wiz 12289: <td>OASIS</td>
1.269 leot 12290: </tr>
12291: <tr>
1.312 gdt 12292: <td>OASIS_BUILD_ARGS</td>
1.320 wiz 12293: <td>OBJHOSTNAME</td>
1.269 leot 12294: </tr>
12295: <tr>
1.312 gdt 12296: <td>OBJMACHINE</td>
1.320 wiz 12297: <td>OCAML_FINDLIB_DIRS</td>
1.269 leot 12298: </tr>
12299: <tr>
1.312 gdt 12300: <td>OCAML_FINDLIB_REGISTER</td>
1.320 wiz 12301: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.269 leot 12302: </tr>
12303: <tr>
1.312 gdt 12304: <td>OCAML_SITELIBDIR</td>
1.320 wiz 12305: <td>OCAML_TOPKG_DOCDIR</td>
1.269 leot 12306: </tr>
12307: <tr>
1.312 gdt 12308: <td>OCAML_USE_DUNE</td>
1.320 wiz 12309: <td>OCAML_USE_FINDLIB</td>
1.269 leot 12310: </tr>
12311: <tr>
1.312 gdt 12312: <td>OCAML_USE_JBUILDER</td>
1.320 wiz 12313: <td>OCAML_USE_OASIS</td>
1.269 leot 12314: </tr>
12315: <tr>
1.312 gdt 12316: <td>OCAML_USE_OASIS_DYNRUN</td>
1.320 wiz 12317: <td>OCAML_USE_OPAM</td>
1.269 leot 12318: </tr>
12319: <tr>
1.312 gdt 12320: <td>OCAML_USE_OPT_COMPILER</td>
1.320 wiz 12321: <td>OCAML_USE_TOPKG</td>
1.269 leot 12322: </tr>
12323: <tr>
1.312 gdt 12324: <td>OMF</td>
1.320 wiz 12325: <td>ONLY_FOR_COMPILER</td>
1.269 leot 12326: </tr>
12327: <tr>
1.312 gdt 12328: <td>ONLY_FOR_PLATFORM</td>
1.320 wiz 12329: <td>OPENSSH_CHROOT</td>
1.269 leot 12330: </tr>
12331: <tr>
1.312 gdt 12332: <td>OPENSSH_GROUP</td>
1.320 wiz 12333: <td>OPENSSH_USER</td>
1.269 leot 12334: </tr>
12335: <tr>
1.312 gdt 12336: <td>OPSYS</td>
1.320 wiz 12337: <td>OPSYS_EMULDIR</td>
1.269 leot 12338: </tr>
12339: <tr>
1.312 gdt 12340: <td>OS</td>
1.320 wiz 12341: <td>OSS_TYPE</td>
1.312 gdt 12342: </tr>
12343: <tr>
1.311 leot 12344: <td>OSX</td>
1.320 wiz 12345: <td>OSX_TOLERATE_SDK_SKEW</td>
12346: </tr>
12347: <tr>
12348: <td>OS_HAVE_ALSA</td>
12349: <td>OS_HAVE_RCD</td>
1.292 leot 12350: </tr>
12351: <tr>
1.309 gutterid 12352: <td>OS_VARIANT</td>
1.320 wiz 12353: <td>OS_VERSION</td>
1.311 leot 12354: </tr>
12355: <tr>
12356: <td>OTF_FONTS_DIR</td>
1.320 wiz 12357: <td>OVERRIDE_DIRDEPTH</td>
1.269 leot 12358: </tr>
12359: <tr>
1.311 leot 12360: <td>OVERRIDE_GEMSPEC</td>
1.320 wiz 12361: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.269 leot 12362: </tr>
12363: <tr>
1.320 wiz 12364: <td>OVERRIDE_ROCKSPEC</td>
1.313 leot 12365: <td>OWN_DIRS</td>
1.269 leot 12366: </tr>
12367: <tr>
1.316 cirnatda 12368: <td>OWN_DIRS_PERMS</td>
1.313 leot 12369: <td>P4GROUP</td>
1.269 leot 12370: </tr>
12371: <tr>
1.316 cirnatda 12372: <td>P4PORT</td>
1.313 leot 12373: <td>P4ROOT</td>
1.269 leot 12374: </tr>
12375: <tr>
1.316 cirnatda 12376: <td>P4USER</td>
1.313 leot 12377: <td>PACKAGES</td>
1.269 leot 12378: </tr>
12379: <tr>
1.316 cirnatda 12380: <td>PALMOS_DEFAULT_SDK</td>
1.313 leot 12381: <td>PAMBASE</td>
1.269 leot 12382: </tr>
12383: <tr>
1.316 cirnatda 12384: <td>PAM_DEFAULT</td>
1.313 leot 12385: <td>PAPERSIZE</td>
1.269 leot 12386: </tr>
12387: <tr>
1.316 cirnatda 12388: <td>PASSIVE_FETCH</td>
1.313 leot 12389: <td>PATCHDIR</td>
1.269 leot 12390: </tr>
12391: <tr>
1.316 cirnatda 12392: <td>PATCHFILES</td>
1.313 leot 12393: <td>PATCH_ARGS</td>
1.269 leot 12394: </tr>
12395: <tr>
1.316 cirnatda 12396: <td>PATCH_DEBUG</td>
1.313 leot 12397: <td>PATCH_DIST_ARGS</td>
1.284 rillig 12398: </tr>
12399: <tr>
1.316 cirnatda 12400: <td>PATCH_DIST_CAT</td>
1.313 leot 12401: <td>PATCH_DIST_STRIP</td>
1.269 leot 12402: </tr>
12403: <tr>
1.316 cirnatda 12404: <td>PATCH_FUZZ_FACTOR</td>
1.313 leot 12405: <td>PATCH_STRIP</td>
1.316 cirnatda 12406: </tr>
12407: <tr>
1.309 gutterid 12408: <td>PATH</td>
1.316 cirnatda 12409: <td>PCCBASE</td>
1.269 leot 12410: </tr>
12411: <tr>
1.320 wiz 12412: <td>PEAR</td>
12413: <td>PEAR_CHANNEL</td>
12414: </tr>
12415: <tr>
12416: <td>PEAR_CHANNEL_ALIAS</td>
12417: <td>PEAR_CHANNEL_VERSION</td>
12418: </tr>
12419: <tr>
1.309 gutterid 12420: <td>PEAR_CMD</td>
1.316 cirnatda 12421: <td>PEAR_LIB</td>
1.292 leot 12422: </tr>
12423: <tr>
1.309 gutterid 12424: <td>PEAR_PACKAGE_XML</td>
1.316 cirnatda 12425: <td>PERL5</td>
1.274 rillig 12426: </tr>
12427: <tr>
1.309 gutterid 12428: <td>PERL5_CONFIGURE</td>
1.316 cirnatda 12429: <td>PERL5_CONFIGURE_DIRS</td>
1.274 rillig 12430: </tr>
12431: <tr>
1.309 gutterid 12432: <td>PERL5_LDFLAGS</td>
1.316 cirnatda 12433: <td>PERL5_LICENSE</td>
1.269 leot 12434: </tr>
12435: <tr>
1.309 gutterid 12436: <td>PERL5_MODULE_TYPE</td>
1.316 cirnatda 12437: <td>PERL5_PACKLIST</td>
1.269 leot 12438: </tr>
12439: <tr>
1.309 gutterid 12440: <td>PERL5_PACKLIST_DIR</td>
1.316 cirnatda 12441: <td>PERL5_PERLBASE</td>
1.269 leot 12442: </tr>
12443: <tr>
1.309 gutterid 12444: <td>PERL5_SITEBASE</td>
1.316 cirnatda 12445: <td>PERL5_USE_PACKLIST</td>
1.269 leot 12446: </tr>
12447: <tr>
1.309 gutterid 12448: <td>PERL5_VENDORBASE</td>
1.316 cirnatda 12449: <td>PFCTL</td>
1.269 leot 12450: </tr>
12451: <tr>
1.309 gutterid 12452: <td>PFVAR_H</td>
1.316 cirnatda 12453: <td>PF_VERSION</td>
1.269 leot 12454: </tr>
12455: <tr>
1.309 gutterid 12456: <td>PGGROUP</td>
1.316 cirnatda 12457: <td>PGHOME</td>
1.269 leot 12458: </tr>
12459: <tr>
1.309 gutterid 12460: <td>PGPKGSRCDIR</td>
1.316 cirnatda 12461: <td>PGSQL_TYPE</td>
1.269 leot 12462: </tr>
12463: <tr>
1.309 gutterid 12464: <td>PGSQL_VERSION</td>
1.316 cirnatda 12465: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.269 leot 12466: </tr>
12467: <tr>
1.305 bacon 12468: <td>PGSQL_VERSION_DEFAULT</td>
1.316 cirnatda 12469: <td>PGUSER</td>
1.269 leot 12470: </tr>
12471: <tr>
1.305 bacon 12472: <td>PG_LIB_EXT</td>
1.316 cirnatda 12473: <td>PHP</td>
1.269 leot 12474: </tr>
12475: <tr>
1.305 bacon 12476: <td>PHPCOMMON_MK</td>
1.316 cirnatda 12477: <td>PHPPKGSRCDIR</td>
1.269 leot 12478: </tr>
12479: <tr>
1.305 bacon 12480: <td>PHP_BASE_VERS</td>
1.316 cirnatda 12481: <td>PHP_CHECK_INSTALLED</td>
1.269 leot 12482: </tr>
12483: <tr>
1.305 bacon 12484: <td>PHP_EXTENSION_DIR</td>
1.316 cirnatda 12485: <td>PHP_INITIAL_TEENY</td>
1.269 leot 12486: </tr>
12487: <tr>
1.305 bacon 12488: <td>PHP_PKG_PREFIX</td>
1.316 cirnatda 12489: <td>PHP_VERSION</td>
1.269 leot 12490: </tr>
12491: <tr>
1.305 bacon 12492: <td>PHP_VERSIONS_ACCEPTED</td>
1.316 cirnatda 12493: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.269 leot 12494: </tr>
12495: <tr>
1.305 bacon 12496: <td>PHP_VERSION_DEFAULT</td>
1.316 cirnatda 12497: <td>PHP_VERSION_REQD</td>
1.269 leot 12498: </tr>
12499: <tr>
1.305 bacon 12500: <td>PILRC_USE_GTK</td>
1.316 cirnatda 12501: <td>PKGCONFIG_BASE</td>
1.269 leot 12502: </tr>
12503: <tr>
1.305 bacon 12504: <td>PKGCONFIG_FILE</td>
1.316 cirnatda 12505: <td>PKGCONFIG_OVERRIDE</td>
1.269 leot 12506: </tr>
12507: <tr>
1.305 bacon 12508: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.316 cirnatda 12509: <td>PKGDIR</td>
1.269 leot 12510: </tr>
12511: <tr>
1.305 bacon 12512: <td>PKGGNUDIR</td>
1.316 cirnatda 12513: <td>PKGINFODIR</td>
1.269 leot 12514: </tr>
12515: <tr>
1.305 bacon 12516: <td>PKGLOCALEDIR</td>
1.316 cirnatda 12517: <td>PKGMANDIR</td>
1.269 leot 12518: </tr>
12519: <tr>
1.305 bacon 12520: <td>PKGNAME</td>
1.316 cirnatda 12521: <td>PKGNAME_REQD</td>
1.269 leot 12522: </tr>
12523: <tr>
1.305 bacon 12524: <td>PKGPATH</td>
1.316 cirnatda 12525: <td>PKGREVISION</td>
1.269 leot 12526: </tr>
12527: <tr>
1.305 bacon 12528: <td>PKGSRC_BLAS_TYPES</td>
1.316 cirnatda 12529: <td>PKGSRC_CHANGES</td>
1.292 leot 12530: </tr>
12531: <tr>
1.305 bacon 12532: <td>PKGSRC_COMPILER</td>
1.316 cirnatda 12533: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.269 leot 12534: </tr>
12535: <tr>
1.305 bacon 12536: <td>PKGSRC_LOCKTYPE</td>
1.316 cirnatda 12537: <td>PKGSRC_MAKE_ENV</td>
1.274 rillig 12538: </tr>
12539: <tr>
1.305 bacon 12540: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.316 cirnatda 12541: <td>PKGSRC_MKPIE</td>
1.269 leot 12542: </tr>
12543: <tr>
1.305 bacon 12544: <td>PKGSRC_MKREPRO</td>
1.316 cirnatda 12545: <td>PKGSRC_RUN_TEST</td>
1.269 leot 12546: </tr>
12547: <tr>
1.305 bacon 12548: <td>PKGSRC_SETENV</td>
1.316 cirnatda 12549: <td>PKGSRC_SLEEPSECS</td>
1.269 leot 12550: </tr>
12551: <tr>
1.305 bacon 12552: <td>PKGSRC_TODO</td>
1.316 cirnatda 12553: <td>PKGSRC_USE_CTF</td>
1.269 leot 12554: </tr>
12555: <tr>
1.305 bacon 12556: <td>PKGSRC_USE_FORTIFY</td>
1.316 cirnatda 12557: <td>PKGSRC_USE_RELRO</td>
1.269 leot 12558: </tr>
12559: <tr>
1.305 bacon 12560: <td>PKGSRC_USE_SSP</td>
1.316 cirnatda 12561: <td>PKGSRC_USE_STACK_CHECK</td>
1.269 leot 12562: </tr>
12563: <tr>
1.305 bacon 12564: <td>PKGTASKS_DATAFILE</td>
1.316 cirnatda 12565: <td>PKGTOOLS_ARGS</td>
1.269 leot 12566: </tr>
12567: <tr>
1.305 bacon 12568: <td>PKGTOOLS_ENV</td>
1.316 cirnatda 12569: <td>PKG_ALTERNATIVES</td>
1.269 leot 12570: </tr>
12571: <tr>
1.305 bacon 12572: <td>PKG_APACHE</td>
1.316 cirnatda 12573: <td>PKG_APACHE_ACCEPTED</td>
1.269 leot 12574: </tr>
12575: <tr>
1.305 bacon 12576: <td>PKG_APACHE_DEFAULT</td>
1.316 cirnatda 12577: <td>PKG_BEST_EXISTS</td>
1.269 leot 12578: </tr>
12579: <tr>
1.305 bacon 12580: <td>PKG_BUILD_OPTIONS</td>
1.316 cirnatda 12581: <td>PKG_COMPRESSION</td>
1.269 leot 12582: </tr>
12583: <tr>
1.305 bacon 12584: <td>PKG_CONFIG</td>
1.316 cirnatda 12585: <td>PKG_CONFIG_PERMS</td>
1.269 leot 12586: </tr>
12587: <tr>
1.305 bacon 12588: <td>PKG_CREATE_USERGROUP</td>
1.316 cirnatda 12589: <td>PKG_DB_TMPDIR</td>
1.269 leot 12590: </tr>
12591: <tr>
1.305 bacon 12592: <td>PKG_DEBUG_LEVEL</td>
1.316 cirnatda 12593: <td>PKG_DEFAULT_OPTIONS</td>
1.269 leot 12594: </tr>
12595: <tr>
1.305 bacon 12596: <td>PKG_DESTDIR_SUPPORT</td>
1.316 cirnatda 12597: <td>PKG_DEVELOPER</td>
1.269 leot 12598: </tr>
12599: <tr>
1.305 bacon 12600: <td>PKG_DISABLED_OPTIONS</td>
1.316 cirnatda 12601: <td>PKG_FATAL_ERRORS</td>
1.269 leot 12602: </tr>
12603: <tr>
1.305 bacon 12604: <td>PKG_FC</td>
1.316 cirnatda 12605: <td>PKG_FILELIST_CMD</td>
1.269 leot 12606: </tr>
12607: <tr>
1.305 bacon 12608: <td>PKG_GECOS</td>
1.316 cirnatda 12609: <td>PKG_GID</td>
1.269 leot 12610: </tr>
12611: <tr>
1.305 bacon 12612: <td>PKG_GROUPS</td>
1.316 cirnatda 12613: <td>PKG_GROUPS_VARS</td>
1.269 leot 12614: </tr>
12615: <tr>
1.305 bacon 12616: <td>PKG_HOME</td>
1.316 cirnatda 12617: <td>PKG_INIT_SCRIPTS</td>
1.269 leot 12618: </tr>
12619: <tr>
1.305 bacon 12620: <td>PKG_JAVA_HOME</td>
1.316 cirnatda 12621: <td>PKG_JVM</td>
1.269 leot 12622: </tr>
12623: <tr>
1.305 bacon 12624: <td>PKG_JVMS_ACCEPTED</td>
1.316 cirnatda 12625: <td>PKG_JVM_DEFAULT</td>
1.269 leot 12626: </tr>
12627: <tr>
1.305 bacon 12628: <td>PKG_LEGACY_OPTIONS</td>
1.316 cirnatda 12629: <td>PKG_LIBTOOL</td>
1.269 leot 12630: </tr>
12631: <tr>
1.305 bacon 12632: <td>PKG_OPTIONS</td>
1.316 cirnatda 12633: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.269 leot 12634: </tr>
12635: <tr>
1.305 bacon 12636: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.316 cirnatda 12637: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.269 leot 12638: </tr>
12639: <tr>
1.305 bacon 12640: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.316 cirnatda 12641: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.269 leot 12642: </tr>
12643: <tr>
1.305 bacon 12644: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.316 cirnatda 12645: <td>PKG_OPTIONS_VAR</td>
1.269 leot 12646: </tr>
12647: <tr>
1.305 bacon 12648: <td>PKG_PHP</td>
1.316 cirnatda 12649: <td>PKG_PHP_MAJOR_VERS</td>
1.269 leot 12650: </tr>
12651: <tr>
1.305 bacon 12652: <td>PKG_PHP_VERSION</td>
1.316 cirnatda 12653: <td>PKG_RCD_SCRIPTS</td>
1.269 leot 12654: </tr>
12655: <tr>
1.305 bacon 12656: <td>PKG_REFCOUNT_DBDIR</td>
1.316 cirnatda 12657: <td>PKG_REGISTER_SHELLS</td>
1.269 leot 12658: </tr>
12659: <tr>
1.305 bacon 12660: <td>PKG_RESUME_TRANSFERS</td>
1.316 cirnatda 12661: <td>PKG_SHELL</td>
1.269 leot 12662: </tr>
12663: <tr>
1.305 bacon 12664: <td>PKG_SUGGESTED_OPTIONS</td>
1.316 cirnatda 12665: <td>PKG_SUPPORTED_OPTIONS</td>
1.269 leot 12666: </tr>
12667: <tr>
1.305 bacon 12668: <td>PKG_SYSCONFBASE</td>
1.316 cirnatda 12669: <td>PKG_SYSCONFBASEDIR</td>
1.269 leot 12670: </tr>
12671: <tr>
1.305 bacon 12672: <td>PKG_SYSCONFDIR</td>
1.316 cirnatda 12673: <td>PKG_SYSCONFDIR_PERMS</td>
1.269 leot 12674: </tr>
12675: <tr>
1.305 bacon 12676: <td>PKG_SYSCONFSUBDIR</td>
1.316 cirnatda 12677: <td>PKG_SYSCONFVAR</td>
1.269 leot 12678: </tr>
12679: <tr>
1.305 bacon 12680: <td>PKG_TOOLS_BIN</td>
1.316 cirnatda 12681: <td>PKG_UID</td>
1.269 leot 12682: </tr>
12683: <tr>
1.305 bacon 12684: <td>PKG_UPDATE_FONTS_DB</td>
1.316 cirnatda 12685: <td>PKG_USERS</td>
1.269 leot 12686: </tr>
12687: <tr>
1.305 bacon 12688: <td>PKG_USERS_VARS</td>
1.316 cirnatda 12689: <td>PKG_VERBOSE</td>
1.269 leot 12690: </tr>
12691: <tr>
1.316 cirnatda 12692: <td>PLEASE</td>
1.305 bacon 12693: <td>PLIST</td>
1.269 leot 12694: </tr>
12695: <tr>
1.313 leot 12696: <td>PLIST_AWK</td>
1.305 bacon 12697: <td>PLIST_AWK_ENV</td>
1.269 leot 12698: </tr>
12699: <tr>
1.313 leot 12700: <td>PLIST_SRC</td>
1.305 bacon 12701: <td>PLIST_SUBST</td>
1.269 leot 12702: </tr>
12703: <tr>
1.313 leot 12704: <td>PLIST_TYPE</td>
1.305 bacon 12705: <td>PLIST_VARS</td>
1.269 leot 12706: </tr>
12707: <tr>
1.313 leot 12708: <td>POPTOP_USE_MPPE</td>
1.305 bacon 12709: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.269 leot 12710: </tr>
12711: <tr>
1.313 leot 12712: <td>POST_FETCH_HOOK</td>
1.305 bacon 12713: <td>PREFER</td>
1.269 leot 12714: </tr>
12715: <tr>
1.313 leot 12716: <td>PREFER_NATIVE</td>
1.305 bacon 12717: <td>PREFER_NATIVE_PTHREADS</td>
1.269 leot 12718: </tr>
12719: <tr>
1.313 leot 12720: <td>PREFER_PKGSRC</td>
1.305 bacon 12721: <td>PREFIX</td>
1.269 leot 12722: </tr>
12723: <tr>
1.313 leot 12724: <td>PREPEND_PATH</td>
1.305 bacon 12725: <td>PRE_ROOT_CMD</td>
1.269 leot 12726: </tr>
12727: <tr>
1.313 leot 12728: <td>PRIVILEGED_STAGES</td>
1.305 bacon 12729: <td>PS</td>
1.269 leot 12730: </tr>
12731: <tr>
1.313 leot 12732: <td>PTHREAD_AUTO_VARS</td>
1.305 bacon 12733: <td>PTHREAD_CFLAGS</td>
1.269 leot 12734: </tr>
12735: <tr>
1.313 leot 12736: <td>PTHREAD_LDFLAGS</td>
1.305 bacon 12737: <td>PTHREAD_LIBS</td>
1.269 leot 12738: </tr>
12739: <tr>
1.313 leot 12740: <td>PTHREAD_OPTS</td>
1.305 bacon 12741: <td>PTHREAD_TYPE</td>
1.269 leot 12742: </tr>
12743: <tr>
1.313 leot 12744: <td>PVM_SSH</td>
1.305 bacon 12745: <td>PYPKGPREFIX</td>
1.269 leot 12746: </tr>
12747: <tr>
1.313 leot 12748: <td>PYTHON_FOR_BUILD_ONLY</td>
1.305 bacon 12749: <td>PYTHON_SELF_CONFLICT</td>
1.269 leot 12750: </tr>
12751: <tr>
1.313 leot 12752: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.305 bacon 12753: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.269 leot 12754: </tr>
12755: <tr>
1.313 leot 12756: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.305 bacon 12757: <td>PYTHON_VERSION_DEFAULT</td>
1.269 leot 12758: </tr>
12759: <tr>
1.313 leot 12760: <td>PYTHON_VERSION_REQD</td>
1.305 bacon 12761: <td>PYVERSSUFFIX</td>
1.269 leot 12762: </tr>
12763: <tr>
1.313 leot 12764: <td>PY_NO_EGG</td>
1.305 bacon 12765: <td>QMAILDIR</td>
1.269 leot 12766: </tr>
12767: <tr>
1.313 leot 12768: <td>QMAIL_ALIAS_USER</td>
1.305 bacon 12769: <td>QMAIL_DAEMON_USER</td>
1.269 leot 12770: </tr>
12771: <tr>
1.313 leot 12772: <td>QMAIL_LOG_USER</td>
1.305 bacon 12773: <td>QMAIL_NOFILES_GROUP</td>
1.269 leot 12774: </tr>
12775: <tr>
1.313 leot 12776: <td>QMAIL_PASSWD_USER</td>
1.305 bacon 12777: <td>QMAIL_QMAIL_GROUP</td>
1.269 leot 12778: </tr>
12779: <tr>
1.313 leot 12780: <td>QMAIL_QUEUE_DIR</td>
1.305 bacon 12781: <td>QMAIL_QUEUE_EXTRA</td>
1.269 leot 12782: </tr>
12783: <tr>
1.313 leot 12784: <td>QMAIL_QUEUE_USER</td>
1.305 bacon 12785: <td>QMAIL_REMOTE_USER</td>
1.269 leot 12786: </tr>
12787: <tr>
1.313 leot 12788: <td>QMAIL_ROOT_USER</td>
1.305 bacon 12789: <td>QMAIL_SEND_USER</td>
1.269 leot 12790: </tr>
12791: <tr>
1.313 leot 12792: <td>QPOPPER_FAC</td>
1.305 bacon 12793: <td>QPOPPER_SPOOL_DIR</td>
1.269 leot 12794: </tr>
12795: <tr>
1.313 leot 12796: <td>QPOPPER_USER</td>
1.305 bacon 12797: <td>RAKE_NAME</td>
1.269 leot 12798: </tr>
12799: <tr>
1.313 leot 12800: <td>RASMOL_DEPTH</td>
1.320 wiz 12801: <td>RCD_DIR</td>
12802: </tr>
12803: <tr>
12804: <td>RCD_ORDER</td>
1.305 bacon 12805: <td>RCD_SCRIPTS</td>
1.292 leot 12806: </tr>
12807: <tr>
1.313 leot 12808: <td>RCD_SCRIPTS_DIR</td>
1.305 bacon 12809: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.269 leot 12810: </tr>
12811: <tr>
1.313 leot 12812: <td>RCD_SCRIPTS_MODE</td>
1.305 bacon 12813: <td>RCD_SCRIPTS_SHELL</td>
1.269 leot 12814: </tr>
12815: <tr>
1.313 leot 12816: <td>RCD_SCRIPT_SRC</td>
1.320 wiz 12817: <td>RCD_SUBR</td>
12818: </tr>
12819: <tr>
1.315 cirnatda 12820: <td>RDOC</td>
1.320 wiz 12821: <td>READLINE_DEFAULT</td>
1.311 leot 12822: </tr>
12823: <tr>
1.315 cirnatda 12824: <td>READLINE_TYPE</td>
1.320 wiz 12825: <td>REAL_ROOT_GROUP</td>
1.269 leot 12826: </tr>
12827: <tr>
1.315 cirnatda 12828: <td>REAL_ROOT_USER</td>
1.320 wiz 12829: <td>RECURSIVE_MAKE</td>
1.269 leot 12830: </tr>
12831: <tr>
1.315 cirnatda 12832: <td>RELAY_CTRL_DIR</td>
1.320 wiz 12833: <td>RELRO_SUPPORTED</td>
1.269 leot 12834: </tr>
12835: <tr>
1.315 cirnatda 12836: <td>REPLACE_AWK</td>
1.320 wiz 12837: <td>REPLACE_BASH</td>
1.269 leot 12838: </tr>
12839: <tr>
1.315 cirnatda 12840: <td>REPLACE_CSH</td>
1.320 wiz 12841: <td>REPLACE_KSH</td>
1.269 leot 12842: </tr>
12843: <tr>
1.315 cirnatda 12844: <td>REPLACE_PERL</td>
1.320 wiz 12845: <td>REPLACE_PERL6</td>
1.269 leot 12846: </tr>
12847: <tr>
1.315 cirnatda 12848: <td>REPLACE_PHP</td>
1.320 wiz 12849: <td>REPLACE_PYTHON</td>
1.269 leot 12850: </tr>
12851: <tr>
1.315 cirnatda 12852: <td>REPLACE_RUBY</td>
1.320 wiz 12853: <td>REPLACE_RUBY_DIRS</td>
1.269 leot 12854: </tr>
12855: <tr>
1.315 cirnatda 12856: <td>REPLACE_RUBY_PAT</td>
1.320 wiz 12857: <td>REPLACE_SH</td>
1.281 leot 12858: </tr>
12859: <tr>
1.315 cirnatda 12860: <td>REPLACE_TEXLUA</td>
1.320 wiz 12861: <td>REQD_DIRS</td>
1.269 leot 12862: </tr>
12863: <tr>
1.315 cirnatda 12864: <td>REQD_DIRS_PERMS</td>
1.320 wiz 12865: <td>REQD_FILES</td>
1.269 leot 12866: </tr>
12867: <tr>
1.315 cirnatda 12868: <td>REQD_FILES_MODE</td>
1.320 wiz 12869: <td>REQD_FILES_PERMS</td>
1.269 leot 12870: </tr>
12871: <tr>
1.315 cirnatda 12872: <td>RESOLV_AUTO_VARS</td>
1.320 wiz 12873: <td>RESOLV_LDFLAGS</td>
1.269 leot 12874: </tr>
12875: <tr>
1.315 cirnatda 12876: <td>RESOLV_LIBS</td>
1.320 wiz 12877: <td>RM</td>
12878: </tr>
12879: <tr>
12880: <td>ROCKSPEC_NAME</td>
12881: <td>ROCKSPEC_SPECFILE</td>
1.269 leot 12882: </tr>
12883: <tr>
1.315 cirnatda 12884: <td>ROOT_CMD</td>
1.320 wiz 12885: <td>ROOT_GROUP</td>
1.311 leot 12886: </tr>
12887: <tr>
1.313 leot 12888: <td>ROOT_USER</td>
1.320 wiz 12889: <td>RPCGEN</td>
1.269 leot 12890: </tr>
12891: <tr>
1.313 leot 12892: <td>RPM</td>
1.320 wiz 12893: <td>RPM2PKG_PLIST</td>
1.269 leot 12894: </tr>
12895: <tr>
1.313 leot 12896: <td>RPM2PKG_PREFIX</td>
1.320 wiz 12897: <td>RPM2PKG_STAGE</td>
1.269 leot 12898: </tr>
12899: <tr>
1.313 leot 12900: <td>RPM2PKG_STRIP</td>
1.320 wiz 12901: <td>RPM2PKG_SUBPREFIX</td>
1.269 leot 12902: </tr>
12903: <tr>
1.313 leot 12904: <td>RPMFILES</td>
1.320 wiz 12905: <td>RPMIGNOREPATH</td>
1.269 leot 12906: </tr>
12907: <tr>
1.313 leot 12908: <td>RPM_DB_PREFIX</td>
1.320 wiz 12909: <td>RSSH_CVS_PATH</td>
1.269 leot 12910: </tr>
12911: <tr>
1.313 leot 12912: <td>RSSH_RDIST_PATH</td>
1.320 wiz 12913: <td>RSSH_RSYNC_PATH</td>
1.269 leot 12914: </tr>
12915: <tr>
1.313 leot 12916: <td>RSSH_SCP_PATH</td>
1.320 wiz 12917: <td>RSSH_SFTP_SERVER_PATH</td>
1.269 leot 12918: </tr>
12919: <tr>
1.313 leot 12920: <td>RUBY</td>
1.320 wiz 12921: <td>RUBYGEM</td>
1.269 leot 12922: </tr>
12923: <tr>
1.313 leot 12924: <td>RUBYGEM_NAME</td>
1.320 wiz 12925: <td>RUBYGEM_OPTIONS</td>
1.269 leot 12926: </tr>
12927: <tr>
1.313 leot 12928: <td>RUBYGEM_VERBOSE</td>
1.320 wiz 12929: <td>RUBY_ABI_VERSION</td>
1.269 leot 12930: </tr>
12931: <tr>
1.313 leot 12932: <td>RUBY_ARCH</td>
1.320 wiz 12933: <td>RUBY_ARCHINC</td>
1.269 leot 12934: </tr>
12935: <tr>
1.313 leot 12936: <td>RUBY_ARCHLIB</td>
1.320 wiz 12937: <td>RUBY_BASE</td>
1.269 leot 12938: </tr>
12939: <tr>
1.313 leot 12940: <td>RUBY_BASERIDIR</td>
1.320 wiz 12941: <td>RUBY_BUILD_DOCUMENT</td>
1.269 leot 12942: </tr>
12943: <tr>
1.313 leot 12944: <td>RUBY_DLEXT</td>
1.320 wiz 12945: <td>RUBY_DOC</td>
1.269 leot 12946: </tr>
12947: <tr>
1.313 leot 12948: <td>RUBY_DYNAMIC_DIRS</td>
1.320 wiz 12949: <td>RUBY_EG</td>
1.269 leot 12950: </tr>
12951: <tr>
1.313 leot 12952: <td>RUBY_ENCODING_ARG</td>
1.320 wiz 12953: <td>RUBY_EXTCONF</td>
1.269 leot 12954: </tr>
12955: <tr>
1.313 leot 12956: <td>RUBY_EXTCONF_CHECK</td>
1.320 wiz 12957: <td>RUBY_EXTCONF_DEBUG</td>
1.269 leot 12958: </tr>
12959: <tr>
1.313 leot 12960: <td>RUBY_EXTCONF_MAKEFILE</td>
1.320 wiz 12961: <td>RUBY_GEM_BASE</td>
1.269 leot 12962: </tr>
12963: <tr>
1.313 leot 12964: <td>RUBY_INC</td>
1.320 wiz 12965: <td>RUBY_LIB</td>
1.269 leot 12966: </tr>
12967: <tr>
1.313 leot 12968: <td>RUBY_LIB_BASE</td>
1.320 wiz 12969: <td>RUBY_NAME</td>
1.269 leot 12970: </tr>
12971: <tr>
1.313 leot 12972: <td>RUBY_NOVERSION</td>
1.320 wiz 12973: <td>RUBY_PKGPREFIX</td>
1.269 leot 12974: </tr>
12975: <tr>
1.313 leot 12976: <td>RUBY_RAILS</td>
1.320 wiz 12977: <td>RUBY_RAILS52_VERSION</td>
1.269 leot 12978: </tr>
12979: <tr>
1.313 leot 12980: <td>RUBY_RAILS60_VERSION</td>
1.320 wiz 12981: <td>RUBY_RAILS61_VERSION</td>
1.312 gdt 12982: </tr>
12983: <tr>
1.313 leot 12984: <td>RUBY_RAILS_ACCEPTED</td>
1.320 wiz 12985: <td>RUBY_RAILS_DEFAULT</td>
1.289 leot 12986: </tr>
12987: <tr>
1.313 leot 12988: <td>RUBY_RAILS_REQD</td>
1.320 wiz 12989: <td>RUBY_RAILS_STRICT_DEP</td>
1.269 leot 12990: </tr>
12991: <tr>
1.313 leot 12992: <td>RUBY_RIDIR</td>
1.320 wiz 12993: <td>RUBY_SETUP</td>
1.269 leot 12994: </tr>
12995: <tr>
1.313 leot 12996: <td>RUBY_SHLIB</td>
1.320 wiz 12997: <td>RUBY_SHLIBALIAS</td>
1.269 leot 12998: </tr>
12999: <tr>
1.313 leot 13000: <td>RUBY_SHLIBVER</td>
1.320 wiz 13001: <td>RUBY_SIMPLE_INSTALL</td>
1.269 leot 13002: </tr>
13003: <tr>
1.313 leot 13004: <td>RUBY_SITEARCHLIB</td>
1.320 wiz 13005: <td>RUBY_SITELIB</td>
1.269 leot 13006: </tr>
13007: <tr>
1.313 leot 13008: <td>RUBY_SITELIB_BASE</td>
1.320 wiz 13009: <td>RUBY_SITERIDIR</td>
1.269 leot 13010: </tr>
13011: <tr>
1.313 leot 13012: <td>RUBY_SLEXT</td>
1.320 wiz 13013: <td>RUBY_SRCDIR</td>
1.269 leot 13014: </tr>
13015: <tr>
1.313 leot 13016: <td>RUBY_STATICLIB</td>
1.320 wiz 13017: <td>RUBY_SUFFIX</td>
1.269 leot 13018: </tr>
13019: <tr>
1.313 leot 13020: <td>RUBY_SYSRIDIR</td>
1.320 wiz 13021: <td>RUBY_USE_PTHREAD</td>
1.269 leot 13022: </tr>
13023: <tr>
1.313 leot 13024: <td>RUBY_VENDORARCHLIB</td>
1.320 wiz 13025: <td>RUBY_VENDORLIB</td>
1.269 leot 13026: </tr>
13027: <tr>
1.313 leot 13028: <td>RUBY_VENDORLIB_BASE</td>
1.320 wiz 13029: <td>RUBY_VER</td>
1.269 leot 13030: </tr>
13031: <tr>
1.313 leot 13032: <td>RUBY_VERSION</td>
1.320 wiz 13033: <td>RUBY_VERSIONS_ACCEPTED</td>
1.269 leot 13034: </tr>
13035: <tr>
1.313 leot 13036: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.320 wiz 13037: <td>RUBY_VERSION_DEFAULT</td>
1.269 leot 13038: </tr>
13039: <tr>
1.313 leot 13040: <td>RUBY_VERSION_REQD</td>
1.320 wiz 13041: <td>RUBY_VER_DIR</td>
1.269 leot 13042: </tr>
13043: <tr>
1.313 leot 13044: <td>RUN</td>
1.320 wiz 13045: <td>RUN_LDCONFIG</td>
1.269 leot 13046: </tr>
13047: <tr>
1.313 leot 13048: <td>SAWFISH_THEMES</td>
1.320 wiz 13049: <td>SCO</td>
1.269 leot 13050: </tr>
13051: <tr>
1.313 leot 13052: <td>SCREWS_GROUP</td>
1.320 wiz 13053: <td>SCREWS_USER</td>
1.269 leot 13054: </tr>
13055: <tr>
1.313 leot 13056: <td>SCRIPTS_ENV</td>
1.320 wiz 13057: <td>SCROLLKEEPER_DATADIR</td>
1.269 leot 13058: </tr>
13059: <tr>
1.313 leot 13060: <td>SCROLLKEEPER_REBUILDDB</td>
1.320 wiz 13061: <td>SCROLLKEEPER_UPDATEDB</td>
1.269 leot 13062: </tr>
13063: <tr>
1.313 leot 13064: <td>SDIST_PAWD</td>
1.320 wiz 13065: <td>SERIAL_DEVICES</td>
1.269 leot 13066: </tr>
13067: <tr>
1.313 leot 13068: <td>SETGIDGAME</td>
1.320 wiz 13069: <td>SETGID_GAMES_PERMS</td>
1.269 leot 13070: </tr>
13071: <tr>
1.313 leot 13072: <td>SETUID_ROOT_PERMS</td>
1.320 wiz 13073: <td>SH</td>
1.269 leot 13074: </tr>
13075: <tr>
1.313 leot 13076: <td>SHLIB</td>
1.320 wiz 13077: <td>SHORTNAME</td>
1.292 leot 13078: </tr>
13079: <tr>
1.313 leot 13080: <td>SIGN_PACKAGES</td>
1.308 leot 13081: <td>SILC_CLIENT_WITH_PERL</td>
1.269 leot 13082: </tr>
13083: <tr>
1.313 leot 13084: <td>SITE_SPECIFIC_PKGS</td>
1.308 leot 13085: <td>SKIP_DEPENDS</td>
1.269 leot 13086: </tr>
13087: <tr>
1.313 leot 13088: <td>SMF_INSTANCES</td>
1.308 leot 13089: <td>SMF_MANIFEST</td>
1.274 rillig 13090: </tr>
13091: <tr>
1.313 leot 13092: <td>SMF_METHODS</td>
1.308 leot 13093: <td>SMF_METHOD_SHELL</td>
1.269 leot 13094: </tr>
13095: <tr>
1.313 leot 13096: <td>SMF_METHOD_SRC</td>
1.308 leot 13097: <td>SMF_NAME</td>
1.269 leot 13098: </tr>
13099: <tr>
1.313 leot 13100: <td>SMF_PREFIX</td>
1.308 leot 13101: <td>SMF_SRCDIR</td>
1.269 leot 13102: </tr>
13103: <tr>
1.313 leot 13104: <td>SNIPROXY_GROUP</td>
1.308 leot 13105: <td>SNIPROXY_USER</td>
1.269 leot 13106: </tr>
13107: <tr>
1.313 leot 13108: <td>SOURCE_BUFFSIZE</td>
1.308 leot 13109: <td>SPECIAL_PERMS</td>
1.269 leot 13110: </tr>
13111: <tr>
1.313 leot 13112: <td>SPECIFIC_PKGS</td>
1.308 leot 13113: <td>SSH_SUID</td>
1.269 leot 13114: </tr>
13115: <tr>
1.313 leot 13116: <td>SSP_SUPPORTED</td>
1.308 leot 13117: <td>SSYNC_PAWD</td>
1.269 leot 13118: </tr>
13119: <tr>
1.313 leot 13120: <td>STEP_MSG</td>
1.308 leot 13121: <td>STRIP</td>
1.269 leot 13122: </tr>
13123: <tr>
1.313 leot 13124: <td>STRIP_DBG</td>
1.308 leot 13125: <td>STRIP_DEBUG</td>
1.269 leot 13126: </tr>
13127: <tr>
1.313 leot 13128: <td>STRIP_DEBUG_SUPPORTED</td>
1.308 leot 13129: <td>STRIP_FILES_SKIP</td>
1.269 leot 13130: </tr>
13131: <tr>
1.313 leot 13132: <td>SU</td>
1.308 leot 13133: <td>SUBDIR</td>
1.269 leot 13134: </tr>
13135: <tr>
1.313 leot 13136: <td>SUBST</td>
1.308 leot 13137: <td>SUBST_CLASSES</td>
1.289 leot 13138: </tr>
13139: <tr>
1.313 leot 13140: <td>SUBST_FILES</td>
1.308 leot 13141: <td>SUBST_FILTER_CMD</td>
1.269 leot 13142: </tr>
13143: <tr>
1.313 leot 13144: <td>SUBST_MESSAGE</td>
1.308 leot 13145: <td>SUBST_NOOP_OK</td>
1.269 leot 13146: </tr>
13147: <tr>
1.313 leot 13148: <td>SUBST_SED</td>
1.308 leot 13149: <td>SUBST_SHOW_DIFF</td>
1.269 leot 13150: </tr>
13151: <tr>
1.313 leot 13152: <td>SUBST_SKIP_TEXT_CHECK</td>
1.308 leot 13153: <td>SUBST_STAGE</td>
1.269 leot 13154: </tr>
13155: <tr>
1.313 leot 13156: <td>SUBST_VARS</td>
1.308 leot 13157: <td>SUNWSPROBASE</td>
1.269 leot 13158: </tr>
13159: <tr>
1.313 leot 13160: <td>SUSE_PREFER</td>
1.308 leot 13161: <td>SU_CMD</td>
1.292 leot 13162: </tr>
13163: <tr>
1.320 wiz 13164: <td>SVN_EXTRACTDIR</td>
13165: <td>SVN_REPO</td>
13166: </tr>
13167: <tr>
13168: <td>SVN_REPOSITORIES</td>
13169: <td>SVN_REVISION</td>
13170: </tr>
13171: <tr>
1.316 cirnatda 13172: <td>SYSCONFBASE</td>
1.313 leot 13173: <td>TBL</td>
1.303 bacon 13174: </tr>
13175: <tr>
1.316 cirnatda 13176: <td>TERMCAP_TYPE</td>
1.313 leot 13177: <td>TERMINFO_DEFAULT</td>
1.274 rillig 13178: </tr>
13179: <tr>
1.316 cirnatda 13180: <td>TERMINFO_TYPE</td>
1.313 leot 13181: <td>TEST</td>
1.269 leot 13182: </tr>
13183: <tr>
1.316 cirnatda 13184: <td>TEST_DEPENDS</td>
1.313 leot 13185: <td>TEST_DIRS</td>
1.269 leot 13186: </tr>
13187: <tr>
1.316 cirnatda 13188: <td>TEST_ENV</td>
1.313 leot 13189: <td>TEST_ENV_SHELL</td>
1.269 leot 13190: </tr>
13191: <tr>
1.316 cirnatda 13192: <td>TEST_MAKE_CMD</td>
1.313 leot 13193: <td>TEST_MAKE_FLAGS</td>
1.269 leot 13194: </tr>
13195: <tr>
1.316 cirnatda 13196: <td>TEST_TARGET</td>
1.313 leot 13197: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.269 leot 13198: </tr>
13199: <tr>
1.316 cirnatda 13200: <td>TEXLIVE_REV</td>
1.313 leot 13201: <td>TEXLIVE_UNVERSIONED</td>
1.269 leot 13202: </tr>
13203: <tr>
1.316 cirnatda 13204: <td>TEXMFSITE</td>
1.313 leot 13205: <td>TEX_FORMATS</td>
1.269 leot 13206: </tr>
13207: <tr>
1.316 cirnatda 13208: <td>TEX_HYPHEN_DAT</td>
1.313 leot 13209: <td>TEX_HYPHEN_DEF</td>
1.269 leot 13210: </tr>
13211: <tr>
1.316 cirnatda 13212: <td>TEX_TEXMF_DIRS</td>
1.313 leot 13213: <td>THTTPD_LOG_FACILITY</td>
1.269 leot 13214: </tr>
13215: <tr>
1.316 cirnatda 13216: <td>TINYDYN_USER</td>
1.313 leot 13217: <td>TO</td>
1.269 leot 13218: </tr>
13219: <tr>
1.316 cirnatda 13220: <td>TOOLS_ALIASES</td>
1.313 leot 13221: <td>TOOLS_ALWAYS_WRAP</td>
1.269 leot 13222: </tr>
13223: <tr>
1.316 cirnatda 13224: <td>TOOLS_ARGS</td>
1.313 leot 13225: <td>TOOLS_BROKEN</td>
1.269 leot 13226: </tr>
13227: <tr>
1.316 cirnatda 13228: <td>TOOLS_CMD</td>
1.313 leot 13229: <td>TOOLS_CMDLINE_SED</td>
1.269 leot 13230: </tr>
13231: <tr>
1.316 cirnatda 13232: <td>TOOLS_CREATE</td>
1.313 leot 13233: <td>TOOLS_DIR</td>
1.269 leot 13234: </tr>
13235: <tr>
1.316 cirnatda 13236: <td>TOOLS_FAIL</td>
1.313 leot 13237: <td>TOOLS_GNU_MISSING</td>
1.269 leot 13238: </tr>
13239: <tr>
1.316 cirnatda 13240: <td>TOOLS_LDCONFIG</td>
1.313 leot 13241: <td>TOOLS_NOOP</td>
1.269 leot 13242: </tr>
13243: <tr>
1.316 cirnatda 13244: <td>TOOLS_PATH</td>
1.313 leot 13245: <td>TOOLS_SCRIPT</td>
1.269 leot 13246: </tr>
13247: <tr>
1.316 cirnatda 13248: <td>TOOL_DEPENDS</td>
1.320 wiz 13249: <td>TTF_FONTDIR</td>
1.311 leot 13250: </tr>
13251: <tr>
1.320 wiz 13252: <td>TTF_FONTS_DIR</td>
1.316 cirnatda 13253: <td>TYPE</td>
1.269 leot 13254: </tr>
13255: <tr>
1.320 wiz 13256: <td>UAC_REQD_EXECS</td>
1.316 cirnatda 13257: <td>UCSPI_SSL_GROUP</td>
1.269 leot 13258: </tr>
13259: <tr>
1.320 wiz 13260: <td>UCSPI_SSL_USER</td>
1.316 cirnatda 13261: <td>UNLIMIT_RESOURCES</td>
1.269 leot 13262: </tr>
13263: <tr>
1.320 wiz 13264: <td>UNPRIVILEGED</td>
1.316 cirnatda 13265: <td>UNPRIVILEGED_GROUP</td>
1.269 leot 13266: </tr>
13267: <tr>
1.320 wiz 13268: <td>UNPRIVILEGED_GROUPS</td>
1.316 cirnatda 13269: <td>UNPRIVILEGED_USER</td>
1.269 leot 13270: </tr>
13271: <tr>
1.320 wiz 13272: <td>UNWRAP_FILES</td>
1.316 cirnatda 13273: <td>UNWRAP_PATTERNS</td>
1.269 leot 13274: </tr>
13275: <tr>
1.320 wiz 13276: <td>UPDATE_GEMSPEC</td>
1.316 cirnatda 13277: <td>UPDATE_TARGET</td>
1.269 leot 13278: </tr>
13279: <tr>
1.320 wiz 13280: <td>URI</td>
1.316 cirnatda 13281: <td>USERGROUP_PHASE</td>
1.269 leot 13282: </tr>
13283: <tr>
1.320 wiz 13284: <td>USERPPP_GROUP</td>
1.316 cirnatda 13285: <td>USER_SPECIFIC_PKGS</td>
1.269 leot 13286: </tr>
13287: <tr>
1.320 wiz 13288: <td>USE_ABI_DEPENDS</td>
1.316 cirnatda 13289: <td>USE_APR</td>
1.320 wiz 13290: </tr>
13291: <tr>
1.311 leot 13292: <td>USE_BSD_MAKEFILE</td>
1.320 wiz 13293: <td>USE_BUILTIN</td>
1.269 leot 13294: </tr>
13295: <tr>
1.311 leot 13296: <td>USE_CROSS_COMPILE</td>
1.320 wiz 13297: <td>USE_CURSES</td>
1.269 leot 13298: </tr>
13299: <tr>
1.311 leot 13300: <td>USE_CWRAPPERS</td>
1.320 wiz 13301: <td>USE_DB185</td>
1.269 leot 13302: </tr>
13303: <tr>
1.311 leot 13304: <td>USE_FEATURES</td>
1.320 wiz 13305: <td>USE_GAMESGROUP</td>
1.269 leot 13306: </tr>
13307: <tr>
1.311 leot 13308: <td>USE_GCC_RUNTIME</td>
1.320 wiz 13309: <td>USE_IMAKE</td>
1.269 leot 13310: </tr>
13311: <tr>
1.311 leot 13312: <td>USE_JAVA</td>
1.320 wiz 13313: <td>USE_JAVA2</td>
1.269 leot 13314: </tr>
13315: <tr>
1.311 leot 13316: <td>USE_LANGUAGES</td>
1.320 wiz 13317: <td>USE_LIBTOOL</td>
1.269 leot 13318: </tr>
13319: <tr>
1.311 leot 13320: <td>USE_NATIVE_GCC</td>
1.320 wiz 13321: <td>USE_NETBSD_REPO</td>
1.269 leot 13322: </tr>
13323: <tr>
1.311 leot 13324: <td>USE_PKGSRC_GCC</td>
1.320 wiz 13325: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.269 leot 13326: </tr>
13327: <tr>
1.311 leot 13328: <td>USE_PKGTASKS</td>
1.320 wiz 13329: <td>USE_PKG_ADMIN_DIGEST</td>
1.269 leot 13330: </tr>
13331: <tr>
1.311 leot 13332: <td>USE_RUBY_EXTCONF</td>
1.320 wiz 13333: <td>USE_RUBY_INSTALL</td>
1.269 leot 13334: </tr>
13335: <tr>
1.311 leot 13336: <td>USE_RUBY_SETUP</td>
1.320 wiz 13337: <td>USE_RUBY_SETUP_PKG</td>
1.269 leot 13338: </tr>
13339: <tr>
1.311 leot 13340: <td>USE_TOOLS</td>
1.320 wiz 13341: <td>UUCP_GROUP</td>
1.269 leot 13342: </tr>
13343: <tr>
1.311 leot 13344: <td>UUCP_USER</td>
1.320 wiz 13345: <td>VARBASE</td>
1.269 leot 13346: </tr>
13347: <tr>
1.311 leot 13348: <td>VARNAME</td>
1.320 wiz 13349: <td>VIM_EXTRA_OPTS</td>
1.269 leot 13350: </tr>
13351: <tr>
1.311 leot 13352: <td>WARNING_MSG</td>
1.320 wiz 13353: <td>WCALC_CGIDIR</td>
1.269 leot 13354: </tr>
13355: <tr>
1.311 leot 13356: <td>WCALC_CGIPATH</td>
1.320 wiz 13357: <td>WCALC_HTMLDIR</td>
1.269 leot 13358: </tr>
13359: <tr>
1.311 leot 13360: <td>WCALC_HTMLPATH</td>
1.320 wiz 13361: <td>WDM_MANAGERS</td>
1.269 leot 13362: </tr>
13363: <tr>
1.311 leot 13364: <td>WRAPPER_CC</td>
1.320 wiz 13365: <td>WRAPPER_REORDER_CMDS</td>
1.269 leot 13366: </tr>
13367: <tr>
1.311 leot 13368: <td>WRKDIR</td>
1.320 wiz 13369: <td>WRKDIR_BASENAME</td>
1.303 bacon 13370: </tr>
13371: <tr>
1.311 leot 13372: <td>WRKDIR_LOCKTYPE</td>
1.320 wiz 13373: <td>WRKLOG</td>
1.269 leot 13374: </tr>
13375: <tr>
1.311 leot 13376: <td>WRKOBJDIR</td>
1.320 wiz 13377: <td>WRKSRC</td>
1.269 leot 13378: </tr>
13379: <tr>
1.311 leot 13380: <td>X10_PORT</td>
1.320 wiz 13381: <td>X11</td>
1.269 leot 13382: </tr>
13383: <tr>
1.311 leot 13384: <td>X11BASE</td>
1.320 wiz 13385: <td>X11_PKGSRCDIR</td>
1.269 leot 13386: </tr>
13387: <tr>
1.311 leot 13388: <td>X11_TYPE</td>
1.320 wiz 13389: <td>X509_CERTIFICATE</td>
1.269 leot 13390: </tr>
13391: <tr>
1.311 leot 13392: <td>X509_KEY</td>
1.320 wiz 13393: <td>XAW_TYPE</td>
1.269 leot 13394: </tr>
13395: <tr>
1.311 leot 13396: <td>XLOCK_DEFAULT_MODE</td>
1.320 wiz 13397: <td>XMKMF</td>
1.269 leot 13398: </tr>
13399: <tr>
1.311 leot 13400: <td>XMKMF_FLAGS</td>
1.320 wiz 13401: <td>XXX</td>
1.274 rillig 13402: </tr>
13403: <tr>
1.320 wiz 13404: <td>XXXX</td>
1.313 leot 13405: <td>YES</td>
1.269 leot 13406: </tr>
13407: <tr>
1.316 cirnatda 13408: <td>ZSH_STATIC</td>
1.313 leot 13409: <td>__stdc__</td>
1.316 cirnatda 13410: </tr>
13411: <tr>
1.295 rillig 13412: <td>_vargroups</td>
1.316 cirnatda 13413: <td>accept</td>
1.289 leot 13414: </tr>
13415: <tr>
1.295 rillig 13416: <td>acquire-localbase-lock</td>
1.316 cirnatda 13417: <td>acquire-lock</td>
1.269 leot 13418: </tr>
13419: <tr>
1.295 rillig 13420: <td>add</td>
1.316 cirnatda 13421: <td>administrator</td>
1.269 leot 13422: </tr>
13423: <tr>
1.295 rillig 13424: <td>alloca</td>
1.316 cirnatda 13425: <td>alternatives</td>
1.289 leot 13426: </tr>
13427: <tr>
1.295 rillig 13428: <td>aslr</td>
1.316 cirnatda 13429: <td>asprintf</td>
1.269 leot 13430: </tr>
13431: <tr>
1.295 rillig 13432: <td>atlas</td>
1.316 cirnatda 13433: <td>autoconf</td>
1.269 leot 13434: </tr>
13435: <tr>
1.295 rillig 13436: <td>automake</td>
1.316 cirnatda 13437: <td>autoreconf</td>
1.269 leot 13438: </tr>
13439: <tr>
1.295 rillig 13440: <td>awk</td>
1.316 cirnatda 13441: <td>bash</td>
1.271 brook 13442: </tr>
13443: <tr>
1.295 rillig 13444: <td>big-endian</td>
1.316 cirnatda 13445: <td>bin-install</td>
1.269 leot 13446: </tr>
13447: <tr>
1.295 rillig 13448: <td>bind</td>
1.316 cirnatda 13449: <td>binpkg-list</td>
1.292 leot 13450: </tr>
13451: <tr>
1.295 rillig 13452: <td>blas</td>
1.316 cirnatda 13453: <td>bootstrap-depends</td>
1.274 rillig 13454: </tr>
13455: <tr>
1.295 rillig 13456: <td>broken</td>
1.316 cirnatda 13457: <td>broken_on_platform</td>
1.269 leot 13458: </tr>
13459: <tr>
1.295 rillig 13460: <td>bsd</td>
1.316 cirnatda 13461: <td>bsd.prog.mk</td>
1.289 leot 13462: </tr>
13463: <tr>
1.295 rillig 13464: <td>build</td>
1.316 cirnatda 13465: <td>build-env</td>
1.269 leot 13466: </tr>
13467: <tr>
1.295 rillig 13468: <td>buildlink-directories</td>
1.316 cirnatda 13469: <td>buildlink-oss-soundcard-h</td>
1.269 leot 13470: </tr>
13471: <tr>
1.295 rillig 13472: <td>c</td>
1.316 cirnatda 13473: <td>c++</td>
1.269 leot 13474: </tr>
13475: <tr>
1.295 rillig 13476: <td>ccache</td>
1.316 cirnatda 13477: <td>cce</td>
1.269 leot 13478: </tr>
13479: <tr>
1.295 rillig 13480: <td>cdefs</td>
1.316 cirnatda 13481: <td>ceil</td>
1.289 leot 13482: </tr>
13483: <tr>
1.295 rillig 13484: <td>changes</td>
1.316 cirnatda 13485: <td>changes-entry</td>
1.269 leot 13486: </tr>
13487: <tr>
1.295 rillig 13488: <td>changes-entry-noupdate</td>
1.316 cirnatda 13489: <td>check</td>
1.269 leot 13490: </tr>
13491: <tr>
1.295 rillig 13492: <td>check-clean</td>
1.316 cirnatda 13493: <td>check-files</td>
1.269 leot 13494: </tr>
13495: <tr>
1.295 rillig 13496: <td>check-files-clean</td>
1.316 cirnatda 13497: <td>check-vulnerable</td>
1.269 leot 13498: </tr>
13499: <tr>
1.295 rillig 13500: <td>checksum</td>
1.316 cirnatda 13501: <td>checksum-phase</td>
1.269 leot 13502: </tr>
13503: <tr>
1.295 rillig 13504: <td>clean</td>
1.316 cirnatda 13505: <td>clean-depends</td>
1.269 leot 13506: </tr>
13507: <tr>
1.295 rillig 13508: <td>cleandir</td>
1.316 cirnatda 13509: <td>commit</td>
1.269 leot 13510: </tr>
13511: <tr>
1.295 rillig 13512: <td>commit-changes-entry</td>
1.316 cirnatda 13513: <td>compact</td>
1.269 leot 13514: </tr>
13515: <tr>
1.295 rillig 13516: <td>compiler</td>
1.316 cirnatda 13517: <td>conf</td>
1.269 leot 13518: </tr>
13519: <tr>
1.295 rillig 13520: <td>config.guess</td>
1.316 cirnatda 13521: <td>config.sub</td>
1.269 leot 13522: </tr>
13523: <tr>
1.295 rillig 13524: <td>configuration</td>
1.316 cirnatda 13525: <td>configure</td>
1.269 leot 13526: </tr>
13527: <tr>
1.295 rillig 13528: <td>configure-env</td>
1.316 cirnatda 13529: <td>configure-help</td>
1.269 leot 13530: </tr>
13531: <tr>
1.295 rillig 13532: <td>configure_args</td>
1.316 cirnatda 13533: <td>connect</td>
1.269 leot 13534: </tr>
13535: <tr>
1.295 rillig 13536: <td>cos</td>
1.316 cirnatda 13537: <td>cputime</td>
1.289 leot 13538: </tr>
13539: <tr>
1.295 rillig 13540: <td>create-usergroup</td>
1.316 cirnatda 13541: <td>csh</td>
1.269 leot 13542: </tr>
13543: <tr>
1.295 rillig 13544: <td>ctf</td>
1.320 wiz 13545: <td>cvs</td>
13546: </tr>
13547: <tr>
1.316 cirnatda 13548: <td>debug</td>
1.320 wiz 13549: <td>declaration</td>
1.269 leot 13550: </tr>
13551: <tr>
1.316 cirnatda 13552: <td>declare</td>
1.320 wiz 13553: <td>defined</td>
1.311 leot 13554: </tr>
13555: <tr>
1.316 cirnatda 13556: <td>depend</td>
1.320 wiz 13557: <td>dependencies</td>
1.269 leot 13558: </tr>
13559: <tr>
1.316 cirnatda 13560: <td>depends</td>
1.320 wiz 13561: <td>depends-checksum</td>
1.269 leot 13562: </tr>
13563: <tr>
1.316 cirnatda 13564: <td>depends-fetch</td>
1.320 wiz 13565: <td>deps</td>
1.269 leot 13566: </tr>
13567: <tr>
1.316 cirnatda 13568: <td>describe</td>
1.320 wiz 13569: <td>destdir</td>
1.269 leot 13570: </tr>
13571: <tr>
1.316 cirnatda 13572: <td>disable</td>
1.320 wiz 13573: <td>distclean</td>
1.269 leot 13574: </tr>
13575: <tr>
1.316 cirnatda 13576: <td>distinfo</td>
1.320 wiz 13577: <td>dl</td>
1.269 leot 13578: </tr>
13579: <tr>
1.316 cirnatda 13580: <td>dlopen</td>
1.320 wiz 13581: <td>do-build</td>
1.277 rillig 13582: </tr>
13583: <tr>
1.316 cirnatda 13584: <td>do-buildlink</td>
1.320 wiz 13585: <td>do-clean</td>
1.269 leot 13586: </tr>
13587: <tr>
1.316 cirnatda 13588: <td>do-configure</td>
1.320 wiz 13589: <td>do-configure-post-hook</td>
1.269 leot 13590: </tr>
13591: <tr>
1.316 cirnatda 13592: <td>do-extract</td>
1.320 wiz 13593: <td>do-fetch</td>
1.269 leot 13594: </tr>
13595: <tr>
1.320 wiz 13596: <td>do-install</td>
1.316 cirnatda 13597: <td>emul</td>
1.289 leot 13598: </tr>
13599: <tr>
1.295 rillig 13600: <td>emul-distinfo</td>
1.316 cirnatda 13601: <td>emul-fetch</td>
1.269 leot 13602: </tr>
13603: <tr>
1.295 rillig 13604: <td>emulation</td>
1.316 cirnatda 13605: <td>emulator</td>
1.274 rillig 13606: </tr>
13607: <tr>
1.295 rillig 13608: <td>enable</td>
1.316 cirnatda 13609: <td>endian</td>
1.269 leot 13610: </tr>
13611: <tr>
1.320 wiz 13612: <td>endif</td>
1.315 cirnatda 13613: <td>enomem</td>
1.320 wiz 13614: </tr>
13615: <tr>
1.316 cirnatda 13616: <td>err</td>
1.320 wiz 13617: <td>errx</td>
1.311 leot 13618: </tr>
13619: <tr>
1.316 cirnatda 13620: <td>etc</td>
1.320 wiz 13621: <td>exp</td>
1.269 leot 13622: </tr>
13623: <tr>
1.316 cirnatda 13624: <td>extract-rpm</td>
1.320 wiz 13625: <td>fabs</td>
1.269 leot 13626: </tr>
13627: <tr>
1.316 cirnatda 13628: <td>feature</td>
1.320 wiz 13629: <td>features</td>
1.289 leot 13630: </tr>
13631: <tr>
1.316 cirnatda 13632: <td>fetch</td>
1.320 wiz 13633: <td>fetch-list</td>
1.269 leot 13634: </tr>
13635: <tr>
1.316 cirnatda 13636: <td>follows</td>
1.320 wiz 13637: <td>forbids</td>
1.269 leot 13638: </tr>
13639: <tr>
1.316 cirnatda 13640: <td>form</td>
1.320 wiz 13641: <td>format</td>
1.269 leot 13642: </tr>
13643: <tr>
1.316 cirnatda 13644: <td>fortify</td>
1.320 wiz 13645: <td>fortify_source</td>
1.269 leot 13646: </tr>
13647: <tr>
1.320 wiz 13648: <td>fossil</td>
1.316 cirnatda 13649: <td>friend</td>
1.269 leot 13650: </tr>
13651: <tr>
1.295 rillig 13652: <td>fts</td>
1.316 cirnatda 13653: <td>fts_close</td>
1.269 leot 13654: </tr>
13655: <tr>
1.295 rillig 13656: <td>fts_open</td>
1.316 cirnatda 13657: <td>fts_read</td>
1.269 leot 13658: </tr>
13659: <tr>
1.295 rillig 13660: <td>fts_set</td>
1.316 cirnatda 13661: <td>gcc</td>
1.289 leot 13662: </tr>
13663: <tr>
1.295 rillig 13664: <td>gethostbyaddr</td>
1.316 cirnatda 13665: <td>gethostbyname</td>
1.269 leot 13666: </tr>
13667: <tr>
1.295 rillig 13668: <td>gethostbyname2</td>
1.316 cirnatda 13669: <td>getopt_long</td>
1.269 leot 13670: </tr>
13671: <tr>
1.295 rillig 13672: <td>getprogname</td>
1.316 cirnatda 13673: <td>getservbyname</td>
1.289 leot 13674: </tr>
13675: <tr>
1.295 rillig 13676: <td>getservbyport</td>
1.316 cirnatda 13677: <td>getservent</td>
1.289 leot 13678: </tr>
13679: <tr>
1.295 rillig 13680: <td>gettext</td>
1.320 wiz 13681: <td>git</td>
13682: </tr>
13683: <tr>
1.316 cirnatda 13684: <td>github</td>
1.320 wiz 13685: <td>gitlab</td>
1.269 leot 13686: </tr>
13687: <tr>
1.295 rillig 13688: <td>glob</td>
1.316 cirnatda 13689: <td>gnu</td>
1.274 rillig 13690: </tr>
13691: <tr>
1.295 rillig 13692: <td>gnu_configure_strict</td>
1.316 cirnatda 13693: <td>go</td>
1.269 leot 13694: </tr>
13695: <tr>
1.295 rillig 13696: <td>go-deps</td>
1.316 cirnatda 13697: <td>golang</td>
1.269 leot 13698: </tr>
13699: <tr>
1.295 rillig 13700: <td>guess-license</td>
1.316 cirnatda 13701: <td>hashbang</td>
1.269 leot 13702: </tr>
13703: <tr>
1.295 rillig 13704: <td>heimdal</td>
1.316 cirnatda 13705: <td>help</td>
1.269 leot 13706: </tr>
13707: <tr>
1.320 wiz 13708: <td>hg</td>
1.315 cirnatda 13709: <td>imake</td>
1.320 wiz 13710: </tr>
13711: <tr>
1.316 cirnatda 13712: <td>increment</td>
1.320 wiz 13713: <td>inet_aton</td>
1.311 leot 13714: </tr>
13715: <tr>
1.316 cirnatda 13716: <td>interp</td>
1.320 wiz 13717: <td>interpreter</td>
1.269 leot 13718: </tr>
13719: <tr>
1.316 cirnatda 13720: <td>intl</td>
1.320 wiz 13721: <td>ip4</td>
1.269 leot 13722: </tr>
13723: <tr>
1.316 cirnatda 13724: <td>ip6</td>
1.320 wiz 13725: <td>ipv4</td>
1.269 leot 13726: </tr>
13727: <tr>
1.316 cirnatda 13728: <td>ipv6</td>
1.320 wiz 13729: <td>iso</td>
1.269 leot 13730: </tr>
13731: <tr>
1.316 cirnatda 13732: <td>kerberos</td>
1.320 wiz 13733: <td>krb</td>
1.303 bacon 13734: </tr>
13735: <tr>
1.316 cirnatda 13736: <td>krb5</td>
1.320 wiz 13737: <td>ksh</td>
1.303 bacon 13738: </tr>
13739: <tr>
1.316 cirnatda 13740: <td>lapack</td>
1.320 wiz 13741: <td>latex</td>
1.269 leot 13742: </tr>
13743: <tr>
1.316 cirnatda 13744: <td>libintl_bindtextdomain</td>
1.320 wiz 13745: <td>libintl_gettext</td>
1.292 leot 13746: </tr>
13747: <tr>
1.316 cirnatda 13748: <td>libintl_textdomain</td>
1.320 wiz 13749: <td>libnbcompat</td>
1.269 leot 13750: </tr>
13751: <tr>
1.316 cirnatda 13752: <td>libs</td>
1.320 wiz 13753: <td>libtool</td>
1.289 leot 13754: </tr>
13755: <tr>
1.316 cirnatda 13756: <td>licence</td>
1.320 wiz 13757: <td>license</td>
1.274 rillig 13758: </tr>
13759: <tr>
1.316 cirnatda 13760: <td>lintl</td>
1.320 wiz 13761: <td>little-endian</td>
1.271 brook 13762: </tr>
13763: <tr>
1.316 cirnatda 13764: <td>lock</td>
1.320 wiz 13765: <td>locking</td>
1.269 leot 13766: </tr>
13767: <tr>
1.316 cirnatda 13768: <td>lvalue</td>
1.320 wiz 13769: <td>make</td>
1.269 leot 13770: </tr>
13771: <tr>
1.316 cirnatda 13772: <td>makesum</td>
1.320 wiz 13773: <td>memory</td>
1.269 leot 13774: </tr>
13775: <tr>
1.320 wiz 13776: <td>mercurial</td>
1.316 cirnatda 13777: <td>meta</td>
1.269 leot 13778: </tr>
13779: <tr>
1.295 rillig 13780: <td>meta-package</td>
1.316 cirnatda 13781: <td>meta_package</td>
1.269 leot 13782: </tr>
13783: <tr>
1.295 rillig 13784: <td>mit-krb5</td>
1.316 cirnatda 13785: <td>mk.conf</td>
1.292 leot 13786: </tr>
13787: <tr>
1.295 rillig 13788: <td>mkl</td>
1.316 cirnatda 13789: <td>mount</td>
1.274 rillig 13790: </tr>
13791: <tr>
1.295 rillig 13792: <td>mprotect</td>
1.316 cirnatda 13793: <td>mremap</td>
1.269 leot 13794: </tr>
13795: <tr>
1.295 rillig 13796: <td>nb</td>
1.316 cirnatda 13797: <td>nbcompat</td>
1.269 leot 13798: </tr>
13799: <tr>
1.320 wiz 13800: <td>netlib</td>
1.295 rillig 13801: <td>obstack</td>
1.320 wiz 13802: </tr>
13803: <tr>
1.316 cirnatda 13804: <td>obstack_ptr_grow</td>
1.320 wiz 13805: <td>occurs</td>
1.269 leot 13806: </tr>
13807: <tr>
1.316 cirnatda 13808: <td>only</td>
1.320 wiz 13809: <td>openblas</td>
1.269 leot 13810: </tr>
13811: <tr>
1.316 cirnatda 13812: <td>options</td>
1.320 wiz 13813: <td>options.mk</td>
1.269 leot 13814: </tr>
13815: <tr>
1.316 cirnatda 13816: <td>order</td>
1.320 wiz 13817: <td>override</td>
1.271 brook 13818: </tr>
13819: <tr>
1.316 cirnatda 13820: <td>override-intltool</td>
1.320 wiz 13821: <td>override-message-intltool</td>
1.269 leot 13822: </tr>
13823: <tr>
1.316 cirnatda 13824: <td>package</td>
1.320 wiz 13825: <td>parallel</td>
1.269 leot 13826: </tr>
13827: <tr>
1.316 cirnatda 13828: <td>path</td>
1.320 wiz 13829: <td>pax</td>
1.269 leot 13830: </tr>
13831: <tr>
1.316 cirnatda 13832: <td>paxctl</td>
1.320 wiz 13833: <td>pbulk-index</td>
1.269 leot 13834: </tr>
13835: <tr>
1.316 cirnatda 13836: <td>pc</td>
1.320 wiz 13837: <td>perl</td>
1.269 leot 13838: </tr>
13839: <tr>
1.316 cirnatda 13840: <td>perl5</td>
1.320 wiz 13841: <td>perms</td>
1.269 leot 13842: </tr>
13843: <tr>
1.316 cirnatda 13844: <td>php</td>
1.320 wiz 13845: <td>pkg-build-options</td>
1.269 leot 13846: </tr>
13847: <tr>
1.316 cirnatda 13848: <td>pkg-config</td>
1.320 wiz 13849: <td>pkg_build_options</td>
1.269 leot 13850: </tr>
13851: <tr>
1.316 cirnatda 13852: <td>platform</td>
1.320 wiz 13853: <td>plist</td>
1.269 leot 13854: </tr>
13855: <tr>
1.316 cirnatda 13856: <td>post-extract</td>
1.320 wiz 13857: <td>post-fetch</td>
1.269 leot 13858: </tr>
13859: <tr>
1.316 cirnatda 13860: <td>post-wrapper</td>
1.320 wiz 13861: <td>pre-build-checks-hook</td>
1.269 leot 13862: </tr>
13863: <tr>
1.316 cirnatda 13864: <td>pre-configure</td>
1.320 wiz 13865: <td>pre-configure-checks-hook</td>
1.289 leot 13866: </tr>
13867: <tr>
1.316 cirnatda 13868: <td>pre-extract</td>
1.320 wiz 13869: <td>pre-fetch</td>
1.269 leot 13870: </tr>
13871: <tr>
1.316 cirnatda 13872: <td>print-go-deps</td>
1.320 wiz 13873: <td>print-plist</td>
1.269 leot 13874: </tr>
13875: <tr>
1.316 cirnatda 13876: <td>print-summary-data</td>
1.320 wiz 13877: <td>privileged-install-hook</td>
1.269 leot 13878: </tr>
13879: <tr>
1.316 cirnatda 13880: <td>pypi</td>
1.320 wiz 13881: <td>python</td>
1.269 leot 13882: </tr>
13883: <tr>
1.316 cirnatda 13884: <td>readme-all</td>
1.320 wiz 13885: <td>recv</td>
1.269 leot 13886: </tr>
13887: <tr>
1.316 cirnatda 13888: <td>recvfrom</td>
1.320 wiz 13889: <td>regcomp</td>
1.289 leot 13890: </tr>
13891: <tr>
1.316 cirnatda 13892: <td>release-localbase-lock</td>
1.320 wiz 13893: <td>release-lock</td>
1.289 leot 13894: </tr>
13895: <tr>
1.316 cirnatda 13896: <td>relro</td>
1.320 wiz 13897: <td>rename</td>
1.269 leot 13898: </tr>
13899: <tr>
1.316 cirnatda 13900: <td>reorder</td>
1.320 wiz 13901: <td>replace</td>
1.269 leot 13902: </tr>
13903: <tr>
1.316 cirnatda 13904: <td>replace_interpreter</td>
1.320 wiz 13905: <td>reproducible</td>
1.269 leot 13906: </tr>
13907: <tr>
1.316 cirnatda 13908: <td>resolv</td>
1.320 wiz 13909: <td>root</td>
1.269 leot 13910: </tr>
13911: <tr>
1.316 cirnatda 13912: <td>ruby</td>
1.320 wiz 13913: <td>send</td>
1.289 leot 13914: </tr>
13915: <tr>
1.316 cirnatda 13916: <td>sendfile</td>
1.320 wiz 13917: <td>sendto</td>
1.269 leot 13918: </tr>
13919: <tr>
1.316 cirnatda 13920: <td>setenv</td>
1.320 wiz 13921: <td>setgid</td>
1.269 leot 13922: </tr>
13923: <tr>
1.316 cirnatda 13924: <td>setprogname</td>
1.320 wiz 13925: <td>setuid</td>
1.269 leot 13926: </tr>
13927: <tr>
1.316 cirnatda 13928: <td>sh</td>
1.320 wiz 13929: <td>shebang</td>
1.269 leot 13930: </tr>
13931: <tr>
1.316 cirnatda 13932: <td>show</td>
1.320 wiz 13933: <td>show-all</td>
1.296 rillig 13934: </tr>
13935: <tr>
1.316 cirnatda 13936: <td>show-build-defs</td>
1.320 wiz 13937: <td>show-depends</td>
1.269 leot 13938: </tr>
13939: <tr>
1.316 cirnatda 13940: <td>show-deps</td>
1.320 wiz 13941: <td>show-distfiles</td>
1.269 leot 13942: </tr>
13943: <tr>
1.316 cirnatda 13944: <td>show-downlevel</td>
1.320 wiz 13945: <td>show-subdir-var</td>
1.269 leot 13946: </tr>
13947: <tr>
1.316 cirnatda 13948: <td>show-tools</td>
1.320 wiz 13949: <td>show-var</td>
1.269 leot 13950: </tr>
13951: <tr>
1.316 cirnatda 13952: <td>show-vars</td>
1.320 wiz 13953: <td>snprintf</td>
1.269 leot 13954: </tr>
13955: <tr>
1.316 cirnatda 13956: <td>socket</td>
1.320 wiz 13957: <td>ssp</td>
1.289 leot 13958: </tr>
13959: <tr>
1.316 cirnatda 13960: <td>st_mode</td>
1.320 wiz 13961: <td>stage-install</td>
1.269 leot 13962: </tr>
13963: <tr>
1.316 cirnatda 13964: <td>strcasestr</td>
1.320 wiz 13965: <td>strict</td>
1.269 leot 13966: </tr>
13967: <tr>
1.316 cirnatda 13968: <td>strip</td>
1.320 wiz 13969: <td>strndup</td>
1.277 rillig 13970: </tr>
13971: <tr>
1.316 cirnatda 13972: <td>strnlen</td>
1.320 wiz 13973: <td>strsep</td>
1.269 leot 13974: </tr>
13975: <tr>
1.316 cirnatda 13976: <td>subst</td>
1.320 wiz 13977: <td>substitutions</td>
1.289 leot 13978: </tr>
13979: <tr>
1.320 wiz 13980: <td>subversion</td>
1.316 cirnatda 13981: <td>sun</td>
1.292 leot 13982: </tr>
13983: <tr>
1.315 cirnatda 13984: <td>sunpro</td>
1.316 cirnatda 13985: <td>sunwspro</td>
1.311 leot 13986: </tr>
13987: <tr>
1.320 wiz 13988: <td>svn</td>
1.276 leot 13989: <td>symlink</td>
1.269 leot 13990: </tr>
13991: <tr>
1.320 wiz 13992: <td>test</td>
1.289 leot 13993: <td>test-env</td>
1.269 leot 13994: </tr>
13995: <tr>
1.320 wiz 13996: <td>tex</td>
1.289 leot 13997: <td>texlive</td>
1.269 leot 13998: </tr>
13999: <tr>
1.320 wiz 14000: <td>tmp</td>
1.289 leot 14001: <td>tool</td>
1.269 leot 14002: </tr>
14003: <tr>
1.320 wiz 14004: <td>tools</td>
1.289 leot 14005: <td>tools-libtool-m4-override</td>
1.269 leot 14006: </tr>
14007: <tr>
1.320 wiz 14008: <td>type</td>
1.289 leot 14009: <td>ulimit</td>
1.269 leot 14010: </tr>
14011: <tr>
1.320 wiz 14012: <td>undefined</td>
1.289 leot 14013: <td>undo-replace</td>
1.269 leot 14014: </tr>
14015: <tr>
1.320 wiz 14016: <td>unlimit</td>
1.289 leot 14017: <td>unprivileged</td>
1.269 leot 14018: </tr>
14019: <tr>
1.320 wiz 14020: <td>unprivileged-install-hook</td>
1.289 leot 14021: <td>unstripped</td>
1.269 leot 14022: </tr>
14023: <tr>
1.320 wiz 14024: <td>update</td>
1.289 leot 14025: <td>upload</td>
1.269 leot 14026: </tr>
14027: <tr>
1.320 wiz 14028: <td>upload-distfiles</td>
1.270 leot 14029: <td>use_tools</td>
1.269 leot 14030: </tr>
14031: <tr>
1.320 wiz 14032: <td>user</td>
1.270 leot 14033: <td>utimes</td>
1.269 leot 14034: </tr>
14035: <tr>
1.320 wiz 14036: <td>vasprintf</td>
1.270 leot 14037: <td>verbose</td>
1.269 leot 14038: </tr>
14039: <tr>
1.320 wiz 14040: <td>vsnprintf</td>
1.270 leot 14041: <td>warn</td>
1.269 leot 14042: </tr>
14043: <tr>
1.320 wiz 14044: <td>warning</td>
1.270 leot 14045: <td>warnings</td>
1.269 leot 14046: </tr>
14047: <tr>
1.320 wiz 14048: <td>warnx</td>
1.289 leot 14049: <td>wattr_off</td>
1.269 leot 14050: </tr>
14051: <tr>
1.320 wiz 14052: <td>wattr_on</td>
1.289 leot 14053: <td>work</td>
1.269 leot 14054: </tr>
14055: <tr>
1.320 wiz 14056: <td>wrapper</td>
1.289 leot 14057: <td>wrkdir</td>
1.269 leot 14058: </tr>
14059: </table>
1.267 rillig 14060: </div>
14061: <div class="appendix">
14062: <div class="titlepage"><div><div><h1 class="title">
14063: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 14064: <div class="toc">
14065: <p><b>Table of Contents</b></p>
1.210 leot 14066: <dl class="toc">
1.267 rillig 14067: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
14068: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75 rillig 14069: </dl>
14070: </div>
1.79 rillig 14071: <p>This section contains information on editing the pkgsrc
14072: guide itself.</p>
1.148 asau 14073: <div class="sect1">
1.75 rillig 14074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 14075: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.79 rillig 14076: <p>The pkgsrc guide's source code is stored in
14077: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
14078: are created from it:</p>
1.148 asau 14079: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 14080: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
14081: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289 leot 14082: <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>
14083: <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 14084: The PDF version of the pkgsrc guide.</p></li>
1.289 leot 14085: <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 14086: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 14087: </ul></div>
14088: </div>
1.148 asau 14089: <div class="sect1">
1.75 rillig 14090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 14091: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.79 rillig 14092: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 14093: <div class="procedure"><ol class="procedure" type="1">
1.304 bacon 14094: <li class="step"><p>Make sure you have checked out the htdocs repository
14095: into a sibling directory of your pkgsrc directory. You will need
14096: the ability to commit from both pkgsrc and htdocs.</p></li>
1.148 asau 14097: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 14098: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 14099: documentation) installed. These are automatically installed when
1.250 leot 14100: 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 14101: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 14102: right directory. All further steps will take place
14103: here.</p></li>
1.148 asau 14104: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 14105: <code class="filename">files/</code>.</p></li>
1.148 asau 14106: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 14107: guide for valid XML and to build the final output files. If you
14108: get any errors at this stage, you can just edit the files, as
14109: there are only symbolic links in the working directory, pointing
14110: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 14111: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 14112: commit)</strong></span></p></li>
1.148 asau 14113: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 14114: regenerate the output files with the proper RCS
14115: Ids.</p></li>
1.148 asau 14116: <li class="step">
1.110 hubertf 14117: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 14118: commit the files in both <code class="filename">pkgsrc/doc</code> and
14119: <code class="filename">htdocs</code>.</p>
1.148 asau 14120: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 14121: <h3 class="title">Note</h3>
14122: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 14123: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
14124: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 14125: directory.</p>
14126: </div>
14127: </li>
1.79 rillig 14128: </ol></div>
1.75 rillig 14129: </div>
14130: </div>
14131: </div></body>
1.1 grant 14132: </html>
CVSweb <webmaster@jp.NetBSD.org>