Annotation of pkgsrc/doc/pkgsrc.html, revision 1.328
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.328 ! jnemeth 33: <div><p class="copyright">Copyright © 1994-2022 The NetBSD Foundation, Inc</p></div>
! 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.41 2022/01/01 06:45:38 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>
1.322 leot 444: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.75 rillig 445: <dd><dl>
1.322 leot 446: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
447: <dd><dl>
448: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
449: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
450: </dl></dd>
451: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
452: <dd><dl>
453: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
454: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
455: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
456: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
457: </dl></dd>
458: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
459: <dd><dl>
460: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
461: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
462: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
463: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
464: </dl></dd>
465: </dl></dd>
466: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
467: <dd><dl>
468: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
469: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.75 rillig 470: </dl></dd>
1.322 leot 471: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.76 rillig 472: <dd><dl>
1.322 leot 473: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
474: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
475: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
476: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
477: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.261 leot 478: <code class="filename">stable</code>,
1.128 wiz 479: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 480: source packages</a></span></dt>
481: </dl></dd>
1.322 leot 482: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
483: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75 rillig 484: <dd><dl>
1.322 leot 485: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
486: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75 rillig 487: </dl></dd>
488: </dl>
489: </div>
1.82 rillig 490: <div class="list-of-tables">
491: <p><b>List of Tables</b></p>
492: <dl>
493: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
494: </dt>
1.299 rillig 495: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 496: </dt>
1.299 rillig 497: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 498: </dt>
1.82 rillig 499: </dl>
500: </div>
1.148 asau 501: <div class="chapter">
502: <div class="titlepage"><div><div><h1 class="title">
503: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75 rillig 504: <div class="toc">
505: <p><b>Table of Contents</b></p>
1.210 leot 506: <dl class="toc">
1.75 rillig 507: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 508: <dd><dl>
509: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
510: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
511: </dl></dd>
1.75 rillig 512: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
513: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 514: <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 515: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
516: </dl>
517: </div>
1.148 asau 518: <div class="sect1">
1.75 rillig 519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
520: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 521: <p>There is a lot of software freely available for Unix-based
522: systems, which is usually available in form of the source code. Before
523: such software can be used, it needs to be configured to the local
524: system, compiled and installed, and this is exactly what The NetBSD
525: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
526: to handle binary packages, so that not every user has to build the
527: packages for himself, which is a time-costly task.</p>
1.75 rillig 528: <p>pkgsrc currently contains several thousand packages,
529: including:</p>
1.148 asau 530: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 531: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.75 rillig 532: web server</p></li>
1.322 leot 533: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75 rillig 534: web browser</p></li>
1.322 leot 535: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75 rillig 536: Desktop Environment</p></li>
1.322 leot 537: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.75 rillig 538: Desktop Environment</p></li>
539: </ul></div>
1.219 rillig 540: <p>… just to name a few.</p>
1.75 rillig 541: <p>pkgsrc has built-in support for handling varying dependencies,
542: such as pthreads and X11, and extended features such as IPv6 support on
543: a range of platforms.</p>
1.148 asau 544: <div class="sect2">
1.82 rillig 545: <div class="titlepage"><div><div><h3 class="title">
546: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
547: <p>
548: pkgsrc provides the following key features:
549: </p>
1.148 asau 550: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 551: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 552: and installation of binary packages. The source and latest
553: patches are retrieved from a master or mirror download site, checksum
554: verified, then built on your system. Support for binary-only
555: distributions is available for both native platforms and NetBSD
556: emulated platforms.</p></li>
1.128 wiz 557: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 558: including binaries, libraries, man pages and other
559: documentation.</p></li>
1.214 sevan 560: <li class="listitem"><p>Tracking of package dependencies automatically, including when
561: performing updates, to ensure required packages are installed. The
562: configuration files of various packages are handled automatically during
563: updates, so local changes are preserved.</p></li>
1.128 wiz 564: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 565: consists of highly portable code. This allows the greatest speed of
1.132 spz 566: development when porting to a new platform. This portability also
1.82 rillig 567: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
568: platforms</em></span>.</p></li>
1.128 wiz 569: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 570: international encryption requirements and build-time options for a
571: large number of packages are all set in a simple, central
572: configuration file.</p></li>
1.128 wiz 573: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 574: freely available under a BSD license, so you may extend and adapt
575: pkgsrc to your needs. Support for local packages and patches is
576: available right out of the box, so you can configure it specifically
577: for your environment.</p></li>
578: </ul></div>
1.91 rillig 579: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 580: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 581: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 582: — That means, if a package contains bugs, it's better to find
1.91 rillig 583: them and to complain about them rather than to just install the package
584: and hope that it works. There are numerous checks in pkgsrc that try to
1.322 leot 585: find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91 rillig 586: of shell scripts), and post-installation checks (installed files,
587: references to shared libraries, script interpreters).</p></li>
1.128 wiz 588: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 589: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 590: pkgsrc has been ported to many operating systems. Care is taken that
591: packages behave the same on all platforms.</p></li>
592: </ul></div>
1.82 rillig 593: </div>
1.148 asau 594: <div class="sect2">
1.82 rillig 595: <div class="titlepage"><div><div><h3 class="title">
596: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
597: <p>pkgsrc consists of both a source distribution and a binary
598: distribution for these operating systems. After retrieving the required
599: source or binaries, you can be up and running with pkgsrc in just
600: minutes!</p>
1.75 rillig 601: <p>pkgsrc was derived from FreeBSD's ports system, and
602: initially developed for NetBSD only. Since then, pkgsrc has
603: grown a lot, and now supports the following platforms:</p>
1.82 rillig 604: <div class="table">
605: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216 tnn 606: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 607: <colgroup>
608: <col>
609: <col>
1.202 sevan 610: <col>
1.82 rillig 611: </colgroup>
612: <thead><tr>
613: <th>Platform</th>
614: <th>Date Support Added</th>
1.202 sevan 615: <th>Notes</th>
1.82 rillig 616: </tr></thead>
617: <tbody>
618: <tr>
1.289 leot 619: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 620: <td align="center">Aug 1997</td>
1.202 sevan 621: <td class="auto-generated"> </td>
1.82 rillig 622: </tr>
623: <tr>
1.110 hubertf 624: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 625: <td align="center">Mar 1999</td>
1.264 sevan 626: <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 627: </tr>
628: <tr>
1.289 leot 629: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 630: <td align="center">Jun 1999</td>
1.264 sevan 631: <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 632: </tr>
633: <tr>
634: <td>
1.230 sevan 635: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82 rillig 636: </td>
637: <td align="center">Oct 2001</td>
1.305 bacon 638: <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 639: </tr>
640: <tr>
1.289 leot 641: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 642: <td align="center">Nov 2002</td>
1.264 sevan 643: <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 644: </tr>
645: <tr>
1.289 leot 646: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 647: <td align="center">Nov 2002</td>
1.264 sevan 648: <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 649: </tr>
650: <tr>
1.289 leot 651: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 652: <td align="center">Dec 2002</td>
1.202 sevan 653: <td>
1.264 sevan 654: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
655: <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 656: </td>
1.82 rillig 657: </tr>
658: <tr>
659: <td>BSD/OS</td>
660: <td align="center">Dec 2003</td>
1.202 sevan 661: <td class="auto-generated"> </td>
1.82 rillig 662: </tr>
663: <tr>
1.289 leot 664: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 665: <td align="center">Dec 2003</td>
1.264 sevan 666: <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 667: </tr>
668: <tr>
669: <td>
1.289 leot 670: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 671: (Microsoft Windows Services for Unix)
672: </td>
673: <td align="center">Mar 2004</td>
1.264 sevan 674: <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 675: </tr>
676: <tr>
1.289 leot 677: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 678: <td align="center">Oct 2004</td>
1.202 sevan 679: <td class="auto-generated"> </td>
1.82 rillig 680: </tr>
681: <tr>
1.110 hubertf 682: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 683: <td align="center">Nov 2004</td>
1.264 sevan 684: <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 685: </tr>
1.98 wiz 686: <tr>
1.289 leot 687: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 688: <td align="center">Apr 2007</td>
1.264 sevan 689: <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 690: </tr>
1.128 wiz 691: <tr>
1.289 leot 692: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128 wiz 693: <td align="center">Sep 2010</td>
1.264 sevan 694: <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 695: </tr>
1.151 obache 696: <tr>
1.289 leot 697: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 698: <td align="center">Jan 2011</td>
1.202 sevan 699: <td class="auto-generated"> </td>
1.151 obache 700: </tr>
701: <tr>
1.289 leot 702: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151 obache 703: <td align="center">Nov 2011</td>
1.264 sevan 704: <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 705: </tr>
706: <tr>
1.289 leot 707: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151 obache 708: <td align="center">Mar 2013</td>
1.264 sevan 709: <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 710: </tr>
1.166 jnemeth 711: <tr>
1.289 leot 712: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166 jnemeth 713: <td align="center">Jul 2013</td>
1.264 sevan 714: <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 715: </tr>
1.214 sevan 716: <tr>
1.289 leot 717: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214 sevan 718: <td align="center">Jun 2014</td>
1.264 sevan 719: <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 720: </tr>
1.82 rillig 721: </tbody>
1.91 rillig 722: </table></div>
1.82 rillig 723: </div>
1.91 rillig 724: <br class="table-break">
1.82 rillig 725: </div>
1.75 rillig 726: </div>
1.148 asau 727: <div class="sect1">
1.75 rillig 728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
729: <a name="overview"></a>1.2. Overview</h2></div></div></div>
730: <p>This document is divided into three parts. The first,
1.110 hubertf 731: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 732: describes how one can use one of the packages in the Package
733: Collection, either by installing a precompiled binary package,
1.93 rillig 734: or by building one's own copy using the NetBSD package system.
1.110 hubertf 735: 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 736: package so it can be easily built by other NetBSD users without
737: knowing about the package's building details. The third part,
1.110 hubertf 738: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 739: is intended for those who want to understand how pkgsrc is
740: implemented.</p>
741: <p>This document is available in various formats:
1.110 hubertf 742: <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 743: </div>
1.148 asau 744: <div class="sect1">
1.75 rillig 745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
746: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128 wiz 747: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
748: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.75 rillig 749: terminology used within this document.</p>
1.148 asau 750: <div class="variablelist"><dl class="variablelist">
1.75 rillig 751: <dt><span class="term">Package</span></dt>
752: <dd><p>A set of files and building instructions
753: that describe what's necessary
754: to build a certain piece of software using
755: pkgsrc. Packages are traditionally stored under
1.236 wiz 756: <code class="filename">/usr/pkgsrc</code>,
757: but may be stored in any location,
758: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75 rillig 759: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 760: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 761: is part of the NetBSD operating system and can be bootstrapped
762: to run on non-NetBSD operating systems as well. It handles
763: building (compiling), installing, and removing of
764: packages.</p></dd>
1.75 rillig 765: <dt><span class="term">Distfile</span></dt>
766: <dd><p>This term describes the file or files that are
767: provided by the author of the piece of software to
768: distribute his work. All the changes necessary to build on
769: NetBSD are reflected in the corresponding package. Usually
770: the distfile is in the form of a compressed tar-archive,
771: but other types are possible, too. Distfiles are usually
772: stored below
1.76 rillig 773: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 774: <dt><span class="term">Port</span></dt>
775: <dd><p>This is the term used by FreeBSD and OpenBSD people
776: for what we call a package.
1.128 wiz 777: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 778: architecture.</p></dd>
779: <dt><span class="term">Precompiled/binary package</span></dt>
780: <dd>
781: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 782: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 783: file so it can be installed on machines of the same
784: machine architecture without the need to
785: recompile. Packages are usually generated in
1.76 rillig 786: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 787: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 788: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 789: especially in the context of precompiled packages.</p>
790: </dd>
791: <dt><span class="term">Program</span></dt>
1.88 wiz 792: <dd><p>The piece of software to be installed which will be
793: constructed from all the files in the distfile by the
794: actions defined in the corresponding package.</p></dd>
1.75 rillig 795: </dl></div>
1.148 asau 796: <div class="sect2">
1.75 rillig 797: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 798: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 799: <div class="variablelist"><dl class="variablelist">
1.75 rillig 800: <dt><span class="term">pkgsrc users</span></dt>
801: <dd>
802: <p>The
803: pkgsrc users are people who use the packages provided by pkgsrc.
804: Typically they are system administrators. The people using the
1.128 wiz 805: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
806: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.75 rillig 807: <p>There are two kinds of pkgsrc users: Some only want to
808: install pre-built binary packages. Others build the pkgsrc
809: packages from source, either for installing them directly or for
1.110 hubertf 810: 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 811: documentation.</p>
812: </dd>
813: <dt><span class="term">package maintainers</span></dt>
814: <dd><p>A
1.110 hubertf 815: 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 816: <dt><span class="term">infrastructure developers</span></dt>
817: <dd><p>These people are involved in all those files
1.76 rillig 818: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 819: 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 820: too.</p></dd>
821: </dl></div>
822: </div>
823: </div>
1.148 asau 824: <div class="sect1">
1.75 rillig 825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
826: <a name="typography"></a>1.4. Typography</h2></div></div></div>
827: <p>When giving examples for commands, shell prompts are used to
828: show if the command should/can be issued as root, or if
1.128 wiz 829: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.226 sevan 830: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
831: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
832: bourne shell and derivatives.</p>
1.75 rillig 833: </div>
834: </div>
1.148 asau 835: <div class="part">
1.75 rillig 836: <div class="titlepage"><div><div><h1 class="title">
837: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
838: <div class="toc">
839: <p><b>Table of Contents</b></p>
1.210 leot 840: <dl class="toc">
1.267 rillig 841: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
842: <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 843: <dd><dl>
1.267 rillig 844: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 845: <dd><dl>
1.267 rillig 846: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
847: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 848: </dl></dd>
1.267 rillig 849: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 850: <dd><dl>
1.267 rillig 851: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
852: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 853: </dl></dd>
854: </dl></dd>
1.267 rillig 855: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75 rillig 856: <dd><dl>
1.267 rillig 857: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
858: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 859: </dl></dd>
1.267 rillig 860: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75 rillig 861: <dd><dl>
1.267 rillig 862: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 863: <dd><dl>
1.267 rillig 864: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
865: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317 nia 866: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
867: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
868: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
869: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
870: <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>
871: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75 rillig 872: </dl></dd>
1.267 rillig 873: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75 rillig 874: <dd><dl>
1.267 rillig 875: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
876: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
877: <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 878: </dl></dd>
879: </dl></dd>
1.267 rillig 880: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75 rillig 881: <dd><dl>
1.267 rillig 882: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
883: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
884: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
885: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 886: <dd><dl>
1.267 rillig 887: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
888: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
889: <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 890: </dl></dd>
1.267 rillig 891: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
892: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75 rillig 893: </dl></dd>
1.267 rillig 894: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75 rillig 895: <dd><dl>
1.267 rillig 896: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
897: <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 898: </dl></dd>
1.267 rillig 899: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 900: builds)</a></span></dt>
1.75 rillig 901: <dd><dl>
1.267 rillig 902: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 903: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 904: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
905: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 906: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
907: <dd><dl>
1.294 rillig 908: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
909: <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 910: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
911: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
912: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
913: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
914: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
915: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
916: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
917: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 918: </dl></dd>
919: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
920: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267 rillig 921: </dl></dd>
922: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
923: <dd><dl>
924: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
925: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
926: </dl></dd>
927: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
928: <dd><dl>
929: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
930: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
931: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
932: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
933: <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>
934: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
935: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
936: <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>
937: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
938: <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 939: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 940: <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>
941: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
942: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
943: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
944: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
945: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
946: <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 947: </dl></dd>
948: </dl>
949: </div>
1.148 asau 950: <div class="chapter">
1.75 rillig 951: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 952: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
953: <p>
954: To get help when using pkgsrc, the definitive source is this
955: document, the pkgsrc guide. If you don't find anything here,
956: there are alternatives:
957: </p>
958: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
959: <li class="listitem">
960: <p>
961: The built-in pkgsrc help, which is available after bootstrapping
962: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
963: help for any topic, such as a variable name like
964: <code class="varname">BUILD_DEFS</code>, a make target like
965: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
966: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322 leot 967: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.267 rillig 968: </li>
969: <li class="listitem"><p>
1.278 rillig 970: To see the value of a single variable, run <span class="command"><strong>bmake
971: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
972: </p></li>
973: <li class="listitem"><p>
974: To see the values of the most common variables, run
975: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
976: topic. To see the variables for a single topic, run
977: <span class="command"><strong>bmake
978: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
979: <span class="command"><strong>bmake show-all-fetch</strong></span>.
980: </p></li>
981: <li class="listitem"><p>
1.267 rillig 982: The pkgsrc-users mailing list, to which
983: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
984: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
985: questions</a>.</p></li>
986: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
987: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
988: or by using a specialized chat program such as
989: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
990: Pick any user name and join the channel #pkgsrc.</p></li>
991: </ul></div>
992: </div>
993: <div class="chapter">
994: <div class="titlepage"><div><div><h2 class="title">
995: <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 996: <div class="toc">
997: <p><b>Table of Contents</b></p>
1.210 leot 998: <dl class="toc">
1.267 rillig 999: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 1000: <dd><dl>
1.267 rillig 1001: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
1002: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 1003: </dl></dd>
1.267 rillig 1004: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 1005: <dd><dl>
1.267 rillig 1006: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
1007: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 1008: </dl></dd>
1009: </dl>
1010: </div>
1.91 rillig 1011: <p>Before you download and extract the files, you need to decide
1012: where you want to extract them. When using pkgsrc as root user, pkgsrc
1013: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
1014: free to install the sources and binary packages wherever you want in
1015: your filesystem, provided that the pathname does not contain white-space
1016: or other characters that are interpreted specially by the shell and some
1017: other programs. A safe bet is to use only letters, digits, underscores
1018: and dashes.</p>
1.148 asau 1019: <div class="sect1">
1.75 rillig 1020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1021: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75 rillig 1022: <p>Before you download any pkgsrc files, you should decide
1023: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1024: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1025: quarterly basis from the current branch and only gets modified
1026: for security updates. The names of the stable branches are built
1027: from the year and the quarter, for example
1.322 leot 1028: <code class="literal">2021Q3</code>.</p>
1.75 rillig 1029: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 wiz 1030: want to download pkgsrc. You can get it as a tar file or via CVS.
1031: Both ways are described here.</p>
1.157 asau 1032: <p>Note that tar archive contains CVS working copy.
1033: Thus you can switch to using CVS at any later time.</p>
1.148 asau 1034: <div class="sect2">
1.75 rillig 1035: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1036: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75 rillig 1037: <p>The primary download location for all pkgsrc files is
1.264 sevan 1038: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157 asau 1039: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1040: (it points to the same location).
1041: There are a number of subdirectories for different purposes,
1.322 leot 1042: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix D. Directory layout of the pkgsrc FTP server">Appendix D, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.157 asau 1043: <p>The tar archive for the current branch is in the directory
1.264 sevan 1044: <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 1045: It is autogenerated weekly.</p>
1.157 asau 1046: <p>To save download time we provide bzip2- and
1047: xz-compressed archives which are published at
1.264 sevan 1048: <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 1049: and
1.264 sevan 1050: <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 1051: respectively.
1052: </p>
1053: <p>You can fetch the same files using FTP.</p>
1.322 leot 1054: <p>The tar file for the stable branch 2021Q3 is in the
1055: directory <code class="filename">pkgsrc-2021Q3</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q3/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249 leot 1056: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112 weinem 1057: <pre class="screen">
1.322 leot 1058: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q3/pkgsrc.tar.gz</code></strong></pre>
1.188 snj 1059: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 1060: or your web browser.</p>
1.112 weinem 1061: <p>Then, extract it with:</p>
1.188 snj 1062: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 weinem 1063: <p>This will create the directory <code class="filename">pkgsrc/</code>
1064: in <code class="filename">/usr/</code> and all the package source will be
1065: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1066: <p>To download pkgsrc-current, run:</p>
1067: <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 1068: </div>
1.148 asau 1069: <div class="sect2">
1.75 rillig 1070: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1071: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128 wiz 1072: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.322 leot 1073: <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-2021Q3 -P pkgsrc</code></strong>
1.128 wiz 1074: </pre>
1075: <p>This will create the directory <code class="filename">pkgsrc/</code>
1076: in your <code class="filename">/usr/</code> directory and all the package source
1077: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1078: <p>To fetch the pkgsrc current branch, run:</p>
1.146 wiz 1079: <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 1080: </pre>
1.289 leot 1081: <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 1082: <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 1083: <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 1084: </pre>
1085: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1086: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1087: or better globally in <code class="filename">/etc/profile</code>:</p>
1088: <pre class="programlisting">
1089: # set CVS remote shell command
1090: CVS_RSH=ssh
1091: export CVS_RSH
1092: </pre>
1093: <p>By default, CVS doesn't do things like most people would expect it to do.
1094: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1095: in your home directory and saving the following lines to it.
1096: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1097: You can find an explanation of this file in the CVS documentation.</p>
1.101 rillig 1098: <pre class="programlisting">
1099: # recommended CVS configuration file from the pkgsrc guide
1.268 sevan 1100: cvs -q
1.101 rillig 1101: checkout -P
1.103 wiz 1102: update -dP
1103: diff -upN
1.101 rillig 1104: rdiff -u
1.128 wiz 1105: release -d
1.101 rillig 1106: </pre>
1.75 rillig 1107: </div>
1108: </div>
1.148 asau 1109: <div class="sect1">
1.75 rillig 1110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1111: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75 rillig 1112: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1113: (which also works if you have first installed it via a tar
1114: file). It saves bandwidth and hard disk activity, compared to
1115: downloading the tar file again.</p>
1.148 asau 1116: <div class="sect2">
1.75 rillig 1117: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1118: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148 asau 1119: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1120: <h3 class="title">Warning</h3>
1.77 rillig 1121: <p>When updating from a tar file, you first need to
1122: completely remove the old pkgsrc directory. Otherwise those
1123: files that have been removed from pkgsrc in the mean time will
1124: not be removed on your local disk, resulting in inconsistencies.
1125: When removing the old files, any changes that you have done to
1126: the pkgsrc files will be lost after updating. Therefore updating
1127: via CVS is strongly recommended.</p>
1.75 rillig 1128: </div>
1.82 rillig 1129: <p>Note that by default the distfiles and the binary packages
1130: are saved in the pkgsrc tree, so don't forget to rescue them
1.188 snj 1131: before updating. You can also configure pkgsrc to store distfiles
1132: and packages in directories outside the pkgsrc tree by setting the
1.82 rillig 1133: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267 rillig 1134: 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 1135: <p>To update pkgsrc from a tar file, download the tar file as
1136: explained above. Then, make sure that you have not made any
1137: changes to the files in the pkgsrc directory. Remove the pkgsrc
1138: directory and extract the new tar file. Done.</p>
1139: </div>
1.148 asau 1140: <div class="sect2">
1.75 rillig 1141: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1142: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132 spz 1143: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1144: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1145: </pre>
1146: <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>
1147: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1148: </pre>
1.148 asau 1149: <div class="sect3">
1.75 rillig 1150: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1151: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75 rillig 1152: <p>When updating pkgsrc, the CVS program keeps track of the
1153: branch you selected. But if you, for whatever reason, want to
1154: switch from the stable branch to the current one, you can do it
1.128 wiz 1155: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1156: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.75 rillig 1157: back to the stable branch, add the
1.322 leot 1158: <span class="quote">“<span class="quote">-rpkgsrc-2021Q3</span>”</span> option.</p>
1.75 rillig 1159: </div>
1.148 asau 1160: <div class="sect3">
1.75 rillig 1161: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1162: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75 rillig 1163: <p>When you update pkgsrc, the CVS program will only touch
1164: those files that are registered in the CVS repository. That
1165: means that any packages that you created on your own will stay
1166: unmodified. If you change files that are managed by CVS, later
1167: updates will try to merge your changes with those that have been
1168: done by others. See the CVS manual, chapter
1.128 wiz 1169: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1170: </div>
1171: </div>
1172: </div>
1173: </div>
1.148 asau 1174: <div class="chapter">
1.75 rillig 1175: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1176: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75 rillig 1177: <div class="toc">
1178: <p><b>Table of Contents</b></p>
1.210 leot 1179: <dl class="toc">
1.267 rillig 1180: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1181: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 1182: </dl>
1183: </div>
1.148 asau 1184: <div class="sect1">
1.75 rillig 1185: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1186: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1187: <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 1188: </div>
1.148 asau 1189: <div class="sect1">
1.82 rillig 1190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1191: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1192: <p>pkgsrc can be bootstrapped for use in two different modes:
1193: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1194: to privileged one all programs are installed under one particular user
1.149 asau 1195: and cannot utilise privileged operations (packages don't create
1196: special users and all special file permissions like setuid are ignored).
1197: </p>
1.82 rillig 1198: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1199: <pre class="screen">
1.167 asau 1200: <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 1201: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1202: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1203: </pre>
1.149 asau 1204: <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>
1205: <p>By default, in privileged mode pkgsrc uses
1206: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1207: where programs will be installed in,
1.230 sevan 1208: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149 asau 1209: directory where pkgsrc will do its internal bookkeeping,
1210: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1211: where packages install their persistent data.
1212: In unprivileged mode pkgsrc uses
1213: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230 sevan 1214: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149 asau 1215: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1216: </p>
1217: <p>You can change default layout using command-line arguments.
1218: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1219: </p>
1.148 asau 1220: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1221: <h3 class="title">Note</h3>
1.110 hubertf 1222: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1223: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1224: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128 wiz 1225: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1226: </div>
1.149 asau 1227: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1228: <h3 class="title">Note</h3>
1229: <p>It is possible to bootstrap multiple instances of pkgsrc
1230: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1231: corresponding to the installation you're working with to build
1232: and install packages.
1233: </p>
1234: </div>
1.75 rillig 1235: </div>
1236: </div>
1.148 asau 1237: <div class="chapter">
1.75 rillig 1238: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1239: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75 rillig 1240: <div class="toc">
1241: <p><b>Table of Contents</b></p>
1.210 leot 1242: <dl class="toc">
1.267 rillig 1243: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 1244: <dd><dl>
1.267 rillig 1245: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1246: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317 nia 1247: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1248: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1249: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1250: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1251: <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>
1252: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.267 rillig 1253: </dl></dd>
1254: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1255: <dd><dl>
1256: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1257: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1258: <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 1259: </dl></dd>
1260: </dl>
1261: </div>
1262: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1263: is to only install the package tools and to use binary packages
1.128 wiz 1264: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1265: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.88 wiz 1266: of pkgsrc, too. Then you are able to build your own packages,
1267: and you can still use binary packages from someone else.</p>
1.148 asau 1268: <div class="sect1">
1.75 rillig 1269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1270: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.317 nia 1271: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264 sevan 1272: site and mirrors, there are collections of binary packages,
1.109 rillig 1273: ready to be installed. These binary packages have been built using the
1274: default settings for the directories, that is:</p>
1.148 asau 1275: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1276: <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>
1277: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1278: <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 1279: </ul></div>
1280: <p>If you cannot use these directories for whatever reasons (maybe
1281: because you're not root), you cannot use these binary packages, but
1.267 rillig 1282: 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 1283: <div class="sect2">
1.75 rillig 1284: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1285: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1286: <p>To install binary packages, you first need to know from where
1287: to get them. The first place where you should look is on the main
1.317 nia 1288: 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 1289: <p>This directory contains binary packages for multiple
1290: platforms. First, select your operating system. (Ignore the
1291: directories with version numbers attached to it, they just exist for
1292: legacy reasons.) Then, select your hardware architecture, and in the
1.128 wiz 1293: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 rillig 1294: <p>In this directory, you often find a file called
1295: <code class="filename">bootstrap.tar.gz</code> which contains the package
1296: management tools. If the file is missing, it is likely that your
1297: operating system already provides those tools. Download the file and
1298: extract it in the <code class="filename">/</code> directory. It will create
1299: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230 sevan 1300: for managing binary packages and the database of installed packages).</p>
1.75 rillig 1301: </div>
1.148 asau 1302: <div class="sect2">
1.75 rillig 1303: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1304: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1305: <p>In the directory from the last section, there is a
1.196 wiz 1306: subdirectory called <code class="filename">All/</code>, which contains all the
1.109 rillig 1307: binary packages that are available for the platform, excluding those
1.317 nia 1308: that may not be distributed via HTTP or FTP.</p>
1.109 rillig 1309: <p>To install packages directly from an FTP or HTTP server, run
1310: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1311: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1312: <pre class="screen">
1.317 nia 1313: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1314: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284 rillig 1315: <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 1316: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.317 nia 1317: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.109 rillig 1318: </pre>
1319: <p>Instead of URLs, you can also use local paths, for example if
1320: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1321: repository. If you want to install packages from multiple sources,
1322: you can separate them by a semicolon in
1323: <code class="varname">PKG_PATH</code>.</p>
1324: <p>After these preparations, installing a package is very
1325: easy:</p>
1326: <pre class="screen">
1.317 nia 1327: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1328: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1329: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1330: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1331: </pre>
1332: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1333: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1334: <p>Any prerequisite packages needed to run the
1.88 wiz 1335: package in question will be installed, too, assuming they are
1.317 nia 1336: present in the repository.</p>
1.75 rillig 1337: <p>After you've installed packages, be sure to have
1.88 wiz 1338: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1339: <code class="varname">PATH</code> so you can actually start the just
1340: installed program.</p>
1.75 rillig 1341: </div>
1.148 asau 1342: <div class="sect2">
1.75 rillig 1343: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1344: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1345: <p>To update binary packages, it is recommended that you use
1346: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1347: package repository to your locally installed packages and safely
1348: replace any older packages.</p>
1349: <p>Note that pkgsrc is released as quarterly branches.
1350: If you are updating to a newer quarterly branch of pkgsrc, you may
1351: need to adjust the repository in
1352: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1353: </div>
1354: <div class="sect2">
1355: <div class="titlepage"><div><div><h3 class="title">
1356: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.82 rillig 1357: <p>To deinstall a package, it does not matter whether it was
1.317 nia 1358: installed from source code or from a binary package. Neither the
1359: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1360: command need to know.</p>
1361: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.88 wiz 1362: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.317 nia 1363: name can be given with or without version number.</p>
1.82 rillig 1364: </div>
1.148 asau 1365: <div class="sect2">
1.82 rillig 1366: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1367: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1368: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.317 nia 1369: installed packages or binary package files.
1370: As with other management tools, it works with packages installed
1371: from source or binaries.</p>
1.82 rillig 1372: </div>
1.148 asau 1373: <div class="sect2">
1.82 rillig 1374: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1375: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82 rillig 1376: <p>
1.279 leot 1377: The pkgsrc Security Team and Packages Groups maintain a list of
1.317 nia 1378: known vulnerabilities to packages which are (or have been)
1.88 wiz 1379: included in pkgsrc. The list is available from the NetBSD
1.317 nia 1380: 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>.
1381: </p>
1382: <p>
1383: Please note that not every "vulnerability" with a CVE assignment is
1384: exploitable in every configuration.
1385: Some bugs are marked as active simply because an fix was not
1386: marked as such.
1387: Operating system specific hardening and mitigation features may also
1388: reduce the impact of bugs.
1.88 wiz 1389: </p>
1.82 rillig 1390: <p>
1.125 wiz 1391: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 1392: this list can be downloaded
1393: automatically, and a security audit of all packages installed on a system
1394: can take place.
1395: </p>
1.82 rillig 1396: <p>
1.125 wiz 1397: There are two components to auditing. The first
1398: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1399: is for downloading
1.88 wiz 1400: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1401: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1402: installed packages are vulnerable. If a package is vulnerable, you
1403: will see output similar to the following:
1404: </p>
1.82 rillig 1405: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289 leot 1406: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1407: <p>
1.125 wiz 1408: You may wish to have the
1.317 nia 1409: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1410: file downloaded daily so that
1411: it remains current. This may be done by adding an appropriate entry
1.322 leot 1412: to the root users <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.125 wiz 1413: </p>
1414: <pre class="screen">
1.233 sevan 1415: # Download vulnerabilities file
1.230 sevan 1416: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.233 sevan 1417: # Audit the installed packages and email results to root
1418: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1419: root >/dev/null 2>&1
1.125 wiz 1420: </pre>
1421: <p>
1.230 sevan 1422: will update the vulnerability list every day at 3AM, followed by an audit
1423: at 3:09AM. The result of the audit are then emailed to root.
1.125 wiz 1424:
1.230 sevan 1425: On NetBSD this may be accomplished instead by adding the following
1426: line to <code class="filename">/etc/daily.conf</code>:
1427: </p>
1428: <pre class="screen">
1429: fetch_pkg_vulnerabilities=YES
1430: </pre>
1431: <p>
1432: to fetch the vulnerability list from the daily security script. The system
1433: is set to audit the packages by default but can be set explicitly, if
1.235 yyamano 1434: desired (not required), by adding the following line to
1.230 sevan 1435: <code class="filename">/etc/security.conf</code>:
1.125 wiz 1436: </p>
1437: <pre class="screen">
1.230 sevan 1438: check_pkg_vulnerabilities=YES
1.125 wiz 1439: </pre>
1440: <p>
1.322 leot 1441: see <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88 wiz 1442: </p>
1.82 rillig 1443: </div>
1.148 asau 1444: <div class="sect2">
1.82 rillig 1445: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1446: <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 1447: <p>
1.322 leot 1448: Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128 wiz 1449: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.317 nia 1450: argument to check if any packages are stale, e.g.
1.88 wiz 1451: </p>
1452: <pre class="screen">
1453: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1454: ...
1.88 wiz 1455: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1456: </pre>
1.82 rillig 1457: </div>
1.148 asau 1458: <div class="sect2">
1.82 rillig 1459: <div class="titlepage"><div><div><h3 class="title">
1.317 nia 1460: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.110 hubertf 1461: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1462: administrative functions on the package system.</p>
1.82 rillig 1463: </div>
1.75 rillig 1464: </div>
1.148 asau 1465: <div class="sect1">
1.75 rillig 1466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1467: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88 wiz 1468: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1469: directory now contains a set of packages, organized into
1470: categories. You can browse the online index of packages, or run
1.110 hubertf 1471: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1472: directory to build local <code class="filename">README.html</code> files for
1.322 leot 1473: all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/index.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88 wiz 1474: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1475: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1476: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1477: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1478: different <code class="varname">LOCALBASE</code> definitions on the same
1479: system (inside a chroot is an exception). </p>
1480: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1481: 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 1482: instructions how to create your own packages.</p>
1.148 asau 1483: <div class="sect2">
1.75 rillig 1484: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1485: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82 rillig 1486: <p>To build packages from source, you need a working C
1.88 wiz 1487: compiler. On NetBSD, you need to install the
1.128 wiz 1488: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1489: sets. If you want to build X11-related packages, the
1.128 wiz 1490: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1491: sets are required, too.</p>
1.75 rillig 1492: </div>
1.148 asau 1493: <div class="sect2">
1.75 rillig 1494: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1495: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75 rillig 1496: <p>The first step for building a package is downloading the
1.88 wiz 1497: distfiles (i.e. the unmodified source). If they have not yet been
1498: downloaded, pkgsrc will fetch them automatically.</p>
1499: <p>If you have all files that you need in the
1500: <code class="filename">distfiles</code> directory,
1501: you don't need to connect. If the distfiles are on CD-ROM, you can
1502: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1503: </p>
1.82 rillig 1504: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1505: <p>
1.110 hubertf 1506: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1507: <p>By default a list of distribution sites will be randomly
1508: intermixed to prevent huge load on servers which holding popular
1509: packages (for example, SourceForge.net mirrors). Thus, every
1510: time when you need to fetch yet another distfile all the mirrors
1511: will be tried in new (random) order. You can turn this feature
1512: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1513: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1514: <p>You can overwrite some of the major distribution sites to
1515: fit to sites that are close to your own. By setting one or two
1516: variables you can modify the order in which the master sites are
1517: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1518: delimited list of domain suffixes.
1519: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1520: contains a whitespace delimited list of regular expressions. It
1521: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1522: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1523: some examples. This may save some of your bandwidth and
1524: time.</p>
1.75 rillig 1525: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1526: if you want to keep the settings, by editing the
1.110 hubertf 1527: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1528: and adding the definitions there.</p>
1.82 rillig 1529: <p>
1.88 wiz 1530: If a package depends on many other packages (such as
1.322 leot 1531: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.88 wiz 1532: alternate between periods of
1533: downloading source, and compiling. To ensure you have all the source
1534: downloaded initially you can run the command:
1535: </p>
1.82 rillig 1536: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1537: <p>
1.88 wiz 1538: which will output and run a set of shell commands to fetch the
1539: necessary files into the <code class="filename">distfiles</code> directory. You can
1540: also choose to download the files manually.
1541: </p>
1.75 rillig 1542: </div>
1.148 asau 1543: <div class="sect2">
1.75 rillig 1544: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1545: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1546: <p>
1.88 wiz 1547: Once the software has downloaded, any patches will be applied, then it
1548: will be compiled for you. This may take some time depending on your
1549: computer, and how many other packages the software depends on and their
1550: compile time.
1551: </p>
1.148 asau 1552: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1553: <h3 class="title">Note</h3>
1554: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1555: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1556: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1557: </div>
1.87 wiz 1558: <p>For example, type</p>
1.88 wiz 1559: <pre class="screen">
1560: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1561: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1562: </pre>
1.75 rillig 1563: <p>at the shell prompt to build the various components of the
1.88 wiz 1564: package.</p>
1.82 rillig 1565: <p>The next stage is to actually install the newly compiled
1.88 wiz 1566: program onto your system. Do this by entering:
1.82 rillig 1567:
1.88 wiz 1568: </p>
1.82 rillig 1569: <pre class="screen">
1.88 wiz 1570: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1571: </pre>
1.82 rillig 1572: <p>
1573:
1.88 wiz 1574: while you are still in the directory for whatever package you
1575: are installing.</p>
1.82 rillig 1576: <p>Installing the package on your system may require you to
1.88 wiz 1577: be root. However, pkgsrc has a
1578: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1579: to only become root for the actual installation step.</p>
1.82 rillig 1580: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1581: You can now enter:
1.82 rillig 1582:
1.88 wiz 1583: </p>
1.82 rillig 1584: <pre class="screen">
1.88 wiz 1585: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1586: </pre>
1.82 rillig 1587: <p>
1588:
1.88 wiz 1589: to remove the compiled files in the work directory, as you shouldn't need
1590: them any more. If other packages were also added to your system
1591: (dependencies) to allow your program to compile, you can tidy these up
1592: also with the command:</p>
1.82 rillig 1593: <pre class="screen">
1.88 wiz 1594: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1595: </pre>
1.75 rillig 1596: <p>Taking the figlet utility as an example, we can install it on our
1.322 leot 1597: system by building as shown in <a class="xref" href="#logs" title="Appendix C. Build logs">Appendix C, <i>Build logs</i></a>.</p>
1.88 wiz 1598: <p>The program is installed under the default root of the
1599: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1600: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1601: variable in your environment, and it will use that value as the
1602: root of your packages tree. So, to use
1603: <code class="filename">/usr/local</code>, set
1604: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1605: Please note that you should use a directory which is dedicated to
1606: packages and not shared with other programs (i.e., do not try and
1607: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1608: to add any of your own files or directories (such as
1609: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1610: <code class="filename">pkgsrc/</code>) below the
1611: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1612: conflicts between programs and other files installed by the
1613: package system and whatever else may have been installed
1614: there.</p>
1.110 hubertf 1615: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 1616: alter some configuration options at build time. Have a look at
1617: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1618: of what will be set there by default. Environment variables such
1619: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 1620: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1621: set them each time you want to use pkgsrc.</p>
1.128 wiz 1622: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1623: covers</span>”</span> to see what is going on when a package is building
1.88 wiz 1624: or being installed. This may be for debugging purposes, or out of
1625: simple curiosity. A number of utility values have been added to
1626: help with this.</p>
1.128 wiz 1627: <div class="orderedlist"><ol class="orderedlist" type="1">
1628: <li class="listitem">
1.322 leot 1629: <p>If you invoke the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88 wiz 1630: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1631: information will be displayed. For example,</p>
1.75 rillig 1632: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1633: <p>will show all the commands that are invoked, up to and
1.128 wiz 1634: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1635: </li>
1.128 wiz 1636: <li class="listitem">
1.322 leot 1637: <p>If you want to know the value of a certain <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1638: definition, then the <code class="varname">VARNAME</code> definition
1639: should be used, in conjunction with the show-var
1.322 leot 1640: target. e.g. to show the expansion of the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 1641: variable <code class="varname">LOCALBASE</code>:</p>
1642: <pre class="screen">
1643: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 1644: /usr/pkg
1645: <code class="prompt">%</code>
1.88 wiz 1646: </pre>
1.75 rillig 1647: </li>
1648: </ol></div>
1649: <p>If you want to install a binary package that you've either
1.88 wiz 1650: created yourself (see next section), that you put into
1651: pkgsrc/packages manually or that is located on a remote FTP
1652: server, you can use the "bin-install" target. This target will
1.322 leot 1653: install a binary package - if available - via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110 hubertf 1654: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1655: sites searched is kept in the variable
1656: <code class="varname">BINPKG_SITES</code>, which defaults to
1.322 leot 1657: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88 wiz 1658: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1659: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1660: details.</p>
1661: <p>A final word of warning: If you set up a system that has a
1662: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1663: set that before any packages are installed, as you cannot use
1664: several directories for the same purpose. Doing so will result in
1665: pkgsrc not being able to properly detect your installed packages,
1666: and fail miserably. Note also that precompiled binary packages are
1667: usually built with the default <code class="varname">LOCALBASE</code> of
1668: <code class="filename">/usr/pkg</code>, and that you should
1669: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1670: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 1671: </div>
1672: </div>
1673: </div>
1.148 asau 1674: <div class="chapter">
1.75 rillig 1675: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1676: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75 rillig 1677: <div class="toc">
1678: <p><b>Table of Contents</b></p>
1.210 leot 1679: <dl class="toc">
1.267 rillig 1680: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1681: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1682: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
1683: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1684: <dd><dl>
1685: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
1686: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1687: <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 1688: </dl></dd>
1.267 rillig 1689: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
1690: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75 rillig 1691: </dl>
1692: </div>
1.104 rillig 1693: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 1694: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1695: that file depends on the installation. On NetBSD, when you use
1.322 leot 1696: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89 rillig 1697: <code class="filename">/etc/</code>. In all other cases the default location is
1698: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1699: bootstrap program to install the binary packages.</p>
1700: <p>The format of the configuration file is that of the usual
1701: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1702: is done by setting variables in this file. Note that you can define all
1703: kinds of variables, and no special error checking (for example for
1.223 rillig 1704: spelling mistakes) takes place.</p>
1.148 asau 1705: <div class="sect1">
1.75 rillig 1706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1707: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223 rillig 1708: <p>The following variables apply to all
1.89 rillig 1709: pkgsrc packages. A complete list of the variables that can be
1710: configured by the user is available in
1711: <code class="filename">mk/defaults/mk.conf</code>, together with some
1712: comments that describe each variable's intent.</p>
1.148 asau 1713: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1714: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 1715: packages will be installed. The default is
1.76 rillig 1716: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 1717: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 wiz 1718: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1719: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.75 rillig 1720: installed. The default is
1.76 rillig 1721: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 1722: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 1723: X11 is installed on the system. The default is
1.194 bsiegert 1724: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 1725: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 1726: downloaded copies of the original source distributions used
1727: for building pkgsrc packages. The default is
1.76 rillig 1728: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 1729: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 1730: database about installed packages is stored. The default is
1.230 sevan 1731: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128 wiz 1732: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 1733: If set, override the packages'
1734: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 1735: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 1736: Backup location(s) for distribution files and patch files
1737: if not found locally or in
1.76 rillig 1738: <code class="filename">${MASTER_SITES}</code> or
1739: <code class="filename">${PATCH_SITES}</code> respectively.
1.230 sevan 1740: The defaults is
1741: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 1742: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 1743: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1744: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128 wiz 1745: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1746: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1747: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125 wiz 1748: List of acceptable licenses. License names are case-sensitive.
1749: Whenever you try to build a package whose license is not in this
1750: list, you will get an error message. If the license condition is
1751: simple enough, the error message will include specific
1752: instructions on how to change this variable.</p></li>
1.75 rillig 1753: </ul></div>
1754: </div>
1.148 asau 1755: <div class="sect1">
1.75 rillig 1756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1757: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219 rillig 1758: <p>
1.75 rillig 1759: </p>
1.148 asau 1760: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1761: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 1762: directory for the binary packages. The default is
1.76 rillig 1763: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 1764: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 1765: The top level directory where, if defined, the separate
1766: working directories will get created, and symbolically
1.76 rillig 1767: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 1768: This is useful for building packages on several
1.76 rillig 1769: architectures, then <code class="filename">${PKGSRCDIR}</code>
1770: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 1771: is local to every architecture. (It should be noted that
1772: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126 jakllsch 1773: — it is an internal definition which refers to the
1.75 rillig 1774: root of the pkgsrc tree. It is possible to have many
1775: pkgsrc tree instances.)</p></li>
1.128 wiz 1776: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 1777: Directory for local patches that aren't part of pkgsrc.
1.299 rillig 1778: 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 1779: information.</p></li>
1.128 wiz 1780: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 1781: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 1782: BSD-style Makefile. If this is not set,
1783: <code class="varname">MAKECONF</code> is set to
1.76 rillig 1784: <code class="filename">/dev/null</code> to avoid picking up
1785: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75 rillig 1786: </ul></div>
1787: </div>
1.148 asau 1788: <div class="sect1">
1.75 rillig 1789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1790: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.312 gdt 1791: <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 1792: By default, binary packages of built packages are
1.263 leot 1793: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256 maya 1794: this variable to "no" prevents this.</p></li></ul></div>
1.217 jnemeth 1795: <p>Packages have to support installation into a
1.103 wiz 1796: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1797: to be built, before the actual filesystem is touched. DESTDIR
1798: support exists in two variations:</p>
1.148 asau 1799: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1800: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 wiz 1801: installation and packaging is still run as root.</p></li>
1802: <li class="listitem"><p>Full DESTDIR support can run the complete
1803: build, installation and packaging as normal user. Root
1804: privileges are only needed to add packages.</p></li>
1805: </ul></div>
1.103 wiz 1806: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1807: clean</code></strong> needs to be run as root.</p>
1.118 imil 1808: <p>Considering the <code class="filename">foo/bar</code> package,
1809: DESTDIR full support can be tested using the following commands
1810:
1811: </p>
1812: <pre class="programlisting">
1813: <code class="prompt">$</code> id
1814: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1815: <code class="prompt">$</code> mkdir $HOME/packages
1816: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1817: </pre>
1818: <p>
1819:
1820: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1821: should be needed
1822:
1823: </p>
1824: <pre class="programlisting">
1.174 asau 1825: <code class="prompt">$</code> make stage-install
1.118 imil 1826: </pre>
1827: <p>
1828:
1829: Create a package without root privileges
1830:
1831: </p>
1832: <pre class="programlisting">
1.174 asau 1833: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 1834: </pre>
1835: <p>
1836:
1837: For the following command, you must be able to gain root
1.322 leot 1838: privileges using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118 imil 1839:
1840: </p>
1841: <pre class="programlisting">
1.174 asau 1842: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 imil 1843: </pre>
1844: <p>
1845:
1846: Then, as a simple user
1847:
1848: </p>
1849: <pre class="programlisting">
1850: <code class="prompt">$</code> make clean
1851: </pre>
1852: <p>
1853:
1854: </p>
1.103 wiz 1855: </div>
1.148 asau 1856: <div class="sect1">
1.103 wiz 1857: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1858: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 1859: <div class="sect2">
1.78 rillig 1860: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1861: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 1862: <p>By default, pkgsrc will use GCC to build packages. This may be
1863: overridden by setting the following variables in /etc/mk.conf:</p>
1.148 asau 1864: <div class="variablelist"><dl class="variablelist">
1.89 rillig 1865: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1866: <dd>
1867: <p>This is a list of values specifying the chain of
1868: compilers to invoke when building packages. Valid values
1869: are:</p>
1.148 asau 1870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 asau 1871: <li class="listitem"><p><code class="varname">ccc</code>:
1872: Compaq C Compilers (Tru64)</p></li>
1873: <li class="listitem"><p><code class="varname">ccache</code>:
1874: compiler cache (chainable)</p></li>
1875: <li class="listitem"><p><code class="varname">clang</code>:
1876: Clang C and Objective-C compiler</p></li>
1.128 wiz 1877: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 1878: distributed C/C++ (chainable)</p></li>
1.174 asau 1879: <li class="listitem"><p><code class="varname">f2c</code>:
1880: Fortran 77 to C compiler (chainable)</p></li>
1881: <li class="listitem"><p><code class="varname">icc</code>:
1882: Intel C++ Compiler (Linux)</p></li>
1883: <li class="listitem"><p><code class="varname">ido</code>:
1884: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128 wiz 1885: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 1886: GNU C/C++ Compiler</p></li>
1.174 asau 1887: <li class="listitem"><p><code class="varname">hp</code>:
1888: HP-UX C/aC++ compilers</p></li>
1.128 wiz 1889: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 1890: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 1891: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 1892: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 1893: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 1894: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 1895: <li class="listitem"><p><code class="varname">xlc</code>:
1.230 sevan 1896: IBM's XL C/C++ compiler suite</p></li>
1.89 rillig 1897: </ul></div>
1898: <p>The default is
1.128 wiz 1899: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 1900: <code class="varname">ccache</code> and/or
1901: <code class="varname">distcc</code> with an appropriate
1902: <code class="varname">PKGSRC_COMPILER</code> setting,
1.128 wiz 1903: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 1904: variable should always be terminated with a value for
1905: a real compiler. Note that only one real compiler
1.128 wiz 1906: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 1907: is not allowed).</p>
1.89 rillig 1908: </dd>
1909: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1910: <dd><p>This specifies the minimum version of GCC to use
1911: when building packages. If the system GCC doesn't
1912: satisfy this requirement, then pkgsrc will build and
1913: install one of the GCC packages to use instead.</p></dd>
1.266 leot 1914: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225 maya 1915: <dd><p>Specifies which version of python to use when several
1916: options are available.</p></dd>
1917: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291 gutterid 1918: <dd><p>Specifies the Fortran compiler to use.
1919: The default is <code class="varname">gfortran</code>.</p></dd>
1.225 maya 1920: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1921: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1922: <code class="varname">gfortran</code> is used, this option specifies which
1923: version to use.</p></dd>
1.89 rillig 1924: </dl></div>
1925: </div>
1.148 asau 1926: <div class="sect2">
1.89 rillig 1927: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1928: <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 1929: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1930: please make sure to use the <code class="literal">+=</code> operator
1931: instead of the <code class="literal">=</code> operator:</p>
1932: <pre class="programlisting">
1.100 rillig 1933: CFLAGS+= -your -flags
1.78 rillig 1934: </pre>
1935: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 1936: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 1937: need to add their own flags. You may want to take a look
1.322 leot 1938: at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128 wiz 1939: package if you're interested in optimization specifically
1940: for the current CPU. </p>
1.78 rillig 1941: </div>
1.148 asau 1942: <div class="sect2">
1.88 wiz 1943: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1944: <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 1945: <p>If you want to pass flags to the linker, both in the configure
1946: step and the build step, you can do this in two ways. Either set
1947: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1948: between the two is that <code class="varname">LIBS</code> will be appended to
1949: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1950: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1951: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1952: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1953: <code class="varname">CFLAGS</code>, if you do not wish to override these
1954: settings, use the <code class="literal">+=</code> operator:</p>
1955: <pre class="programlisting">
1.100 rillig 1956: LDFLAGS+= -your -linkerflags
1.88 wiz 1957: </pre>
1958: </div>
1.78 rillig 1959: </div>
1.148 asau 1960: <div class="sect1">
1.78 rillig 1961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1962: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 1963: <p>
1.75 rillig 1964: </p>
1.148 asau 1965: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1966: <li class="listitem">
1.75 rillig 1967: <p><code class="varname">PKG_DEVELOPER</code>:
1968: Run some sanity checks that package developers want:
1969: </p>
1.148 asau 1970: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 1971: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 1972: fuzz</p></li>
1.128 wiz 1973: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 1974: binaries will find their shared libs.</p></li>
1.75 rillig 1975: </ul></div>
1976: <p>
1.87 wiz 1977: </p>
1.75 rillig 1978: </li>
1.128 wiz 1979: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 1980: of debugging output which is displayed whilst making and
1981: installing the package. The default value for this is 0,
1982: which will not display the commands as they are executed
1983: (normal, default, quiet operation); the value 1 will display
1984: all shell commands before their invocation, and the value 2
1985: will display both the shell commands before their invocation,
1.223 rillig 1986: as well as their actual execution progress with <span class="command"><strong>set
1987: -x</strong></span>.</p></li>
1.75 rillig 1988: </ul></div>
1989: <p>
1990: </p>
1991: </div>
1.148 asau 1992: <div class="sect1">
1.75 rillig 1993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1994: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 1995: <p>Some packages have build time options, usually to select
1996: between different dependencies, enable optional support for big
1997: dependencies or enable experimental features.</p>
1.75 rillig 1998: <p>To see which options, if any, a package supports, and which
1.110 hubertf 1999: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2000: show-options</strong></span>, for example:</p>
1.75 rillig 2001: <pre class="programlisting">
2002: The following options are supported by this package:
2003: ssl Enable SSL support.
2004: Exactly one of the following gecko options is required:
2005: firefox Use firefox as gecko rendering engine.
2006: mozilla Use mozilla as gecko rendering engine.
2007: At most one of the following database options may be selected:
2008: mysql Enable support for MySQL database.
2009: pgsql Enable support for PostgreSQL database.
1.1 grant 2010:
1.75 rillig 2011: These options are enabled by default: firefox
2012: These options are currently enabled: mozilla ssl
1.1 grant 2013: </pre>
1.75 rillig 2014: <p>The following variables can be defined in
1.110 hubertf 2015: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2016: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2017: which can be used to select or disable options for all packages
2018: that support them, and
2019: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2020: which can be used to select or disable options specifically for
2021: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.128 wiz 2022: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 2023: are disabled. A few examples:</p>
1.75 rillig 2024: <pre class="screen">
1.110 hubertf 2025: <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 2026: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2027: PKG_OPTIONS.kdebase= debug -sasl
2028: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2029: <p>It is important to note that options that were specifically
1.120 snj 2030: suggested by the package maintainer must be explicitly removed if
1.111 rillig 2031: you do not wish to include the option. If you are unsure you can view
2032: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2033: <p>The following settings are consulted in the order given, and
2034: the last setting that selects or disables an option is
2035: used:</p>
1.128 wiz 2036: <div class="orderedlist"><ol class="orderedlist" type="1">
2037: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 2038: maintainer</p></li>
1.128 wiz 2039: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 2040: variables (see below)</p></li>
1.128 wiz 2041: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2042: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75 rillig 2043: </ol></div>
2044: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2045: selected is used, all others are automatically disabled. If an
2046: option of the group is explicitly disabled, the previously
2047: selected option, if any, is used. It is an error if no option
2048: from a required group of options is selected, and building the
2049: package will fail.</p>
2050: <p>Before the options framework was introduced, build options
2051: were selected by setting a variable (often named
2052: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2053: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2054: transition to the options framework for the user, these legacy
2055: variables are converted to the appropriate options setting
2056: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2057: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2058: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2059: directly. Support for the legacy variables will be removed
2060: eventually.</p>
1.75 rillig 2061: </div>
2062: </div>
1.148 asau 2063: <div class="chapter">
1.75 rillig 2064: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2065: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75 rillig 2066: <div class="toc">
2067: <p><b>Table of Contents</b></p>
1.210 leot 2068: <dl class="toc">
1.267 rillig 2069: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2070: <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 2071: </dl>
2072: </div>
1.148 asau 2073: <div class="sect1">
1.75 rillig 2074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2075: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2076: <p>Once you have built and installed a package, you can create
2077: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.322 leot 2078: another system with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87 wiz 2079: the same package on a group of hosts and wasting CPU time. It also
2080: provides a simple means for others to install your package, should
2081: you distribute it.</p>
2082: <p>To create a binary package, change into the appropriate
1.110 hubertf 2083: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2084: package</strong></span>:</p>
2085: <pre class="screen">
1.223 rillig 2086: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2087: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2088: </pre>
1.87 wiz 2089: <p>This will build and install your package (if not already done),
2090: and then build a binary package from what was installed. You can
1.110 hubertf 2091: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2092: it. Binary packages are created by default in
2093: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.322 leot 2094: gzipped tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a
2095: continuation of the above <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/index.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.267 rillig 2096: <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 2097: such a binary package.</p>
1.75 rillig 2098: </div>
1.148 asau 2099: <div class="sect1">
1.75 rillig 2100: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2101: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.299 rillig 2102: <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 2103: </div>
2104: </div>
1.148 asau 2105: <div class="chapter">
1.106 rillig 2106: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2107: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 2108: builds)</h2></div></div></div>
2109: <div class="toc">
2110: <p><b>Table of Contents</b></p>
1.210 leot 2111: <dl class="toc">
1.267 rillig 2112: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295 rillig 2113: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267 rillig 2114: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2115: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293 rillig 2116: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2117: <dd><dl>
1.294 rillig 2118: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2119: <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 2120: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
2121: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
2122: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
2123: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
2124: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
2125: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
2126: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
2127: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293 rillig 2128: </dl></dd>
2129: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2130: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.106 rillig 2131: </dl>
2132: </div>
1.290 gutterid 2133: <p>For a number of reasons, you may want to build binary packages
2134: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180 wiz 2135: For instance, when you have multiple machines that should run the same software,
2136: it is wasted time if they all build their packages themselves from source.
2137: Or you may want to build a list of packages you want and check them before
1.290 gutterid 2138: deploying onto production systems.
1.180 wiz 2139: There is a way of getting a set of binary packages:
1.290 gutterid 2140: the bulk build system, or pbulk ("p" stands for "parallel").
1.223 rillig 2141: This chapter describes how to set it up.</p>
1.148 asau 2142: <div class="sect1">
1.106 rillig 2143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2144: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180 wiz 2145: <p>First of all, you have to decide whether you build all packages
2146: or a limited set of them. Full bulk builds usually consume a lot more resources,
2147: both space and time, than builds for some practical sets of packages.
1.290 gutterid 2148: A number of particularly heavy packages exist that are not actually
2149: interesting to a wide audience. (The approximate resource consumption for a
2150: 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>.)
2151: For limited bulk builds you need to make a list of packages you want to build.
1.223 rillig 2152: Note that all their dependencies will be built, so you don't need to track them manually.
1.180 wiz 2153: </p>
2154: <p>During bulk builds various packages are installed and deinstalled
2155: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2156: so make sure that you don't need any package during the builds.
1.223 rillig 2157: Essentially, you should provide a fresh system, either a chroot environment
1.180 wiz 2158: or something even more restrictive, depending on what the operating system provides,
2159: or dedicate the whole physical machine.
2160: As a useful side effect this makes sure that bulk builds cannot
2161: break anything in your system. There have been numerous cases where
1.106 rillig 2162: certain packages tried to install files outside the
2163: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2164: <code class="filename">/etc</code>.
2165: </p>
1.106 rillig 2166: </div>
1.148 asau 2167: <div class="sect1">
1.106 rillig 2168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.295 rillig 2169: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
2170: <p>Running a bulk build works roughly as follows:</p>
1.148 asau 2171: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2172: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2173: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116 rillig 2174: </ul></div>
1.148 asau 2175: <div class="sect2">
1.116 rillig 2176: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 2177: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223 rillig 2178: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178 asau 2179: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2180: Configure network access to fetch distribution files.
1.223 rillig 2181: Create a user with name "pbulk".</p>
1.178 asau 2182: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2183: <pre class="screen">
1.264 sevan 2184: <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>
2185: <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 2186: <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 2187: </pre>
2188: <p>Or any other way that fits (e.g., curl, wget).</p>
2189: <p>Deploy and configure pbulk tools, e.g.:</p>
2190: <pre class="screen">
1.230 sevan 2191: <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 2192: <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>
2193: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2194: </pre>
2195: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2196: <h3 class="title">Note</h3>
2197: <p><code class="filename">mk.conf.frag</code> is a fragment of
2198: <code class="filename">mk.conf</code> that contains settings you want to
2199: apply to packages you build. For instance,</p>
2200: <pre class="programlisting">
1.223 rillig 2201: PKG_DEVELOPER= yes # perform more checks
2202: X11_TYPE= modular # use pkgsrc X11
2203: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2204: # when building all packages)
1.178 asau 2205: </pre>
2206: </div>
2207: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223 rillig 2208: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178 asau 2209: <pre class="programlisting">
2210: www/firefox
2211: mail/thunderbird
2212: misc/libreoffice4
2213: </pre>
1.179 asau 2214: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2215: and make final amendments, if wanted.</p>
1.178 asau 2216: <p>Start it:</p>
2217: <pre class="screen">
2218: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2219: </pre>
2220: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2221: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2222: </p>
2223: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2224: <h3 class="title">Note</h3>
2225: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2226: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2227: The script is kept small enough for better understanding.</p>
2228: </div>
2229: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2230: <h3 class="title">Note</h3>
2231: <p>The <code class="filename">pbulk.sh</code> script supports running
1.320 wiz 2232: unprivileged bulk build and helps configuring distributed bulk builds.
2233: Distributed bulk builds support either building in worker chroots
2234: (each node is a path to a different chroot)
2235: that replicate the target system, including the pbulk prefix,
2236: or remote machines (each node is
2237: an IP address that must be accessible over SSH without a password).</p>
1.178 asau 2238: </div>
1.106 rillig 2239: </div>
2240: </div>
1.148 asau 2241: <div class="sect1">
1.106 rillig 2242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2243: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180 wiz 2244: <p>A complete bulk build requires lots of disk space. Some of the
2245: disk space can be read-only, some other must be writable. Some can be on
2246: remote filesystems (such as NFS) and some should be local. Some can be
2247: temporary filesystems, others must survive a sudden reboot.</p>
2248: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.320 wiz 2249: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2250: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.180 wiz 2251: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2252: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2253: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2254: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2255: </ul></div>
2256: </div>
2257: <div class="sect1">
2258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.293 rillig 2259: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2260: <p>To ensure that pkgsrc packages work in different configurations, it
2261: makes sense to run non-default bulk builds from time to time. This
2262: section lists some ideas for bulk builds that intentionally let packages
2263: fail if they don't follow the pkgsrc style.</p>
2264: <div class="sect2">
2265: <div class="titlepage"><div><div><h3 class="title">
1.294 rillig 2266: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.293 rillig 2267: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2268: <pre class="programlisting">
2269: GNU_CONFIGURE_STRICT= yes
2270: </pre>
2271: <p>When a package fails this additional check, the most common cause
2272: is that the configure option was valid for an older version of the
2273: package but does not apply anymore. In that case, just remove it.</p>
2274: </div>
2275: <div class="sect2">
2276: <div class="titlepage"><div><div><h3 class="title">
1.294 rillig 2277: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293 rillig 2278: <p>The job of a compiler is not restricted to producing executable
1.294 rillig 2279: code, most compilers also detect typical programming mistakes. The pkgsrc
2280: compiler wrappers make it easy to force compiler options when the package
2281: is built. This can be used to find typical bugs across all packages that
2282: are in pkgsrc. By reporting these bugs upstream, the packages will be
2283: more reliable with the next updates.</p>
2284: <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 2285: <pre class="programlisting">
2286: CFLAGS+= -Werror=char-subscripts
1.294 rillig 2287: CFLAGS+= -Werror=implicit-function-declaration
1.293 rillig 2288: </pre>
1.294 rillig 2289: <p>When a package fails to build using these stricter compiler
2290: options, document the circumstances in which the compiler produced the
2291: error message. This includes:</p>
1.293 rillig 2292: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2293: <li class="listitem"><p>The platform
2294: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2295: <li class="listitem"><p>The source file</p></li>
2296: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2297: part of the diagnostic.</p></li>
1.294 rillig 2298: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293 rillig 2299: </ul></div>
2300: <p>If a package produces these error messages, but the package is
1.294 rillig 2301: 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
2302: in the next builds:</p>
1.293 rillig 2303: <pre class="programlisting">
1.294 rillig 2304: .if ${PKGPATH} == category/package
1.293 rillig 2305: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2306: # error message
2307: # code
1.294 rillig 2308: # Reason why the code does not need to be fixed.
1.293 rillig 2309: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.294 rillig 2310: .endif
1.293 rillig 2311: </pre>
2312: <p>If the error messages from the compiler are valid and the code
1.294 rillig 2313: needs to be fixed, prepare a local patch (see
2314: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2315: authors of the package, providing them with the information you collected
2316: above.</p>
2317: <p>Patches that are not essential for the package to work should only
2318: be reported upstream but not committed to pkgsrc, to make future updates
2319: easier.</p>
1.293 rillig 2320: </div>
2321: <div class="sect2">
2322: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2323: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
2324: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2325: these apply to all phases of the package build process. Especially in the
2326: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2327: decisions. The GNU configure scripts feed many small test programs to the
2328: C compiler to see whether certain headers are available, functions are
2329: defined in a library and programs can be run. In many cases these
2330: programs would not survive a strict compiler run with <code class="literal">-Wall
2331: -Wextra -Werror</code>.</p>
2332: <p>The pkgsrc infrastructure is flexible enough to support compiler
2333: options being added between the <code class="literal">configure</code> and
2334: <code class="literal">build</code> phases. It's a little more complicated than the
2335: other examples in this section but still easy enough.</p>
2336: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2337: desired compiler options. The compiler wrapper's original task is to hide
2338: unwanted directories of include files and to normalize compiler options.
2339: It does this by wrapping the compiler command and rewriting the command
2340: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2341: package directory and examine the
2342: <code class="filename">work/.cwrappers/config</code> directory. It contains
2343: individual configurations for the C compiler and the related tools. The
2344: plan is to find a hook between the configure and build phases, and to
2345: modify these configuration files at that point.</p>
2346: <p>To find this hook, have a look at
2347: <code class="filename">mk/build/build.mk</code>, which contains among others the
2348: <code class="literal">pre-build-checks-hook</code>. The word
2349: <code class="literal">checks</code> doesn't quite fit, but the
2350: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2351: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2352: <pre class="programlisting">
2353: # Just a few example options.
2354: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2355:
2356: .if ${BUILD_ONLY_CFLAGS:U:M*}
2357: pre-build-checks-hook: add-build-only-cflags
2358:
2359: add-build-only-cflags: .PHONY
2360: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2361: ${TEST} ! -f ${.TARGET} || exit 0; \
2362: for flag in ${BUILD_ONLY_CFLAGS}; do \
2363: ${ECHO} "append=$$flag" >> cc; \
2364: done; \
2365: > ${.TARGET}
2366: .endif
2367: </pre>
2368: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2369: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2370: not with spaces.)</p>
2371: <p>The condition in the <code class="literal">.if</code> statement contains the
2372: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2373: should be undefined, possibly because it is only defined for a subset of
2374: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2375: at least one compiler option, to prevent a syntax error in the shell
2376: parser.</p>
2377: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2378: that the additional compiler options are only appended once, even if
2379: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2380: creates a marker file.</p>
2381: <p>To verify that this setup works, run <span class="command"><strong>bmake
2382: configure</strong></span> in a package directory. Up to now, everything works
2383: as usual. Examine the directory
2384: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2385: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2386: the file <code class="filename">cc</code>. Examine the tail of the
2387: <code class="filename">work/.work.log</code> file to see that the normal compiler
2388: options are used.</p>
2389: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2390: options to the file <code class="filename">cc</code> and will create the marker
2391: file in the same directory. After that, the build starts as usual, but
2392: with the added compiler options. Examine the tail of the file
2393: <code class="filename">work/.work.log</code> to see that the lines starting with
2394: <code class="literal">[*]</code> don't contain the compiler options, but the
2395: corresponding lines starting with <code class="literal"><.></code> do end
2396: with these options.</p>
2397: <p>Building packages using this setup variant and fixing the resulting
2398: 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>
2399: </div>
2400: <div class="sect2">
2401: <div class="titlepage"><div><div><h3 class="title">
2402: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.293 rillig 2403: <p>Some directories like <code class="varname">PREFIX</code>,
2404: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2405: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2406: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2407: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2408: <pre class="programlisting">
2409: PREFIX= /a-random-uuid
2410: PKG_SYSCONFDIR= /a-random-uuid
2411: VARBASE= /a-random-uuid
2412: PKGMANDIR= a-random-uuid
2413: PKG_INFODIR= a-random-uuid
2414: </pre>
2415: </div>
2416: <div class="sect2">
2417: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2418: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.293 rillig 2419: <p>When building a package, warnings are typically ignored since they
2420: just flow by and do not cause the build to fail immediately. To find
2421: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2422: <pre class="programlisting">
2423: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2424: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2425: </pre>
2426: <p>(There are many more classes of warnings in pkgsrc, and most of
2427: them can be redefined with a simple definition like above.</p>
1.294 rillig 2428: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293 rillig 2429: the package Makefile, research whether the package actually needs Perl.
2430: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2431: Makefile, and if it doesn't, add
2432: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2433: </div>
2434: <div class="sect2">
2435: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2436: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293 rillig 2437: <p>Using pkglint as part of the regular build process is mostly a
2438: waste of time. If you want to fix some of the warnings, just run pkglint
2439: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2440: 10), which is much faster than a complete bulk build.</p>
2441: </div>
2442: <div class="sect2">
2443: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2444: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293 rillig 2445: <p>To ensure that the binary packages don't contain references to the
2446: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2447: that variable includes the item <code class="literal">extra</code>, it is
2448: possible to define additional patterns that must not appear in any
2449: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2450: <pre class="programlisting">
2451: CHECK_WRKREF= extra
2452: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2453: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2454: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2455: </pre>
2456: <p>The above patterns will probably generate many false positives,
2457: therefore the results need to be taken with a grain of salt.</p>
2458: </div>
2459: <div class="sect2">
2460: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2461: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.293 rillig 2462: <p>To run the test suites that come with each package, add this line
2463: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2464: <pre class="programlisting">
2465: PKGSRC_RUN_TEST= yes
2466: </pre>
2467: <p>Be prepared that even the most basic packages fail this test. When
2468: doing a bulk build with this, it will often abort in the early phase
2469: where the packages are scanned for their dependencies since there are
2470: cyclic dependencies. There is still a lot to do in this area.</p>
2471: </div>
2472: <div class="sect2">
2473: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2474: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293 rillig 2475: <p>To catch typos in the shell snippets from the Makefile fragments,
2476: add the <code class="literal">-u</code> flag to most of the commands by adding this
2477: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2478: <pre class="programlisting">
2479: RUN= @set -eu;
2480: </pre>
1.296 rillig 2481: <p>After that, ensure that none of the bulk build log files (even
2482: those for successfully built packages) contains the string
2483: <code class="literal">parameter not set</code> or whatever error message the
2484: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293 rillig 2485: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2486: definition.</p>
2487: </div>
2488: <div class="sect2">
2489: <div class="titlepage"><div><div><h3 class="title">
1.296 rillig 2490: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.293 rillig 2491: <p>The build logs of a package are often quite long. This allows error
2492: messages or other interesting details to hide between the noise. To make
2493: the actual error message stand out more, add these lines to
2494: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2495: <pre class="programlisting">
2496: GNU_CONFIGURE_QUIET= yes
2497: MAKE_FLAGS+= -s
2498: </pre>
2499: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2500: Make. On exotic platforms with their own make, it may be a little
2501: different.</p>
2502: </div>
2503: </div>
2504: <div class="sect1">
2505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2506: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2507: <p>After your pkgsrc bulk-build has completed, you may wish to
2508: create a CD-ROM set of the resulting binary packages to assist
2509: in installing packages on other machines. The
1.322 leot 2510: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/index.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87 wiz 2511: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2512: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2513: way that keeps all the dependencies for a given package on the same
2514: CD as that package.</p>
1.148 asau 2515: <div class="sect2">
1.75 rillig 2516: <div class="titlepage"><div><div><h3 class="title">
1.293 rillig 2517: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2518: <p>Complete documentation for cdpack is found in the cdpack(1)
2519: man page. The following short example assumes that the binary
2520: packages are left in
2521: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2522: sufficient disk space exists in <code class="filename">/u2</code> to
2523: hold the ISO 9660 images.</p>
2524: <pre class="screen">
2525: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2526: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2527: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2528: </pre>
2529: <p>If you wish to include a common set of files
2530: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2531: etc.) on each CD in the collection, then you need to create a
1.290 gutterid 2532: directory which contains these files, e.g.:</p>
1.87 wiz 2533: <pre class="screen">
2534: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2535: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2536: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2537: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2538: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2539: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2540: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2541: </pre>
1.75 rillig 2542: <p>Now create the images:</p>
2543: <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 2544: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2545: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2546: in their root directories.</p>
1.75 rillig 2547: </div>
2548: </div>
2549: </div>
1.148 asau 2550: <div class="chapter">
1.75 rillig 2551: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2552: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2553: <div class="toc">
2554: <p><b>Table of Contents</b></p>
1.210 leot 2555: <dl class="toc">
1.267 rillig 2556: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2557: <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 2558: </dl>
2559: </div>
2560: <p>The files that are installed by pkgsrc are organized in a way that
2561: is similar to what you find in the <code class="filename">/usr</code> directory
2562: of the base system. But some details are different. This is because
2563: pkgsrc initially came from FreeBSD and had adopted its file system
2564: hierarchy. Later it was largely influenced by NetBSD. But no matter
2565: which operating system you are using pkgsrc with, you can expect the
2566: same layout for pkgsrc.</p>
1.91 rillig 2567: <p>There are mainly four root directories for pkgsrc, which are all
2568: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2569: When pkgsrc has been installed as root, the default locations
2570: are:</p>
2571: <pre class="programlisting">
1.100 rillig 2572: LOCALBASE= /usr/pkg
2573: PKG_SYSCONFBASE= /usr/pkg/etc
2574: VARBASE= /var
1.231 sevan 2575: PKG_DBDIR= /usr/pkg/pkgdb
1.91 rillig 2576: </pre>
2577: <p>In unprivileged mode (when pkgsrc has been installed as any other
2578: user), the default locations are:</p>
2579: <pre class="programlisting">
1.100 rillig 2580: LOCALBASE= ${HOME}/pkg
2581: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2582: VARBASE= ${HOME}/pkg/var
1.231 sevan 2583: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.91 rillig 2584: </pre>
2585: <p>What these four directories are for, and what they look like is
2586: explained below.</p>
1.148 asau 2587: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2588: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2589: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2590: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 2591: the well-known subdirectories like <code class="filename">bin</code>,
2592: <code class="filename">include</code>, <code class="filename">lib</code>,
2593: <code class="filename">share</code> and
2594: <code class="filename">sbin</code>.</p></li>
1.128 wiz 2595: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 2596: <code class="filename">/var</code> in the base system. Some programs (especially
2597: games, network daemons) need write access to it during normal
2598: operation.</p></li>
1.128 wiz 2599: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2600: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 2601: 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 2602: itself.</p></li>
2603: </ul></div>
1.148 asau 2604: <div class="sect1">
1.90 rillig 2605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2606: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2607: </h2></div></div></div>
1.90 rillig 2608: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2609: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2610: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2611: <dt><span class="term"><code class="filename">bin</code></span></dt>
2612: <dd><p>Contains executable programs that are intended to be
2613: directly used by the end user.</p></dd>
2614: <dt><span class="term"><code class="filename">emul</code></span></dt>
2615: <dd><p>Contains files for the emulation layers of various other
2616: operating systems, especially for
2617: NetBSD.</p></dd>
2618: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2619: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2620: <dd><p>Contains
2621: the configuration files.</p></dd>
2622: <dt><span class="term"><code class="filename">include</code></span></dt>
2623: <dd><p>Contains headers for the C and C++ programming
2624: languages.</p></dd>
2625: <dt><span class="term"><code class="filename">info</code></span></dt>
2626: <dd><p>Contains GNU info files of various
2627: packages.</p></dd>
2628: <dt><span class="term"><code class="filename">lib</code></span></dt>
2629: <dd><p>Contains shared and static
2630: libraries.</p></dd>
2631: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2632: <dd><p>Contains data files that don't change after
2633: installation. Other data files belong into
2634: <code class="filename">${VARBASE}</code>.</p></dd>
2635: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2636: <dd><p>Contains programs that are not intended to be used by
2637: end users, such as helper programs or network
2638: daemons.</p></dd>
2639: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2640: <dd><p>Contains programs that are intended to be executed as
2641: CGI scripts by a web server.</p></dd>
2642: <dt><span class="term"><code class="filename">man</code> (the usual value of
2643: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2644: <dd><p>Contains brief
2645: documentation in form of manual pages.</p></dd>
2646: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2647: <dd><p>Contains programs that are intended to be used only by
2648: the super-user.</p></dd>
2649: <dt><span class="term"><code class="filename">share</code></span></dt>
2650: <dd><p>Contains platform-independent data files that don't
2651: change after installation.</p></dd>
2652: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2653: <dd><p>Contains documentation files provided by the
2654: packages.</p></dd>
2655: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2656: <dd><p>Contains example files provided by the packages. Among
2657: others, the original configuration files are saved here and copied to
2658: <code class="filename">${PKG_SYSCONFDIR}</code> during
2659: installation.</p></dd>
2660: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2661: <dd><p>Contains the original files for rc.d
2662: scripts.</p></dd>
2663: <dt><span class="term"><code class="filename">var</code> (the usual location of
2664: <code class="filename">${VARBASE}</code>)</span></dt>
2665: <dd><p>Contains files
2666: that may be modified after
2667: installation.</p></dd>
2668: </dl></div>
2669: </div>
1.148 asau 2670: <div class="sect1">
1.90 rillig 2671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2672: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2673: </h2></div></div></div>
1.148 asau 2674: <div class="variablelist"><dl class="variablelist">
1.90 rillig 2675: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2676: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2677: <dd><p>Contains
2678: information about the currently installed
2679: packages.</p></dd>
2680: <dt><span class="term"><code class="filename">games</code></span></dt>
2681: <dd><p>Contains highscore
2682: files.</p></dd>
2683: <dt><span class="term"><code class="filename">log</code></span></dt>
2684: <dd><p>Contains log files.</p></dd>
2685: <dt><span class="term"><code class="filename">run</code></span></dt>
2686: <dd><p>Contains informational files about daemons that are
2687: currently running.</p></dd>
2688: </dl></div>
2689: </div>
2690: </div>
1.148 asau 2691: <div class="chapter">
1.90 rillig 2692: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2693: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2694: <div class="toc">
2695: <p><b>Table of Contents</b></p>
1.210 leot 2696: <dl class="toc">
1.267 rillig 2697: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2698: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2699: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2700: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2701: <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>
2702: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2703: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2704: <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>
2705: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2706: <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 2707: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 rillig 2708: <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>
2709: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
2710: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2711: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2712: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2713: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2714: <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 2715: </dl>
2716: </div>
2717: <p>This section contains hints, tips & tricks on special things in
2718: pkgsrc that we didn't find a better place for in the previous chapters, and
2719: it contains items for both pkgsrc users and developers.</p>
1.148 asau 2720: <div class="sect1">
1.75 rillig 2721: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2722: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2723: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2724: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2725: <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 2726: This is a general purpose list for most issues regarding
2727: pkgsrc, regardless of platform, e.g. soliciting user help
2728: for pkgsrc configuration, unexpected build failures, using
2729: particular packages, upgrading pkgsrc installations,
2730: questions regarding the pkgsrc release branches, etc. General announcements or
2731: proposals for changes that impact the pkgsrc user community,
2732: e.g. major infrastructure changes, new features, package
2733: removals, etc., may also be posted.</p></li>
1.289 leot 2734: <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 2735: A list where the results of pkgsrc bulk builds are sent and
2736: discussed.</p></li>
1.289 leot 2737: <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 2738: This list is for those who are interested in getting a
2739: commit message for every change committed to pkgsrc. It is
2740: also available in digest form, meaning one daily message
2741: containing all commit messages for changes to the package
2742: source tree in that 24 hour period.</p></li>
2743: </ul></div>
2744: <p>To subscribe, do:</p>
2745: <pre class="programlisting">
1.100 rillig 2746: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2747: </pre>
2748: <p>Archives for all these mailing lists are available from
1.289 leot 2749: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2750: </div>
1.148 asau 2751: <div class="sect1">
1.75 rillig 2752: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2753: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2754: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2755: a number of useful utilities for both users and developers of pkgsrc. This
1.233 sevan 2756: section attempts only to make the reader aware of some of the utilities and when
1.75 rillig 2757: they might be useful, and not to duplicate the documentation that comes
2758: with each package.</p>
2759: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.322 leot 2760: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/index.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75 rillig 2761: Symlinks for use by buildlink.</p></li></ul></div>
2762: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2763: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2764: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/index.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233 sevan 2765: Calculates various kinds of checksums (including SHA3).</p></li>
1.322 leot 2766: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/index.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75 rillig 2767: Compatibility library for pkgsrc tools.</p></li>
1.322 leot 2768: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/index.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87 wiz 2769: non-BSD systems due to lack of native mtree.</p></li>
1.322 leot 2770: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75 rillig 2771: Up-to-date replacement for
1.76 rillig 2772: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2773: systems where pkg_install is not present.</p></li>
2774: </ul></div>
2775: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2777: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75 rillig 2778: Create a binary package from an
1.110 hubertf 2779: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2780: save the old package.</p></li>
1.322 leot 2781: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/index.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75 rillig 2782: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2783: from multiple locations. It currently supports the following
2784: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.322 leot 2785: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117 jnemeth 2786: the best compiler flags to optimise code for your current
1.128 wiz 2787: CPU and compiler. </p></li>
1.75 rillig 2788: </ul></div>
2789: <p>Utilities for keeping track of installed packages, being up to date,
2790: etc:</p>
1.148 asau 2791: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2792: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/index.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173 wiz 2793: update tool similar to apt(1). Download, install, and upgrade
2794: binary packages easily.</p></li>
1.322 leot 2795: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75 rillig 2796: packages whose installed versions do not match the latest pkgsrc
2797: entries.</p></li>
1.322 leot 2798: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75 rillig 2799: dependency graphs of packages, to aid in choosing a strategy for
2800: updating.</p></li>
1.322 leot 2801: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/index.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
2802: graphs from the output of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
2803: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112 weinem 2804: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.322 leot 2805: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75 rillig 2806: does various checks on the complete pkgsrc system.</p></li>
1.322 leot 2807: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/index.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75 rillig 2808: packages you have installed.</p></li>
2809: </ul></div>
2810: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2811: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2812: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75 rillig 2813: making and maintaining patches for a package (includes pkgdiff,
2814: pkgvi, mkpatches, etc.).</p></li>
1.322 leot 2815: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/index.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75 rillig 2816: converting to pkgsrc.</p></li>
2817: </ul></div>
2818: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2819: utilities)</p>
1.148 asau 2820: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 2821: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/index.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75 rillig 2822: packages in a chrooted area.</p></li>
1.322 leot 2823: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/index.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75 rillig 2824: kernel version for chrooted cross builds.</p></li>
2825: </ul></div>
2826: </div>
1.148 asau 2827: <div class="sect1">
1.75 rillig 2828: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2829: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219 rillig 2830: <p>To install packages from source as a non-root user, download
1.267 rillig 2831: 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 2832: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2833: --unprivileged</strong></span>.</p>
2834: <p>This will install the binary part of pkgsrc to
2835: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2836: into <code class="filename">~/pkg/etc</code>.</p>
2837: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75 rillig 2838: </div>
1.148 asau 2839: <div class="sect1">
1.75 rillig 2840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2841: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 2842: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2843: enable this feature by adding the option
2844: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 2845: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 2846: distfile is found, pkgsrc will try to resume it.</p>
2847: <p>You can also
1.168 wiz 2848: use a different program than the platform default program by changing the
1.117 jnemeth 2849: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2850: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2851: by using the value manual. A value of custom disables the system defaults
2852: and dependency tracking for the fetch program. In that case you have to
2853: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2854: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2855: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75 rillig 2856: <p>For example, if you want to use
1.117 jnemeth 2857: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 2858: like:</p>
2859: <pre class="programlisting">
1.223 rillig 2860: FETCH_USING= wget
1.1 grant 2861: </pre>
1.75 rillig 2862: </div>
1.148 asau 2863: <div class="sect1">
1.75 rillig 2864: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2865: <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 2866: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 2867: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 2868: you will have to add the following line into
1.110 hubertf 2869: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 2870: <pre class="programlisting">
1.103 wiz 2871: X11_TYPE=modular
1.1 grant 2872: </pre>
1.75 rillig 2873: </div>
1.148 asau 2874: <div class="sect1">
1.75 rillig 2875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2876: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 2877: <p>If you are sitting behind a firewall which does not allow direct
2878: connections to Internet hosts (i.e. non-NAT), you may specify the
2879: relevant proxy hosts. This is done using an environment variable in the
2880: form of a URL, e.g. in Amdahl, the machine
1.128 wiz 2881: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 2882: port 80 as the proxy port number. So the proxy environment variables
2883: are:</p>
2884: <pre class="programlisting">
1.100 rillig 2885: ftp_proxy=ftp://orpheus.amdahl.com:80/
2886: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 2887: </pre>
1.75 rillig 2888: </div>
1.148 asau 2889: <div class="sect1">
1.75 rillig 2890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2891: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 wiz 2892: <p>Some fetch tools are not prepared to support HTTPS by default
2893: (for example, the one in NetBSD 6.0), or the one installed by the
2894: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2895: dependency graph).</p>
2896: <p>Usually you won't notice, because distribution files are
2897: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2898: be often enough if you are following pkgsrc-current. In that case, set
2899: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2900: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2901: with HTTPS support by default. Of course, these tools need to be
2902: installed before you can use them this way.</p>
2903: </div>
2904: <div class="sect1">
2905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2906: <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 2907: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 2908: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 2909: the first available command from the following list:</p>
1.148 asau 2910: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2911: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2912: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 2913: </ul></div>
2914: <p>On a default NetBSD installation, this will be
1.76 rillig 2915: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 2916: connections first, and falls back to active connections if the server
2917: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 2918: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 2919: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2920: <p>Having that option present will prevent
1.76 rillig 2921: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 2922: transfers.</p>
2923: </div>
1.148 asau 2924: <div class="sect1">
1.75 rillig 2925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2926: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 2927: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 2928: from work or university, where you can't run a <span class="command"><strong>make
1.132 spz 2929: 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 2930: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 2931: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 2932: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 2933: resulting list to your machine at work/school and use it there. If you
1.322 leot 2934: don't have a NetBSD-compatible <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75 rillig 2935: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2936: URL:</p>
2937: <p>At home:</p>
2938: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2939: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2940: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2941: <p>At work:</p>
2942: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 2943: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 2944: home.</p>
2945: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 2946: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2947: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 2948: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 2949: directly by running:</p>
1.75 rillig 2950: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2951: <p>If you even decide to ignore
2952: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2953: by running:</p>
2954: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2955: </div>
1.148 asau 2956: <div class="sect1">
1.75 rillig 2957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2958: <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 2959: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.322 leot 2960: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75 rillig 2961: package, you get the error from make that it doesn't know how to make
1.76 rillig 2962: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 2963: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 2964: the NetBSD base distribution on your machine. It is recommended to do
2965: that to format man pages.</p>
1.322 leot 2966: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75 rillig 2967: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 2968: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 2969: </div>
1.148 asau 2970: <div class="sect1">
1.75 rillig 2971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2972: <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 2973: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 2974: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 2975: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 2976: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2977: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 2978: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 2979: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 2980: -r</strong></span>).</p>
2981: </div>
1.148 asau 2982: <div class="sect1">
1.75 rillig 2983: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2984: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 2985: <p>When installing packages as non-root user and using the just-in-time
1.322 leot 2986: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75 rillig 2987: password for each required package installed. To avoid this, the sudo
2988: package can be used, which does password caching over a limited time. To
2989: use it, install sudo (either as binary package or from
1.322 leot 2990: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/index.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110 hubertf 2991: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 2992: <span class="emphasis"><em>after</em></span> the definition of the
2993: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 2994: <pre class="programlisting">
1.100 rillig 2995: .if exists(${LOCALBASE}/bin/sudo)
2996: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2997: .endif
1.1 grant 2998: </pre>
1.75 rillig 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="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3003: <p>As the system administrator, you can choose where configuration files
3004: are installed. The default settings make all these files go into
1.76 rillig 3005: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3006: be suboptimal depending on your expectations (e.g., a read-only,
3007: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3008: configuration of the provided packages).</p>
3009: <p>In order to change the defaults, you can modify the
3010: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3011: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3012: directory; some common examples include <code class="filename">/etc</code> or
3013: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3014: <p>Furthermore, you can change this value on a per-package basis by
3015: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3016: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3017: package you would like to modify, that is, the contents of
3018: <code class="varname">PKGBASE</code>.</p>
3019: <p>Note that after changing these settings, you must rebuild and
3020: reinstall any affected packages.</p>
3021: </div>
1.148 asau 3022: <div class="sect1">
1.75 rillig 3023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3024: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75 rillig 3025: <p>Please be aware that there can often be bugs in third-party software,
3026: and some of these bugs can leave a machine vulnerable to exploitation by
3027: attackers. In an effort to lessen the exposure, the NetBSD packages team
3028: maintains a database of known-exploits to packages which have at one time
3029: been included in pkgsrc. The database can be downloaded automatically, and
3030: a security audit of all packages installed on a system can take place. To
1.114 jmcneill 3031: do this, refer to the following two tools (installed as part of the
1.322 leot 3032: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128 wiz 3033: <div class="orderedlist"><ol class="orderedlist" type="1">
3034: <li class="listitem">
1.122 reed 3035: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 3036: download a list of the security vulnerabilities information. This list
1.132 spz 3037: is kept up to date by the pkgsrc security team, and is distributed
3038: from the NetBSD ftp server:</p>
1.292 leot 3039: <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 3040: </li>
1.128 wiz 3041: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3042: current machine, checking each known vulnerability. If a
1.75 rillig 3043: vulnerable package is installed, it will be shown by output to stdout,
3044: including a description of the type of vulnerability, and a URL
3045: containing more information.</p></li>
3046: </ol></div>
1.233 sevan 3047: <p>Use of these tools is strongly recommended!
1.317 nia 3048: 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 3049: reporting.</p>
3050: <p>If this database is installed, pkgsrc builds will use it to
3051: perform a security check before building any package.</p>
1.75 rillig 3052: </div>
1.148 asau 3053: <div class="sect1">
1.75 rillig 3054: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3055: <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 3056: <p>When you add your own preferences to the
3057: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3058: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3059: environment variables to the <code class="filename">./configure</code>
1.322 leot 3060: scripts and to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75 rillig 3061: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3062: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3063: package.</p>
3064: <p>Currently there is no solution to this problem. If you
3065: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3066: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3067: directory and then inspect any <code class="filename">Makefile</code> and
3068: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3069: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 3070: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 3071: programmers write so bad code that it only works for the
3072: specific combination of <code class="varname">CFLAGS</code> they have
3073: chosen.</p>
1.287 rillig 3074: <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>
3075: <pre class="programlisting">
3076: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3077: CFLAGS+= -Dpkgsrc___CFLAGS
3078: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3079: </pre>
3080: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3081: to see whether the above flags are passed to the actual build
3082: commands in general.</p>
3083: <p>To find out whether the flags are passed to individual compiler
3084: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3085: most cases, the flags from the original command lines (the lines starting
3086: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3087: (the lines starting with <code class="literal"><.></code>). If the flag is
3088: missing from the actual compiler command, it must have been removed by
1.299 rillig 3089: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75 rillig 3090: </div>
1.148 asau 3091: <div class="sect1">
1.80 rillig 3092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3093: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 3094: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 3095: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 3096: case that occurs often is that people only update pkgsrc in
3097: parts, because of performance reasons. Since pkgsrc is one large
3098: system, not a collection of many small systems, there are
3099: sometimes changes that only work when the whole pkgsrc tree is
3100: updated.</p></li>
1.148 asau 3101: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 wiz 3102: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3103: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.80 rillig 3104: files.</p></li>
1.148 asau 3105: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3106: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3107: verify this.</p></li>
1.218 rillig 3108: <li class="step"><p>If you are a package developer who wants to invest
1.267 rillig 3109: 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 3110: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 3111: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3112: </ol></div>
3113: </div>
1.148 asau 3114: <div class="sect1">
1.88 wiz 3115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3116: <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 3117: <p>You have modified a file from pkgsrc, and someone else has
3118: modified that same file afterwards in the CVS repository. Both changes
3119: are in the same region of the file, so when you updated pkgsrc, the
3120: <code class="literal">cvs</code> command marked the conflicting changes in the
3121: file. Because of these markers, the file is no longer a valid
3122: <code class="filename">Makefile</code>.</p>
3123: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3124: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3125: -dP</strong></span> in that directory to download the current version.</p>
3126: </div>
1.75 rillig 3127: </div>
3128: </div>
1.148 asau 3129: <div class="part">
1.75 rillig 3130: <div class="titlepage"><div><div><h1 class="title">
3131: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148 asau 3132: <div class="partintro">
1.77 rillig 3133: <div></div>
3134: <p>This part of the book deals with creating and
1.128 wiz 3135: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 3136: guide on creating a new package. The remaining chapters are more
3137: like a reference manual for pkgsrc.</p>
1.75 rillig 3138: <div class="toc">
3139: <p><b>Table of Contents</b></p>
1.210 leot 3140: <dl class="toc">
1.267 rillig 3141: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299 rillig 3142: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91 rillig 3143: <dd><dl>
1.299 rillig 3144: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3145: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3146: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91 rillig 3147: <dd><dl>
1.299 rillig 3148: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3149: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3150: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3151: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3152: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91 rillig 3153: </dl></dd>
1.299 rillig 3154: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3155: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3156: <dd><dl>
3157: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3158: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3159: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3160: </dl></dd>
3161: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3162: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106 rillig 3163: </dl></dd>
1.299 rillig 3164: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106 rillig 3165: <dd><dl>
1.299 rillig 3166: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3167: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3168: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3169: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3170: <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 3171: <dd><dl>
1.299 rillig 3172: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3173: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106 rillig 3174: </dl></dd>
1.299 rillig 3175: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3176: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3177: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3178: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3179: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3180: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3181: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3182: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3183: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3184: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3185: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3186: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3187: </dl></dd>
3188: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3189: <dd><dl>
3190: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106 rillig 3191: <dd><dl>
1.299 rillig 3192: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
3193: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
3194: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
3195: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
1.106 rillig 3196: </dl></dd>
1.299 rillig 3197: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3198: <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 3199: </dl></dd>
1.299 rillig 3200: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 3201: <dd><dl>
1.299 rillig 3202: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3203: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3204: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3205: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106 rillig 3206: <dd><dl>
1.299 rillig 3207: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3208: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3209: <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>
3210: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106 rillig 3211: </dl></dd>
3212: </dl></dd>
1.299 rillig 3213: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106 rillig 3214: <dd><dl>
1.299 rillig 3215: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3216: <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>
3217: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3218: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3219: </dl></dd>
1.299 rillig 3220: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106 rillig 3221: <dd><dl>
1.299 rillig 3222: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3223: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3224: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3225: </dl></dd>
3226: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3227: <dd><dl>
3228: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3229: <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 3230: <dd><dl>
1.299 rillig 3231: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3232: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133 wiz 3233: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3234: and
3235: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3236: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106 rillig 3237: </dl></dd>
1.299 rillig 3238: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3239: <dd><dl>
3240: <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>
3241: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3242: </dl></dd>
3243: </dl></dd>
3244: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106 rillig 3245: <dd><dl>
1.299 rillig 3246: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3247: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3248: <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>
3249: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3250: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3251: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3252: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3253: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3254: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106 rillig 3255: </dl></dd>
1.299 rillig 3256: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3257: <dd><dl>
3258: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3259: <dd><dl>
3260: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3261: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106 rillig 3262: </dl></dd>
1.299 rillig 3263: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106 rillig 3264: <dd><dl>
1.299 rillig 3265: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3266: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
3267: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
3268: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
3269: </dl></dd>
3270: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3271: <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>
3272: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3273: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3274: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3275: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3276: <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 3277: </dl></dd>
3278: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3279: <dd><dl>
3280: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3281: <dd><dl>
3282: <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>
3283: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3284: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3285: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3286: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3287: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3288: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3289: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3290: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3291: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3292: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3293: </dl></dd>
3294: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3295: <dd><dl>
3296: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3297: <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>
3298: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3299: </dl></dd>
3300: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3301: <dd><dl>
3302: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3303: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3304: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
3305: </dl></dd>
3306: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3307: <dd><dl>
3308: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3309: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 3310: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
3311: <dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
3312: <dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
3313: <dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
1.267 rillig 3314: </dl></dd>
3315: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3316: <dd><dl>
3317: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3318: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 3319: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3320: <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>
3321: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 3322: </dl></dd>
3323: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3324: <dd><dl>
3325: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3326: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3327: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3328: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3329: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 3330: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 3331: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
3332: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 3333: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
3334: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
3335: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
3336: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
3337: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
3338: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
3339: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 3340: emulation</a></span></dt>
1.318 nia 3341: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
3342: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.77 rillig 3343: </dl></dd>
1.267 rillig 3344: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3345: </dl></dd>
1.299 rillig 3346: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3347: <dd><dl>
3348: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3349: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3350: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3351: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3352: </dl></dd>
1.267 rillig 3353: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77 rillig 3354: <dd><dl>
1.267 rillig 3355: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3356: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3357: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3358: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3359: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3360: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3361: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3362: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3363: </dl></dd>
3364: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75 rillig 3365: </dl>
3366: </div>
1.77 rillig 3367: </div>
1.148 asau 3368: <div class="chapter">
1.77 rillig 3369: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 3370: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3371: <p>
3372: To get help when developing pkgsrc, the definitive source is this
3373: document, the pkgsrc guide. If you don't find anything here,
3374: there are alternatives:
3375: </p>
3376: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3377: <li class="listitem">
3378: <p>
3379: The built-in pkgsrc help, which is available after bootstrapping
3380: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3381: help for any topic, such as a variable name like
3382: <code class="varname">BUILD_DEFS</code>, a make target like
3383: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3384: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.322 leot 3385: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.267 rillig 3386: </li>
3387: <li class="listitem"><p>
1.278 rillig 3388: To see the value of a single variable, run <span class="command"><strong>bmake
3389: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3390: </p></li>
3391: <li class="listitem"><p>
3392: To see the values of the most common variables, run
3393: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3394: topic. To see the variables for a single topic, run
3395: <span class="command"><strong>bmake
3396: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3397: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3398: </p></li>
3399: <li class="listitem"><p>
1.267 rillig 3400: The tech-pkg mailing list, to which
3401: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3402: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3403: questions</a>.</p></li>
3404: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3405: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3406: or by using a specialized chat program such as
3407: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3408: Pick any user name and join the channel #pkgsrc.</p></li>
3409: </ul></div>
3410: </div>
3411: <div class="chapter">
3412: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 3413: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91 rillig 3414: <div class="toc">
3415: <p><b>Table of Contents</b></p>
1.210 leot 3416: <dl class="toc">
1.299 rillig 3417: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3418: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3419: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3420: <dd><dl>
3421: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3422: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3423: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3424: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3425: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3426: </dl></dd>
3427: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3428: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3429: <dd><dl>
3430: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3431: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3432: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91 rillig 3433: </dl></dd>
1.299 rillig 3434: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3435: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91 rillig 3436: </dl>
3437: </div>
1.299 rillig 3438: <p>Whenever you're preparing a package, there are a number of
3439: files involved which are described in the following
3440: sections.</p>
3441: <div class="sect1">
3442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3443: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3444: </h2></div></div></div>
3445: <p>Building, installation and creation of a binary package are all
3446: controlled by the package's <code class="filename">Makefile</code>.
3447: The <code class="filename">Makefile</code> describes various things about
3448: a package, for example from where to get it, how to configure,
3449: build, and install it.</p>
3450: <p>A package <code class="filename">Makefile</code> contains several
3451: sections that describe the package.</p>
3452: <p>In the first section there are the following variables, which
3453: should appear exactly in the order given here. The order and
3454: grouping of the variables is mostly historical and has no further
3455: meaning.</p>
3456: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3457: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3458: distribution file to be downloaded from the package's
3459: website.</p></li>
3460: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3461: package, as used by pkgsrc. You need to provide it if
3462: <code class="varname">DISTNAME</code> (which is the default) is not a good
3463: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3464: provided (no distribution file is required). Usually it is the pkgsrc
3465: directory name together with the version number. It must match the
3466: regular expression
3467: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3468: starts with a letter or digit, and contains only letters, digits,
1.319 nia 3469: dashes, underscores, dots and plus signs.
3470: New packages should have entirely lower-case names, with the exception
3471: of some that must follow pre-existing conventions
3472: (e.g. R packages begin with <code class="varname">R-</code>).
3473: You can use the <code class="code">:tl</code> variable modifier to lower-case
3474: the package name.</p></li>
1.299 rillig 3475: <li class="listitem">
3476: <p><code class="varname">CATEGORIES</code> is a list of categories
3477: which the package fits in. You can choose any of the top-level
3478: directories of pkgsrc for it.</p>
3479: <p>Currently the following values are available for
3480: <code class="varname">CATEGORIES</code>. If more than
3481: one is used, they need to be separated by spaces:</p>
1.77 rillig 3482: <pre class="programlisting">
1.299 rillig 3483: archivers cross geography meta-pkgs security
3484: audio databases graphics misc shells
3485: benchmarks devel ham multimedia sysutils
3486: biology editors inputmethod net textproc
3487: cad emulators lang news time
3488: chat finance mail parallel wm
3489: comms fonts math pkgtools www
3490: converters games mbone print x11
1.77 rillig 3491: </pre>
3492: </li>
1.299 rillig 3493: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3494: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3495: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3496: and <code class="varname">DISTFILES</code> are discussed in detail in
3497: <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>
3498: </ul></div>
3499: <p>The second section contains information about separately
3500: downloaded patches, if any.
3501: </p>
3502: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3503: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3504: Name(s) of additional files that contain distribution patches.
3505: There is no default. pkgsrc will look for them at
3506: <code class="varname">PATCH_SITES</code>.
3507: They will automatically be uncompressed before patching if
3508: the names end with <code class="filename">.gz</code> or
3509: <code class="filename">.Z</code>.</p></li>
3510: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3511: Primary location(s) for distribution patch files (see
3512: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3513: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.322 leot 3514: an argument to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.299 rillig 3515: help find the correct files to patch. It defaults to
3516: <span class="command"><strong>-p0</strong></span>.</p></li>
3517: </ul></div>
3518: <p>The third section contains the following variables.
3519: </p>
3520: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3521: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
3522: address of the person who feels responsible for this package,
3523: and who is most likely to look at problems or questions regarding
1.322 leot 3524: this package which have been reported with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.299 rillig 3525: Other developers may contact the <code class="varname">MAINTAINER</code>
3526: before making changes to the package, but are not required to
3527: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3528: to yourself. If you really can't maintain the package for future
3529: updates, set it to
3530: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
3531: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
3532: of <code class="varname">MAINTAINER</code> when you do not want other
3533: developers to update or change the package without contacting
3534: you first. A package Makefile should contain one of
3535: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3536: not both. </p></li>
3537: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3538: find more information about the package.</p></li>
3539: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3540: description of the package (should not include the package
3541: name).</p></li>
3542: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3543: 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>
3544: </ul></div>
3545: <p>Other variables that affect the build:
3546: </p>
3547: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3548: <p><code class="varname">WRKSRC</code>: The directory where the
3549: interesting distribution files of the package are found. The
3550: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3551: works for most packages.</p>
3552: <p>If a package doesn't create a subdirectory for itself
3553: (most GNU software does, for instance), but extracts itself in
3554: the current directory, you should set
3555: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3556: <p>If a package doesn't create a subdirectory with the
3557: name of <code class="varname">DISTNAME</code> but some different name,
3558: set <code class="varname">WRKSRC</code> to point to the proper name in
3559: <code class="filename">${WRKDIR}</code>, for example
3560: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.322 leot 3561: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/index.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/index.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.299 rillig 3562: <p>The name of the working directory created by pkgsrc is
3563: taken from the <code class="varname">WRKDIR_BASENAME</code>
3564: variable. By default, its value is
3565: <code class="filename">work</code>. If you want to use the same
3566: pkgsrc tree for building different kinds of binary packages,
3567: you can change the variable according to your needs. Two
3568: other variables handle common cases of setting
3569: <code class="varname">WRKDIR_BASENAME</code> individually. If
3570: <code class="varname">OBJHOSTNAME</code> is defined in
3571: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3572: the host's name is attached to the directory name. If
3573: <code class="varname">OBJMACHINE</code> is defined, the platform name
3574: is attached, which might look like
3575: <code class="filename">work.i386</code> or
3576: <code class="filename">work.sparc</code>.</p>
3577: </li></ul></div>
3578: <p>Please pay attention to the following gotchas:</p>
3579: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3580: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3581: installed in compressed form by the package. For packages using
3582: BSD-style makefiles which honor MANZ, there is
3583: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3584: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3585: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3586: below).</p></li>
3587: <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>
3588: </ul></div>
3589: </div>
1.148 asau 3590: <div class="sect1">
1.91 rillig 3591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 3592: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3593: </h2></div></div></div>
3594: <p>The <code class="filename">distinfo</code> file contains the message
3595: digest, or checksum, of each distfile needed for the package. This
3596: ensures that the distfiles retrieved from the Internet have not been
3597: corrupted during transfer or altered by a malign force to introduce
3598: a security hole. To provide maximum security, all distfiles are
3599: protected using three different message digest algorithms (SHA1,
3600: RMD160, SHA512), as well as the file size.</p>
3601: <p>The <code class="filename">distinfo</code> file also contains the
3602: checksums for all the patches found in the
3603: <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
3604: are only applied intentionally and that they don't accidentally change,
3605: e.g. when merging different changes together. They also make sure that
3606: new patches are actually added to CVS and old ones are removed.
3607: Too see whether the patches and the <code class="filename">distinfo</code> file
3608: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3609: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3610: <span class="command"><strong>make distinfo</strong></span> command.</p>
3611: <p>Some packages have different sets of distfiles depending on
1.322 leot 3612: the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk8/index.html" target="_top"><code class="filename">lang/openjdk8</code></a>. These are kept in the same
1.299 rillig 3613: <code class="filename">distinfo</code> file and care should be taken when
3614: upgrading such a package to ensure distfile information is not
3615: lost.</p>
3616: </div>
3617: <div class="sect1">
3618: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3619: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3620: </h2></div></div></div>
3621: <p>Some packages don't work out-of-the box on the various
3622: platforms that are supported by pkgsrc. These packages need
3623: to be patched to make them work. The patch files can be
3624: found in the <code class="filename">patches/</code> directory.</p>
3625: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3626: applied to the files in <code class="varname">WRKSRC</code> directory after
3627: extracting them, in alphabetic order.</p>
1.148 asau 3628: <div class="sect2">
1.91 rillig 3629: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3630: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3631: <p>The <code class="filename">patch-*</code> files should be in
3632: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3633: problems. (To force patches to apply with fuzz you can set
3634: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3635: should contain only changes for a single file, and no file should be
3636: patched by more than one patch file. This helps to keep future
3637: modifications simple.</p>
3638: <p>Each patch file is structured as follows: In the first line,
3639: there is the RCS Id of the patch itself. The second line should be
3640: empty for aesthetic reasons. After that, there should be a comment for
3641: each change that the patch does. There are a number of standard
3642: cases:</p>
3643: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3644: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3645: mention the vulnerability ID (CAN, CVE).</p></li>
3646: <li class="listitem"><p>Patches that change source code should mention the
3647: platform and other environment (for example, the compiler) that the
3648: patch is needed for.</p></li>
3649: </ul></div>
3650: <p>The patch should be commented so that any
3651: developer who knows the code of the application can make some use of
3652: the patch. Special care should be taken for the upstream developers,
3653: since we generally want that they accept our patches, so we have less
3654: work in the future.</p>
1.91 rillig 3655: </div>
1.148 asau 3656: <div class="sect2">
1.91 rillig 3657: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3658: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3659: <p>One important thing to mention is to pay attention that no RCS
3660: IDs get stored in the patch files, as these will cause problems when
3661: later checked into the NetBSD CVS tree. Use the
1.322 leot 3662: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.299 rillig 3663: problems.</p>
3664: <p>For even more automation, we recommend using
3665: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
3666: whole set of patches. You just have to backup files before you
3667: edit them to <code class="filename">filename.orig</code>, e.g. with
3668: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3669: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3670: you upgrade a package this way, you can easily compare the new
3671: set of patches with the previously existing one with
3672: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3673: are replaced by new files, so carefully check if you want to take all
3674: the changes.</p>
3675: <p>When you have finished a package, remember to generate
3676: the checksums for the patch files by using the <span class="command"><strong>make
3677: 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>
3678: <p>When adding a patch that corrects a problem in the
3679: distfile (rather than e.g. enforcing pkgsrc's view of where
3680: man pages should go), send the patch as a bug report to the
3681: maintainer. This benefits non-pkgsrc users of the package,
3682: and usually makes it possible to remove the patch in future
3683: version.</p>
3684: <p>The file names of the patch files are usually of the form
3685: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3686: Many packages still use the previous convention
3687: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3688: but new patches should be of the form containing the filename.
1.322 leot 3689: <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.299 rillig 3690: automatically.</p>
1.118 imil 3691: </div>
1.275 brook 3692: <div class="sect2">
3693: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3694: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3695: <p>If you want to share patches between multiple packages
3696: in pkgsrc, e.g. because they use the same distfiles, set
3697: <code class="varname">PATCHDIR</code> to the path where the patch files
3698: can be found, e.g.:</p>
3699: <pre class="programlisting">
3700: PATCHDIR= ../../editors/xemacs/patches
3701: </pre>
3702: <p>Patch files that are distributed by the author or other
3703: maintainers can be listed in
3704: <code class="varname">PATCHFILES</code>.</p>
3705: <p>If it is desired to store any patches that should not be
3706: committed into pkgsrc, they can be kept outside the pkgsrc
3707: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3708: directory tree there is expected to have the same
3709: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3710: patches are expected to be stored inside these dirs (also
3711: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3712: example, if you want to keep a private patch for
3713: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3714: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3715: files in the named directory are expected to be patch files,
3716: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3717: applied</em></span>.</p>
1.275 brook 3718: </div>
3719: <div class="sect2">
3720: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 3721: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3722: <p>When fixing a portability issue in the code do not use
3723: preprocessor magic to check for the current operating system nor
3724: platform. Doing so hurts portability to other platforms because
3725: the OS-specific details are not abstracted appropriately.</p>
3726: <p>The general rule to follow is: instead of checking for the
3727: operating system the application is being built on, check for the
3728: specific <span class="emphasis"><em>features</em></span> you need. For example,
3729: instead of assuming that kqueue is available under NetBSD and
3730: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3731: kqueue support, add a check that detects kqueue itself —
3732: yes, this generally involves patching the
3733: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3734: that prevents some OSes from adopting interfaces from other OSes
3735: (e.g. Linux implementing kqueue), something that the above checks
3736: cannot take into account.</p>
3737: <p>Of course, checking for features generally involves more
3738: work on the developer's side, but the resulting changes are
3739: cleaner and there are chances they will work on many other
3740: platforms. Not to mention that there are higher chances of being
3741: later integrated into the mainstream sources. Remember:
3742: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3743: <p>Some typical examples:</p>
3744: <div class="table">
3745: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3746: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3747: <colgroup>
3748: <col>
3749: <col>
3750: <col>
3751: </colgroup>
3752: <thead><tr>
3753: <th>Where</th>
3754: <th>Incorrect</th>
3755: <th>Correct</th>
3756: </tr></thead>
3757: <tbody>
3758: <tr>
3759: <td>configure script</td>
3760: <td>
1.275 brook 3761: <pre class="programlisting">
1.299 rillig 3762: case ${target_os} in
3763: netbsd*) have_kvm=yes ;;
3764: *) have_kvm=no ;;
3765: esac
1.275 brook 3766: </pre>
1.299 rillig 3767: </td>
3768: <td>
1.275 brook 3769: <pre class="programlisting">
1.299 rillig 3770: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275 brook 3771: </pre>
1.299 rillig 3772: </td>
3773: </tr>
3774: <tr>
3775: <td>C source file</td>
3776: <td>
1.91 rillig 3777: <pre class="programlisting">
1.299 rillig 3778: #if defined(__NetBSD__)
3779: # include <sys/event.h>
3780: #endif
1.91 rillig 3781: </pre>
1.299 rillig 3782: </td>
3783: <td>
1.91 rillig 3784: <pre class="programlisting">
1.299 rillig 3785: #if defined(HAVE_SYS_EVENT_H)
3786: # include <sys/event.h>
3787: #endif
1.91 rillig 3788: </pre>
1.299 rillig 3789: </td>
3790: </tr>
3791: <tr>
3792: <td>C source file</td>
3793: <td>
1.91 rillig 3794: <pre class="programlisting">
1.299 rillig 3795: int
3796: monitor_file(...)
3797: {
3798: #if defined(__NetBSD__)
3799: int fd = kqueue();
3800: ...
3801: #else
3802: ...
3803: #endif
3804: }
1.91 rillig 3805: </pre>
1.299 rillig 3806: </td>
3807: <td>
1.91 rillig 3808: <pre class="programlisting">
1.299 rillig 3809: int
3810: monitor_file(...)
3811: {
3812: #if defined(HAVE_KQUEUE)
3813: int fd = kqueue();
3814: ...
3815: #else
3816: ...
3817: #endif
3818: }
1.91 rillig 3819: </pre>
1.299 rillig 3820: </td>
3821: </tr>
3822: </tbody>
3823: </table></div>
3824: </div>
3825: <br class="table-break">
3826: </div>
3827: <div class="sect2">
3828: <div class="titlepage"><div><div><h3 class="title">
3829: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3830: <p>Always, always, <span class="strong"><strong>always</strong></span>
3831: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3832: improvements you do to a package to the mainstream developers.
3833: This is the only way to get their attention on portability issues
3834: and to ensure that future versions can be built out-of-the box on
3835: NetBSD. Furthermore, any user that gets newer distfiles will get
3836: the fixes straight from the packaged code.</p>
3837: <p>This generally involves cleaning up the patches
3838: (because sometimes the patches that are
3839: added to pkgsrc are quick hacks), filing bug reports in the
3840: appropriate trackers for the projects and working with the
3841: mainstream authors to accept your changes. It is
3842: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3843: the packages in pkgsrc are kept simple and thus further changes
3844: can be done without much hassle.</p>
3845: <p>When you have done this, please add a URL to the upstream
3846: bug report to the patch comment.</p>
3847: <p>Support the idea of free software!</p>
3848: </div>
1.91 rillig 3849: </div>
1.299 rillig 3850: <div class="sect1">
3851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3852: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3853: <div class="variablelist"><dl class="variablelist">
3854: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3855: <dd><p>A multi-line description of the piece of software. This should include
3856: any credits where they are due. Please bear in mind that others do not
3857: share your sense of humour (or spelling idiosyncrasies), and that others
3858: will read everything that you write here.</p></dd>
3859: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3860: <dd><p>This file governs the files that are installed on your
3861: system: all the binaries, manual pages, etc. There are other
3862: directives which may be entered in this file, to control the
3863: creation and deletion of directories, and the location of
3864: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3865: information.</p></dd>
3866: </dl></div>
3867: </div>
3868: <div class="sect1">
3869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3870: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3871: <div class="sect2">
3872: <div class="titlepage"><div><div><h3 class="title">
3873: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3874: <div class="variablelist"><dl class="variablelist">
3875: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3876: <dd>
1.322 leot 3877: <p>This shell script is invoked twice by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.299 rillig 3878: First time after package extraction and before files are
3879: moved in place, the second time after the files to install
3880: are moved in place. This can be used to do any custom
3881: procedures not possible with @exec commands in
1.322 leot 3882: <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
3883: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information. See also <a class="xref" href="#files-and-dirs-outside-prefix" title="20.1. Files and directories outside the installation prefix">Section 20.1, “Files and directories outside the installation prefix”</a>.
1.299 rillig 3884: Please note that you can modify variables in it easily by using
3885: <code class="varname">FILES_SUBST</code> in the package's
3886: <code class="filename">Makefile</code>:</p>
1.91 rillig 3887: <pre class="programlisting">
1.299 rillig 3888: FILES_SUBST+= SOMEVAR="somevalue"
1.91 rillig 3889: </pre>
1.299 rillig 3890: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3891: <code class="filename">INSTALL</code>. By default, substitution is
3892: performed for <code class="varname">PREFIX</code>,
3893: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3894: <code class="varname">VARBASE</code>, and a few others, type
3895: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3896: complete list.</p>
3897: </dd>
3898: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3899: <dd><p>This script is executed before and after any files are removed. It is
3900: this script's responsibility to clean up any additional messy details
3901: around the package's installation, since all pkg_delete knows is how to
3902: delete the files created in the original distribution.
1.322 leot 3903: See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
3904: and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.299 rillig 3905: The same methods to replace variables can be used as for
3906: the <code class="filename">INSTALL</code> file.</p></dd>
3907: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3908: <dd>
3909: <p>This file is displayed after installation of the package.
1.312 gdt 3910: While this was used often in the past, it has two
3911: problems: the display will be missed if many packages are
3912: intalled at once, and the person installing the package
3913: and the one using or configuring it may be different. It
3914: should therefore be used only in exceptional circumstances
3915: where lasting negative consequences would result from
3916: someone not reading it.</p>
3917: <p>MESSAGE should not be used for:</p>
3918: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3919: <li class="listitem"><p>exhortations to read the documentation</p></li>
3920: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
3921: <li class="listitem"><p>anything that should be explained in the
3922: installation/configuration documentation that should
3923: come with the package</p></li>
3924: </ul></div>
3925: <p>If the documentation provided by upstream needs
1.313 leot 3926: enhancing, create e.g. files/README.pkgsrc and install it
3927: in the package's documentation directory.
1.312 gdt 3928: </p>
3929: <p>Note that MESSAGE is shown for all operating
3930: systems and all init systems. If a MESSAGE is necessary,
1.313 leot 3931: it should be narrowed to only those operating systems and
1.312 gdt 3932: init systems to which it applies.</p>
3933: <p>Note that you can modify variables in it easily by using
1.299 rillig 3934: <code class="varname">MESSAGE_SUBST</code> in the package's
3935: <code class="filename">Makefile</code>:</p>
1.91 rillig 3936: <pre class="programlisting">
1.299 rillig 3937: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.91 rillig 3938: </pre>
1.299 rillig 3939: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
3940: <code class="filename">MESSAGE</code>. By default, substitution is
3941: performed for <code class="varname">PKGNAME</code>,
3942: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
3943: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3944: <code class="varname">PKG_SYSCONFDIR</code>,
3945: <code class="varname">ROOT_GROUP</code>, and
3946: <code class="varname">ROOT_USER</code>.</p>
3947: <p>You can display a different or additional files by
3948: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3949: default is <code class="filename">MESSAGE</code>, if the file
3950: exists.</p>
3951: </dd>
3952: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
3953: <dd>
3954: <p>This file is used by the alternatives framework.
3955: It creates, configures, and destroys generic wrappers used to
3956: run programs with similar interfaces.
3957: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3958: for more information.</p>
3959: <p>Each line of the file contains two filenames, first
3960: the wrapper and then the alternative provided by the package.
3961: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3962: </dd>
3963: </dl></div>
3964: </div>
3965: <div class="sect2">
3966: <div class="titlepage"><div><div><h3 class="title">
3967: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
3968: <div class="variablelist"><dl class="variablelist">
3969: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
3970: <dd><p>This file contains arbitrary things that could
3971: also go into a <code class="filename">Makefile</code>, but its purpose is
3972: to be used by more than one package. This file should only be
3973: used when the packages that will use the file are known in
3974: advance. For other purposes it is often better to write a
3975: <code class="filename">*.mk</code> file and give it a good name that
3976: describes what it does.</p></dd>
3977: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
3978: <dd><p>This file contains the dependency information
3979: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
3980: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
3981: <dd><p>This file contains workarounds for compiler bugs
3982: and similar things. It is included automatically by the pkgsrc
3983: infrastructure, so you don't need an extra
3984: <code class="literal">.include</code> line for
3985: it.</p></dd>
3986: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
3987: <dd><p>This file contains the code for the
3988: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
3989: selected by the user. If a package has only one or two options,
3990: it is equally acceptable to put the code directly into the
3991: <code class="filename">Makefile</code>.</p></dd>
3992: </dl></div>
3993: </div>
3994: <div class="sect2">
3995: <div class="titlepage"><div><div><h3 class="title">
3996: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
3997: <div class="variablelist"><dl class="variablelist">
3998: <dt><span class="term"><code class="filename">README*</code></span></dt>
3999: <dd><p>These files do not take place in the creation of
4000: a package and thus are purely informative to the package
4001: developer.</p></dd>
4002: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4003: <dd><p>This file contains things that need to be done
4004: to make the package even
4005: better.</p></dd>
4006: </dl></div>
4007: </div>
4008: </div>
4009: <div class="sect1">
4010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4011: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
4012: </h2></div></div></div>
4013: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4014: unpacked into the directory denoted by
4015: <code class="varname">WRKDIR</code>. It can be removed by running
4016: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4017: directory is also used to keep various timestamp files.
4018: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4019: The default is <code class="filename">${.CURDIR}/work</code>
4020: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4021: if <code class="varname">OBJMACHINE</code> is set.</p>
1.91 rillig 4022: </div>
1.299 rillig 4023: <div class="sect1">
4024: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4025: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
4026: </h2></div></div></div>
4027: <p>If you have any files that you wish to be placed in the package
4028: prior to configuration or building, you can place these files here
4029: and use a <span class="command"><strong>${CP}</strong></span> command in the
4030: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4031: <p>If you want to share files in this way with other
4032: packages, set the <code class="varname">FILESDIR</code> variable to point
4033: to the other package's <code class="filename">files</code> directory,
4034: e.g.:</p>
1.91 rillig 4035: <pre class="programlisting">
1.299 rillig 4036: FILESDIR= ../../editors/xemacs/files
1.91 rillig 4037: </pre>
4038: </div>
4039: </div>
1.148 asau 4040: <div class="chapter">
1.75 rillig 4041: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 4042: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75 rillig 4043: <div class="toc">
4044: <p><b>Table of Contents</b></p>
1.210 leot 4045: <dl class="toc">
1.299 rillig 4046: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4047: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4048: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4049: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4050: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4051: <dd><dl>
4052: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4053: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4054: </dl></dd>
4055: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4056: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4057: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4058: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4059: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4060: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4061: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4062: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4063: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4064: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4065: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4066: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75 rillig 4067: </dl>
4068: </div>
1.148 asau 4069: <div class="sect1">
1.75 rillig 4070: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4071: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4072: <p>This chapter gives a detailed description on how a package is
4073: built. Building a package is separated into different
4074: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4075: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4076: described in the following sections. Each phase is split into
4077: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4078: containing phase, prefixed by one of <code class="varname">pre-</code>,
4079: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4080: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4081: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4082: <p>Never override the regular targets (like
4083: <code class="varname">fetch</code>), if you have to, override the
4084: <code class="varname">do-*</code> ones instead.</p>
4085: <p>The basic steps for building a program are always the same. First
4086: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4087: the local system and then extracted. After any pkgsrc-specific patches
4088: to compile properly are applied, the software can be configured, then
4089: built (usually by compiling), and finally the generated binaries, etc.
4090: can be put into place on the system.</p>
4091: <p>To get more details about what is happening at each step,
4092: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4093: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4094: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4095: </div>
4096: <div class="sect1">
4097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4098: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4099: <p>Before outlining the process performed by the NetBSD package system in
4100: the next section, here's a brief discussion on where programs are
4101: installed, and which variables influence this.</p>
4102: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4103: where all files of the final program shall be installed. It is
4104: usually set to <code class="varname">LOCALBASE</code>
4105: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4106: for pkgs in the <code class="filename">cross</code> category. The value of
4107: <code class="varname">PREFIX</code> needs to be put
4108: into the various places in the program's source where paths to
4109: 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>
4110: <p>When choosing which of these variables to use,
4111: follow the following rules:</p>
1.148 asau 4112: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 4113: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4114: where the current pkg will be installed. When referring to a
4115: pkg's own installation path, use
4116: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
4117: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
4118: are installed. If you need to construct a -I or -L argument
4119: to the compiler to find includes and libraries installed by
4120: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
4121: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4122: installed all packages in <code class="filename">/usr/local</code>. As
4123: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4124: administrator, this variable is a misnomer.</p></li>
4125: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4126: distribution (from xsrc, etc.) is installed. When looking for
4127: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4128: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4129: <li class="listitem"><p>X11-based packages using imake must set
4130: <code class="varname">USE_IMAKE</code> to be installed correctly under
4131: <code class="varname">LOCALBASE</code>.</p></li>
4132: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.322 leot 4133: install files according to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.299 rillig 4134: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4135: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4136: </ul></div>
4137: </div>
4138: <div class="sect1">
4139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4140: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4141: <p>When building a package, various directories are used to store
4142: source files, temporary files, pkgsrc-internal files, and so on. These
4143: directories are explained here.</p>
4144: <p>Some of the directory variables contain relative pathnames. There
4145: are two common base directories for these relative directories:
4146: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4147: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4148: inside the package itself.</p>
4149: <div class="variablelist"><dl class="variablelist">
4150: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4151: <dd><p>This is an absolute pathname that points to the pkgsrc
4152: root directory. Generally, you don't need
4153: it.</p></dd>
4154: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4155: <dd><p>This is an absolute pathname that points to the
4156: current package.</p></dd>
4157: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
4158: <dd><p>This is a pathname relative to
4159: <code class="varname">PKGSRCDIR</code> that points to the current
4160: package.</p></dd>
4161: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4162: <dd><p>This is an absolute pathname pointing to the directory
4163: where all work takes place. The distfiles are extracted to this
4164: directory. It also contains temporary directories and log files used by
4165: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4166: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4167: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4168: <dd><p>This is an absolute pathname pointing to the directory
4169: where the distfiles are extracted. It is usually a direct subdirectory
4170: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4171: that isn't hidden. This variable may be changed by a package
4172: <code class="filename">Makefile</code>.</p></dd>
4173: </dl></div>
4174: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4175: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4176: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4177: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4178: If users would like to have their pkgsrc trees behave in a
4179: read-only manner, then the value of
4180: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4181: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 4182: </div>
1.148 asau 4183: <div class="sect1">
1.75 rillig 4184: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4185: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4186: <p>You can run a particular phase by typing <span class="command"><strong>make
4187: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
4188: phase. This will automatically run all phases that are required for this
4189: phase. The default phase is <code class="varname">build</code>, that is, when you
4190: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
4191: the package will be built, but not installed.</p>
1.75 rillig 4192: </div>
1.148 asau 4193: <div class="sect1">
1.75 rillig 4194: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4195: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4196: <p>The first step in building a package is to fetch the
4197: distribution files (distfiles) from the sites that are providing
4198: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4199: phase.</p>
1.148 asau 4200: <div class="sect2">
1.93 rillig 4201: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 4202: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4203: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4204: defines all URLs from where the distfile, whose name is
4205: derived from the <code class="varname">DISTNAME</code> variable, is
4206: fetched. The more complicated cases are described
4207: below.</p>
4208: <p>The variable <code class="varname">DISTFILES</code> specifies
4209: the list of distfiles that have to be fetched. Its value
4210: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4211: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4212: so that most packages don't need to define it at all.
4213: <code class="varname">EXTRACT_SUFX</code> is
4214: <code class="literal">.tar.gz</code> by default, but can be changed
4215: freely. Note that if your package requires additional
4216: distfiles to the default one, you cannot just append the
4217: additional filenames using the <code class="literal">+=</code>
4218: operator, but you have write for example:</p>
4219: <pre class="programlisting">
4220: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4221: </pre>
4222: <p>Each distfile is fetched from a list of sites, usually
4223: <code class="varname">MASTER_SITES</code>. If the package has multiple
4224: <code class="varname">DISTFILES</code> or multiple
4225: <code class="varname">PATCHFILES</code> from different sites, you can
4226: set
4227: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4228: to the list of URLs where the file
4229: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4230: (including the suffix) can be found.</p>
4231: <pre class="programlisting">
4232: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4233: DISTFILES+= foo-file.tar.gz
4234: SITES.foo-file.tar.gz= \
4235: https://www.somewhere.com/somehow/ \
4236: https://www.somewhereelse.com/mirror/somehow/
4237: </pre>
4238: <p>When actually fetching the distfiles, each item from
4239: <code class="varname">MASTER_SITES</code> or
4240: <code class="varname">SITES.*</code> gets the name of each distfile
4241: appended to it, without an intermediate slash. Therefore,
4242: all site values have to end with a slash or other separator
4243: character. This allows for example to set
4244: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4245: that gets the name of the distfile as a parameter. In this
4246: case, the definition would look like:</p>
4247: <pre class="programlisting">
4248: MASTER_SITES= https://www.example.com/download.cgi?file=
4249: </pre>
4250: <p> The exception to this rule are URLs starting with a dash.
4251: In that case the URL is taken as is, fetched and the result
4252: stored under the name of the distfile. You can use this style
4253: for the case when the download URL style does not match the
4254: above common case. For example, if permanent download URL is a
4255: redirector to the real download URL, or the download file name
4256: is offered by an HTTP Content-Disposition header. In the
4257: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4258: created instead of the default
4259: <code class="filename">v1.0.0.tar.gz</code>.</p>
4260: <pre class="programlisting">
4261: DISTNAME= foo-1.0.0
4262: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4263: </pre>
4264: <p>There are some predefined values for
4265: <code class="varname">MASTER_SITES</code>, which can be used in
4266: packages. The names of the variables should speak for
4267: themselves.</p>
4268: <table border="0" summary="Simple list" class="simplelist">
4269: <tr>
4270: <td>MASTER_SITE_APACHE</td>
4271: <td>MASTER_SITE_BACKUP</td>
4272: </tr>
4273: <tr>
4274: <td>MASTER_SITE_CRATESIO</td>
4275: <td>MASTER_SITE_CYGWIN</td>
4276: </tr>
4277: <tr>
4278: <td>MASTER_SITE_DEBIAN</td>
4279: <td>MASTER_SITE_FREEBSD</td>
4280: </tr>
4281: <tr>
4282: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4283: <td>MASTER_SITE_GENTOO</td>
4284: </tr>
4285: <tr>
4286: <td>MASTER_SITE_GITHUB</td>
4287: <td>MASTER_SITE_GNOME</td>
4288: </tr>
4289: <tr>
4290: <td>MASTER_SITE_GNU</td>
4291: <td>MASTER_SITE_GNUSTEP</td>
4292: </tr>
4293: <tr>
4294: <td>MASTER_SITE_HASKELL_HACKAGE</td>
4295: <td>MASTER_SITE_IFARCHIVE</td>
4296: </tr>
4297: <tr>
4298: <td>MASTER_SITE_KDE</td>
4299: <td>MASTER_SITE_MOZILLA</td>
4300: </tr>
4301: <tr>
4302: <td>MASTER_SITE_MOZILLA_ALL</td>
4303: <td>MASTER_SITE_MYSQL</td>
4304: </tr>
4305: <tr>
4306: <td>MASTER_SITE_NETLIB</td>
4307: <td>MASTER_SITE_OPENBSD</td>
4308: </tr>
4309: <tr>
4310: <td>MASTER_SITE_OPENOFFICE</td>
4311: <td>MASTER_SITE_OSDN</td>
4312: </tr>
4313: <tr>
4314: <td>MASTER_SITE_PERL_CPAN</td>
4315: <td>MASTER_SITE_PGSQL</td>
4316: </tr>
4317: <tr>
4318: <td>MASTER_SITE_PYPI</td>
4319: <td>MASTER_SITE_RUBYGEMS</td>
4320: </tr>
4321: <tr>
4322: <td>MASTER_SITE_R_CRAN</td>
4323: <td>MASTER_SITE_SOURCEFORGE</td>
4324: </tr>
1.85 jmmv 4325: <tr>
1.299 rillig 4326: <td>MASTER_SITE_SUNSITE</td>
4327: <td>MASTER_SITE_SUSE</td>
1.85 jmmv 4328: </tr>
4329: <tr>
1.299 rillig 4330: <td>MASTER_SITE_TEX_CTAN</td>
4331: <td>MASTER_SITE_XCONTRIB</td>
1.85 jmmv 4332: </tr>
4333: <tr>
1.299 rillig 4334: <td>MASTER_SITE_XEMACS</td>
4335: <td>MASTER_SITE_XORG</td>
4336: </tr>
4337: </table>
4338: <p>Some explanations for the less self-explaining ones:
4339: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
4340: 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
4341: 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>
4342: <p>If you choose one of these predefined sites, you may
4343: want to specify a subdirectory of that site. Since these
4344: macros may expand to more than one actual site, you
4345: <span class="emphasis"><em>must</em></span> use the following construct to
4346: specify a subdirectory:</p>
1.100 rillig 4347: <pre class="programlisting">
1.299 rillig 4348: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4349: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100 rillig 4350: </pre>
1.299 rillig 4351: <p>Note the trailing slash after the subdirectory
4352: name.</p>
4353: </div>
4354: <div class="sect2">
4355: <div class="titlepage"><div><div><h3 class="title">
4356: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4357: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4358: all the distfiles exist in a local directory
4359: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4360: user). If the files do not exist, they are fetched using
4361: commands of the form</p>
1.100 rillig 4362: <pre class="programlisting">
1.299 rillig 4363: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4364: </pre>
4365: <p>where <code class="literal">${site}</code> varies through
4366: several possibilities in turn: first,
4367: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4368: sites specified in either <code class="varname">SITES.file</code> if
4369: defined, else <code class="varname">MASTER_SITES</code> or
4370: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4371: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4372: all except the first and the last can be optionally sorted
4373: by the user, via setting either
4374: <code class="varname">MASTER_SORT_RANDOM</code>, and
4375: <code class="varname">MASTER_SORT_AWK</code> or
4376: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4377: <p> The specific command and arguments used depend on the
4378: <code class="varname">FETCH_USING</code> parameter. The example above is
4379: for <code class="literal">FETCH_USING=custom</code>.</p>
4380: <p>The distfiles mirror run by the NetBSD Foundation uses the
4381: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4382: distfiles, if they are freely distributable. Packages setting
4383: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4384: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4385: mirrored.</p>
1.85 jmmv 4386: </div>
4387: </div>
1.299 rillig 4388: <div class="sect1">
4389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4390: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4391: <p>After the distfile(s) are fetched, their checksum is
4392: generated and compared with the checksums stored in the
4393: distinfo file. If the checksums don't match, the build is
4394: aborted. This is to ensure the same distfile is used for
4395: building, and that the distfile wasn't changed, e.g. by some
4396: malign force, deliberately changed distfiles on the master
4397: distribution site or network lossage.</p>
1.75 rillig 4398: </div>
1.148 asau 4399: <div class="sect1">
1.75 rillig 4400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4401: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4402: <p>When the distfiles are present on the local system, they
4403: need to be extracted, as they usually come in the form of some
4404: compressed archive format.</p>
4405: <p>By default, all <code class="varname">DISTFILES</code> are
4406: extracted. If you only need some of them, you can set the
4407: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4408: files.</p>
4409: <p>Extracting the files is usually done by a little
4410: program, <code class="filename">mk/extract/extract</code>, which
4411: already knows how to extract various archive formats, so most
4412: likely you will not need to change anything here. But if you
4413: need, the following variables may help you:</p>
1.148 asau 4414: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4415: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4416: <dd><p>Use these variables to override the default
4417: options for an extract command, which are defined in
4418: <code class="filename">mk/extract/extract</code>.</p></dd>
4419: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4420: <dd><p>This variable can be set to
4421: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4422: (which is the default value), <code class="literal">pax</code>, or an
4423: absolute pathname pointing to the command with which tar
4424: archives should be extracted. It is preferred to choose bsdtar over gtar
4425: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 4426: </dl></div>
1.299 rillig 4427: <p>If the <code class="filename">extract</code> program doesn't
4428: serve your needs, you can also override the
4429: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4430: command used for extracting the files. This command is
4431: executed in the <code class="filename">${WRKSRC}</code>
4432: directory. During execution of this command, the shell
4433: variable <code class="varname">extract_file</code> holds the absolute
4434: pathname of the file that is going to be extracted.</p>
4435: <p>And if that still does not suffice, you can override the
4436: <code class="varname">do-extract</code> target in the package
4437: Makefile.</p>
1.75 rillig 4438: </div>
1.148 asau 4439: <div class="sect1">
1.75 rillig 4440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4441: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4442: <p>After extraction, all the patches named by the
4443: <code class="varname">PATCHFILES</code>, those present in the patches
4444: subdirectory of the package as well as in
4445: $LOCALPATCHES/$PKGPATH (e.g.
4446: <code class="filename">/usr/local/patches/graphics/png</code>) are
4447: applied. Patchfiles ending in <code class="filename">.Z</code> or
4448: <code class="filename">.gz</code> are uncompressed before they are
4449: applied, files ending in <code class="filename">.orig</code> or
4450: <code class="filename">.rej</code> are ignored. Any special options to
1.322 leot 4451: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.299 rillig 4452: <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.322 leot 4453: <p>By default <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.299 rillig 4454: fail if the expected text from the patch context is not found in the
4455: patched file. If that happens, fix the patch file by comparing it
4456: with the actual text in the file to be patched.</p>
1.78 rillig 4457: </div>
1.148 asau 4458: <div class="sect1">
1.75 rillig 4459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4460: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4461: <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>.
4462: </p>
1.75 rillig 4463: </div>
1.148 asau 4464: <div class="sect1">
1.75 rillig 4465: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4466: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4467: <p>This phase creates wrapper programs for the compilers and
4468: linkers. The following variables can be used to tweak the
4469: wrappers.</p>
4470: <div class="variablelist"><dl class="variablelist">
4471: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4472: <dd><p>The command used to print progress
4473: messages. Does nothing by default. Set to
4474: <code class="literal">${ECHO}</code> to see the progress
4475: messages.</p></dd>
4476: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4477: <dd><p>This variable can be set to
4478: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4479: depending on whether you want additional information in the
4480: wrapper log file.</p></dd>
4481: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4482: <dd><p>This variable can be set to
4483: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4484: on whether the wrapper should use its cache, which will
4485: improve the speed. The default value is
4486: <code class="literal">yes</code>, but is forced to
4487: <code class="literal">no</code> if the platform does not support
4488: it.</p></dd>
4489: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4490: <dd><p>A list of reordering commands. A reordering
4491: command has the form
4492: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4493: It ensures that that
4494: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4495: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4496: </p></dd>
4497: </dl></div>
4498: </div>
4499: <div class="sect1">
4500: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4501: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4502: <p>Most pieces of software need information on the header
4503: files, system calls, and library routines which are available
4504: on the platform they run on. The process of determining this
4505: information is known as configuration, and is usually
4506: automated. In most cases, a script is supplied with the
4507: distfiles, and its invocation results in generation of header
4508: files, Makefiles, etc.</p>
4509: <p>If the package contains a configure script, this can be
4510: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4511: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4512: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.301 rillig 4513: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4514: <p>In the <code class="literal">do-configure</code> stage, a rough
4515: equivalent of the following command is run. See
4516: <code class="filename">mk/configure/configure.mk</code>, target
4517: <code class="literal">do-configure-script</code> for the exact
4518: definition.</p>
4519: <pre class="programlisting">
4520: .for dir in ${CONFIGURE_DIRS}
4521: cd ${WRKSRC} && cd ${dir} \
4522: && env ${CONFIGURE_ENV} \
4523: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299 rillig 4524: .endfor
1.100 rillig 4525: </pre>
1.299 rillig 4526: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4527: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4528: <code class="varname">WRKSRC</code>. In each of these directories, the
4529: configure script is run with the environment
4530: <code class="varname">CONFIGURE_ENV</code> and arguments
4531: <code class="varname">CONFIGURE_ARGS</code>. The variables
4532: <code class="varname">CONFIGURE_ENV</code>,
4533: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4534: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4535: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4536: package.</p>
4537: <p>If the program uses the Perl way of configuration (mainly Perl
4538: modules, but not only), i.e. a file called
4539: <code class="filename">Makefile.PL</code>, it should include
4540: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4541: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4542: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4543: <p>If the program uses an <code class="filename">Imakefile</code>
4544: for configuration, the appropriate steps can be invoked by
4545: setting <code class="varname">USE_IMAKE</code> to
4546: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4547: You can add variables to xmkmf's environment by adding them to the
4548: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4549: <p>If the program uses <code class="filename">cmake</code>
4550: for configuration, the appropriate steps can be invoked by
4551: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
4552: You can add variables to cmake's environment by adding them to the
4553: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
4554: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
4555: The top directory argument is given by the
4556: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
4557: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
4558: <p>If there is no configure step at all, set
4559: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 4560: </div>
1.148 asau 4561: <div class="sect1">
1.75 rillig 4562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4563: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301 rillig 4564: <p>For building a package, a rough equivalent of the following
4565: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4566: <code class="literal">do-build</code> for the exact definition.</p>
1.97 rillig 4567: <pre class="programlisting">
1.301 rillig 4568: .for dir in ${BUILD_DIRS}
4569: cd ${WRKSRC} && cd ${dir} \
1.299 rillig 4570: && env ${MAKE_ENV} \
1.301 rillig 4571: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299 rillig 4572: -f ${MAKE_FILE} \
4573: ${BUILD_TARGET}
4574: .endfor
1.97 rillig 4575: </pre>
1.299 rillig 4576: <p><code class="varname">BUILD_DIRS</code> (default:
4577: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4578: <code class="varname">WRKSRC</code>. In each of these directories,
4579: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4580: <code class="varname">MAKE_ENV</code> and arguments
4581: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4582: <code class="varname">MAKE_ENV</code>,
4583: <code class="varname">BUILD_MAKE_FLAGS</code>,
4584: <code class="varname">MAKE_FILE</code> and
4585: <code class="varname">BUILD_TARGET</code> may all be changed by the
4586: package.</p>
4587: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4588: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4589: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4590: default value of <code class="varname">MAKE_FILE</code> is
4591: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4592: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4593: <p>If there is no build step at all, set
4594: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.97 rillig 4595: </div>
1.148 asau 4596: <div class="sect1">
1.97 rillig 4597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4598: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4599: <p>[TODO]</p>
1.75 rillig 4600: </div>
1.148 asau 4601: <div class="sect1">
1.75 rillig 4602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4603: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4604: <p>Once the build stage has completed, the final step is to
4605: install the software in public directories, so users can
4606: access the programs and files.</p>
1.301 rillig 4607: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4608: of the following code is executed; see
4609: <code class="filename">mk/install/install.mk</code>, target
4610: <code class="literal">do-install</code> for the exact definition. Additionally,
4611: before and after this code, several consistency checks are run
4612: against the files-to-be-installed, see
4613: <code class="filename">mk/check/*.mk</code> for details.</p>
4614: <pre class="programlisting">
4615: .for dir in ${INSTALL_DIRS}
4616: cd ${WRKSRC} && cd ${dir} \
4617: && env ${INSTALL_ENV} ${MAKE_ENV} \
4618: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4619: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299 rillig 4620: .endfor
1.220 wiz 4621: </pre>
1.299 rillig 4622: <p>The variable's meanings are analogous to the ones in the
4623: <span class="emphasis"><em>build</em></span> phase.
4624: <code class="varname">INSTALL_DIRS</code> defaults to
4625: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4626: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4627: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4628: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4629: defined.</p>
4630: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4631: variables are useful. They are all variations of the
1.322 leot 4632: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.299 rillig 4633: permissions preset. <code class="varname">INSTALL</code> is the plain
4634: install command. The specialized variants, together with their
4635: intended use, are:</p>
4636: <div class="variablelist"><dl class="variablelist">
4637: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4638: <dd><p>directories that contain
4639: binaries</p></dd>
4640: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4641: <dd><p>directories that contain
4642: scripts</p></dd>
4643: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4644: <dd><p>directories that contain shared and static
4645: libraries</p></dd>
4646: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4647: <dd><p>directories that contain data
4648: files</p></dd>
4649: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4650: <dd><p>directories that contain man
4651: pages</p></dd>
4652: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4653: <dd><p>directories that contain data files for games
4654: </p></dd>
4655: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4656: <dd><p>binaries that can be stripped from debugging
4657: symbols</p></dd>
4658: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4659: <dd><p>binaries that cannot be
4660: stripped</p></dd>
4661: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4662: <dd><p>game
4663: binaries</p></dd>
4664: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4665: <dd><p>shared and static
4666: libraries</p></dd>
4667: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4668: <dd><p>data files</p></dd>
4669: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4670: <dd><p>data files for
4671: games</p></dd>
4672: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4673: <dd><p>man pages</p></dd>
4674: </dl></div>
4675: <p>Some other variables are:</p>
4676: <div class="variablelist"><dl class="variablelist">
4677: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.322 leot 4678: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.299 rillig 4679: when installing binaries. Any debugging sections and symbols present in
4680: binaries will be preserved.
4681: </p></dd>
4682: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4683: <dd><p>A list of directories relative to
4684: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4685: beginning of the <span class="emphasis"><em>install</em></span> phase.
4686: The package is supposed to create all needed directories itself
4687: before installing files to it and list all other directories here.
4688: </p></dd>
4689: </dl></div>
4690: <p>In the rare cases that a package shouldn't install anything,
4691: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4692: mostly relevant for packages in the <code class="filename">regress</code>
4693: category.</p>
1.75 rillig 4694: </div>
1.148 asau 4695: <div class="sect1">
1.75 rillig 4696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4697: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4698: <p>Once the install stage has completed, a binary package of
4699: the installed files can be built. These binary packages can be
4700: used for quick installation without previous compilation, e.g. by
4701: the <span class="command"><strong>make bin-install</strong></span> or by using
4702: <span class="command"><strong>pkg_add</strong></span>.</p>
4703: <p>By default, the binary packages are created in
4704: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4705: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4706: one for each category in the <code class="varname">CATEGORIES</code>
4707: variable. <code class="varname">PACKAGES</code> defaults to
4708: <code class="filename">pkgsrc/packages</code>.</p>
1.75 rillig 4709: </div>
1.148 asau 4710: <div class="sect1">
1.75 rillig 4711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4712: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4713: <p>Once you're finished with a package, you can clean the work
4714: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4715: to clean the work directories of all dependencies too, use
4716: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 4717: </div>
1.148 asau 4718: <div class="sect1">
1.75 rillig 4719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 4720: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148 asau 4721: <div class="variablelist"><dl class="variablelist">
1.299 rillig 4722: <dt><span class="term">pre/post-*</span></dt>
4723: <dd>
4724: <p>For any of the main targets described in the previous
4725: section (configure, build, install, etc.), two auxiliary
4726: targets exist with
4727: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4728: prefix for the main target's name. These targets are
4729: invoked before and after the main target is called,
4730: allowing extra configuration or installation steps be
4731: performed from a package's Makefile, for example, which
4732: a program's configure script or install target
4733: omitted.</p>
4734: <p>About 5% of the pkgsrc packages define their custom
4735: post-extract target, another 5% define pre-configure, and 10%
4736: define post-install. The other pre/post-* targets are defined
4737: even less often.</p>
4738: </dd>
4739: <dt><span class="term">do-*</span></dt>
1.75 rillig 4740: <dd>
1.299 rillig 4741: <p>Should one of the main targets do the wrong thing,
4742: and should there be no variable to fix this, you can
4743: redefine it with the do-* target. (Note that redefining
4744: the target itself instead of the do-* target is a bad
4745: idea, as the pre-* and post-* targets won't be called
4746: anymore, etc.)</p>
4747: <p>About 15% of the pkgsrc packages override the default
4748: do-install, the other do-* targets are overridden even less
4749: often.</p>
1.75 rillig 4750: </dd>
1.299 rillig 4751: <dt><span class="term">reinstall</span></dt>
1.75 rillig 4752: <dd>
1.299 rillig 4753: <p>If you did a <span class="command"><strong>make install</strong></span> and
4754: you noticed some file was not installed properly, you
4755: can repeat the installation with this target, which will
4756: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4757: <p>This is the default value of
4758: <code class="varname">DEPENDS_TARGET</code> except in the case of
4759: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4760: package</strong></span>, where the defaults are
4761: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4762: respectively.</p>
1.75 rillig 4763: </dd>
1.299 rillig 4764: <dt><span class="term">deinstall</span></dt>
4765: <dd>
1.322 leot 4766: <p>This target does a <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.299 rillig 4767: current directory, effectively de-installing the
4768: package. The following variables can be used to tune the
4769: behaviour:</p>
4770: <div class="variablelist"><dl class="variablelist">
4771: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.322 leot 4772: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.299 rillig 4773: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4774: <dd><p>Remove all packages that require (depend on)
4775: the given package. This can be used to remove any
4776: packages that may have been pulled in by a given
4777: package, e.g. if <span class="command"><strong>make deinstall
4778: DEINSTALLDEPENDS=1</strong></span> is done in
4779: <code class="filename">pkgsrc/x11/kde</code>, this is
4780: likely to remove whole KDE. Works by adding
1.322 leot 4781: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.299 rillig 4782: command line.</p></dd>
4783: </dl></div>
4784: </dd>
4785: <dt><span class="term">bin-install</span></dt>
4786: <dd><p>Install a binary package from local disk and via FTP
4787: from a list of sites (see the
4788: <code class="varname">BINPKG_SITES</code> variable), and do a
4789: <span class="command"><strong>make package</strong></span> if no binary package is
4790: available anywhere. The arguments given to
4791: <span class="command"><strong>pkg_add</strong></span> can be set via
4792: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4793: operation, etc.</p></dd>
4794: <dt><span class="term">install-clean</span></dt>
4795: <dd><p>This target removes the state files for the "install" and later
4796: phases so that the "install" target may be re-invoked. This can be
4797: used after editing the PLIST to install the package without
4798: rebuilding it.</p></dd>
4799: <dt><span class="term">build-clean</span></dt>
4800: <dd><p>This target removes the state files for the "build" and later
4801: phases so that the "build" target may be re-invoked.</p></dd>
4802: <dt><span class="term">update</span></dt>
4803: <dd>
4804: <p>This target causes the current package to be
4805: updated to the latest version. The package and all
4806: depending packages first get de-installed, then current
4807: versions of the corresponding packages get compiled and
4808: installed. This is similar to manually noting which
4809: packages are currently installed, then performing a
4810: series of <span class="command"><strong>make deinstall</strong></span> and
4811: <span class="command"><strong>make install</strong></span> (or whatever
4812: <code class="varname">UPDATE_TARGET</code> is set to) for these
4813: packages.</p>
4814: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4815: resume package updating in case a previous <span class="command"><strong>make
4816: update</strong></span> was interrupted for some reason.
4817: However, in this case, make sure you don't call
4818: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4819: list of dependent packages in <code class="varname">WRKDIR</code>.
4820: Otherwise, you lose the ability to automatically update
4821: the current package along with the dependent packages
4822: you have installed.</p>
4823: <p>Resuming an interrupted <span class="command"><strong>make
4824: update</strong></span> will only work as long as the package
4825: tree remains unchanged. If the source code for one of
4826: the packages to be updated has been changed, resuming
4827: <span class="command"><strong>make update</strong></span> will most certainly
4828: fail!</p>
4829: <p>The following variables can be used either on the
4830: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4831: alter the behaviour of <span class="command"><strong>make
4832: update</strong></span>:</p>
4833: <div class="variablelist"><dl class="variablelist">
4834: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4835: <dd><p>Install target to recursively use for the
4836: updated package and the dependent packages.
4837: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4838: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4839: <span class="command"><strong>make update</strong></span>. Other good
4840: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4841: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4842: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4843: endless loop!</p></dd>
4844: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4845: <dd><p>Don't clean up after updating. Useful if
4846: you want to leave the work sources of the updated
4847: packages around for inspection or other purposes.
4848: Be sure you eventually clean up the source tree
4849: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4850: or you may run into troubles with old source code
4851: still lying around on your next
4852: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4853: update</strong></span>.</p></dd>
4854: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4855: <dd><p>Deinstall each package before installing
4856: (making <code class="varname">DEPENDS_TARGET</code>). This
4857: may be necessary if the
4858: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4859: called after interrupting a running <span class="command"><strong>make
4860: update</strong></span>.</p></dd>
4861: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4862: <dd><p>Allows you to disable recursion and hardcode
4863: the target for packages. The default is
4864: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4865: facilitating a recursive update of prerequisite
4866: packages. Only set
4867: <code class="varname">DEPENDS_TARGET</code> if you want to
4868: disable recursive updates. Use
4869: <code class="varname">UPDATE_TARGET</code> instead to just
4870: set a specific target for each package to be
4871: installed during <span class="command"><strong>make update</strong></span>
4872: (see above).</p></dd>
4873: </dl></div>
4874: </dd>
4875: <dt><span class="term">clean-update</span></dt>
4876: <dd>
4877: <p>Clean the source tree for all packages that would
4878: get updated if <span class="command"><strong>make update</strong></span> was called
4879: from the current directory. This target should not be
4880: used if the current package (or any of its depending
4881: packages) have already been de-installed (e.g., after
4882: calling <span class="command"><strong>make update</strong></span>) or you may lose
4883: some packages you intended to update. As a rule of
4884: thumb: only use this target <span class="emphasis"><em>before</em></span>
4885: the first time you run <span class="command"><strong>make update</strong></span>
4886: and only if you have a dirty package tree (e.g., if you
4887: used <code class="varname">NOCLEAN</code>).</p>
4888: <p>If you are unsure about whether your tree is
4889: clean, you can either perform a <span class="command"><strong>make
4890: clean</strong></span> at the top of the tree, or use the
4891: following sequence of commands from the directory of the
4892: package you want to update (<span class="emphasis"><em>before</em></span>
4893: running <span class="command"><strong>make update</strong></span> for the first
4894: time, otherwise you lose all the packages you wanted to
4895: update!):</p>
4896: <pre class="screen">
4897: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
4898: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
4899: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
4900: </pre>
4901: <p>The following variables can be used either on the
4902: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
4903: <span class="command"><strong>make clean-update</strong></span>:</p>
4904: <div class="variablelist"><dl class="variablelist">
4905: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
4906: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
4907: reconstruct the list of directories to update for
4908: this package. Only use this if <span class="command"><strong>make
4909: update</strong></span> successfully installed all
4910: packages you wanted to update. Normally, this is
4911: done automatically on <span class="command"><strong>make
4912: update</strong></span>, but may have been suppressed by
4913: the <code class="varname">NOCLEAN</code> variable (see
4914: above).</p></dd>
4915: </dl></div>
4916: </dd>
4917: <dt><span class="term">replace</span></dt>
4918: <dd>
4919: <p>Update the installation of the current package. This
4920: differs from update in that it does not replace dependent
1.322 leot 4921: packages. You will need to install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.299 rillig 4922: target to work.</p>
4923: <p><span class="emphasis"><em>Be careful when using this
4924: target!</em></span> There are no guarantees that dependent
4925: packages will still work, in particular they will most
4926: certainly break if you <span class="command"><strong>make replace</strong></span> a
4927: library package whose shared library major version changed
4928: between your installed version and the new one. For this
4929: reason, this target is not officially supported and only
4930: recommended for advanced users.</p>
4931: </dd>
4932: <dt><span class="term">info</span></dt>
1.322 leot 4933: <dd><p>This target invokes <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.299 rillig 4934: package. You can use this to check which version of a
4935: package is installed.</p></dd>
4936: <dt><span class="term">index</span></dt>
4937: <dd>
4938: <p>This is a top-level command, i.e. it should be used in
4939: the <code class="filename">pkgsrc</code> directory. It creates a
4940: database of all packages in the local pkgsrc tree, including
4941: dependencies, comment, maintainer, and some other useful
4942: information. Individual entries are created by running
4943: <span class="command"><strong>make describe</strong></span> in the packages'
4944: directories. This index file is saved as
4945: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
4946: verbose format by running <span class="command"><strong>make
4947: print-index</strong></span>. You can search in it with
4948: <span class="command"><strong>make search
4949: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
4950: extract a list of all packages that depend on a particular
4951: one by running <span class="command"><strong>make show-deps
4952: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
4953: <p>Running this command takes a very long time, some
4954: hours even on fast machines!</p>
4955: </dd>
4956: <dt><span class="term">readme</span></dt>
4957: <dd>
4958: <p>This target generates a
1.314 nia 4959: <code class="filename">index.html</code> file, which can be
1.322 leot 4960: viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/index.html" target="_top"><code class="filename">www/links</code></a>. The generated files
1.299 rillig 4961: contain references to any packages which are in the
4962: <code class="varname">PACKAGES</code> directory on the local
4963: host. The generated files can be made to refer to URLs
4964: based on <code class="varname">FTP_PKG_URL_HOST</code> and
4965: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314 nia 4966: wanted to generate <code class="filename">index.html</code>
1.299 rillig 4967: files which pointed to binary packages on the local
4968: machine, in the directory
4969: <code class="filename">/usr/packages</code>, set
4970: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
4971: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
4972: <code class="varname">${PACKAGES}</code> directory and its
4973: subdirectories will be searched for all the binary
4974: packages.</p>
4975: <p>The target can be run at the toplevel or in category
4976: directories, in which case it descends recursively.</p>
4977: </dd>
4978: <dt><span class="term">readme-all</span></dt>
4979: <dd><p>This is a top-level command, run it in
4980: <code class="filename">pkgsrc</code>. Use this target to create a
4981: file <code class="filename">README-all.html</code> which contains a
4982: list of all packages currently available in the NetBSD
4983: Packages Collection, together with the category they belong
4984: to and a short description. This file is compiled from the
1.314 nia 4985: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299 rillig 4986: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
4987: readme</strong></span>.</p></dd>
4988: <dt><span class="term">cdrom-readme</span></dt>
4989: <dd><p>This is very much the same as the
4990: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
4991: used when generating a pkgsrc tree to be written to a
4992: CD-ROM. This target also produces
1.314 nia 4993: <code class="filename">index.html</code> files, and can be made
1.299 rillig 4994: to refer to URLs based on
4995: <code class="varname">CDROM_PKG_URL_HOST</code> and
4996: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
4997: <dt><span class="term">show-distfiles</span></dt>
4998: <dd><p>This target shows which distfiles and patchfiles
4999: are needed to build the package
5000: (<code class="varname">ALLFILES</code>, which contains all
5001: <code class="varname">DISTFILES</code> and
5002: <code class="varname">PATCHFILES</code>, but not
5003: <code class="filename">patches/*</code>).</p></dd>
5004: <dt><span class="term">show-downlevel</span></dt>
5005: <dd><p>This target shows nothing if the package is not
5006: installed. If a version of this package is installed,
5007: but is not the version provided in this version of
5008: pkgsrc, then a warning message is displayed. This target
5009: can be used to show which of your installed packages are
5010: downlevel, and so the old versions can be deleted, and
5011: the current ones added.</p></dd>
5012: <dt><span class="term">show-pkgsrc-dir</span></dt>
5013: <dd><p>This target shows the directory in the pkgsrc
5014: hierarchy from which the package can be built and
5015: installed. This may not be the same directory as the one
5016: from which the package was installed. This target is
5017: intended to be used by people who may wish to upgrade
5018: many packages on a single host, and can be invoked from
5019: the top-level pkgsrc Makefile by using the
5020: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
5021: <dt><span class="term">show-installed-depends</span></dt>
5022: <dd><p>This target shows which installed packages match
5023: the current package's <code class="varname">DEPENDS</code>. Useful
5024: if out of date dependencies are causing build
5025: problems.</p></dd>
5026: <dt><span class="term">print-build-depends-list</span></dt>
5027: <dd><p>This target shows the list of packages that the current package
5028: depends on for building.</p></dd>
5029: <dt><span class="term">print-run-depends-list</span></dt>
5030: <dd><p>This target shows the list of packages that the current package
5031: depends on for running.</p></dd>
5032: <dt><span class="term">check-shlibs</span></dt>
5033: <dd><p>After a package is installed, check all its
5034: binaries and (on ELF platforms) shared libraries to see
5035: if they find the shared libs they need. Run by default
5036: 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>
5037: <dt><span class="term">print-PLIST</span></dt>
5038: <dd>
5039: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5040: upgraded pkg, this prints out an attempt to generate a
5041: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5042: -newer work/.extract_done</strong></span>. An attempt is made
5043: to care for shared libs etc., but it is
5044: <span class="emphasis"><em>strongly</em></span> recommended to review the
5045: result before putting it into
5046: <code class="filename">PLIST</code>. On upgrades, it's useful to
5047: diff the output of this command against an already
5048: existing <code class="filename">PLIST</code> file.</p>
1.322 leot 5049: <p>If the package installs files via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.299 rillig 5050: other methods that don't update file access times, be
5051: sure to add these files manually to your
5052: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5053: -newer</span>”</span> command used by this target won't catch
5054: them!</p>
5055: <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
5056: information on this target.</p>
5057: </dd>
5058: </dl></div>
5059: </div>
5060: </div>
5061: <div class="chapter">
5062: <div class="titlepage"><div><div><h2 class="title">
5063: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5064: <div class="toc">
5065: <p><b>Table of Contents</b></p>
5066: <dl class="toc">
5067: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5068: <dd><dl>
5069: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
5070: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
5071: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
5072: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
5073: </dl></dd>
5074: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5075: <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>
5076: </dl>
5077: </div>
5078: <p>When you find a package that is not yet in pkgsrc, you
5079: most likely have a URL from where you can download the source
5080: code. Starting with this URL, creating a package involves only a
5081: few steps.</p>
5082: <div class="procedure"><ol class="procedure" type="1">
5083: <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
5084: enable the basic quality checks.</p></li>
5085: <li class="step">
1.322 leot 5086: <p>Install the package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkg_developer/index.html" target="_top"><code class="filename">meta-pkgs/pkg_developer</code></a>, which among others will
1.299 rillig 5087: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5088: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5089: <span class="command"><strong>mkpatches</strong></span>:</p>
5090: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5091: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5092: </li>
5093: <li class="step">
5094: <p>Choose one of the top-level directories as the category in
5095: which you want to place your package. You can also create a directory of
5096: your own (maybe called <code class="filename">local</code>). In that category
5097: directory, create another directory for your package and change into
5098: it:</p>
5099: <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>
5100: <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>
5101: </li>
5102: <li class="step">
5103: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
5104: you for a URL. Enter the URL of the distribution file (in most cases a
5105: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
5106: of your package are created automatically. The distribution file is
5107: extracted automatically to fill in some details in the
5108: <code class="filename">Makefile</code> that would otherwise have to be done
5109: manually:</p>
5110: <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>
5111: </li>
5112: <li class="step">
5113: <p>Examine the extracted files to determine the dependencies of
5114: your package. Ideally, this is mentioned in some
5115: <code class="filename">README</code> file, but things may differ. For each of
5116: these dependencies, look where it exists in pkgsrc, and if there is a
5117: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5118: line to your package <code class="filename">Makefile</code> which includes that
5119: file just before the last line. If the
5120: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5121: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5122: that the package's include files and libraries are provided.</p>
5123: <p>If you just need binaries from a package, add a
5124: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5125: version of the dependency and where it can be found in pkgsrc. This line
5126: should be placed in the third paragraph. If the dependency is only
5127: needed for building the package, but not when using it, use
5128: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5129: instead of <code class="varname">DEPENDS</code>.
5130: The difference between <code class="varname">TOOL_DEPENDS</code> and
5131: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5132: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
5133: packages, i.e. packages for the architecture where the package
5134: is built;
5135: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
5136: packages, i.e. packages for the architecture for which the package
5137: is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
5138: to specify a dependency used only for testing the resulting package
5139: built, using the upstream project's included test suite.
5140: Your package may then look like this:</p>
5141: <pre class="programlisting">
5142: [...]
5143:
5144: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5145: DEPENDS+= screen-[0-9]*:../../misc/screen
5146: DEPENDS+= screen>=4.0:../../misc/screen
5147:
5148: [...]
5149:
5150: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5151: .include "../../devel/glib2/buildlink3.mk"
5152: .include "../../mk/bsd.pkg.mk"
5153: </pre>
5154: </li>
5155: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5156: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5157: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5158: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5159: additional explanations.</p></li>
5160: <li class="step"><p>In many cases the package is not yet ready to build. You can
5161: 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
5162: over there, you can hopefully continue here.</p></li>
5163: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5164: directory from the extracted files. Besides these files, a lot of cache
5165: files and other system information has been saved in the working
5166: directory, which may become wrong after you edited the
5167: <code class="filename">Makefile</code>.</p></li>
5168: <li class="step">
5169: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5170: 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>
5171: <p>If the extracted files from the package need to be fixed, run multiple rounds of these commands:</p>
5172: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>make</code></strong>
5173: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5174: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
5175: <code class="prompt">$</code> <strong class="userinput"><code>make mps</code></strong>
5176: <code class="prompt">$</code> <strong class="userinput"><code>make clean</code></strong></pre>
5177: </li>
5178: <li class="step"><p>When the package builds fine, the next step is to install
5179: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5180: everything works.</p></li>
5181: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5182: contains a list of the files that are installed by the package, is
5183: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5184: >PLIST</strong></span> to generate a probably correct list. Check
5185: the file using your preferred text editor to see if the list of
5186: files looks plausible.</p></li>
5187: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5188: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5189: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5190: had been registered in the database of installed files, but with an
5191: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5192: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5193: registered with the list of files from
5194: <code class="filename">PLIST</code>.</p></li>
5195: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
5196: package from the set of installed files.</p></li>
5197: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5198: from above again in a single step, making sure that the PLIST is correct
5199: and the whole package is created as intended.</p></li>
5200: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything left to do.</p></li>
5201: <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>
5202: </ol></div>
5203: <div class="sect1">
5204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5205: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5206: <div class="sect2">
5207: <div class="titlepage"><div><div><h3 class="title">
5208: <a name="creating.perl-module"></a>14.1.1. Perl modules</h3></div></div></div>
5209: <p>Simple Perl modules are handled automatically by
5210: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
5211: </div>
5212: <div class="sect2">
5213: <div class="titlepage"><div><div><h3 class="title">
5214: <a name="creating.python-module"></a>14.1.2. Python modules and programs</h3></div></div></div>
5215: <p>Python modules and programs packages are easily created using a
5216: set of predefined variables.</p>
5217: <p>
5218: If some Python versions are not supported by the software, set the
5219: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5220: that are not supported, e.g.
5221: </p>
5222: <pre class="programlisting">
5223: PYTHON_VERSIONS_INCOMPATIBLE= 27
5224: </pre>
5225: <p>
5226: If the packaged software is a Python module, include one of
5227: <code class="filename">../../lang/python/egg.mk</code>,
5228: <code class="filename">../../lang/python/distutils.mk</code>, or
5229: <code class="filename">../../lang/python/extension.mk</code>.</p>
5230: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
5231: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
5232: If the packaged software is using setuptools, you only need
5233: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
5234: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
5235: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>,
5236: so pkgsrc will use this framework.
5237: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>;
5238: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
5239: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
5240: to the name of the script.</p>
5241: <p>Either way, the package directory should be called
5242: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5243: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5244: </p>
5245: <pre class="programlisting">
5246: DISTNAME= foopymodule-1.2.10
5247: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5248: </pre>
5249: <p>If it is an application, include
5250: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5251: In order to correctly set the path to the Python interpreter, use the
5252: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5253: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5254: For example:
5255: </p>
5256: <pre class="programlisting">
5257: REPLACE_PYTHON= *.py
5258: </pre>
5259: <p>Some Python modules have separate distributions for Python-2.x
5260: and Python-3.x support. In pkgsrc this is handled by the
5261: <code class="filename">versioned_dependencies.mk</code> file. Set
5262: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
5263: packages that should be depended upon and include
5264: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
5265: then the pkgsrc infrastructure will depend on the appropriate package
5266: version. For example:
5267: </p>
5268: <pre class="programlisting">
5269: PYTHON_VERSIONED_DEPENDENCIES=dialog
5270: </pre>
5271: <p>
5272: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
5273: of supported packages.</p>
5274: </div>
5275: <div class="sect2">
5276: <div class="titlepage"><div><div><h3 class="title">
5277: <a name="creating.R-package"></a>14.1.3. R packages</h3></div></div></div>
5278: <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>
5279: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.322 leot 5280: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/index.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
1.299 rillig 5281: Individual packages (and optionally their dependencies) may be created
5282: and updated. R packages generally follow the same form, and most of
5283: the relevant information needed is contained in a
5284: <code class="filename">DESCRIPTION</code> file as part of each R package on
5285: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5286: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5287: creates or updates a package in the canonical form. The resulting
5288: package should be reviewed for correctness.</p>
5289: </div>
5290: <div class="sect2">
5291: <div class="titlepage"><div><div><h3 class="title">
5292: <a name="creating.TeX-package"></a>14.1.4. TeXlive packages</h3></div></div></div>
5293: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.322 leot 5294: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/index.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
1.299 rillig 5295: <p>If the TeXlive package name is not known, it may be useful to
5296: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5297: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5298: 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
5299: archive</a>.</p>
5300: <p>If the TeXlive package name is known, download the files from
5301: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5302: archive</a>. For package <code class="filename">foo</code>, you will need
5303: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5304: also have associated documentation packages, so download
5305: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5306: should be placed in the appropriate category directory, which is often
5307: but not always <code class="filename">print</code>. Then run the following
5308: command in the category directory.</p>
5309: <pre class="programlisting">
5310: texlive2pkg foo.tar.xz foo.doc.tar.xz
5311: </pre>
5312: <p>This will create two packages, <code class="filename">tex-foo</code> and
5313: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5314: are correct.</p>
5315: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5316: currently does not include version information in package filenames
5317: and changes their contents periodically when updates occur.
5318: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5319: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5320: main one and the corresponding documentation, upload the distfiles
5321: with the following command in each package directory.</p>
5322: <pre class="programlisting">
5323: make upload-distfiles
5324: </pre>
5325: </div>
5326: </div>
5327: <div class="sect1">
5328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5329: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5330: <div class="sect2">
5331: <div class="titlepage"><div><div><h3 class="title">
5332: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5333: <div class="sect3">
5334: <div class="titlepage"><div><div><h4 class="title">
5335: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5336: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5337: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5338: pkgsrc. As the description says it has to do with the web, the obvious
5339: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5340: <pre class="programlisting">
5341: <code class="prompt">$</code> mkdir www/nvu
5342: <code class="prompt">$</code> cd www/nvu
5343: </pre>
5344: <p>The web site says that the sources are available as a tar file, so
5345: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5346: <pre class="programlisting">
5347: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5348: </pre>
5349: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5350: below the <code class="varname">DISTNAME</code> line, as the package name should
5351: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5352: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5353: <code class="varname">COMMENT</code> fields. Then the package
5354: <code class="filename">Makefile</code> looked like that:</p>
5355: <pre class="programlisting">
5356: # $NetBSD $
5357: #
5358:
5359: DISTNAME= nvu-1.0-sources
5360: PKGNAME= nvu-1.0
5361: CATEGORIES= www
5362: MASTER_SITES= http://cvs.nvu.com/download/
5363: EXTRACT_SUFX= .tar.bz2
5364:
5365: MAINTAINER= rillig@NetBSD.org
5366: HOMEPAGE= http://cvs.nvu.com/
5367: COMMENT= Web Authoring System
5368:
5369: # url2pkg-marker (please do not remove this line.)
5370: .include "../../mk/bsd.pkg.mk"
5371: </pre>
5372: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5373: this is a workaround to prevent CVS expanding to the filename of the
5374: guide.</p>
5375: <p>Then, I quit the editor and watched pkgsrc downloading a large
5376: source archive:</p>
5377: <pre class="programlisting">
5378: url2pkg> Running "make makesum" ...
5379: => Required installed package digest>=20010302: digest-20060826 found
5380: => Fetching nvu-1.0-sources.tar.bz2
5381: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5382: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5383: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5384: url2pkg> Running "make extract" ...
5385: => Required installed package digest>=20010302: digest-20060826 found
5386: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5387: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5388: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5389: ===> Installing dependencies for nvu-1.0
5390: ===> Overriding tools for nvu-1.0
5391: ===> Extracting for nvu-1.0
5392: url2pkg> Adjusting the Makefile.
5393:
5394: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5395:
5396: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5397: </pre>
5398: </div>
5399: <div class="sect3">
5400: <div class="titlepage"><div><div><h4 class="title">
5401: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5402: <p>Now that the package has been extracted, let's see what's inside
5403: it. The package has a <code class="filename">README.txt</code>, but that only
5404: says something about mozilla, so it's probably useless for seeing what
5405: dependencies this package has. But since there is a GNU configure script
5406: in the package, let's hope that it will complain about everything it
5407: needs.</p>
5408: <pre class="programlisting">
5409: <code class="prompt">$</code> bmake
5410: => Required installed package digest>=20010302: digest-20060826 found
5411: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5412: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5413: ===> Patching for nvu-1.0
5414: ===> Creating toolchain wrappers for nvu-1.0
5415: ===> Configuring for nvu-1.0
5416: [...]
5417: configure: error: Perl 5.004 or higher is required.
5418: [...]
5419: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5420: [...]
5421: </pre>
5422: <p>That worked quite well. So I opened the package Makefile in my
5423: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5424: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5425: package have changed now, and since a perl wrapper is automatically
5426: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5427: from scratch.</p>
5428: <pre class="programlisting">
5429: <code class="prompt">$</code> bmake clean
5430: ===> Cleaning for nvu-1.0
5431: <code class="prompt">$</code> bmake
5432: [...]
5433: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5434: GNU Make. You will not be able to build Mozilla without GNU Make.
5435: [...]
5436: </pre>
5437: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5438: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5439: <pre class="programlisting">
5440: [...]
5441: checking for GTK - version >= 1.2.0... no
5442: *** Could not run GTK test program, checking why...
5443: [...]
5444: </pre>
5445: <p>Now to the other dependencies. The first question is: Where is the
5446: GTK package hidden in pkgsrc?</p>
5447: <pre class="programlisting">
5448: <code class="prompt">$</code> echo ../../*/gtk*
5449: [many packages ...]
5450: <code class="prompt">$</code> echo ../../*/gtk
5451: ../../x11/gtk
5452: <code class="prompt">$</code> echo ../../*/gtk2
5453: ../../x11/gtk2
5454: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5455: ../../x11/gtk2/buildlink3.mk
5456: </pre>
5457: <p>The first try was definitely too broad. The second one had exactly
5458: one result, which is very good. But there is one pitfall with GNOME
5459: packages. Before GNOME 2 had been released, there were already many
5460: GNOME 1 packages in pkgsrc. To be able to continue to use these
5461: packages, the GNOME 2 packages were imported as separate packages, and
5462: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5463: whether this was the case here, and indeed it was.</p>
5464: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5465: file, adding the dependency is very easy. I just inserted an
5466: <code class="literal">.include</code> line before the last line of the package
5467: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5468: <pre class="programlisting">
5469: [...]
5470: .include "../../x11/gtk2/buildlink3.mk"
5471: .include "../../mk/bsd.pkg.mk
5472: </pre>
5473: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5474: was:</p>
1.75 rillig 5475: <pre class="programlisting">
1.299 rillig 5476: [...]
5477: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5478: checking for GTK - version >= 1.2.0... no
5479: *** Could not run GTK test program, checking why...
5480: *** The test program failed to compile or link. See the file config.log for the
5481: *** exact error that occured. This usually means GTK was incorrectly installed
5482: *** or that you have moved GTK since it was installed. In the latter case, you
5483: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5484: configure: error: Test for GTK failed.
5485: [...]
1.222 sevan 5486: </pre>
1.299 rillig 5487: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5488: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5489: told me that this package really wanted to have the GNOME 1 version of
5490: GTK. If the package had looked for GTK2, it would have looked for
5491: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5492: So I changed the <code class="literal">x11/gtk2</code> to
5493: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5494: and tried again.</p>
1.119 mishka 5495: <pre class="programlisting">
1.299 rillig 5496: [...]
5497: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5498: In file included from xpidl.c:42:
5499: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5500: In file included from xpidl.c:42:
5501: xpidl.h:132: error: parse error before "IDL_ns"
5502: [...]
1.222 sevan 5503: </pre>
1.299 rillig 5504: <p>The package still does not find all of its dependencies. Now the
5505: question is: Which package provides the
5506: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119 mishka 5507: <pre class="programlisting">
1.299 rillig 5508: <code class="prompt">$</code> echo ../../*/*idl*
5509: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5510: <code class="prompt">$</code> echo ../../*/*IDL*
5511: ../../net/libIDL
1.222 sevan 5512: </pre>
1.299 rillig 5513: <p>Let's take the one from the second try. So I included the
5514: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5515: again. But the error didn't change. After digging through some of the
5516: code, I concluded that the build process of the package was broken and
5517: couldn't have ever worked, but since the Mozilla source tree is quite
5518: large, I didn't want to fix it. So I added the following to the package
5519: <code class="filename">Makefile</code> and tried again:</p>
1.197 wiz 5520: <pre class="programlisting">
1.299 rillig 5521: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5522: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.222 sevan 5523: </pre>
1.299 rillig 5524: <p>The latter line is needed because the package expects the library
5525: <code class="filename">libIDL.so</code>, but only
5526: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5527: wrapper to rewrite that on the fly.</p>
5528: <p>The next problem was related to a recent change of the FreeType
1.322 leot 5529: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/index.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.299 rillig 5530: which patch files were relevant for this issue and copied them to the
5531: <code class="filename">patches</code> directory. Then I retried, fixed the
5532: patches so that they applied cleanly and retried again. This time,
5533: everything worked.</p>
1.197 wiz 5534: </div>
1.299 rillig 5535: <div class="sect3">
5536: <div class="titlepage"><div><div><h4 class="title">
5537: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87 wiz 5538: <pre class="programlisting">
1.299 rillig 5539: <code class="prompt">$</code> bmake CHECK_FILES=no install
5540: [...]
5541: <code class="prompt">$</code> bmake print-PLIST >PLIST
5542: <code class="prompt">$</code> bmake deinstall
5543: <code class="prompt">$</code> bmake install
1.222 sevan 5544: </pre>
1.299 rillig 5545: </div>
5546: </div>
1.75 rillig 5547: </div>
5548: </div>
1.148 asau 5549: <div class="chapter">
1.75 rillig 5550: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 5551: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 5552: <div class="toc">
5553: <p><b>Table of Contents</b></p>
1.210 leot 5554: <dl class="toc">
1.299 rillig 5555: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5556: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5557: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5558: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5559: <dd><dl>
5560: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5561: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5562: <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>
5563: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.75 rillig 5564: </dl></dd>
5565: </dl>
5566: </div>
1.299 rillig 5567: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5568: each of which forms a well-defined part of the pkgsrc system. Using
1.322 leot 5569: the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.299 rillig 5570: like pkgsrc requires some discipline to keep the code correct and
5571: understandable.</p>
5572: <p>The basic ingredients for <code class="filename">Makefile</code>
5573: programming are variables and shell
5574: commands. Among these shell commands may even be more complex ones
1.322 leot 5575: like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/awk.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.299 rillig 5576: as intended it is necessary to quote all variables correctly when they
5577: are used.</p>
5578: <p>This chapter describes some patterns that appear quite often in
5579: <code class="filename">Makefile</code>s, including the pitfalls that come along
5580: with them.</p>
1.148 asau 5581: <div class="sect1">
1.75 rillig 5582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5583: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5584: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5585: <p>When you are creating a file as a
5586: target of a rule, always write the data to a temporary file first
5587: and finally rename that file. Otherwise there might occur an error
5588: in the middle of generating the file, and when the user runs
1.322 leot 5589: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.299 rillig 5590: regenerated properly. Example:</p>
1.75 rillig 5591: <pre class="programlisting">
1.299 rillig 5592: wrong:
5593: @echo "line 1" > ${.TARGET}
5594: @echo "line 2" >> ${.TARGET}
5595: @false
5596:
5597: correct:
5598: @echo "line 1" > ${.TARGET}.tmp
5599: @echo "line 2" >> ${.TARGET}.tmp
5600: @false
5601: @mv ${.TARGET}.tmp ${.TARGET}
1.100 rillig 5602: </pre>
1.299 rillig 5603: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5604: <code class="filename">wrong</code> will exist, although there was an error
5605: message in the first run. On the other hand, running <span class="command"><strong>make
5606: correct</strong></span> gives an error message twice, as expected.</p>
1.322 leot 5607: <p>You might remember that <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.299 rillig 5608: <code class="literal">${.TARGET}</code> in case of error, but this only
5609: happens when it is interrupted, for example by pressing
5610: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.322 leot 5611: when one of the commands fails (like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.299 rillig 5612: </li></ul></div>
5613: </div>
5614: <div class="sect1">
5615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5616: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5617: <p><code class="filename">Makefile</code> variables contain strings that
5618: can be processed using the five operators <code class="code">=</code>,
5619: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.322 leot 5620: <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.299 rillig 5621: page.</p>
5622: <p>When a variable's value is parsed from a
5623: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5624: the backslash character <code class="code">\</code> are handled specially. If a
5625: backslash is the last character in a line, that backslash is removed
5626: from the line and the line continues with the next line of the file.</p>
5627: <p>The <code class="code">#</code> character starts a comment that reaches
5628: until the end of the line. To get an actual <code class="code">#</code> character,
5629: such as in a URL, write <code class="code">\#</code> instead.</p>
5630: <p>The evaluation of variables either happens immediately or lazy.
5631: It happens immediately when the variable occurs on the right-hand
5632: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5633: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5634: In the other cases, it is evaluated lazily.</p>
5635: <p>Some of the modifiers split the string into words and then
5636: operate on the words, others operate on the string as a whole. When a
5637: string is split into words, double quotes and single quotes are
1.322 leot 5638: interpreted as delimiters, just like in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.299 rillig 5639: <div class="sect2">
5640: <div class="titlepage"><div><div><h3 class="title">
5641: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5642: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5643: <li class="listitem"><p>All variable names starting with an underscore
5644: are reserved for use by the pkgsrc infrastructure. They shall
5645: not be used by packages.</p></li>
5646: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5647: lowercase variable names for the iteration
5648: variables.</p></li>
5649: <li class="listitem"><p>All list variables should have a plural name,
5650: such as <code class="varname">PKG_OPTIONS</code> or
5651: <code class="varname">DISTFILES</code>.</p></li>
5652: </ul></div>
5653: </div>
5654: </div>
5655: <div class="sect1">
5656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5657: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5658: <div class="sect2">
5659: <div class="titlepage"><div><div><h3 class="title">
5660: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5661: <p>When adding a string that possibly contains whitespace or quotes to
5662: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5663: modifier.</p>
5664: <p>When adding another list to a list (example 2), it must not be
5665: quoted, since its elements are already quoted.</p>
1.75 rillig 5666: <pre class="programlisting">
1.299 rillig 5667: STRING= foo * bar `date`
5668: LIST= # empty
5669: ANOTHER_LIST= a=b c=d
5670:
5671: LIST+= ${STRING:Q} # 1
5672: LIST+= ${ANOTHER_LIST} # 2
1.100 rillig 5673: </pre>
1.299 rillig 5674: </div>
5675: <div class="sect2">
5676: <div class="titlepage"><div><div><h3 class="title">
5677: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5678: <p>Echoing a string containing special characters needs special
5679: work.</p>
1.75 rillig 5680: <pre class="programlisting">
1.299 rillig 5681: STRING= foo bar < > * `date` $$HOME ' "
5682: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5683:
5684: all:
5685: echo ${STRING} # 1
5686: echo ${STRING:Q} # 2
5687: printf '%s\n' ${STRING:Q}'' # 3
5688: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.100 rillig 5689: </pre>
1.299 rillig 5690: <p>Example 1 leads to a syntax error in the shell, as the characters
5691: are just copied.</p>
5692: <p>Example 2 quotes the string so that the shell interprets it
5693: correctly. But the echo command may additionally interpret strings with a
5694: leading dash or those containing backslashes.</p>
1.322 leot 5695: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.299 rillig 5696: interprets the format string, but not the next argument. The trailing
5697: single quotes handle the case when the string is empty. In that case, the
5698: :Q modifier would result in an empty string too, which would then be
1.322 leot 5699: skipped by the shell. For <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.299 rillig 5700: but other programs may care.</p>
5701: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5702: need to be quoted because the quoting has already been done
5703: when adding elements to the list.</p>
1.75 rillig 5704: </div>
1.148 asau 5705: <div class="sect2">
1.75 rillig 5706: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 5707: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5708: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5709: GNU-style configure script (especially those that call other configure
5710: scripts), it must not have leading or trailing whitespace, since
5711: otherwise the configure script gets confused. To trim leading and
5712: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5713: following example:</p>
1.75 rillig 5714: <pre class="programlisting">
1.299 rillig 5715: CPPFLAGS= # empty
5716: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5717: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 grant 5718:
1.299 rillig 5719: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 grant 5720:
1.299 rillig 5721: all:
5722: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5723: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5724: </pre>
5725: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5726: trailing whitespace because the <code class="code">+=</code> operator always adds a
5727: space.</p>
5728: </div>
5729: <div class="sect2">
5730: <div class="titlepage"><div><div><h3 class="title">
5731: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5732: <p>When a possibly empty variable is used in a shell program, it may
5733: lead to a syntax error.</p>
5734: <pre class="programlisting">
5735: EGFILES= # empty
1.87 wiz 5736:
1.299 rillig 5737: install-examples: # produces a syntax error in the shell
5738: for egfile in ${EGFILES}; do \
5739: echo "Installing $$egfile"; \
5740: done
5741: </pre>
5742: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.322 leot 5743: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.299 rillig 5744: To fix this syntax error, use one of the snippets below.</p>
5745: <pre class="programlisting">
5746: EMPTY= # empty
1.87 wiz 5747:
1.299 rillig 5748: install-examples:
5749: for egfile in ${EGFILES} ""; do \
5750: [ -n "$$egfile" ] || continue; \
5751: echo "Installing $$egfile"; \
5752: done
5753: </pre>
5754: <p>In this case, an empty string is appended to the iteration list (to
5755: prevent the syntax error) and filtered out later.</p>
5756: <pre class="programlisting">
5757: EGFILES= # empty
1.87 wiz 5758:
1.299 rillig 5759: install-examples:
5760: .for egfile in ${EGFILES}
5761: echo "Installing ${egfile}"
5762: .endfor
1.100 rillig 5763: </pre>
1.299 rillig 5764: <p>If one of the filenames contains special characters, it should be
5765: enclosed in single or double quotes.</p>
5766: <p>To have a shell command test whether a make variable is empty, use
5767: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5768: </div>
5769: </div>
5770: </div>
5771: <div class="chapter">
5772: <div class="titlepage"><div><div><h2 class="title">
5773: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5774: <div class="toc">
5775: <p><b>Table of Contents</b></p>
5776: <dl class="toc">
5777: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5778: <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>
5779: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5780: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5781: </dl>
1.75 rillig 5782: </div>
1.299 rillig 5783: <p>Many packages have the ability to be built to support different
5784: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5785: in pkgsrc that provides generic handling of those options that
5786: determine different ways in which the packages can be built. It's
5787: possible for the user to specify exactly which sets of options will be
5788: built into a package or to allow a set of global default options
5789: apply.</p>
5790: <p>There are two broad classes of behaviors that one might want to
5791: control via options. One is whether some particular feature is
5792: enabled in a program that will be built anyway, often by including or
5793: not including a dependency on some other package. The other is
5794: whether or not an additional program will be built as part of the
5795: package. Generally, it is better to make a split package for such
5796: additional programs instead of using options, because it enables
5797: binary packages to be built which can then be added separately. For
5798: example, the foo package might have minimal dependencies (those
5799: packages without which foo doesn't make sense), and then the foo-gfoo
5800: package might include the GTK frontend program gfoo. This is better
5801: than including a gtk option to foo that adds gfoo, because either that
5802: option is default, in which case binary users can't get foo without
5803: gfoo, or not default, in which case they can't get gfoo. With split
5804: packages, they can install foo without having GTK, and later decide to
5805: install gfoo (pulling in GTK at that time). This is an advantage to
5806: source users too, avoiding the need for rebuilds.</p>
5807: <p>Plugins with widely varying dependencies should usually be split
5808: instead of options.</p>
5809: <p>It is often more work to maintain split packages, especially if
5810: the upstream package does not support this. The decision of split
5811: vs. option should be made based on the likelihood that users will want
5812: or object to the various pieces, the size of the dependencies that are
5813: included, and the amount of work.</p>
5814: <p>A further consideration is licensing. Non-free parts, or parts
5815: that depend on non-free dependencies (especially plugins) should
5816: almost always be split if feasible.</p>
5817: <div class="sect1">
5818: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5819: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5820: <p>Global default options are listed in
5821: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5822: that should be built into every package if that option is supported.
5823: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 5824: </div>
1.148 asau 5825: <div class="sect1">
1.75 rillig 5826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 5827: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5828: </h2></div></div></div>
5829: <p>The following example shows how
5830: <code class="filename">bsd.options.mk</code> should be used
5831: by the hypothetical ``wibble'' package, either in the package
5832: <code class="filename">Makefile</code>, or in a file,
5833: e.g. <code class="filename">options.mk</code>, that is included by the
5834: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 5835: <pre class="programlisting">
1.299 rillig 5836: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5837: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5838: PKG_OPTIONS_OPTIONAL_GROUPS= database
5839: PKG_OPTIONS_GROUP.database= mysql pgsql
5840: PKG_SUGGESTED_OPTIONS= wibble-foo
5841: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5842: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5843:
5844: .include "../../mk/bsd.prefs.mk"
5845:
5846: # this package was previously named wibble2
5847: .if defined(PKG_OPTIONS.wibble2)
5848: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5849: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5850: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5851: .endif
5852:
5853: .include "../../mk/bsd.options.mk"
5854:
5855: # Package-specific option-handling
1.100 rillig 5856:
1.299 rillig 5857: ###
5858: ### FOO support
5859: ###
5860: .if !empty(PKG_OPTIONS:Mwibble-foo)
5861: CONFIGURE_ARGS+= --enable-foo
5862: .endif
1.100 rillig 5863:
1.299 rillig 5864: ###
5865: ### LDAP support
5866: ###
5867: .if !empty(PKG_OPTIONS:Mldap)
5868: . include "../../databases/openldap-client/buildlink3.mk"
5869: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5870: .endif
1.100 rillig 5871:
1.299 rillig 5872: ###
5873: ### database support
5874: ###
5875: .if !empty(PKG_OPTIONS:Mmysql)
5876: . include "../../mk/mysql.buildlink3.mk"
5877: .endif
5878: .if !empty(PKG_OPTIONS:Mpgsql)
5879: . include "../../mk/pgsql.buildlink3.mk"
5880: .endif
5881: </pre>
5882: <p>The first section contains the information about which build
5883: options are supported by the package, and any default options settings
5884: if needed.</p>
5885: <div class="orderedlist"><ol class="orderedlist" type="1">
5886: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.322 leot 5887: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.299 rillig 5888: options. It should be set to
5889: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5890: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5891: at the point where the options are processed.</p></li>
5892: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
5893: build options supported by the package.</p></li>
5894: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
5895: list of names of groups of mutually exclusive options. The options in
5896: each group are listed in
5897: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5898: The most specific setting of any option from the group takes
5899: precedence over all other options in the group. Options from the
5900: groups will be automatically added to
5901: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
5902: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
5903: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5904: packages will fail if no option from the group is
5905: selected.</p></li>
5906: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
5907: of names of sets of options. At least one option from each set must
5908: be selected. The options in each set are listed in
5909: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5910: Options from the sets will be automatically added to
5911: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5912: fail if no option from the set is selected.</p></li>
5913: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
5914: build options which are enabled by default.</p></li>
5915: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
5916: of
5917: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
5918: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
5919: their option counterparts. Pairs should be added with
5920: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
5921: warning will be issued if the user uses a legacy
5922: variable.</p></li>
5923: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
5924: of
5925: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
5926: pairs that map options that have been renamed to their new
5927: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
5928: the listing of global legacy options. A warning will be issued if
5929: the user uses a legacy option.</p></li>
5930: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
5931: options implied by deprecated variables used. This can be used for
5932: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5933: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5934: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
5935: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
5936: a list of warnings about deprecated variables or options used, and
5937: what to use instead.</p></li>
5938: </ol></div>
5939: <p>A package should never modify
5940: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5941: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5942: To suggest a default set of options, use
5943: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5944: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5945: including <code class="filename">bsd.options.mk</code>. If none of
5946: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5947: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5948: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5949: happen with platform-specific options if none of them is supported on
5950: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5951: empty list and the package is otherwise treated as not using the
5952: options framework.</p>
5953: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5954: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5955: build options, properly filtered to remove unsupported and duplicate
5956: options.</p>
5957: <p>The remaining sections contain the logic that is specific to
5958: each option. The correct way to check for an option is to check
5959: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5960: <pre class="programlisting">
5961: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100 rillig 5962: </pre>
1.75 rillig 5963: </div>
1.299 rillig 5964: <div class="sect1">
5965: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5966: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
5967: <p>Options that enable similar features in different packages (like
5968: optional support for a library) should use a common name in all
5969: packages that support it (like the name of the library). If another
5970: package already has an option with the same meaning, use the same
5971: name.</p>
5972: <p>Options that enable features specific to one package, where it's
5973: unlikely that another (unrelated) package has the same (or a similar)
5974: optional feature, should use a name prefixed with
5975: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5976: <p>If a group of related packages share an optional feature
5977: specific to that group, prefix it with the name of the
5978: <span class="quote">“<span class="quote">main</span>”</span> package
5979: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5980: <p>For new options, add a line to
5981: <code class="filename">mk/defaults/options.description</code>. Lines have two
5982: fields, separated by tab. The first field is the option name, the
5983: second its description. The description should be a whole sentence
5984: (starting with an uppercase letter and ending with a period) that
5985: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5986: support.</span>”</span> The file is sorted by option names.</p>
5987: </div>
5988: <div class="sect1">
5989: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5990: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
5991: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
5992: different dependencies based on the options with which the package was
5993: built. For querying these options, the file
5994: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5995: typical example looks like this:</p>
1.87 wiz 5996: <pre class="programlisting">
1.299 rillig 5997: pkgbase := libpurple
5998: .include "../../mk/pkg-build-options.mk"
5999:
6000: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6001: ...
6002: .endif
1.229 sevan 6003: </pre>
1.299 rillig 6004: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6005: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6006: options of the libpurple package, which can then be queried like
6007: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6008: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6009: details.</p>
1.75 rillig 6010: </div>
6011: </div>
1.148 asau 6012: <div class="chapter">
1.75 rillig 6013: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 6014: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 6015: <div class="toc">
6016: <p><b>Table of Contents</b></p>
1.210 leot 6017: <dl class="toc">
1.299 rillig 6018: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
6019: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
6020: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75 rillig 6021: </dl>
6022: </div>
1.299 rillig 6023: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6024: by pkgsrc and also for individual packages to define what commands
6025: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6026: or for later run-time of an installed packaged (such as
6027: <code class="varname">DEPENDS</code>).
6028: If the native system provides an adequate tool, then in many cases, a pkgsrc
6029: package will not be used.</p>
6030: <p>When building a package, the replacement tools are
6031: made available in a directory (as symlinks or wrapper scripts)
6032: that is early in the executable search path. Just like the buildlink
6033: system, this helps with consistent builds.</p>
6034: <p>A tool may be needed to help build a specific package. For example,
6035: perl, GNU make (gmake) or yacc may be needed.</p>
6036: <p>Also a tool may be needed, for example, because the native system's supplied
6037: tool may be inefficient for building a package with pkgsrc.
6038: For example, a package may need GNU awk, bison (instead of
6039: yacc) or a better sed.</p>
6040: <p>The tools used by a package can be listed by running
6041: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 6042: <div class="sect1">
1.75 rillig 6043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6044: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6045: <p>The default set of tools used by pkgsrc is defined in
6046: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6047: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6048: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6049: These can be seen by running:
6050: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6051: <p>If a package needs a specific program to build
6052: then the <code class="varname">USE_TOOLS</code> variable can be used
6053: to define the tools needed.</p>
1.75 rillig 6054: </div>
1.299 rillig 6055: <div class="sect1">
6056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6057: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6058: <p>In the following examples, the :run means that it is needed at
6059: run-time (and becomes a DEPENDS).
6060: The default is a build dependency which can be set with
6061: :build. (So in this example, it is the same as gmake:build
6062: and pkg-config:build.)</p>
1.75 rillig 6063: <pre class="programlisting">
1.299 rillig 6064: USE_TOOLS+= gmake perl:run pkg-config
1.1 grant 6065: </pre>
1.299 rillig 6066: <p>When using the tools framework, a
6067: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6068: which contains the full path to the appropriate tool. For example,
6069: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6070: on Linux systems.</p>
6071: <p>If you always need a pkgsrc version of the
6072: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6073: </p>
1.75 rillig 6074: </div>
1.299 rillig 6075: <div class="sect1">
6076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6077: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6078: <p>When improving or porting pkgsrc to a new platform, have a look
6079: at (or create) the corresponding platform specific make file fragment under
6080: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6081: the name of the common tools. For example:</p>
1.75 rillig 6082: <pre class="programlisting">
1.299 rillig 6083: .if exists(/usr/bin/bzcat)
6084: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6085: .elif exists(/usr/bin/bzip2)
6086: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6087: .endif
6088:
6089: TOOLS_PLATFORM.true?= true # shell builtin
1.1 grant 6090: </pre>
1.75 rillig 6091: </div>
6092: </div>
1.299 rillig 6093: <div class="chapter">
6094: <div class="titlepage"><div><div><h2 class="title">
6095: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6096: <div class="toc">
6097: <p><b>Table of Contents</b></p>
6098: <dl class="toc">
6099: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6100: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6101: <dd><dl>
6102: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6103: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6104: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6105: and
6106: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6107: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6108: </dl></dd>
6109: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
6110: <dd><dl>
6111: <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>
6112: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
6113: </dl></dd>
6114: </dl>
1.75 rillig 6115: </div>
1.299 rillig 6116: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6117: are seen by a package's configure and build processes. This is implemented
6118: in a two step process:</p>
6119: <div class="orderedlist"><ol class="orderedlist" type="1">
6120: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6121: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6122: of <code class="varname">WRKDIR</code>.</p></li>
6123: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6124: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6125: <code class="option">-L${LOCALBASE}/lib</code> into references to
6126: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6127: native compiler on some operating systems look like GCC, so that
6128: packages that expect GCC won't require modifications to build with
6129: those native compilers.</p></li>
6130: </ol></div>
6131: <p>This normalizes the environment in which a package is built so that the
6132: package may be built consistently despite what other software may be
6133: installed. Please note that the normal system header and library paths,
6134: e.g. <code class="filename">/usr/include</code>,
6135: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6136: designed to insulate the package build from non-system-supplied
6137: software.</p>
1.148 asau 6138: <div class="sect1">
1.75 rillig 6139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6140: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6141: <p>The process of converting packages to use the buildlink3
6142: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6143: The things to keep in mind are:</p>
1.128 wiz 6144: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299 rillig 6145: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6146: instead of the actual toolchain. Some packages are tricky,
6147: and the only way to know for sure is the check
6148: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6149: wrappers are being invoked.</p></li>
6150: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6151: the package Makefile, e.g. Java VMs, standalone shells,
6152: etc., because the code to symlink files into
6153: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6154: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6155: </p></li>
6156: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6157: <code class="filename">buildlink3.mk</code> files that you list in a
6158: package's Makefile are added as dependencies for that package.
6159: </p></li>
6160: </ol></div>
6161: <p>If a dependency on a particular package is required for its libraries and
6162: headers, then we replace:</p>
6163: <pre class="programlisting">
6164: DEPENDS+= foo>=1.1.0:../../category/foo
6165: </pre>
6166: <p>with</p>
6167: <pre class="programlisting">
6168: .include "../../category/foo/buildlink3.mk"
6169: </pre>
6170: <p>The buildlink3.mk files usually define the required dependencies.
6171: If you need a newer version of the dependency when using buildlink3.mk
6172: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 6173: <pre class="programlisting">
1.299 rillig 6174: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6175: .include "../../category/foo/buildlink3.mk"
1.1 grant 6176: </pre>
1.299 rillig 6177: <p>There are several <code class="filename">buildlink3.mk</code>
6178: files in <code class="filename">pkgsrc/mk</code>
6179: that handle special package issues:</p>
6180: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6181: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6182: the native or a pkgsrc Berkeley DB implementation based on
6183: the values of <code class="varname">BDB_ACCEPTED</code> and
6184: <code class="varname">BDB_DEFAULT</code>.</p></li>
6185: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6186: comes with neither Curses nor NCurses, this will take care
1.322 leot 6187: to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/index.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.299 rillig 6188: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6189: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6190: adding a dependency on Heimdal or MIT-krb5 for packages that
6191: require a Kerberos 5 implementation.</p></li>
6192: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6193: system-provided Motif installation or adds a dependency on
1.322 leot 6194: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/index.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/index.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.299 rillig 6195: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6196: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6197: to choose which Motif version will be used.</p></li>
6198: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6199: system-provided GNU readline or editline (libedit) installation,
1.322 leot 6200: or adds a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/index.html" target="_top"><code class="filename">devel/readline</code></a>,
6201: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/index.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.299 rillig 6202: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6203: If your package really needs GNU readline library, its Makefile
6204: should include <code class="filename">devel/readline/buildlink3.mk</code>
6205: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6206: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6207: variables that may be used by packages that use the
6208: Open Sound System (OSS) API.</p></li>
6209: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6210: any of the Postgres versions in the variable
6211: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6212: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6213: the file for more information.</p></li>
6214: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6215: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.322 leot 6216: a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/index.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.299 rillig 6217: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6218: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6219: library.</p></li>
6220: </ul></div>
6221: <p>The comments in those <code class="filename">buildlink3.mk</code>
6222: files provide a more complete
6223: description of how to use them properly.</p>
1.75 rillig 6224: </div>
1.148 asau 6225: <div class="sect1">
1.75 rillig 6226: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6227: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6228: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6229: included by Makefiles to indicate the need to compile and link
6230: against header files and libraries provided by the package. A
6231: <code class="filename">buildlink3.mk</code> file should always provide
6232: enough information to add the correct type of dependency
6233: relationship and include any other
6234: <code class="filename">buildlink3.mk</code> files that it needs to find
6235: headers and libraries that it needs in turn.</p>
6236: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.322 leot 6237: file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/index.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.299 rillig 6238: package is highly recommended. For most packages, the following
6239: command will generate a good starting point for
6240: <code class="filename">buildlink3.mk</code> files:</p>
6241: <pre class="screen">
6242: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6243: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6244: </pre>
1.148 asau 6245: <div class="sect2">
1.75 rillig 6246: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6247: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6248: <p>The following real-life example
6249: <code class="filename">buildlink3.mk</code> is taken
6250: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 6251: <pre class="programlisting">
1.299 rillig 6252: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
6253:
6254: BUILDLINK_TREE+= tiff
6255:
6256: .if !defined(TIFF_BUILDLINK3_MK)
6257: TIFF_BUILDLINK3_MK:=
6258:
6259: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6260: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6261: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6262:
6263: .include "../../devel/zlib/buildlink3.mk"
6264: .include "../../graphics/jpeg/buildlink3.mk"
6265: .endif # TIFF_BUILDLINK3_MK
6266:
6267: BUILDLINK_TREE+= -tiff
1.1 grant 6268: </pre>
1.299 rillig 6269: <p>The header and footer manipulate
6270: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6271: <code class="filename">buildlink3.mk</code> files and is used to track
6272: the dependency tree.</p>
6273: <p>The main section is protected from multiple inclusion
6274: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6275: added. Several important variables are set in the section:</p>
6276: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6277: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6278: is the dependency version recorded in the installed
1.299 rillig 6279: package; this should always be set using
6280: <span class="command"><strong>+=</strong></span> to ensure that
6281: we're appending to any pre-existing list of values. This
1.300 wiz 6282: variable should be set to the last version of the
1.299 rillig 6283: package that had an backwards-incompatible API change.
6284: </p></li>
6285: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6286: is the location of the <em class="replaceable"><code>pkg</code></em>
6287: pkgsrc directory.</p></li>
6288: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6289: (not shown above) controls whether we use
6290: <code class="varname">BUILD_DEPENDS</code> or
6291: <code class="varname">DEPENDS</code> to add the dependency on
6292: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6293: selected by setting
6294: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6295: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
6296: used.</p></li>
6297: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6298: and
6299: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6300: (not shown above) are lists of subdirectories of
6301: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6302: to add to the header and library search paths. These
6303: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6304: respectively.</p></li>
6305: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6306: (not shown above) is the list of preprocessor flags to add
6307: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6308: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6309: should be avoided and instead be handled using
6310: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6311: above.</p></li>
6312: </ul></div>
6313: <p>The following variables are all optionally defined within
6314: this second section (protected against multiple inclusion) and
6315: control which package files are symlinked into
6316: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6317: transformed during the symlinking:</p>
6318: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6319: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6320: (not shown above) is a shell glob pattern relative to
6321: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6322: to be symlinked into
6323: <code class="filename">${BUILDLINK_DIR}</code>,
6324: e.g. <code class="filename">include/*.h</code>.</p></li>
6325: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6326: (not shown above) is a shell pipeline that
6327: outputs to stdout a list of files relative to
6328: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6329: The resulting files are to be symlinked
6330: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6331: this takes the <code class="filename">+CONTENTS</code> of a
6332: <em class="replaceable"><code>pkg</code></em> and filters it through
6333: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6334: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6335: (not shown above) is a filter command that filters
6336: <code class="filename">+CONTENTS</code> input into a list of files
6337: relative to
6338: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6339: on stdout. By default,
6340: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6341: outputs the contents of the <code class="filename">include</code>
6342: and <code class="filename">lib</code> directories in the package
6343: <code class="filename">+CONTENTS</code>.</p></li>
6344: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6345: (not shown above) is a list of sed arguments used to
6346: transform the name of the source filename into a
6347: destination filename, e.g. <span class="command"><strong>-e
6348: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6349: </ul></div>
6350: <p>This section can additionally include any
6351: <code class="filename">buildlink3.mk</code> needed for
6352: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6353: Including these <code class="filename">buildlink3.mk</code> files
6354: means that the headers and libraries for these
6355: dependencies are also symlinked into
6356: <code class="filename">${BUILDLINK_DIR}</code>
6357: whenever the <em class="replaceable"><code>pkg</code></em>
6358: <code class="filename">buildlink3.mk</code>
6359: file is included. Dependencies are only added for directly
6360: include <code class="filename">buildlink3.mk</code> files.</p>
6361: <p>When providing a <code class="filename">buildlink3.mk</code> and
6362: including other <code class="filename">buildlink3.mk</code> files in it,
6363: please only add necessary ones, i.e., those whose libraries or
6364: header files are automatically exposed when the package is
6365: use.</p>
6366: <p>In particular, if only an executable
6367: (<code class="filename">bin/foo</code>) is linked against a library, that
6368: library does not need to be propagated in the
6369: <code class="filename">buildlink3.mk</code> file.</p>
6370: <p>The following steps should help you decide if a
6371: <code class="filename">buildlink3.mk</code> file needs to be included:
6372: </p>
6373: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6374: <li class="listitem"><p>Look at the installed header files: What
6375: headers do they include? The packages providing these files
6376: must be buildlinked.</p></li>
6377: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6378: libraries and look against what other libraries they link.
6379: Some of the packages providing these probably need to be
6380: buildlinked; however, it's not automatic, since e.g. GTK on
6381: some systems pulls in the X libraries, so they will show up in
6382: the <code class="filename">ldd</code> output, while on others (like OS
6383: X) it won't. <code class="filename">ldd</code> output can thus only be
6384: used as a hint.</p></li>
6385: </ul></div>
6386: <p>
6387: </p>
6388: </div>
1.148 asau 6389: <div class="sect2">
1.75 rillig 6390: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 6391: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6392: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6393: and
6394: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6395: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300 wiz 6396: <p>Both variables set lower bounds for a version of this package.
6397: The two variables differ in that one describes source
1.299 rillig 6398: compatibility (API) and the other binary compatibility (ABI).
6399: The difference is that a change in the API breaks compilation of
6400: programs while changes in the ABI stop compiled programs from
6401: running.</p>
1.300 wiz 6402: <p>The
6403: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6404: variable in a <code class="filename">buildlink3.mk</code> should be
6405: changed very rarely. (One possible scenario: If all packages
6406: using this package need a higher version than defined in the
6407: <code class="filename">buildlink3.mk</code>,
1.299 rillig 6408: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6409: could be updated to that higher version.)</p>
6410: <p>On the other hand, changes to
1.299 rillig 6411: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6412: are more common. The variable will need to be updated every
6413: time the major version of one of its shared libraries is changed,
6414: or any other change where a binary built against the previous
6415: version of the package will not run against the new version any
6416: longer.</p>
6417: <p>In such a case, the package's
1.299 rillig 6418: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6419: must be increased to require the new package version. Then the
6420: <code class="varname">PKGREVISION</code> of all packages
6421: <em class="replaceable"><code>foo</code></em> that depend on this package need
6422: to be increased, and if they have
6423: <code class="filename">buildlink3.mk</code> files,
6424: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6425: in their <code class="filename">buildlink3.mk</code> files must be
6426: increased to the new version as well. This is required so that a
6427: package will pull in the versions of the packages that use the
6428: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6429: uniquely identify the packages built against the new ABI. The
1.322 leot 6430: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/revbump/index.html" target="_top"><code class="filename">pkgtools/revbump</code></a> package can
1.300 wiz 6431: help with these updates.</p>
6432: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6433: about dependencies on other packages, including the
6434: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299 rillig 6435: <p>Please take careful consideration before adjusting
6436: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6437: or
6438: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300 wiz 6439: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6440: cause unneeded package deletions and rebuilds. In many cases,
6441: new versions of packages work just fine with older
6442: dependencies.</p>
1.326 gutterid 6443: <p>Also, it is not needed to set
1.299 rillig 6444: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6445: when it is identical to
1.326 gutterid 6446: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
6447: <p>Note there is also the distinction that users are able to disable
6448: enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
6449: variable, but there is no equivalent option for API dependencies.</p>
1.75 rillig 6450: </div>
6451: </div>
1.148 asau 6452: <div class="sect1">
1.75 rillig 6453: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6454: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6455: <p>Some packages in pkgsrc install headers and libraries that
6456: coincide with headers and libraries present in the base system.
6457: Aside from a <code class="filename">buildlink3.mk</code> file, these
6458: packages should also include a <code class="filename">builtin.mk</code>
6459: file that includes the necessary checks to decide whether using
6460: the built-in software or the pkgsrc software is
6461: appropriate.</p>
6462: <p>The only requirements of a builtin.mk file for
6463: <em class="replaceable"><code>pkg</code></em> are:</p>
6464: <div class="orderedlist"><ol class="orderedlist" type="1">
6465: <li class="listitem"><p>It should set
6466: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6467: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6468: after it is included.</p></li>
6469: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6470: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6471: which is already set before the
6472: <code class="filename">builtin.mk</code> file is included.</p></li>
6473: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6474: is <span class="emphasis"><em>very</em></span> important and takes careful
6475: attention to <code class="filename">Makefile</code> coding.</p></li>
6476: </ol></div>
6477: <div class="sect2">
6478: <div class="titlepage"><div><div><h3 class="title">
6479: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6480: <p>The following is the recommended template for builtin.mk
6481: files:</p>
1.75 rillig 6482: <pre class="programlisting">
1.299 rillig 6483: .if !defined(IS_BUILTIN.foo)
6484: #
6485: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6486: # genuinely exists in the system or not.
6487: #
6488: IS_BUILTIN.foo?= no
1.100 rillig 6489:
1.299 rillig 6490: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6491: # version can be determined.
6492: #
6493: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6494: BUILTIN_PKG.foo?= foo-1.0
6495: . endif
6496: .endif # IS_BUILTIN.foo
1.100 rillig 6497:
1.299 rillig 6498: .if !defined(USE_BUILTIN.foo)
6499: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6500: . if defined(BUILTIN_PKG.foo)
6501: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6502: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6503: USE_BUILTIN.foo!= \
6504: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6505: && ${ECHO} "yes" || ${ECHO} "no"
6506: . endif
6507: . endfor
6508: . endif
6509: .endif # USE_BUILTIN.foo
1.100 rillig 6510:
1.299 rillig 6511: CHECK_BUILTIN.foo?= no
6512: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6513: #
6514: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6515: # "yes" or "no".
6516: #
6517: .endif # CHECK_BUILTIN.foo
1.75 rillig 6518: </pre>
1.299 rillig 6519: <p>The first section sets
6520: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6521: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6522: in the base system. This should not be a base system software
6523: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6524: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6525: included as part of the base system. This variable is only
6526: used internally within the <code class="filename">builtin.mk</code>
6527: file.</p>
6528: <p>The second section sets
6529: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6530: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6531: system if it exists (if
6532: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6533: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6534: within the <code class="filename">builtin.mk</code> file.</p>
6535: <p>The third section sets
6536: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6537: and is <span class="emphasis"><em>required</em></span> in all
6538: <code class="filename">builtin.mk</code> files. The code in this
6539: section must make the determination whether the built-in
6540: software is adequate to satisfy the dependencies listed in
6541: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6542: This is typically done by comparing
6543: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6544: against each of the dependencies in
6545: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6546: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6547: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6548: end of the <code class="filename">builtin.mk</code> file. Note that
6549: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6550: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6551: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6552: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6553: that the built-in version of the software is similar enough to
6554: be used as a replacement.</p>
6555: <p>The last section is guarded by
6556: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6557: and includes code that uses the value of
6558: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6559: set in the previous section. This typically includes, e.g.,
6560: adding additional dependency restrictions and listing additional
6561: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6562: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6563: </div>
6564: <div class="sect2">
6565: <div class="titlepage"><div><div><h3 class="title">
6566: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
6567: <p>When building packages, it's possible to choose whether to set
6568: a global preference for using either the built-in (native)
6569: version or the pkgsrc version of software to satisfy a
6570: dependency. This is controlled by setting
6571: <code class="varname">PREFER_PKGSRC</code> and
6572: <code class="varname">PREFER_NATIVE</code>. These variables take values
6573: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
6574: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
6575: use the pkgsrc versions of software, while
6576: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
6577: built-in versions. Preferences are determined by the most
6578: specific instance of the package in either
6579: <code class="varname">PREFER_PKGSRC</code> or
6580: <code class="varname">PREFER_NATIVE</code>. If a package is specified
6581: in neither or in both variables, then
6582: <code class="varname">PREFER_PKGSRC</code> has precedence over
6583: <code class="varname">PREFER_NATIVE</code>. For example, to require
6584: using pkgsrc versions of software for all but the most basic
6585: bits on a NetBSD system, you can set:</p>
1.75 rillig 6586: <pre class="programlisting">
1.299 rillig 6587: PREFER_PKGSRC= yes
6588: PREFER_NATIVE= getopt skey tcp_wrappers
6589: </pre>
6590: <p>A package <span class="emphasis"><em>must</em></span> have a
6591: <code class="filename">builtin.mk</code>
6592: file to be listed in <code class="varname">PREFER_NATIVE</code>,
6593: otherwise it is simply ignored in that list.</p>
1.305 bacon 6594: <p><code class="varname">PREFER_PKGSRC</code> and
6595: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
6596: to ensure that the bootstrap process does not use inapropriate
6597: native tools as dependencies for core packages.
6598:
6599: </p>
6600: <pre class="screen">
6601: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
6602: </pre>
6603: <p>
6604:
1.299 rillig 6605: Switching between settings globally at a later date can introduce
6606: complications with dependency resolution. This is caused by packages
1.305 bacon 6607: built with the opposite preference being installed alongside each
6608: other. Hence, any changes to these variables after bootstrap will
6609: necessitate rebuilding all packages depending on one whose preference
6610: has been changed. This is not trivial and should be avoided.</p>
6611: <p>When using pkgsrc on Linux systems, there is high risk of
6612: "leakage", where programs installed by pkgsrc may inadvertently use a
6613: command or library not installed by pkgsrc, e.g. those installed by
6614: yum or apt. Such foreign dependencies may be installed, removed, or
6615: upgraded to a version incompatible with the pkgsrc package at any
6616: time, causing pkgsrc packages to subsequently malfunction. Pkgsrc
6617: cannot prevent this, as it has no control over other package managers.
6618: Another potential problem is that under Redhat Enterprise and related
6619: Linux systems, yum packages are only patched and never upgraded, so
6620: eventually they may become too outdated for use by pkgsrc. Even
6621: intentionally using foreign dependencies, not considered leakage, can
6622: lead to these problems, so it is generally discouraged. In order to
6623: minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
6624: This ensures that pkgsrc is aware of any changes to dependency packages
6625: and can rebuild or upgrade the entire dependency tree as needed. This
6626: default can be overridden by setting --prefer-pkgsrc to "no" or a list of
6627: packages, or by setting --prefer-native to "yes".</p>
1.75 rillig 6628: </div>
1.107 rillig 6629: </div>
1.75 rillig 6630: </div>
1.148 asau 6631: <div class="chapter">
1.75 rillig 6632: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 6633: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75 rillig 6634: <div class="toc">
6635: <p><b>Table of Contents</b></p>
1.210 leot 6636: <dl class="toc">
1.299 rillig 6637: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6638: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6639: <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>
6640: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6641: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6642: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6643: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6644: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6645: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75 rillig 6646: </dl>
6647: </div>
1.299 rillig 6648: <p>The <code class="filename">PLIST</code> file contains a package's
6649: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6650: the package (relative to the <code class="filename">${PREFIX}</code>
6651: directory it's been installed in) plus some additional statements
1.322 leot 6652: - see the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.299 rillig 6653: This chapter addresses some issues that need attention when
6654: dealing with the <code class="filename">PLIST</code> file (or files, see
6655: below!).</p>
1.148 asau 6656: <div class="sect1">
1.75 rillig 6657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6658: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6659: <p>Be sure to add a RCS ID line as the first thing in any
6660: <code class="filename">PLIST</code> file you write:</p>
6661: <pre class="programlisting">
6662: @comment $NetBSD $
6663: </pre>
6664: <p>An artificial space has been added between NetBSD and $, this is a
6665: workaround here to prevent CVS expanding to the filename of the guide. When
6666: adding the RCS ID the space should be omitted.</p>
1.75 rillig 6667: </div>
1.148 asau 6668: <div class="sect1">
1.75 rillig 6669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6670: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6671: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6672: to output a PLIST that matches any new files since the package
6673: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6674: more information on this target.</p>
1.75 rillig 6675: </div>
1.148 asau 6676: <div class="sect1">
1.75 rillig 6677: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6678: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6679: </h2></div></div></div>
6680: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6681: of AWK patterns and actions that are used to filter the output of
6682: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6683: scripting you like to it, but be careful with quoting.</p>
6684: <p>For example, to get all files inside the
6685: <code class="filename">libdata/foo</code> directory removed from the
6686: resulting PLIST:</p>
1.88 wiz 6687: <pre class="programlisting">
1.299 rillig 6688: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.100 rillig 6689: </pre>
1.300 wiz 6690: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6691: evaluated after the file list and directory list are sorted.
6692: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6693: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6694: list and directory list are sorted.</p>
1.299 rillig 6695: </div>
6696: <div class="sect1">
6697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6698: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6699: <p>A number of variables are substituted automatically in
6700: PLISTs when a package is installed on a system. This includes the
6701: following variables:</p>
6702: <div class="variablelist"><dl class="variablelist">
6703: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6704: <dd>
6705: <p>Some packages like emacs and perl embed information
6706: about which architecture they were built on into the
6707: pathnames where they install their files. To handle this
6708: case, PLIST will be preprocessed before actually used, and
6709: the symbol
6710: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6711: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6712: same is done if the string
6713: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6714: PLIST somewhere - use this on packages that have GNU
6715: autoconf-created configure scripts.</p>
6716: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6717: <h3 class="title">Legacy note</h3>
6718: <p>There used to be a symbol
6719: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6720: was replaced by the output of <span class="command"><strong>uname
6721: -m</strong></span>, but that's no longer supported and has
6722: been removed.</p>
6723: </div>
6724: </dd>
6725: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6726: <dd>
6727: <p>Some packages want to embed the OS name and version
6728: into some paths. To do this, use these variables in the
6729: <code class="filename">PLIST</code>:
6730: </p>
6731: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6732: <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>
6733: <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>
6734: <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>
6735: </ul></div>
6736: </dd>
6737: </dl></div>
6738: <p>For a list of values which are replaced by
6739: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6740: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6741: <code class="varname">PLIST_SUBST</code> should help.</p>
6742: <p>If you want to change other variables not listed above, you
6743: can add variables and their expansions to this variable in the
6744: 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 6745: <pre class="programlisting">
1.299 rillig 6746: PLIST_SUBST+= SOMEVAR="somevalue"
1.100 rillig 6747: </pre>
1.299 rillig 6748: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6749: in the <code class="filename">PLIST</code> with
6750: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6751: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6752: the common case of conditionally including some
6753: <code class="filename">PLIST</code> entries. It can be done by adding
6754: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6755: setting the corresponding <code class="varname">PLIST.foo</code> variable
6756: to <code class="literal">yes</code> if the entry should be included.
6757: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6758: in the <code class="filename">PLIST</code> with either
6759: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6760: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6761: For example, in <code class="filename">Makefile</code>:</p>
1.174 asau 6762: <pre class="programlisting">
1.299 rillig 6763: PLIST_VARS+= foo
6764: .if <em class="replaceable"><code>condition</code></em>
6765: PLIST.foo= yes
6766: .else
1.174 asau 6767: </pre>
1.299 rillig 6768: <p>And then in <code class="filename">PLIST</code>:</p>
1.81 rillig 6769: <pre class="programlisting">
1.299 rillig 6770: @comment $NetBSD $
6771: bin/bar
6772: man/man1/bar.1
6773: ${PLIST.foo}bin/foo
6774: ${PLIST.foo}man/man1/foo.1
6775: ${PLIST.foo}share/bar/foo.data
1.100 rillig 6776: </pre>
1.299 rillig 6777: <p>An artificial space has been added between NetBSD and $, this is a
6778: workaround here to prevent CVS expanding to the filename of the guide. When
1.309 gutterid 6779: adding the RCS ID the space should be omitted.</p>
1.81 rillig 6780: </div>
1.299 rillig 6781: <div class="sect1">
6782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6783: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6784: <p>Man pages should be installed in compressed form if
6785: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6786: and uncompressed otherwise. To handle this in the
6787: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6788: appended/removed automatically for man pages according to
6789: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6790: or not, see above for details. This modification of the
6791: <code class="filename">PLIST</code> file is done on a copy of it, not
6792: <code class="filename">PLIST</code> itself.</p>
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="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6797: </h2></div></div></div>
6798: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6799: in generating the binary package, set the variable
6800: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.322 leot 6801: The files are later concatenated using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.299 rillig 6802: important. The default for <code class="varname">PLIST_SRC</code> is
6803: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 6804: </div>
1.148 asau 6805: <div class="sect1">
1.75 rillig 6806: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6807: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6808: <p>Some packages decide to install a different set of files based on
6809: the operating system being used. These differences can be
6810: automatically handled by using the following files:</p>
6811: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6812: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6813: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6814: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6815: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6816: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6817: </ul></div>
1.75 rillig 6818: </div>
1.148 asau 6819: <div class="sect1">
1.75 rillig 6820: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6821: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6822: <p>Some packages decide to generate hard-to-guess file names
6823: during installation that are hard to wire down.</p>
6824: <p>In such cases, you can set the
6825: <code class="varname">GENERATE_PLIST</code> variable to shell code
6826: terminated (with a semicolon) that will output PLIST entries which
6827: will be appended to the PLIST</p>
6828: <p>You can find one example in editors/xemacs:</p>
6829: <pre class="programlisting">
6830: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6831: </pre>
6832: <p>which will append something like
6833: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6834: <code class="filename">PLIST</code>.
6835: </p>
1.75 rillig 6836: </div>
1.148 asau 6837: <div class="sect1">
1.75 rillig 6838: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6839: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6840: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6841: multiple (and unrelated) packages install files. These
6842: directories were problematic because you had to add special
6843: tricks in the PLIST to conditionally remove them, or have some
6844: centralized package handle them.</p>
6845: <p>In pkgsrc, it is now easy: Each package should create
6846: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6847: will remove any directories left empty after uninstalling a
6848: package.</p>
6849: <p>If a package needs an empty directory to work, create
6850: the directory during installation as usual, and also add an
6851: entry to the PLIST:
6852:
6853: </p>
6854: <pre class="programlisting">
6855: @pkgdir path/to/empty/directory
6856: </pre>
6857: <p>
6858:
6859: or take a look at <code class="varname">MAKE_DIRS</code> and
6860: <code class="varname">OWN_DIRS</code>.
1.88 wiz 6861: </p>
1.75 rillig 6862: </div>
1.299 rillig 6863: </div>
6864: <div class="chapter">
6865: <div class="titlepage"><div><div><h2 class="title">
6866: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6867: <div class="toc">
6868: <p><b>Table of Contents</b></p>
6869: <dl class="toc">
6870: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6871: <dd><dl>
6872: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6873: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6874: </dl></dd>
6875: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6876: <dd><dl>
6877: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6878: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
6879: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
6880: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
6881: </dl></dd>
6882: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6883: <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>
6884: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6885: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6886: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6887: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6888: <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>
6889: </dl>
6890: </div>
6891: <p>This chapter describes the framework known as
6892: <code class="literal">pkginstall</code>, whose key features are:</p>
6893: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6894: <li class="listitem"><p>Generic installation and manipulation of directories and files
6895: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6896: <li class="listitem"><p>Automatic handling of configuration files during installation,
6897: provided that packages are correctly designed.</p></li>
6898: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6899: <li class="listitem"><p>Registration of system users and groups.</p></li>
6900: <li class="listitem"><p>Registration of system shells.</p></li>
6901: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6902: </ul></div>
6903: <p>The following sections inspect each of the above points in detail.</p>
6904: <p>You may be thinking that many of the things described here could be
6905: easily done with simple code in the package's post-installation target
6906: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6907: as the code in them is only executed when building from source. Machines
6908: using binary packages could not benefit from it at all (as the code itself
6909: could be unavailable). Therefore, the only way to achieve any of the items
6910: described above is by means of the installation scripts, which are
6911: automatically generated by pkginstall.</p>
1.148 asau 6912: <div class="sect1">
1.75 rillig 6913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 6914: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6915: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6916: of files and directories that belong to a package. The names used in it
6917: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6918: which means that it cannot register files outside this directory (absolute
6919: path names are not allowed). Despite this restriction, some packages need
6920: to install files outside this location; e.g., under
6921: <code class="filename">${VARBASE}</code> or
6922: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6923: is to create such files during installation time by using
6924: installation scripts.</p>
6925: <p>The generic installation scripts are shell scripts that can
6926: contain arbitrary code. The list of scripts to execute is taken from
6927: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6928: <code class="filename">INSTALL</code>. A similar variable exists for package
6929: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6930: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6931: commands, so they have the potential to create and manage files
6932: anywhere in the file system.</p>
6933: <p>Using these general installation files is not recommended, but
6934: may be needed in some special cases. One reason for avoiding them is
6935: that the user has to trust the packager that there is no unwanted or
6936: simply erroneous code included in the installation script. Also,
6937: previously there were many similar scripts for the same functionality,
6938: and fixing a common error involved finding and changing all of
6939: them.</p>
6940: <p>The pkginstall framework offers another, standardized way. It
6941: provides generic scripts to abstract the manipulation of such files
6942: and directories based on variables set in the package's
6943: <code class="filename">Makefile</code>. The rest of this section describes
6944: these variables.</p>
6945: <div class="sect2">
6946: <div class="titlepage"><div><div><h3 class="title">
6947: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
6948: <p>The following variables can be set to request the creation of
6949: directories anywhere in the file system:</p>
6950: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6951: <li class="listitem">
6952: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
6953: contain a list of directories that should be created and should attempt
6954: to be destroyed by the installation scripts. The difference between
6955: the two is that the latter prompts the administrator to remove any
6956: directories that may be left after deinstallation (because they were
6957: not empty), while the former does not. Example:</p>
6958: <pre class="programlisting">
6959: MAKE_DIRS+= ${VARBASE}/foo/private
6960: </pre>
6961: </li>
6962: <li class="listitem">
6963: <p><code class="varname">MAKE_DIRS_PERMS</code> and
6964: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
6965: which directories should be created and should attempt to be destroyed
6966: by the installation scripts. Each tuple holds the following values,
6967: separated by spaces: the directory name, its owner, its group and its
6968: numerical mode. For example:</p>
6969: <pre class="programlisting">
6970: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
6971: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
6972: </pre>
6973: <p>The difference between the two is exactly the same as their
6974: non-<code class="varname">PERMS</code> counterparts.</p>
6975: </li>
6976: </ul></div>
1.75 rillig 6977: </div>
1.299 rillig 6978: <div class="sect2">
6979: <div class="titlepage"><div><div><h3 class="title">
6980: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
6981: <p>Creating non-empty files outside the installation prefix is tricky
6982: because the <code class="filename">PLIST</code> forces all files to be inside it.
6983: To overcome this problem, the only solution is to extract the file in the
6984: known place (i.e., inside the installation prefix) and copy it to the
6985: appropriate location during installation (done by the installation scripts
6986: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
6987: file</em></span> in the following paragraphs, which describe the variables
6988: that can be used to automatically and consistently handle files outside the
6989: installation prefix:</p>
6990: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6991: <li class="listitem">
6992: <p><code class="varname">CONF_FILES</code> and
6993: <code class="varname">REQD_FILES</code> are pairs of master and target files.
6994: During installation time, the master file is copied to the target one
6995: if and only if the latter does not exist. Upon deinstallation, the
6996: target file is removed provided that it was not modified by the
6997: installation.</p>
6998: <p>The difference between the two is that the latter prompts the
6999: administrator to remove any files that may be left after
7000: deinstallation (because they were not empty), while the former does
7001: not.</p>
7002: </li>
7003: <li class="listitem">
7004: <p><code class="varname">CONF_FILES_PERMS</code> and
7005: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
7006: files as well as their target locations. For each of them, it also
7007: specifies their owner, their group and their numeric permissions, in
7008: this order. For example:</p>
1.88 wiz 7009: <pre class="programlisting">
1.299 rillig 7010: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
7011: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100 rillig 7012: </pre>
1.299 rillig 7013: <p>The difference between the two is exactly the same as their
7014: non-<code class="varname">PERMS</code> counterparts.</p>
7015: </li>
7016: </ul></div>
7017: </div>
1.75 rillig 7018: </div>
1.148 asau 7019: <div class="sect1">
1.75 rillig 7020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7021: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
7022: <p>Configuration files are special in the sense that they are installed
7023: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
7024: need special treatment during installation (most of which is automated by
7025: pkginstall). The main concept you must bear in mind is that files marked
7026: as configuration files are automatically copied to the right place (somewhere
7027: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
7028: and only if</em></span> they didn't exist before. Similarly, they will not
7029: be removed if they have local modifications. This ensures that
7030: administrators never lose any custom changes they may have made.</p>
7031: <div class="sect2">
7032: <div class="titlepage"><div><div><h3 class="title">
7033: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7034: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7035: specifies where configuration files shall be installed. Its contents are
7036: set based upon the following variables:</p>
7037: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7038: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7039: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
7040: be overridden by the user to point to his preferred location (e.g.,
7041: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7042: Packages must not use it directly.</p></li>
7043: <li class="listitem">
7044: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7045: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7046: for the package being built shall be installed. The definition of this
7047: variable only makes sense in the package's
7048: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7049: <p>As an example, consider the Apache package,
1.322 leot 7050: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.299 rillig 7051: configuration files under the
7052: <code class="filename">httpd/</code> subdirectory of
7053: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7054: Makefile.</p>
7055: </li>
7056: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7057: variable that holds this package's configuration directory (if
7058: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7059: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7060: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7061: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7062: directory where the configuration files for the package identified by
7063: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7064: </ul></div>
7065: <p>Based on the above variables, pkginstall determines the value of
7066: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
7067: variable that can be used within a package to refer to its configuration
7068: directory. The algorithm used to set its value is basically the
7069: following:</p>
7070: <div class="orderedlist"><ol class="orderedlist" type="1">
7071: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7072: its value is used.</p></li>
7073: <li class="listitem"><p>If the previous variable is not defined but
7074: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7075: <code class="filename">Makefile</code>, the resulting value is
7076: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7077: <li class="listitem"><p>Otherwise, it is set to
7078: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7079: </ol></div>
7080: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
7081: 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
7082: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
7083: be created with OWN_DIRS or MAKE_DIRS.</p>
7084: </div>
7085: <div class="sect2">
7086: <div class="titlepage"><div><div><h3 class="title">
7087: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7088: <p>Given that pkgsrc (and users!) expect configuration files to be in a
7089: known place, you need to teach each package where it shall install its
7090: files. In some cases you will have to patch the package Makefiles to
7091: achieve it. If you are lucky, though, it may be as easy as passing an
7092: extra flag to the configuration script; this is the case of GNU Autoconf-
7093: generated files:</p>
1.75 rillig 7094: <pre class="programlisting">
1.299 rillig 7095: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100 rillig 7096: </pre>
1.299 rillig 7097: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
7098: for</em></span> its configuration files, not where they will be originally
7099: installed (although the difference is never explicit,
7100: unfortunately).</p>
1.75 rillig 7101: </div>
1.299 rillig 7102: <div class="sect2">
7103: <div class="titlepage"><div><div><h3 class="title">
7104: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
7105: <p>As said before, pkginstall automatically handles configuration files.
7106: This means that <span class="strong"><strong>the packages themselves must not
7107: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7108: directly</strong></span>. Bad news is that many software installation scripts
7109: will, out of the box, mess with the contents of that directory. So what is
7110: the correct procedure to fix this issue?</p>
7111: <p>You must teach the package (usually by manually patching it) to
7112: install any configuration files under the examples hierarchy,
7113: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7114: <code class="filename">PLIST</code> registers them and the administrator always
7115: has the original copies available.</p>
7116: <p>Once the required configuration files are in place (i.e., under the
7117: examples hierarchy), the pkginstall framework can use them as master copies
7118: during the package installation to update what is in
7119: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7120: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
7121: 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
7122: about their syntax and their purpose. Here is an example, taken from the
1.322 leot 7123: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/index.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.88 wiz 7124: <pre class="programlisting">
1.299 rillig 7125: EGDIR= ${PREFIX}/share/doc/mutt/samples
7126: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.100 rillig 7127: </pre>
1.299 rillig 7128: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
7129: package and has no meaning outside it.</p>
1.75 rillig 7130: </div>
1.299 rillig 7131: <div class="sect2">
7132: <div class="titlepage"><div><div><h3 class="title">
7133: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
7134: <p>The automatic copying of config files can be toggled by setting the
7135: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7136: installation.</p>
1.88 wiz 7137: </div>
1.75 rillig 7138: </div>
1.148 asau 7139: <div class="sect1">
1.75 rillig 7140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7141: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7142: <p>System startup scripts are special files because they must be
7143: installed in a place known by the underlying OS, usually outside the
7144: 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
7145: can be used. However, pkginstall provides a special mechanism to handle
7146: these files.</p>
7147: <p>In order to provide system startup scripts, the package has
7148: to:</p>
7149: <div class="orderedlist"><ol class="orderedlist" type="1">
7150: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7151: the <code class="literal">.sh</code> suffix appended. Considering the
1.322 leot 7152: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/index.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.299 rillig 7153: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
7154: <li class="listitem">
7155: <p>Tell pkginstall to handle it, appending the name of the script,
7156: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7157: Continuing the previous example:</p>
7158: <pre class="programlisting">
7159: RCD_SCRIPTS+= cupsd
7160: </pre>
7161: </li>
7162: </ol></div>
7163: <p>Once this is done, pkginstall will do the following steps for each
7164: script in an automated fashion:</p>
7165: <div class="orderedlist"><ol class="orderedlist" type="1">
7166: <li class="listitem"><p>Process the file found in the files directory applying all the
7167: substitutions described in the <code class="filename">FILES_SUBST</code>
7168: variable.</p></li>
7169: <li class="listitem"><p>Copy the script from the files directory to the examples
7170: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
7171: that this master file must be explicitly registered in the
7172: <code class="filename">PLIST</code>.</p></li>
7173: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7174: from the examples hierarchy into the system-wide startup scripts
7175: directory.</p></li>
7176: </ol></div>
7177: <div class="sect2">
7178: <div class="titlepage"><div><div><h3 class="title">
7179: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7180: <p>The automatic copying of config files can be toggled by setting the
7181: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7182: installation. Note that the scripts will be always copied inside the
7183: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7184: matter what the value of this variable is.</p>
1.75 rillig 7185: </div>
7186: </div>
1.299 rillig 7187: <div class="sect1">
7188: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7189: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7190: <p>If a package needs to create special users and/or groups during
7191: installation, it can do so by using the pkginstall framework.</p>
7192: <p>Users can be created by adding entries to the
7193: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7194: syntax:</p>
7195: <pre class="programlisting">
7196: user:group
7197: </pre>
7198: <p>Further specification of user details may be done by setting
7199: per-user variables.
7200: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7201: numeric UID for the user.
7202: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7203: user's description or comment.
7204: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7205: user's home directory, and defaults to
7206: <code class="filename">/nonexistent</code> if not specified.
7207: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7208: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7209: not specified.</p>
7210: <p>Similarly, groups can be created by adding entries to the
7211: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7212: <pre class="programlisting">
7213: group
7214: </pre>
7215: <p>The numeric GID of the group may be set by defining
7216: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7217: <p>If a package needs to create the users and groups at an earlier
7218: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7219: <code class="literal">configure</code>,<code class="literal">build</code>, or
7220: <code class="literal">pre-install</code> to indicate the phase before which the
7221: users and groups are created. In this case, the numeric UIDs and GIDs
7222: of the created users and groups are automatically hardcoded into the
7223: final installation scripts.</p>
1.75 rillig 7224: </div>
1.148 asau 7225: <div class="sect1">
1.75 rillig 7226: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7227: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7228: <p>Packages that install system shells should register them in the shell
7229: database, <code class="filename">/etc/shells</code>, to make things easier to the
7230: administrator. This must be done from the installation scripts to keep
7231: binary packages working on any system. pkginstall provides an easy way to
7232: accomplish this task.</p>
7233: <p>When a package provides a shell interpreter, it has to set the
7234: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7235: add some hooks to the installation scripts to handle it. Consider the
1.322 leot 7236: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/index.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.299 rillig 7237: <pre class="programlisting">
7238: PKG_SHELL= ${PREFIX}/bin/zsh
7239: </pre>
7240: <div class="sect2">
7241: <div class="titlepage"><div><div><h3 class="title">
7242: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7243: <p>The automatic registration of shell interpreters can be disabled by
7244: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7245: environment variable to <code class="literal">NO</code>.</p>
7246: </div>
1.75 rillig 7247: </div>
1.148 asau 7248: <div class="sect1">
1.75 rillig 7249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 7250: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7251: <p>Packages that install X11 fonts should update the database files
7252: that index the fonts within each fonts directory. This can easily be
7253: accomplished within the pkginstall framework.</p>
7254: <p>When a package installs X11 fonts, it must list the directories in
7255: which fonts are installed in the
7256: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7257: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7258: <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
7259: installation scripts to run the appropriate commands to update the fonts
7260: database files within each of those directories. For convenience, if the
7261: directory path is relative, it is taken to be relative to the package's
1.322 leot 7262: installation prefix. Consider the following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/index.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75 rillig 7263: <pre class="programlisting">
1.299 rillig 7264: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75 rillig 7265: </pre>
1.299 rillig 7266: <div class="sect2">
7267: <div class="titlepage"><div><div><h3 class="title">
7268: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7269: <p>The automatic update of fonts databases can be disabled by
7270: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7271: environment variable to <code class="literal">NO</code>.</p>
1.75 rillig 7272: </div>
7273: </div>
7274: </div>
1.148 asau 7275: <div class="chapter">
1.75 rillig 7276: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 7277: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75 rillig 7278: <div class="toc">
7279: <p><b>Table of Contents</b></p>
1.210 leot 7280: <dl class="toc">
1.267 rillig 7281: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75 rillig 7282: <dd><dl>
1.267 rillig 7283: <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>
7284: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7285: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7286: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7287: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7288: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7289: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7290: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7291: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7292: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7293: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7294: </dl></dd>
7295: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7296: <dd><dl>
7297: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7298: <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>
7299: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7300: </dl></dd>
7301: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7302: <dd><dl>
7303: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7304: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7305: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
7306: </dl></dd>
7307: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7308: <dd><dl>
7309: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7310: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.320 wiz 7311: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
7312: <dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
7313: <dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
7314: <dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
1.267 rillig 7315: </dl></dd>
7316: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7317: <dd><dl>
7318: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7319: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287 rillig 7320: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7321: <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>
7322: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267 rillig 7323: </dl></dd>
7324: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7325: <dd><dl>
7326: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7327: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7328: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7329: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7330: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.318 nia 7331: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.267 rillig 7332: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
7333: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.318 nia 7334: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
7335: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
7336: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
7337: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
7338: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
7339: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
7340: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.87 wiz 7341: emulation</a></span></dt>
1.318 nia 7342: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
7343: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.75 rillig 7344: </dl></dd>
1.267 rillig 7345: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7346: </dl>
7347: </div>
1.148 asau 7348: <div class="sect1">
1.75 rillig 7349: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 7350: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78 rillig 7351: <p>One appealing feature of pkgsrc is that it runs on many
1.218 rillig 7352: different platforms. As a result, it is important to ensure,
7353: where possible, that packages in pkgsrc are portable. This
7354: chapter mentions some particular details you should pay
7355: attention to while working on pkgsrc.</p>
1.148 asau 7356: <div class="sect2">
1.78 rillig 7357: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7358: <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 7359: </h3></div></div></div>
1.78 rillig 7360: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7361: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7362: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7363: want to use those variables in the preprocessor directives of
1.322 leot 7364: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87 wiz 7365: <code class="literal">.for</code>), you need to include the file
7366: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7367: loads the user preferences.</p>
1.78 rillig 7368: <p>But note that some variables may not be completely defined
1.219 rillig 7369: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7370: included, as they may contain references to variables that are
7371: not yet defined. In shell commands (the lines in
7372: <code class="filename">Makefile</code> that are indented with a tab) this
7373: is no problem, since variables are only expanded when they are
7374: used. But in the preprocessor directives mentioned above and in
7375: dependency lines (of the form <code class="literal">target:
7376: dependencies</code>) the variables are expanded at load
7377: time.</p>
1.148 asau 7378: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 7379: <h3 class="title">Note</h3>
1.218 rillig 7380: <p>To check whether a variable can be used at load time,
7381: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78 rillig 7382: </div>
7383: </div>
1.148 asau 7384: <div class="sect2">
1.78 rillig 7385: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7386: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88 wiz 7387: <p>Occasionally, packages require interaction from the user,
7388: and this can be in a number of ways:</p>
1.148 asau 7389: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7390: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 7391: interaction such as entering username/password or accepting a
7392: license on a web page.</p></li>
1.128 wiz 7393: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 7394: passwords.</p></li>
1.128 wiz 7395: <li class="listitem"><p>help to configure the package before it is built</p></li>
7396: <li class="listitem"><p>help during the build process</p></li>
7397: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 7398: </ul></div>
1.218 rillig 7399: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7400: variable to define which stages need interaction. This should be
7401: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7402: <pre class="programlisting">
1.100 rillig 7403: INTERACTIVE_STAGE= configure install
1.222 sevan 7404: </pre>
1.88 wiz 7405: <p>The user can then decide to skip this package by setting the
1.218 rillig 7406: <code class="varname">BATCH</code> variable. Packages that require interaction
7407: are also excluded from bulk builds.</p>
1.75 rillig 7408: </div>
1.148 asau 7409: <div class="sect2">
1.75 rillig 7410: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7411: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222 sevan 7412: <p>Authors of software can choose the licence under which software
7413: can be copied. The Free Software Foundation has declared some
7414: licenses "Free", and the Open Source Initiative has a definition of
7415: "Open Source".</p>
7416: <p>By default, pkgsrc allows packages with Free or Open Source
7417: licenses to be built. To allow packages with other licenses to be
7418: built as well, the pkgsrc user needs to add these licenses to the
7419: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7420: that this variable only affects which packages may be
7421: <span class="emphasis"><em>built</em></span>, while the license terms often also
7422: restrict the actual use of the package and its redistribution.</p>
1.98 wiz 7423: <p>One might want to only install packages with a BSD license,
1.218 rillig 7424: or the GPL, and not the other. The free licenses are added to the
1.222 sevan 7425: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.121 jnemeth 7426: user can override the default by setting the
7427: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222 sevan 7428: of "+=". The licenses accepted by default are defined in the
7429: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7430: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78 rillig 7431: <p>The license tag mechanism is intended to address
1.87 wiz 7432: copyright-related issues surrounding building, installing and
7433: using a package, and not to address redistribution issues (see
7434: <code class="varname">RESTRICTED</code> and
1.222 sevan 7435: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121 jnemeth 7436: Packages with redistribution restrictions should set these
7437: tags.</p>
1.98 wiz 7438: <p>Denoting that a package may be copied according to a
7439: particular license is done by placing the license in
1.87 wiz 7440: <code class="filename">pkgsrc/licenses</code> and setting the
7441: <code class="varname">LICENSE</code> variable to a string identifying the
1.322 leot 7442: license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/index.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87 wiz 7443: <pre class="programlisting">
1.100 rillig 7444: LICENSE= xv-license
1.222 sevan 7445: </pre>
1.87 wiz 7446: <p>When trying to build, the user will get a notice that the
1.98 wiz 7447: package is covered by a license which has not been placed in the
7448: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7449: <pre class="programlisting">
1.100 rillig 7450: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7451: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7452: ===> To view the license, enter "/usr/bin/make show-license".
7453: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7454: ===> ACCEPTABLE_LICENSES+=xv-license
7455: *** Error code 1
1.222 sevan 7456: </pre>
1.110 hubertf 7457: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7458: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7459: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7460: convey to pkgsrc that it should not in the future fail because of
7461: that license:</p>
1.78 rillig 7462: <pre class="programlisting">
1.100 rillig 7463: ACCEPTABLE_LICENSES+=xv-license
1.222 sevan 7464: </pre>
7465: <p>The use of <code class="varname">LICENSE=shareware</code>,
7466: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7467: is deprecated because it does not crisply refer to a particular
7468: license text. Another problem with such usage is that it does not
7469: enable a user to tell pkgsrc to proceed for a single package
7470: without also telling pkgsrc to proceed for all packages with that
7471: tag.</p>
7472: <div class="sect3">
7473: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7474: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154 rodent 7475: <p>When adding a package with a new license, the following steps
7476: are required:</p>
7477: <div class="orderedlist"><ol class="orderedlist" type="1">
7478: <li class="listitem">
1.284 rillig 7479: <p>Check whether the license qualifies as Free or Open Source by
7480: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7481: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222 sevan 7482: Open Source Initiative</a>. If this is the case, the filename in
7483: <code class="filename">pkgsrc/licenses/</code> does not need the
7484: <code class="filename">-license</code> suffix, and the license name should be
7485: added to:</p>
1.154 rodent 7486: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7487: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7488: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7489: <li class="listitem"><p>default_acceptable_licenses in
7490: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154 rodent 7491: </ul></div>
7492: </li>
1.284 rillig 7493: <li class="listitem"><p>The license text should be added to
7494: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7495: licenses can be seen in this directory.</p></li>
1.154 rodent 7496: </ol></div>
1.222 sevan 7497: </div>
7498: <div class="sect3">
7499: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7500: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98 wiz 7501: <p>When the license changes (in a way other than formatting),
1.222 sevan 7502: make sure that the new license has a different name (e.g.,
1.98 wiz 7503: append the version number if it exists, or the date). Just
7504: because a user told pkgsrc to build programs under a previous
7505: version of a license does not mean that pkgsrc should build
1.99 rillig 7506: programs under the new licenses. The higher-level point is that
1.98 wiz 7507: pkgsrc does not evaluate licenses for reasonableness; the only
7508: test is a mechanistic test of whether a particular text has been
1.222 sevan 7509: approved by either of two bodies (FSF or OSI).</p>
7510: </div>
1.75 rillig 7511: </div>
1.148 asau 7512: <div class="sect2">
1.75 rillig 7513: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7514: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75 rillig 7515: <p>Some licenses restrict how software may be re-distributed.
1.222 sevan 7516: By declaring the restrictions, package tools can
1.98 wiz 7517: automatically refrain from e.g. placing binary packages on FTP
7518: sites.</p>
1.222 sevan 7519: <p>There are four possible restrictions, which are
1.98 wiz 7520: the cross product of sources (distfiles) and binaries not being
7521: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7522: language in any license, and because non-Free licenses tend to be
7523: different from each other, pkgsrc adopts a definition of FTP and
1.222 sevan 7524: CD-ROM.
7525:
7526: "FTP" means making the source or binary file available over the
7527: Internet at no charge.
7528:
7529: "CD-ROM" means making the source or binary available on some kind of
7530: media, together with other source and binary packages, which is sold
7531: for a distribution charge.
1.98 wiz 7532: </p>
7533: <p>In order to encode these restrictions, the package system
1.87 wiz 7534: defines five make variables that can be set to note these
7535: restrictions:</p>
1.148 asau 7536: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7537: <li class="listitem">
1.75 rillig 7538: <p><code class="varname">RESTRICTED</code></p>
7539: <p>This variable should be set whenever a restriction
1.87 wiz 7540: exists (regardless of its kind). Set this variable to a
1.98 wiz 7541: string containing the reason for the restriction. It should
7542: be understood that those wanting to understand the restriction
7543: will have to read the license, and perhaps seek advice of
7544: counsel.</p>
1.75 rillig 7545: </li>
1.128 wiz 7546: <li class="listitem">
1.75 rillig 7547: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7548: <p>Binaries may not be placed on CD-ROM containing other
7549: binary packages, for which a distribution charge may be made.
7550: In this case, set this variable to
7551: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7552: </li>
1.128 wiz 7553: <li class="listitem">
1.75 rillig 7554: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7555: <p>Binaries may not made available on the Internet without
7556: charge. In this case, set this variable to
7557: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7558: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7559: </li>
1.128 wiz 7560: <li class="listitem">
1.75 rillig 7561: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7562: <p>Distfiles may not be placed on CD-ROM, together with
7563: other distfiles, for which a fee may be charged. In this
7564: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7565: </p>
1.75 rillig 7566: </li>
1.128 wiz 7567: <li class="listitem">
1.75 rillig 7568: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7569: <p>Distfiles may not made available via FTP at no charge.
7570: In this case, set this variable to
7571: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7572: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7573: </li>
7574: </ul></div>
1.222 sevan 7575: <p>Please note that packages will be removed from pkgsrc when the
7576: distfiles are not distributable and cannot be obtained for a period
7577: of one full quarter branch. Packages with manual/interactive fetch
7578: must have a maintainer and it is his/her responsibility to ensure
7579: this.</p>
1.75 rillig 7580: </div>
1.148 asau 7581: <div class="sect2">
1.75 rillig 7582: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7583: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290 gutterid 7584: <p>Your package may depend on some other package being present,
7585: and there are various ways of expressing this dependency.
7586: pkgsrc supports the <code class="varname">DEPENDS</code>,
7587: <code class="varname">BUILD_DEPENDS</code>,
7588: <code class="varname">TOOL_DEPENDS</code>, and
7589: <code class="varname">TEST_DEPENDS</code> definitions, the
1.88 wiz 7590: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7591: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7592: to handle dependencies, and which uses the variables named above.
1.299 rillig 7593: 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 7594: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7595: definition registers that pre-requisite in the binary package so it
7596: will be pulled in when the binary package is later installed, whilst
7597: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7598: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7599: dependency that is only needed for building or testing the resulting
1.299 rillig 7600: 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 7601: <p>This means that if you only need a package present whilst
1.290 gutterid 7602: you are building or testing, it should be noted as a
7603: <code class="varname">TOOL_DEPENDS</code>,
7604: <code class="varname">BUILD_DEPENDS</code>, or
7605: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.269 leot 7606: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7607: packages, i.e. packages for the architecture where the package
7608: is built;
7609: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290 gutterid 7610: packages, i.e., packages for the architecture for which the package
1.269 leot 7611: is built.</p>
1.290 gutterid 7612: <p>The format for a <code class="varname">DEPENDS</code>,
7613: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7614: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75 rillig 7615: <pre class="programlisting">
1.100 rillig 7616: <pre-req-package-name>:../../<category>/<pre-req-package>
1.222 sevan 7617: </pre>
1.128 wiz 7618: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7619: may include any of the wildcard version numbers recognized by
1.322 leot 7620: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128 wiz 7621: <div class="orderedlist"><ol class="orderedlist" type="1">
7622: <li class="listitem">
1.75 rillig 7623: <p>If your package needs another package's binaries or
1.160 wiz 7624: libraries to build and run, and if that package has a
1.87 wiz 7625: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7626: <pre class="programlisting">
1.100 rillig 7627: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7628: </pre>
1.75 rillig 7629: </li>
1.128 wiz 7630: <li class="listitem">
1.160 wiz 7631: <p>If your package needs another package's binaries or
7632: libraries only for building, and if that package has a
7633: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7634: <pre class="programlisting">
7635: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7636: </pre>
1.160 wiz 7637: <p>but set
7638: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7639: to make it a build dependency only. This case is rather
7640: rare.</p>
7641: </li>
7642: <li class="listitem">
1.132 spz 7643: <p>If your package needs binaries from another package to build,
1.269 leot 7644: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75 rillig 7645: <pre class="programlisting">
1.269 leot 7646: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222 sevan 7647: </pre>
1.75 rillig 7648: </li>
1.269 leot 7649: <li class="listitem"><p>If your package needs static libraries to link against, header
7650: files to include, etc. from another package to build,
7651: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132 spz 7652: <li class="listitem"><p>If your package needs a library with which to link and
7653: there is no <code class="filename">buildlink3.mk</code> file
7654: available, create one. Using
7655: <code class="varname">DEPENDS</code> won't be sufficient because the
7656: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7657: <li class="listitem">
1.132 spz 7658: <p>If your package needs some executable to be able to run
7659: correctly and if there's no
7660: <code class="filename">buildlink3.mk</code> file, this is specified
7661: using the <code class="varname">DEPENDS</code> variable. The
1.322 leot 7662: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/index.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.242 wiz 7663: be able to execute the latex binary from the tex-latex-bin package
1.132 spz 7664: when it runs, and that is specified:</p>
1.75 rillig 7665: <pre class="programlisting">
1.242 wiz 7666: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222 sevan 7667: </pre>
1.132 spz 7668: </li>
1.290 gutterid 7669: <li class="listitem"><p>If your package includes a test suite that has extra
7670: dependencies only required for this purpose (frequently this
7671: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7672: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132 spz 7673: <li class="listitem">
7674: <p>You can use wildcards in package dependencies. Note that
7675: such wildcard dependencies are retained when creating binary
7676: packages. The dependency is checked when installing the binary
7677: package and any package which matches the pattern will be
7678: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7679: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7680: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7681: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7682: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7683: <p>Wildcards can also be used to specify that a package
1.87 wiz 7684: will only build against a certain minimum version of a
7685: pre-requisite:</p>
1.75 rillig 7686: <pre class="programlisting">
1.132 spz 7687: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.222 sevan 7688: </pre>
1.132 spz 7689: <p>This means that the package will build using version 6.0
7690: of ImageMagick or newer. Such a dependency may be warranted
7691: if, for example, the command line options of an executable
7692: have changed.</p>
7693: <p>If you need to depend on minimum versions of libraries,
1.298 wiz 7694: set
7695: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7696: to the appropriate pattern before including its
7697: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7698: <pre class="programlisting">
7699: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7700: .include "../../graphics/jpeg/buildlink3.mk"
7701: </pre>
1.75 rillig 7702: <p>For security fixes, please update the package
1.267 rillig 7703: 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 7704: information.</p>
1.75 rillig 7705: </li>
7706: </ol></div>
7707: <p>If your package needs files from another package to build,
1.87 wiz 7708: add the relevant distribution files to
7709: <code class="varname">DISTFILES</code>, so they will be extracted
1.322 leot 7710: automatically. See the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/index.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87 wiz 7711: (It relies on the jpeg sources being present in source form
7712: during the build.)</p>
1.75 rillig 7713: </div>
1.148 asau 7714: <div class="sect2">
1.75 rillig 7715: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7716: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7717: <p>Your package may conflict with other packages a user might
1.87 wiz 7718: already have installed on his system, e.g. if your package
1.88 wiz 7719: installs the same set of files as another package in the pkgsrc
1.190 wiz 7720: tree or has the same <code class="varname">PKGNAME</code>.</p>
1.322 leot 7721: <p>For example, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/libXaw3d/index.html" target="_top"><code class="filename">x11/libXaw3d</code></a>
7722: and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/index.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.255 leot 7723: install the same shared library, thus you set in
7724: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7725: <pre class="programlisting">
7726: CONFLICTS= Xaw-Xpm-[0-9]*
7727: </pre>
7728: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7729: <pre class="programlisting">
7730: CONFLICTS= libXaw3d-[0-9]*
7731: </pre>
1.322 leot 7732: <p><a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255 leot 7733: that conflict with existing packages and abort. However, in many
7734: situations this is too late in the process. Binary package managers
7735: will not know about the conflict until they attempt to install the
7736: package after already downloading it and all its dependencies.
7737: Users may also waste time building a package and its dependencies
7738: only to find out at the end that it conflicts with another package
7739: they have installed.</p>
7740: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7741: should be added in all cases where it is known that packages conflict
7742: with each other. These <code class="varname">CONFLICTS</code> entries are
1.322 leot 7743: exported in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255 leot 7744: managers to inform users that packages cannot be installed onto
7745: the target system.</p>
1.75 rillig 7746: </div>
1.148 asau 7747: <div class="sect2">
1.75 rillig 7748: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7749: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7750: <p>There are several reasons why a package might be
1.88 wiz 7751: instructed to not build under certain circumstances. If the
1.87 wiz 7752: package builds and runs on most platforms, the exceptions
1.193 dholland 7753: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7754: the package builds and runs on a small handful of platforms,
7755: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7756: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7757: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7758: (OS-version-platform) that can use glob-style
7759: wildcards.</p>
7760: <p>If a package is not appropriate for some platforms (as
1.225 maya 7761: opposed to merely broken), a different set of variables should be
1.193 dholland 7762: used as this affects failure reporting and statistics.
7763: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7764: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 dholland 7765: the package is appropriate for only a small handful of platforms
7766: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7767: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7768: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7769: (OS-version-platform) that can use glob-style
7770: wildcards.</p>
1.88 wiz 7771: <p>Some packages are tightly bound to a specific version of an
1.322 leot 7772: operating system, e.g. LKMs or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/index.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
1.88 wiz 7773: backwards compatible with other versions of the OS, and should be
7774: uploaded to a version specific directory on the FTP server. Mark
7775: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7776: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7777: the package system internals, but may be used in the
7778: future.</p>
1.75 rillig 7779: <p>If the package should be skipped (for example, because it
1.87 wiz 7780: provides functionality already provided by the system), set
1.88 wiz 7781: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7782: the package should fail because some preconditions are not met,
7783: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7784: message.</p>
1.75 rillig 7785: </div>
1.148 asau 7786: <div class="sect2">
1.75 rillig 7787: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7788: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7789: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7790: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7791: be set in the package Makefile. This will be carried into any
7792: binary package that is made from this pkgsrc entry. A
1.128 wiz 7793: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.322 leot 7794: not be deleted using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128 wiz 7795: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7796: </div>
1.148 asau 7797: <div class="sect2">
1.75 rillig 7798: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7799: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7800: <p>When a vulnerability is found, this should be noted in
1.320 wiz 7801: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>.
7802: Entries in that file consist of three parts:</p>
7803: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7804: <li class="listitem"><p>package version pattern</p></li>
7805: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
7806: <li class="listitem"><p>URL providing additional information about the issue</p></li>
7807: </ul></div>
7808: <p>For the package version pattern please always use `<' to
7809: mark an upper bound (not `<='!). This will avoid possible
7810: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
7811: related to security fixes. Lower bounds can be added too, using
7812: '>' or '>='. For example,
1.321 wiz 7813: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.320 wiz 7814: versions 1.0 (included) to 1.2 (excluded) of
7815: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
7816: issue.</p>
7817: <p>Entries should always be added at the bottom of the file.</p>
7818: <p>When fixing packages, please modify the upper bound of the
7819: corresponding entry. To continue the previous example, if a fix
7820: was backported to version 1.1nb2, change the previous pattern to
1.321 wiz 7821: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.320 wiz 7822: <p>To locally test a package version pattern against a
7823: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
7824: pmatch</strong></span> command.</p>
7825: <p>The URL should be as permanent as possible and provide as
7826: much information about the issue as possible. CVE entries are
7827: preferred.</p>
7828: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.138 wiz 7829: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7830: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7831: <code class="varname">PKGREVISION</code> should be increased (this is of
7832: course not necessary if the problem is fixed by using a newer
7833: release of the software), and the pattern in the
7834: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7835: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7836: branch, be sure to submit a pullup request!</p>
1.75 rillig 7837: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7838: semi-automatically by a weekly cron job.</p>
1.320 wiz 7839: <p>In case a security issue is disputed, please contact
7840: pkgsrc-security@NetBSD.org.</p>
1.75 rillig 7841: </div>
1.148 asau 7842: <div class="sect2">
1.75 rillig 7843: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7844: <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 7845: <p>When making fixes to an existing package it can be useful
1.87 wiz 7846: to change the version number in <code class="varname">PKGNAME</code>. To
7847: avoid conflicting with future versions by the original author, a
1.128 wiz 7848: <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 7849: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7850: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7851: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7852: <pre class="programlisting">
1.100 rillig 7853: DISTNAME= foo-17.42
7854: PKGREVISION= 9
1.222 sevan 7855: </pre>
1.75 rillig 7856: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7857: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7858: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7859: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7860: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7861: <p>When a new release of the package is released, the
1.87 wiz 7862: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7863: minor release of the above package, things should be like:</p>
1.75 rillig 7864: <pre class="programlisting">
1.100 rillig 7865: DISTNAME= foo-17.43
1.222 sevan 7866: </pre>
1.87 wiz 7867: <p><code class="varname">PKGREVISION</code> should be incremented for any
7868: non-trivial change in the resulting binary package. Without a
7869: <code class="varname">PKGREVISION</code> bump, someone with the previous
7870: version installed has no way of knowing that their package is out
7871: of date. Thus, changes without increasing
7872: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7873: trivial that no reasonable person would want to upgrade", and this
7874: is the rough test for when increasing
7875: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7876: changes that do not merit increasing
7877: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 7878: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7879: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284 rillig 7880: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7881: comments in Makefile.</p></li>
7882: <li class="listitem"><p>Changing build variables if the resulting binary
7883: package is the same.</p></li>
7884: <li class="listitem"><p>Changing
7885: <code class="filename">DESCR</code>.</p></li>
7886: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7887: default options don't change.</p></li>
1.100 rillig 7888: </ul></div>
1.87 wiz 7889: <p>Examples of changes that do merit an increase to
7890: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 7891: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284 rillig 7892: <li class="listitem"><p>Security fixes</p></li>
7893: <li class="listitem"><p>Changes or additions to a patch
7894: file</p></li>
7895: <li class="listitem"><p>Changes to the
7896: <code class="filename">PLIST</code></p></li>
7897: <li class="listitem"><p>A dependency is changed or
7898: renamed.</p></li>
1.100 rillig 7899: </ul></div>
1.78 rillig 7900: <p>PKGREVISION must also be incremented when dependencies have ABI
7901: changes.</p>
1.75 rillig 7902: </div>
1.148 asau 7903: <div class="sect2">
1.79 rillig 7904: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7905: <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 7906: <p>When you want to replace the same text in multiple files, or
7907: multiple times in the same file, it is cumbersome to maintain a patch
7908: file for this. This is where the SUBST framework steps in. It provides an
7909: easy-to-use interface for replacing text in files. It just needs the
7910: following information:</p>
7911: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7912: <li class="listitem"><p>In which phase of the package build cycle should the
7913: replacement happen?</p></li>
7914: <li class="listitem"><p>In which files should the replacement
1.287 rillig 7915: happen?</p></li>
1.295 rillig 7916: <li class="listitem"><p>Which text should be replaced with
7917: what?</p></li>
1.287 rillig 7918: </ul></div>
7919: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295 rillig 7920: variables. A minimal example is:</p>
7921: <pre class="programlisting">
7922: SUBST_CLASSES+= paths
7923: SUBST_STAGE.paths= pre-configure
7924: SUBST_FILES.paths= src/*.c
7925: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
7926: </pre>
7927: <p>Translated into English, it means: In the pre-configure stage (that
7928: is, after applying the patches from the patches/ directory and before
7929: running the configure script and the portability check), replace the text
7930: <code class="literal">/usr/local</code> with the content of the variable
7931: <code class="varname">PREFIX</code>.</p>
7932: <p>Each SUBST block starts by appending an identifier to
7933: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
7934: identifier can be chosen freely by the package. If there should ever be
7935: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
7936: early, so don't worry about name collisions.</p>
7937: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
7938: SUBST block are parameterized using this identifier. In the remainder of
7939: this section, these parameterized variables are written as
7940: <code class="varname">SUBST_STAGE.*</code>.</p>
7941: <pre class="programlisting">
7942: SUBST_CLASSES+= paths
7943: SUBST_STAGE.paths= pre-configure
7944: SUBST_MESSAGE.paths= Fixing absolute paths.
7945: SUBST_FILES.paths= src/*.c
7946: SUBST_FILES.paths+= scripts/*.sh
7947: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
7948: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
7949: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
7950: </pre>
7951: <p>To get a complete picture about the SUBST substitutions, run
7952: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
7953: expected, run pkglint on the package, which detects several typical
7954: mistakes surrounding the SUBST blocks. For any questions that might
7955: remain after this, have a look at
7956: <code class="filename">mk/subst.mk</code>.</p>
7957: <div class="sect3">
7958: <div class="titlepage"><div><div><h4 class="title">
7959: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
7960: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
7961: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
7962: <code class="literal">pre-configure</code> is used most often, by far. The most
7963: popular stages are, in chronological order:</p>
7964: <div class="variablelist"><dl class="variablelist">
7965: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
7966: <dd>
7967: <p>The substitutions are applied immediately after the
7968: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
7969: package will leave no traces of the original files.</p>
7970: <p>When the substitution applies to files for which there is also a
7971: patch in the <code class="filename">patches/</code> directory, this means that the
7972: patches will be computed based on the result of the substitution. When
7973: these patches are sent to the upstream maintainer later, to be fixed in
7974: the upstream package, these patches may no longer match what the upstream
7975: author is used to. Because of this, <code class="literal">pre-configure</code> is
7976: often a better choice.</p>
7977: </dd>
7978: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
7979: <dd>
7980: <p>The substitutions are applied after the patches from the
7981: <code class="filename">patches/</code> directory. This makes it possible to run
7982: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.322 leot 7983: can be edited using the tools pkgvi and mkpatches from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package.</p>
1.295 rillig 7984: <p>When updating the patches, it is helpful to explicitly separate the
7985: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
7986: configure</strong></span>, and to only edit the patches between these commands.
7987: Otherwise the substitutions from the SUBST block will end up in the patch
7988: file. When this happens in really obvious ways, pkglint will complain
7989: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
7990: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
7991: can only detect these really obvious
7992: cases.</p>
7993: </dd>
7994: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
7995: <dd><p>This stage should only be used if the package defines a
7996: <code class="literal">pre-configure</code> action itself, and the substitution must
7997: happen after that. Typical examples are packages that use the
7998: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
7999: script from
8000: <code class="filename">configure.ac</code>.</p></dd>
8001: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
8002: <dd><p>This stage is used to fix up any mistakes by the
8003: configure stage.</p></dd>
8004: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
8005: <dd><p>This stage should only be used for substitutions that are
8006: clearly related to building the package, not for fixing the
8007: configuration. Substitutions for pathnames (such as replacing
8008: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
8009: user names (such as replacing <code class="literal">@MY_USER@</code> with the
8010: actual username) belong in pre-configure or post-configure
8011: instead.</p></dd>
8012: <dt><span class="term"><code class="literal">post-build</code></span></dt>
8013: <dd>
8014: <p>Just as with pre-build, this stage should only be used
8015: for substitutions that are clearly related to building the package, not
8016: for fixing the configuration. Substitutions for pathnames (such as
8017: replacing <code class="filename">/usr/local</code> with
8018: <code class="literal">${PREFIX}</code>) or user names (such as replacing
8019: <code class="literal">@MY_USER@</code> with the actual username) belong in
8020: pre-configure or post-configure instead.</p>
8021: <p>A typical use is to update pkg-config files to include the rpath
8022: compiler options.</p>
8023: </dd>
8024: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8025: <dd><p>In general, the install phase should be as simple as
8026: possible. As with the pre-build and post-build stages, it should not be
8027: used to fix pathnames or user names, these belong in pre-configure
8028: instead. There are only few legitimate use cases for applying
8029: substitutions in this stage.</p></dd>
8030: </dl></div>
8031: </div>
8032: <div class="sect3">
8033: <div class="titlepage"><div><div><h4 class="title">
1.296 rillig 8034: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295 rillig 8035: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8036: filename patterns. These patterns are relative to
8037: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8038: A typical example is:</p>
8039: <pre class="programlisting">
8040: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8041: </pre>
8042: <p>The above patterns, especially the last, are quite broad. The SUBST
8043: implementation checks that each filename pattern that is mentioned here
8044: has an effect. For example, if none of the
8045: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8046: and substituted, that filename pattern is redundant and should be left
1.296 rillig 8047: out. By default, the SUBST framework will complain with an error message.
8048: If the text to be substituted occurs in some of the files from a single
8049: pattern, but not in all of them, that is totally ok, and the SUBST
1.295 rillig 8050: framework will only print an INFO message for those files.</p>
8051: <p>If there is a good reason for having redundant filename patterns,
1.296 rillig 8052: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295 rillig 8053: <p>Another popular way of choosing the files for the substitutions is
8054: via a shell command, like this:</p>
8055: <pre class="programlisting">
1.296 rillig 8056: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.295 rillig 8057: SUBST_FILES.path= ${C_FILES_CMD:sh}
8058: </pre>
8059: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8060: freely chosen and independent of the SUBST framework.</p>
8061: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8062: lists each file individually. Thereby chances are higher that there are
8063: filename patterns in which no substitution happens. Since the SUBST
8064: framework cannot know whether the filename patterns in
8065: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8066: Makefile (where any redundant filename pattern would be suspicious) or
8067: been generated by a shell command (in which redundant filename patterns
8068: are more likely and to be expected), it will complain about these
8069: redundant filename patterns. Therefore, SUBST blocks that use a shell
8070: command to generate the list of filename patterns often need to set
8071: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8072: </div>
8073: <div class="sect3">
8074: <div class="titlepage"><div><div><h4 class="title">
8075: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8076: <p>In most cases, the substitutions are given using one or more
1.322 leot 8077: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.295 rillig 8078: <pre class="programlisting">
8079: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8080: </pre>
8081: <p>Each of the sed commands needs to be preceded by the
8082: <code class="literal">-e</code> option and should be specified on a line of its
8083: own, to avoid hiding short sed commands at the end of a line.</p>
8084: <p>Since the sed commands often contain shell metacharacters as the
8085: separator (the <code class="literal">|</code> in the above example), it is common
8086: to enclose them in single quotes.</p>
8087: <p>A common substitution is to replace placeholders of the form
8088: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8089: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8090: <pre class="programlisting">
8091: SUBST_VARS.path= PREFIX
8092: </pre>
8093: <p>This type of substitutions is typically done by the GNU configure
1.296 rillig 8094: scripts during the do-configure stage, but in some cases these need to be
8095: overridden. The same pattern is also used when a package defines patches
8096: that replace previously hard-coded paths like
8097: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8098: placeholder first, which then gets substituted by the actual
8099: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8100: cases, it works equally well to just use the SUBST framework to directly
8101: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8102: thereby omitting the intermediate patch file.</p>
1.295 rillig 8103: <p>If the above is not flexible enough, it is possible to not use sed
8104: at all for the substitution but to specify an entirely different command,
8105: like this:</p>
1.87 wiz 8106: <pre class="programlisting">
1.295 rillig 8107: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8108: </pre>
8109: <p>This is used for the few remaining packages in which the
8110: distributed files use Windows-style line endings that need to be
8111: converted to UNIX-style line endings.</p>
8112: </div>
8113: <div class="sect3">
8114: <div class="titlepage"><div><div><h4 class="title">
8115: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8116: <p>When a SUBST block is applied during a package build, a message is
8117: logged. The default message is fine for most purposes but can be
8118: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8119: message.</p>
8120: </div>
1.79 rillig 8121: </div>
1.75 rillig 8122: </div>
1.148 asau 8123: <div class="sect1">
1.75 rillig 8124: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8125: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 8126: <div class="sect2">
1.75 rillig 8127: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8128: <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 8129: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8130: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8131: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8132: with the name of each file to download as an argument, expecting
8133: it to output the URL of the directory from which to download
1.322 leot 8134: it. <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/index.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87 wiz 8135: example of this usage.</p>
1.75 rillig 8136: <p>If the download can't be automated, because the user must
1.87 wiz 8137: submit personal information to apply for a password, or must pay
8138: for the source, or whatever, you can set
8139: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8140: displayed to the user before aborting the build. Example:</p>
8141: <pre class="programlisting">
1.100 rillig 8142: FETCH_MESSAGE= "Please download the files"
8143: FETCH_MESSAGE+= " "${DISTFILES:Q}
8144: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222 sevan 8145: </pre>
1.75 rillig 8146: </div>
1.148 asau 8147: <div class="sect2">
1.75 rillig 8148: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8149: <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 8150: <p>Sometimes authors of a software package make some
1.87 wiz 8151: modifications after the software was released, and they put up a
8152: new distfile without changing the package's version number. If a
8153: package is already in pkgsrc at that time, the checksum will
8154: no longer match. The contents of the new distfile should be
8155: compared against the old one before changing anything, to make
8156: sure the distfile was really updated on purpose, and that
8157: no trojan horse or so crept in.
1.97 rillig 8158: Please mention that the distfiles were compared and what was found
1.159 rodent 8159: in your commit message.</p>
1.220 wiz 8160: <p>Then, the correct way to work around this is to set
8161: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8162: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8163: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8164: a variable prefix). All <code class="varname">DISTFILES</code> and
1.93 rillig 8165: <code class="varname">PATCHFILES</code> for this package will be put in that
1.267 rillig 8166: 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 8167: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220 wiz 8168: including the <code class="filename">nbX</code> suffix) or a date stamp can
8169: be appended, like
8170: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284 rillig 8171: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8172: name does not contain a version and the distfile is apt to change. In
8173: cases where the likelihood of this is very small,
8174: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8175: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8176: distfile name changes, even if a package is being moved or
8177: renamed.</p>
1.159 rodent 8178: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 8179: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8180: path in the filenames.
1.159 rodent 8181: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 8182: Furthermore, a mail to the package's authors seems appropriate
8183: telling them that changing distfiles after releases without
8184: changing the file names is not good practice.</p>
1.75 rillig 8185: </div>
1.199 tnn 8186: <div class="sect2">
8187: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8188: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284 rillig 8189: <p>Helper methods exist for packages hosted on github.com which
8190: will often have distfile names that clash with other packages, for
8191: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8192: from below:</p>
1.199 tnn 8193: <div class="sect3">
8194: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8195: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284 rillig 8196: <p>If your distfile URL looks similar to
1.303 bacon 8197: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284 rillig 8198: then you are packaging a tagged release.</p>
1.199 tnn 8199: <pre class="programlisting">
1.303 bacon 8200: DISTNAME= example-1.0
1.200 tnn 8201: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8202: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8203: GITHUB_TAG= v${PKGVERSION_NOREV}
1.199 tnn 8204: EXTRACT_SUFX= .zip
8205: </pre>
8206: </div>
8207: <div class="sect3">
8208: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8209: <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>
8210: <p>If your distfile looks similar to
8211: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8212: release, then set the package version to 0.0.0.N, where N is the number
8213: of commits to the repository, and set GITHUB_TAG to the commit hash.
8214: This will (almost) ensure that the first tagged release will have a
8215: version greater than this one so that package upgrades will function
8216: properly.</p>
8217: <pre class="programlisting">
8218: DISTNAME= example-0.0.0.347
8219: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8220: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8221: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8222: </pre>
8223: </div>
8224: <div class="sect3">
8225: <div class="titlepage"><div><div><h4 class="title">
8226: <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>
8227: <p>If your distfile looks similar to
8228: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8229: then include the last release version and the commit count since that
8230: release in the package version and set GITHUB_TAG to the commit hash.
8231: The latest release and commit count are shown in the output of
8232: "git describe --tags":
8233: </p>
8234: <pre class="screen">
8235: # git clone https://github.com/username/example
8236: # cd example
8237: # git describe --tags
8238: 1.2.3-5-g988881a
8239: </pre>
1.199 tnn 8240: <pre class="programlisting">
1.303 bacon 8241: DISTNAME= example-1.2.3.5
8242: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8243: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.200 tnn 8244: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222 sevan 8245: </pre>
1.199 tnn 8246: </div>
8247: <div class="sect3">
8248: <div class="titlepage"><div><div><h4 class="title">
1.303 bacon 8249: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284 rillig 8250: <p>If your distfile URL looks similar to
1.303 bacon 8251: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284 rillig 8252: then you are packaging a release.</p>
1.199 tnn 8253: <pre class="programlisting">
8254: DISTNAME= offensive-1.6
1.200 tnn 8255: PKGNAME= ${DISTNAME:S/offensive/proper/}
8256: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.303 bacon 8257: GITHUB_PROJECT= example
1.200 tnn 8258: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8259: EXTRACT_SUFX= .zip
1.222 sevan 8260: </pre>
1.199 tnn 8261: </div>
8262: </div>
1.75 rillig 8263: </div>
1.148 asau 8264: <div class="sect1">
1.75 rillig 8265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8266: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 8267: <div class="sect2">
1.75 rillig 8268: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8269: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8270: <p>pkgsrc supports many different machines, with different
1.87 wiz 8271: object formats like a.out and ELF, and varying abilities to do
8272: shared library and dynamic loading at all. To accompany this,
8273: varying commands and options have to be passed to the
8274: compiler, linker, etc. to get the Right Thing, which can be
8275: pretty annoying especially if you don't have all the machines
8276: at your hand to test things. The
1.322 leot 8277: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/index.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128 wiz 8278: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 8279: both static and dynamic libraries from a set of source files,
8280: thus being platform-independent.</p>
8281: <p>Here's how to use libtool in a package in seven simple
8282: steps:</p>
1.128 wiz 8283: <div class="orderedlist"><ol class="orderedlist" type="1">
8284: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8285: Makefile.</p></li>
1.128 wiz 8286: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8287: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 8288: add it to the definition of <code class="varname">CC</code>, if only
8289: libraries are being built in a given Makefile. This one command
8290: will build both PIC and non-PIC library objects, so you need not
8291: have separate shared and non-shared library rules.</p></li>
1.128 wiz 8292: <li class="listitem">
1.75 rillig 8293: <p>For the linking of the library, remove any
1.128 wiz 8294: <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
8295: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 8296: <pre class="programlisting">
1.100 rillig 8297: ${LIBTOOL} --mode=link \
8298: ${CC} -o ${.TARGET:.a=.la} \
8299: ${OBJS:.o=.lo} \
8300: -rpath ${PREFIX}/lib \
8301: -version-info major:minor
1.222 sevan 8302: </pre>
1.75 rillig 8303: <p>Note that the library is changed to have a
1.87 wiz 8304: <code class="filename">.la</code> extension, and the objects are
8305: changed to have a <code class="filename">.lo</code>
8306: extension. Change <code class="varname">OBJS</code> as
8307: necessary. This automatically creates all of the
8308: <code class="filename">.a</code>,
8309: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8310: necessary) in the build directory. Be sure to include
1.128 wiz 8311: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 8312: minor are zero, as libtool will otherwise strip off the
8313: shared library version.</p>
1.75 rillig 8314: <p>From the libtool manual:</p>
8315: <pre class="programlisting">
1.100 rillig 8316: So, libtool library versions are described by three integers:
1.69 rillig 8317:
1.100 rillig 8318: CURRENT
8319: The most recent interface number that this library implements.
1.69 rillig 8320:
1.100 rillig 8321: REVISION
8322: The implementation number of the CURRENT interface.
1.69 rillig 8323:
1.100 rillig 8324: AGE
8325: The difference between the newest and oldest interfaces that
8326: this library implements. In other words, the library implements
8327: all the interface numbers in the range from number `CURRENT -
8328: AGE' to `CURRENT'.
1.1 grant 8329:
1.100 rillig 8330: If two libraries have identical CURRENT and AGE numbers, then the
8331: dynamic linker chooses the library with the greater REVISION number.
1.222 sevan 8332: </pre>
1.128 wiz 8333: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 8334: different results for a.out and ELF (excluding symlinks)
8335: in only one case. An ELF library of the form
1.128 wiz 8336: <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 8337: will have a symlink of
1.128 wiz 8338: <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 8339: on an a.out platform. This is handled
8340: automatically.</p>
1.128 wiz 8341: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 8342: directory of the library being built.</p>
1.76 rillig 8343: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8344: <code class="filename">.la</code> file, the other files will be
8345: added automatically.</p>
1.75 rillig 8346: </li>
1.128 wiz 8347: <li class="listitem">
1.76 rillig 8348: <p>When linking shared object (<code class="filename">.so</code>)
1.322 leot 8349: files, i.e. files that are loaded via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128 wiz 8350: shared libraries, use <span class="quote">“<span class="quote">-module
8351: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 8352: tacked on.</p>
1.76 rillig 8353: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8354: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8355: </li>
1.128 wiz 8356: <li class="listitem">
1.75 rillig 8357: <p>When linking programs that depend on these libraries
1.87 wiz 8358: <span class="emphasis"><em>before</em></span> they are installed, preface
1.322 leot 8359: the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ld.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 8360: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 8361: libraries (static or shared), but please be aware that
8362: libtool will not allow you to specify a relative path in
1.128 wiz 8363: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 8364: expects you to change that argument to be the
8365: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8366: <pre class="programlisting">
1.100 rillig 8367: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222 sevan 8368: </pre>
1.75 rillig 8369: <p>should be changed to:</p>
8370: <pre class="programlisting">
1.100 rillig 8371: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222 sevan 8372: </pre>
1.75 rillig 8373: <p>and it will do the right thing with the libraries.</p>
8374: </li>
1.128 wiz 8375: <li class="listitem">
1.322 leot 8376: <p>When installing libraries, preface the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8377: or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cp.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.128 wiz 8378: --mode=install</span>”</span>, and change the library name to
1.87 wiz 8379: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8380: <pre class="programlisting">
1.126 jakllsch 8381: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222 sevan 8382: </pre>
1.76 rillig 8383: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8384: shared library, any needed symlinks, and run
1.322 leot 8385: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75 rillig 8386: </li>
1.128 wiz 8387: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8388: the <code class="filename">.la</code>
8389: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8390: </ol></div>
8391: </div>
1.148 asau 8392: <div class="sect2">
1.75 rillig 8393: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8394: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8395: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8396: package Makefile. This will override the package's own libtool
8397: in most cases. For older libtool using packages, libtool is
8398: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8399: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8400: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8401: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8402: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 8403: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8404: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 8405: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8406: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8407: libraries built and installed, then use
8408: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8409: <p>If your package makes use of the platform-independent library
1.87 wiz 8410: for loading dynamic shared objects, that comes with libtool
8411: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8412: <p>Some packages use libtool incorrectly so that the package
8413: may not work or build in some circumstances. Some of the more
8414: common errors are:</p>
1.148 asau 8415: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8416: <li class="listitem">
1.75 rillig 8417: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8418: executable or library. This in itself isn't a problem if one of two things
8419: has been done:</p>
1.128 wiz 8420: <div class="orderedlist"><ol class="orderedlist" type="1">
8421: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 8422: <code class="filename">libfoo.la</code>, not
8423: <code class="filename">foo.la</code></p></li>
1.128 wiz 8424: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 8425: </ol></div>
8426: </li>
1.128 wiz 8427: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8428: The function lt_dlinit() should be called and the macro
8429: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8430: executables.</p></li>
1.75 rillig 8431: </ul></div>
8432: </div>
1.148 asau 8433: <div class="sect2">
1.75 rillig 8434: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8435: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8436: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8437: to regenerate the configure script and Makefile.in makefile
8438: templates, then they should be executed in a pre-configure
8439: target.</p>
1.75 rillig 8440: <p>For packages that need only autoconf:</p>
8441: <pre class="programlisting">
1.100 rillig 8442: AUTOCONF_REQD= 2.50 # if default version is not good enough
8443: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8444: ...
1.1 grant 8445:
1.100 rillig 8446: pre-configure:
8447: cd ${WRKSRC} && autoconf
1.1 grant 8448:
1.100 rillig 8449: ...
1.222 sevan 8450: </pre>
1.75 rillig 8451: <p>and for packages that need automake and autoconf:</p>
8452: <pre class="programlisting">
1.100 rillig 8453: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8454: USE_TOOLS+= automake # use "automake14" for automake-1.4
8455: ...
8456:
8457: pre-configure:
8458: set -e; cd ${WRKSRC}; \
8459: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8460:
1.100 rillig 8461: ...
1.222 sevan 8462: </pre>
1.75 rillig 8463: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8464: require GNU Make.</p>
1.75 rillig 8465: <p>There are times when the configure process makes
1.87 wiz 8466: additional changes to the generated files, which then causes
8467: the build process to try to re-execute the automake sequence.
8468: This is prevented by touching various files in the configure
8469: stage. If this causes problems with your package you can set
8470: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8471: Makefile.</p>
1.75 rillig 8472: </div>
8473: </div>
1.148 asau 8474: <div class="sect1">
1.75 rillig 8475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8476: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148 asau 8477: <div class="sect2">
1.87 wiz 8478: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8479: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8480: <p>Compilers for the C, C++, and Fortran languages comes with
8481: the NetBSD base system. By default, pkgsrc assumes that a package
8482: is written in C and will hide all other compilers (via the wrapper
1.299 rillig 8483: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8484: <p>To declare which language's compiler a package needs, set
8485: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.327 wiz 8486: currently are:
8487: </p>
8488: <pre class="programlisting">
8489: c99, c++, c++03, gnu++03, c++0x, gnu++0x, c++11, gnu++11,
8490: c++14, gnu++14, c++17, gnu++17, c++20, gnu++20, fortran,
8491: fortran77, java, objc, obj-c++, and ada.
8492: </pre>
8493: <p>
8494: (and any combination). The default is
1.128 wiz 8495: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 8496: written in C++, usually need a C compiler for the configure
8497: phase.</p>
8498: </div>
1.148 asau 8499: <div class="sect2">
1.87 wiz 8500: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8501: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87 wiz 8502: <p>If a program is written in Java, use the Java framework in
8503: pkgsrc. The package must include
8504: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8505: provides the following variables:</p>
1.148 asau 8506: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8507: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 8508: dependency on the JDK is added. If
1.128 wiz 8509: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 8510: there is only a runtime dependency on the JDK. The default is
1.128 wiz 8511: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 8512: JDK.</p></li>
1.128 wiz 8513: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 8514: a package needs a Java2 implementation. The supported values
1.128 wiz 8515: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8516: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8517: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8518: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 8519: above. This variable is not set by default.</p></li>
1.130 wiz 8520: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8521: automatically set to the runtime location of the used Java
8522: implementation dependency. It may be used to set
8523: <code class="varname">JAVA_HOME</code> to a good value if the program
8524: needs this variable to be defined.
8525: </p></li>
1.87 wiz 8526: </ul></div>
8527: </div>
1.148 asau 8528: <div class="sect2">
1.87 wiz 8529: <div class="titlepage"><div><div><h3 class="title">
1.320 wiz 8530: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
8531: <p>If a program is written in Go and has any dependencies on
8532: other Go modules, have the package include
8533: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8534: <div class="orderedlist"><ol class="orderedlist" type="1">
8535: <li class="listitem"><p>Generate a list of those dependencies with
8536: <span class="command"><strong>make clean && make patch && make show-go-modules >
8537: go-modules.mk</strong></span>.</p></li>
8538: <li class="listitem">
8539: <p>Prepend </p>
8540: <pre class="programlisting">.include
8541: "go-modules.mk"</pre>
8542: <p> to any other
8543: </p>
8544: <pre class="programlisting">.include</pre>
8545: <p>s.</p>
8546: </li>
8547: <li class="listitem"><p>Incorporate these modules in
8548: <code class="filename">distinfo</code> with <span class="command"><strong>make
8549: makesum</strong></span>.</p></li>
8550: </ol></div>
8551: </div>
8552: <div class="sect2">
8553: <div class="titlepage"><div><div><h3 class="title">
8554: <a name="perl-scripts"></a>21.4.4. Packages containing Perl scripts</h3></div></div></div>
1.318 nia 8555: <p>If your package contains interpreted Perl scripts, add
1.128 wiz 8556: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 8557: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8558: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8559: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 8560: that you want adjusted. Every occurrence of
8561: <code class="filename">*/bin/perl</code> in a she-bang line will be
1.325 gutterid 8562: replaced with the full path to the Perl executable.</p>
8563: <p>If a particular version of Perl is needed, set the
1.87 wiz 8564: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 8565: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.318 nia 8566: <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.325 gutterid 8567: about handling Perl modules.</p>
8568: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
8569: for the language now known as Raku.</p>
1.87 wiz 8570: </div>
1.148 asau 8571: <div class="sect2">
1.87 wiz 8572: <div class="titlepage"><div><div><h3 class="title">
1.320 wiz 8573: <a name="shell-scripts"></a>21.4.5. Packages containing shell scripts</h3></div></div></div>
1.147 wiz 8574: <p><code class="varname">REPLACE_SH</code>,
8575: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8576: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.309 gutterid 8577: hash bangs in files. Please use the appropriate one, preferring
1.147 wiz 8578: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183 wiz 8579: Each should contain a list of scripts, relative to
8580: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8581: occurrence of the matching shell in a she-bang line will be
8582: replaced with the full path to the shell executable.
1.147 wiz 8583: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8584: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8585: </div>
1.148 asau 8586: <div class="sect2">
1.147 wiz 8587: <div class="titlepage"><div><div><h3 class="title">
1.320 wiz 8588: <a name="other-programming-languages"></a>21.4.6. Other programming languages</h3></div></div></div>
1.325 gutterid 8589: <p>There are further similar REPLACE variables available, e.g.,
8590: <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
8591: and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.326 gutterid 8592: noted above, have their actions defined centrally in
1.325 gutterid 8593: <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.326 gutterid 8594: languages define the actions of these variables within their own
8595: dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
8596: actioned in <code class="filename">lang/php/phpversion.mk</code>, and
8597: <code class="varname">REPLACE_PYTHON</code> is actioned in
1.325 gutterid 8598: <code class="filename">lang/python/application.mk</code>. For other languages,
8599: consult the mk files found within their specific directories (the
8600: naming convention varies).</p>
8601: <p>Currently, special handling for other languages varies
1.87 wiz 8602: in pkgsrc. If a compiler package provides a
8603: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8604: just add a (build) dependency on the appropriate compiler
8605: package.</p>
8606: </div>
8607: </div>
1.148 asau 8608: <div class="sect1">
1.87 wiz 8609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8610: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8611: <p>The most common failures when building a package are that
8612: some platforms do not provide certain header files, functions or
8613: libraries, or they provide the functions in a library that the
8614: original package author didn't know. To work around this, you
8615: can rewrite the source code in most cases so that it does not
8616: use the missing functions or provides a replacement function.</p>
1.148 asau 8617: <div class="sect2">
1.77 rillig 8618: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8619: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8620: <p>If a package already comes with a GNU configure script, the
8621: preferred way to fix the build failure is to change the
8622: configure script, not the code. In the other cases, you can
8623: utilize the C preprocessor, which defines certain macros
8624: depending on the operating system and hardware architecture it
8625: compiles for. These macros can be queried using for example
8626: <code class="varname">#if defined(__i386)</code>. Almost every operating
8627: system, hardware architecture and compiler has its own macro.
8628: For example, if the macros <code class="varname">__GNUC__</code>,
8629: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8630: are all defined, you know that you are using NetBSD on an i386
8631: compatible CPU, and your compiler is GCC.</p>
8632: <p>The list of the following macros for hardware and
8633: operating system depends on the compiler that is used. For
8634: example, if you want to conditionally compile code on Solaris,
8635: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8636: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 8637: <div class="sect3">
1.75 rillig 8638: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8639: <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 8640: <p>To distinguish between 4.4 BSD-derived systems and the
8641: rest of the world, you should use the following code.</p>
8642: <pre class="programlisting">
1.100 rillig 8643: #include <sys/param.h>
8644: #if (defined(BSD) && BSD >= 199306)
8645: /* BSD-specific code goes here */
8646: #else
8647: /* non-BSD-specific code goes here */
8648: #endif
1.75 rillig 8649: </pre>
1.77 rillig 8650: <p>If this distinction is not fine enough, you can also test
8651: for the following macros.</p>
1.75 rillig 8652: <pre class="programlisting">
1.151 obache 8653: Cygwin __CYGWIN__
8654: DragonFly __DragonFly__
1.100 rillig 8655: FreeBSD __FreeBSD__
1.151 obache 8656: Haiku __HAIKU__
1.100 rillig 8657: Interix __INTERIX
8658: IRIX __sgi (TODO: get a definite source for this)
8659: Linux linux, __linux, __linux__
1.193 dholland 8660: Mac OS X __APPLE__
1.151 obache 8661: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8662: Minix3 __minix
1.100 rillig 8663: NetBSD __NetBSD__
8664: OpenBSD __OpenBSD__
8665: Solaris sun, __sun
1.75 rillig 8666: </pre>
8667: </div>
1.148 asau 8668: <div class="sect3">
1.75 rillig 8669: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8670: <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 8671: <pre class="programlisting">
1.100 rillig 8672: i386 i386, __i386, __i386__
8673: MIPS __mips
8674: SPARC sparc, __sparc
1.75 rillig 8675: </pre>
8676: </div>
1.148 asau 8677: <div class="sect3">
1.75 rillig 8678: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8679: <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 8680: <pre class="programlisting">
1.100 rillig 8681: GCC __GNUC__ (major version), __GNUC_MINOR__
8682: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8683: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8684: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8685: </pre>
8686: </div>
8687: </div>
1.148 asau 8688: <div class="sect2">
1.78 rillig 8689: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8690: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8691: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8692: combinations of compiler version and architecture and almost
8693: always relation to optimisation being enabled. Common symptoms
8694: are gcc internal errors or never finishing compiling a
1.78 rillig 8695: file.</p>
8696: <p>Typically, a workaround involves testing the
8697: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8698: optimisation for that combination of file,
1.198 tnn 8699: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8700: <p>This used to be a big problem in the past, but is rarely
8701: needed now as compiler technology has matured. If you still need
8702: to add a compiler specific workaround, please do so in the file
8703: <code class="filename">hacks.mk</code> and describe the symptom and
8704: compiler version as detailed as possible.</p>
1.78 rillig 8705: </div>
1.148 asau 8706: <div class="sect2">
1.78 rillig 8707: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 8708: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8709: <p>Compilation sometimes fails with an error message like this:</p>
8710: <pre class="programlisting">
8711: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8712: fatal error: pango/pango.h: No such file or directory
8713: </pre>
8714: <p>The proper way to fix this problem depends on the type of the
8715: header, which is described in the following sections.</p>
8716: <div class="sect3">
8717: <div class="titlepage"><div><div><h4 class="title">
8718: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8719: <p>If the header name looks like it comes from a different package,
8720: that other package should be included via the buildlink3
8721: framework.</p>
8722: <p>First, look whether the header is somewhere in the buildlink3
8723: directory below <code class="varname">WRKDIR</code>. In the above case of
8724: the missing Pango header:</p>
8725: <pre class="programlisting">
8726: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8727: </pre>
8728: <p>In the case of Pango, the output is:</p>
8729: <pre class="programlisting">
8730: work/.buildlink/include/pango-1.0/pango/pango.h
8731: </pre>
8732: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8733: in the <code class="filename">.buildlink</code> directory, it would have been
8734: found automatically. There is an extra <code class="filename">pango-1.0</code>
8735: path component though, which means that the compiler command line must
8736: contain an option of the form
8737: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8738: most cases this option is generated by the configure script, which can be examined using:</p>
8739: <pre class="programlisting">
8740: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8741: -I/usr/pkg/include/pango-1.0
8742: -I/usr/pkg/include/pango-1.0
8743: -I/usr/pkg/include/pango-1.0
8744: -I/usr/pkg/include/pango-1.0
8745: -I/usr/pkg/include/pango-1.0
8746: </pre>
8747: <p>This looks good. These options are transformed by the buildlink
8748: wrapper to refer to the correct path inside
8749: <code class="filename">work/.buildlink</code>.</p>
8750: <p>Since the compilation fails though, examine the compiler command
8751: lines in <code class="filename">work/.work.log</code> to see whether the
8752: <code class="literal">-I</code> option is included in the particular command
8753: line.</p>
8754: <p>To further analyze the situation, run <span class="command"><strong>bmake
8755: build-env</strong></span>, which sets up an interactive, realistic environment
8756: including all the pkgsrc wrapper commands and environment variables. From
8757: there, try to compile some simple example programs that use the
8758: header.</p>
8759: </div>
8760: <div class="sect3">
8761: <div class="titlepage"><div><div><h4 class="title">
8762: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8763: <p>If the name of the header seems to come from the package itself,
8764: and if the build is run with parallel jobs, the package may have some
8765: undeclared dependencies between the <code class="filename">.c</code> and the
8766: <code class="filename">.h</code> files, and a C file is compiled before its
8767: required header is generated.</p>
8768: <p>To see whether the build runs with parallel jobs, run
8769: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8770: like this:</p>
8771: <pre class="programlisting">
8772: usr MAKE_JOBS= 7
8773: pkg MAKE_JOBS_SAFE # undefined
8774: def _MAKE_JOBS_N= 7
8775: </pre>
8776: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8777: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8778: package could have disabled parallel builds by setting
8779: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8780: in this case it hasn't.</p>
8781: <p>To see whether the build failure is caused by parallel builds,
8782: first save the exact error message and a bit of context, maybe you need
8783: it later for reporting a bug. Next, run:</p>
8784: <pre class="programlisting">
8785: MAKE_JOBS_SAFE=no bmake clean build
8786: </pre>
8787: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8788: report</a> against the pkgsrc package, including the exact error
8789: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8790: </div>
1.288 rillig 8791: <div class="sect3">
8792: <div class="titlepage"><div><div><h4 class="title">
8793: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
8794: <p>Pkgsrc does not work reliably if any of
8795: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
8796: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
8797: bootstrap program prevents installing pkgsrc in symlink-based
8798: directories. Existing pkgsrc installations are not checked for symlinks
8799: though.</p>
8800: <p>The "No such file or directory" error messages are a typical
8801: symptom of symlinks, and it's quite difficult to find out that this is
8802: the actual cause.</p>
8803: </div>
8804: <div class="sect3">
8805: <div class="titlepage"><div><div><h4 class="title">
8806: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
8807: <p>When building a hierarchy of packages, it may happen that one
8808: package is built and then pkgsrc is updated. This situation can provoke
8809: various hard to diagnose build errors. To clean up the situation:</p>
8810: <pre class="programlisting">
8811: <code class="prompt">$</code> (cd ../../ && test -f mk/bsd.pkg.mk && rm -rf */*/work)
8812: </pre>
8813: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
8814: this command in the wrong directory.)</p>
8815: <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
8816: that directory as well.</p>
8817: </div>
8818: <div class="sect3">
8819: <div class="titlepage"><div><div><h4 class="title">
8820: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
8821: <p>On platforms other than BSD, third-party packages are installed in
8822: <code class="filename">/usr/include</code>, together with the base system. This
8823: means that pkgsrc cannot distinguish between headers provided by the base
8824: system (which it needs) and headers from third-party packages (which are
8825: often included in pkgsrc as well). This can lead to subtle version
8826: mismatches.</p>
8827: <p>In pkgsrc installations that have been active for several years, it
8828: may happen that some files are manually deleted. To exclude this unlikely
8829: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
8830: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
8831: check/fix dependencies.</p>
8832: <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>
8833: for contact information. Be prepared to describe what you have tried so
8834: far and what any error messages were.</p>
8835: </div>
1.287 rillig 8836: </div>
8837: <div class="sect2">
8838: <div class="titlepage"><div><div><h3 class="title">
8839: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.128 wiz 8840: </h3></div></div></div>
1.92 rillig 8841: <p>This error message often means that a package did not
1.78 rillig 8842: link to a shared library it needs. The following functions are
8843: known to cause this error message over and over.</p>
8844: <div class="informaltable">
1.216 tnn 8845: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78 rillig 8846: <colgroup>
8847: <col>
8848: <col>
8849: <col>
8850: </colgroup>
8851: <thead><tr>
8852: <th>Function</th>
8853: <th>Library</th>
8854: <th>Affected platforms</th>
8855: </tr></thead>
8856: <tbody>
8857: <tr>
8858: <td>accept, bind, connect</td>
8859: <td>-lsocket</td>
8860: <td>Solaris</td>
8861: </tr>
8862: <tr>
8863: <td>crypt</td>
8864: <td>-lcrypt</td>
8865: <td>DragonFly, NetBSD</td>
8866: </tr>
8867: <tr>
8868: <td>dlopen, dlsym</td>
8869: <td>-ldl</td>
8870: <td>Linux</td>
8871: </tr>
8872: <tr>
8873: <td>gethost*</td>
8874: <td>-lnsl</td>
8875: <td>Solaris</td>
8876: </tr>
8877: <tr>
8878: <td>inet_aton</td>
8879: <td>-lresolv</td>
8880: <td>Solaris</td>
8881: </tr>
8882: <tr>
8883: <td>nanosleep, sem_*, timer_*</td>
8884: <td>-lrt</td>
8885: <td>Solaris</td>
8886: </tr>
8887: <tr>
8888: <td>openpty</td>
8889: <td>-lutil</td>
8890: <td>Linux</td>
8891: </tr>
8892: </tbody>
8893: </table>
8894: </div>
8895: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8896: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8897: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8898: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8899: bmake</strong></span>.</p>
1.148 asau 8900: <div class="sect3">
1.92 rillig 8901: <div class="titlepage"><div><div><h4 class="title">
1.287 rillig 8902: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8903: <p>When you are using the SunPro compiler, there is another
8904: possibility. That compiler cannot handle the following code:</p>
8905: <pre class="programlisting">
1.100 rillig 8906: extern int extern_func(int);
1.93 rillig 8907:
1.100 rillig 8908: static inline int
8909: inline_func(int x)
8910: {
1.92 rillig 8911: return extern_func(x);
1.100 rillig 8912: }
1.93 rillig 8913:
1.100 rillig 8914: int main(void)
8915: {
1.92 rillig 8916: return 0;
1.100 rillig 8917: }
1.92 rillig 8918: </pre>
8919: <p>It generates the code for <code class="function">inline_func</code> even if
8920: that function is never used. This code then refers to
8921: <code class="function">extern_func</code>, which can usually not be resolved. To
8922: solve this problem you can try to tell the package to disable inlining
8923: of functions.</p>
8924: </div>
1.87 wiz 8925: </div>
1.148 asau 8926: <div class="sect2">
1.87 wiz 8927: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 8928: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87 wiz 8929: <p>Sometimes packages fail to build because the compiler runs
8930: into an operating system specific soft limit. With the
8931: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204 wiz 8932: to unlimit the resources. Currently, the allowed values are any combination of
8933: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8934: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.87 wiz 8935: Setting this variable is similar to running the shell builtin
1.110 hubertf 8936: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8937: segment size or maximum stack size of a process, respectively, to
8938: their hard limits.</p>
1.78 rillig 8939: </div>
1.75 rillig 8940: </div>
1.148 asau 8941: <div class="sect1">
1.75 rillig 8942: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8943: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 8944: <div class="sect2">
1.75 rillig 8945: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8946: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8947: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8948: with some operating systems cannot create more than one
8949: directory at a time. As such, you should call
8950: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8951: <pre class="programlisting">
1.100 rillig 8952: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8953: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222 sevan 8954: </pre>
1.128 wiz 8955: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8956: dir2</code></span>”</span> to the
1.87 wiz 8957: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8958: automatically do the right thing.</p>
1.75 rillig 8959: </div>
1.148 asau 8960: <div class="sect2">
1.75 rillig 8961: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8962: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8963: <p>In general, documentation should be installed into
1.87 wiz 8964: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8965: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8966: includes the version number of the package).</p>
1.84 wiz 8967: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8968: directory where HTML documentation is installed with the
1.128 wiz 8969: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8970: is needed because otherwise the documentation ends up in
8971: <code class="filename">${PREFIX}/share/doc/html</code> or other
8972: places.</p>
8973: <p>An exception to the above is that library API documentation
1.322 leot 8974: generated with the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/index.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87 wiz 8975: browsers (devhelp) should be left at their default location, which
8976: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8977: documentation can be recognized from files ending in
8978: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8979: (It is also acceptable to install such files in
8980: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8981: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8982: <code class="filename">.devhelp*</code> file must be directly in that
8983: directory then, no additional subdirectory level is allowed in
8984: this case. This is usually achieved by using
1.128 wiz 8985: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8986: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8987: though.)</p>
1.75 rillig 8988: </div>
1.148 asau 8989: <div class="sect2">
1.75 rillig 8990: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8991: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8992: <p>Certain packages, most of them in the games category, install
1.87 wiz 8993: a score file that allows all users on the system to record their
8994: highscores. In order for this to work, the binaries need to be
8995: installed setgid and the score files owned by the appropriate
1.142 wiz 8996: group and/or owner (traditionally the "games" user/group). Set
8997: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8998: following variables, documented in more detail in
8999: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 9000: behaviour: <code class="varname">GAMEDATAMODE</code>,
9001: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210 leot 9002: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
9003: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
9004: <code class="varname">GAMEDATA_PERMS</code> and
9005: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
9006: <p>An example that illustrates some of the variables described above is
9007: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
9008: used to properly set directory permissions of the directory where the
9009: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
9010: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
9011: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
9012: binary:</p>
9013: <pre class="programlisting">
1.223 rillig 9014: USE_GAMESGROUP= yes
1.210 leot 9015:
1.223 rillig 9016: BUILD_DEFS+= VARBASE
1.210 leot 9017:
1.223 rillig 9018: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
9019: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
9020: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222 sevan 9021: </pre>
1.210 leot 9022: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
9023: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
9024: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
9025: needed to be accessed by setgid games and
9026: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114 jmcneill 9027: <p>A package should therefore never hard code file ownership or
1.210 leot 9028: access permissions but rely on <code class="varname">*_PERMS</code> as described above
9029: or alternatively on <code class="varname">INSTALL_GAME</code>,
9030: <code class="varname">INSTALL_GAME_DATA</code> and
9031: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75 rillig 9032: </div>
1.148 asau 9033: <div class="sect2">
1.75 rillig 9034: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9035: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 9036: <p><code class="varname">DESTDIR</code> support means that a package
9037: installs into a staging directory, not the final location of the
9038: files. Then a binary package is created which can be used for
9039: installation as usual. There are two ways: Either the package must
1.128 wiz 9040: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9041: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 9042: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9043: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224 leot 9044: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
9045: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145 wiz 9046: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9047: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 9048: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9049: the inclusion.</p></li>
1.128 wiz 9050: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 9051: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 9052: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 9053: automatically. Many manual rules and pre/post-install often are
9054: incorrect; fix them.</p></li>
1.128 wiz 9055: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 9056: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 9057: <li class="listitem"><p>In general, packages should support
1.103 wiz 9058: <code class="varname">UNPRIVILEGED</code> to be able to use
9059: DESTDIR.</p></li>
9060: </ul></div>
9061: </div>
1.148 asau 9062: <div class="sect2">
1.103 wiz 9063: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9064: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 9065: <p>Your package may also contain scripts with hardcoded paths to
1.318 nia 9066: other interpreters besides (or as well as) Perl. To correct the
1.87 wiz 9067: full pathname to the script interpreter, you need to set the
9068: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 9069: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 9070: <pre class="programlisting">
1.100 rillig 9071: REPLACE_INTERPRETER+= tcl
9072: REPLACE.tcl.old= .*/bin/tclsh
9073: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9074: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9075: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222 sevan 9076: </pre>
1.148 asau 9077: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9078: <h3 class="title">Note</h3>
9079: <p>Before March 2006, these variables were called
1.87 wiz 9080: <code class="varname">_REPLACE.*</code> and
9081: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 9082: </div>
9083: </div>
1.148 asau 9084: <div class="sect2">
1.75 rillig 9085: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9086: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.75 rillig 9087: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 9088: the Makefile fragment
9089: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 9090: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 9091: configuration for such modules as well as various hooks to tune
9092: this configuration. See comments in this file for
9093: details.</p>
1.75 rillig 9094: <p>Perl5 modules will install into different places depending
1.87 wiz 9095: on the version of perl used during the build process. To
9096: address this, pkgsrc will append lines to the
9097: <code class="filename">PLIST</code> corresponding to the files listed in
9098: the installed <code class="filename">.packlist</code> file generated by
9099: most perl5 modules. This is invoked by defining
9100: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 9101: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9102: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9103: e.g.:</p>
1.75 rillig 9104: <pre class="programlisting">
1.153 wiz 9105: PERL5_PACKLIST= auto/Pg/.packlist
1.222 sevan 9106: </pre>
1.153 wiz 9107: <p>The perl5 config variables
9108: <code class="varname">installarchlib</code>,
9109: <code class="varname">installscript</code>,
9110: <code class="varname">installvendorbin</code>,
9111: <code class="varname">installvendorscript</code>,
9112: <code class="varname">installvendorarch</code>,
9113: <code class="varname">installvendorlib</code>,
9114: <code class="varname">installvendorman1dir</code>, and
9115: <code class="varname">installvendorman3dir</code> represent those
9116: locations in which components of perl5 modules may be installed,
9117: provided as variable with uppercase and prefixed with
9118: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9119: and may be used by perl5 packages that don't have a packlist.
9120: These variables are also substituted for in the
9121: <code class="filename">PLIST</code> as uppercase prefixed with
9122: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 9123: </div>
1.148 asau 9124: <div class="sect2">
1.75 rillig 9125: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9126: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 9127: <p>Some packages install info files or use the
1.128 wiz 9128: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 9129: commands. <code class="varname">INFO_FILES</code> should be defined in
9130: the package Makefile so that <code class="filename">INSTALL</code> and
9131: <code class="filename">DEINSTALL</code> scripts will be generated to
9132: handle registration of the info files in the Info directory
1.128 wiz 9133: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 9134: files registration is either provided by the system, or by a
9135: special purpose package automatically added as dependency if
9136: needed.</p>
1.75 rillig 9137: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 9138: <code class="filename">${PREFIX}</code> where info files are primarily
9139: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 9140: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 9141: <p>The info files for the package should be listed in the
1.87 wiz 9142: package <code class="filename">PLIST</code>; however any split info files
9143: need not be listed.</p>
1.128 wiz 9144: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9145: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 9146: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 9147: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 9148: should be noted with the <code class="varname">TEXINFO_REQD</code>
9149: variable in the package <code class="filename">Makefile</code>. By
9150: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 9151: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 9152: does not match the required minimum, a build dependency on the
1.322 leot 9153: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/index.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87 wiz 9154: be added automatically.</p>
1.75 rillig 9155: <p>The build and installation process of the software provided
1.87 wiz 9156: by the package should not use the
1.110 hubertf 9157: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 9158: info files is the task of the package
9159: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 9160: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 9161: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 9162: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9163: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 9164: in <code class="varname">PATH</code>.</p>
1.110 hubertf 9165: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 9166: no effect except the logging of a message. The script overriding
1.110 hubertf 9167: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 9168: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 9169: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 9170: </div>
1.148 asau 9171: <div class="sect2">
1.75 rillig 9172: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9173: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 9174: <p>All packages that install manual pages should install them
1.87 wiz 9175: into the same directory, so that there is one common place to look
9176: for them. In pkgsrc, this place is
9177: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9178: should be used in packages. The default for
9179: <code class="varname">PKGMANDIR</code> is
1.128 wiz 9180: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9181: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 9182: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9183: <h3 class="title">Note</h3>
1.87 wiz 9184: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9185: is far from complete.</p>
1.75 rillig 9186: </div>
1.81 rillig 9187: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 9188: <code class="filename">man/</code> as the top level directory for the man
9189: page file entries, and the pkgsrc framework will convert as
9190: needed. In all other places, the correct
9191: <code class="varname">PKGMANDIR</code> must be used.</p>
9192: <p>Packages that are
9193: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 9194: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 9195: <code class="filename">./configure</code>
9196: --mandir switch to set where the man pages should be installed.
9197: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9198: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9199: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9200: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 9201: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 9202: Or if the <code class="filename">./configure</code> script uses
9203: a non-standard use of --mandir, you can set
9204: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299 rillig 9205: <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 9206: information on installation of compressed manual pages.</p>
1.75 rillig 9207: </div>
1.148 asau 9208: <div class="sect2">
1.75 rillig 9209: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9210: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9211: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9212: the fonts database in the directory where they get installed at
9213: installation and deinstallation time. This can be automatically
9214: done by using the pkginstall framework.</p>
1.75 rillig 9215: <p>You can list the directories where fonts are installed in the
1.87 wiz 9216: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9217: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 9218: <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 9219: Also make sure that the database file
9220: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9221: <p>Note that you should not create new directories for fonts;
1.87 wiz 9222: instead use the standard ones to avoid that the user needs to
9223: manually configure his X server to find them.</p>
1.75 rillig 9224: </div>
1.148 asau 9225: <div class="sect2">
1.75 rillig 9226: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9227: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9228: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9229: registered in system-wide catalogs (like DTDs, sub-catalogs,
9230: etc.), you need to take some extra steps:</p>
1.128 wiz 9231: <div class="orderedlist"><ol class="orderedlist" type="1">
9232: <li class="listitem"><p>Include
1.87 wiz 9233: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9234: your <code class="filename">Makefile</code>, which takes care of
9235: registering those files in system-wide catalogs at
9236: installation and deinstallation time.</p></li>
1.128 wiz 9237: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9238: any SGML catalogs installed by the package.</p></li>
1.128 wiz 9239: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9240: any XML catalogs installed by the package.</p></li>
1.128 wiz 9241: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9242: to be added to the SGML catalog. These come in groups of
9243: three strings; see xmlcatmgr(1) for more information
9244: (specifically, arguments recognized by the 'add' action).
9245: Note that you will normally not use this variable.</p></li>
1.128 wiz 9246: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9247: to be added to the XML catalog. These come in groups of three
9248: strings; see xmlcatmgr(1) for more information (specifically,
9249: arguments recognized by the 'add' action). Note that you will
9250: normally not use this variable.</p></li>
1.75 rillig 9251: </ol></div>
9252: </div>
1.148 asau 9253: <div class="sect2">
1.75 rillig 9254: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9255: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9256: <p>If a package provides extensions to the MIME database by
1.87 wiz 9257: installing <code class="filename">.xml</code> files inside
9258: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9259: need to take some extra steps to ensure that the database is kept
9260: consistent with respect to these new files:</p>
1.128 wiz 9261: <div class="orderedlist"><ol class="orderedlist" type="1">
9262: <li class="listitem"><p>Include
1.87 wiz 9263: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9264: (avoid using the <code class="filename">buildlink3.mk</code> file from
9265: this same directory, which is reserved for inclusion from
9266: other <code class="filename">buildlink3.mk</code> files). It takes
9267: care of rebuilding the MIME database at installation and
9268: deinstallation time, and disallows any access to it directly
9269: from the package.</p></li>
1.128 wiz 9270: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 9271: <code class="filename">share/mime</code> directory,
9272: <span class="emphasis"><em>except</em></span> for files saved under
9273: <code class="filename">share/mime/packages</code>. The former are
9274: handled automatically by
9275: the update-mime-database program, but the latter are
9276: package-dependent and must be removed by the package that
9277: installed them in the first place.</p></li>
1.128 wiz 9278: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9279: from the PLIST. They will be handled by the shared-mime-info
9280: package.</p></li>
1.75 rillig 9281: </ol></div>
9282: </div>
1.148 asau 9283: <div class="sect2">
1.75 rillig 9284: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9285: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.93 rillig 9286: <p>If a package uses intltool during its build, add
9287: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9288: which forces it to use the intltool package provided by pkgsrc,
9289: instead of the one bundled with the distribution file.</p>
1.75 rillig 9290: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9291: latest available version; this way, the package benefits of any
9292: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9293: </div>
1.148 asau 9294: <div class="sect2">
1.75 rillig 9295: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9296: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9297: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9298: the startup directory by default, but you can enable it, by adding
9299: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9300: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9301: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9302: it will automatically remove the scripts when the package is
9303: deinstalled.</p>
1.75 rillig 9304: </div>
1.148 asau 9305: <div class="sect2">
1.75 rillig 9306: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9307: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9308: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9309: the <code class="filename">ls-R</code> database of the tree needs to be
9310: updated.</p>
1.148 asau 9311: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 9312: <h3 class="title">Note</h3>
1.125 wiz 9313: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 9314: packages should install files
1.125 wiz 9315: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9316: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 9317: </div>
1.128 wiz 9318: <div class="orderedlist"><ol class="orderedlist" type="1">
9319: <li class="listitem"><p>Include
1.125 wiz 9320: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 9321: takes care of rebuilding the <code class="filename">ls-R</code>
9322: database at installation and deinstallation time.</p></li>
1.128 wiz 9323: <li class="listitem">
1.75 rillig 9324: <p>If your package installs files into a texmf
1.87 wiz 9325: tree other than the one
1.125 wiz 9326: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9327: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 9328: trees that need database update.</p>
1.75 rillig 9329: <p>If your package also installs font map files that need
1.110 hubertf 9330: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 9331: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 9332: set <code class="varname">TEX_MAP_FILES</code> and/or
9333: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 9334: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9335: be run automatically at installation/deinstallation to
9336: enable/disable font map files for TeX output
9337: drivers.</p>
1.75 rillig 9338: </li>
1.128 wiz 9339: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9340: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 9341: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 9342: </ol></div>
9343: </div>
1.148 asau 9344: <div class="sect2">
1.85 jmmv 9345: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9346: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.87 wiz 9347: emulation</h3></div></div></div>
9348: <p>There are some packages that provide libraries and
9349: executables for running binaries from a one operating system
9350: on a different one (if the latter supports it). One example
9351: is running Linux binaries on NetBSD.</p>
1.322 leot 9352: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/index.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87 wiz 9353: helps in extracting and packaging Linux rpm packages.</p>
9354: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9355: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9356: if all libraries for each installed executable can be found by
9357: the dynamic linker. Since the standard dynamic linker is run,
9358: this fails for emulation packages, because the libraries used
9359: by the emulation are not in the standard directories.</p>
9360: </div>
1.299 rillig 9361: <div class="sect2">
9362: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9363: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.299 rillig 9364: <p>If a package installs images under the
9365: <code class="filename">share/icons/hicolor</code> and/or updates the
9366: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9367: database, you need to take some extra steps to make sure that the
9368: shared theme directory is handled appropriately and that the cache
9369: database is rebuilt:</p>
9370: <div class="orderedlist"><ol class="orderedlist" type="1">
9371: <li class="listitem"><p>Include
9372: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9373: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9374: entry that refers to the theme cache.</p></li>
9375: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9376: directories from the <code class="filename">share/icons/hicolor</code>
9377: hierarchy because they will be handled automatically.</p></li>
9378: </ol></div>
9379: <p>The best way to verify that the PLIST is correct with
9380: respect to the last two points is to regenerate it using
9381: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9382: </div>
9383: <div class="sect2">
9384: <div class="titlepage"><div><div><h3 class="title">
1.318 nia 9385: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.299 rillig 9386: <p>If a package installs <code class="filename">.desktop</code> files
9387: under <code class="filename">share/applications</code> and these include
9388: MIME information (MimeType key), you need to take extra steps to
9389: ensure that they are registered into the MIME database:</p>
9390: <div class="orderedlist"><ol class="orderedlist" type="1">
9391: <li class="listitem"><p>Include
9392: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9393: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9394: <code class="filename">share/applications/mimeinfo.cache</code> file.
9395: It will be handled automatically.</p></li>
9396: </ol></div>
9397: <p>The best way to verify that the PLIST is correct with
9398: respect to the last point is to regenerate it using <span class="command"><strong>make
9399: print-PLIST</strong></span>.</p>
9400: </div>
9401: </div>
9402: <div class="sect1">
9403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9404: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9405: <p>In some cases one does not have the time to solve a problem
9406: immediately. In this case, one can plainly mark a package as broken. For
9407: this, one just sets the variable <code class="varname">BROKEN</code> to the
9408: reason why the package is broken (similar to the
9409: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9410: the package will immediately be shown this message, and the build
9411: will not be even tried.</p>
9412: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9413: intervals.</p>
9414: </div>
9415: </div>
9416: <div class="chapter">
9417: <div class="titlepage"><div><div><h2 class="title">
9418: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9419: <div class="toc">
9420: <p><b>Table of Contents</b></p>
9421: <dl class="toc">
9422: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9423: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9424: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9425: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9426: </dl>
9427: </div>
9428: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9429: site</a>:</p>
9430: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9431: environment, an intuitive and attractive desktop for users, and the
9432: GNOME development platform, an extensive framework for building
9433: applications that integrate into the rest of the desktop.</p></blockquote></div>
9434: <p>pkgsrc provides a seamless way to automatically build and install
9435: a complete GNOME environment <span class="emphasis"><em>under many different
9436: platforms</em></span>. We can say with confidence that pkgsrc is one of
9437: the most advanced build and packaging systems for GNOME due to its
9438: included technologies buildlink3, the wrappers and tools framework and
9439: automatic configuration file management. Lots of efforts are put into
9440: achieving a completely clean deinstallation of installed software
9441: components.</p>
9442: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9443: the above also means that great efforts are put into making GNOME work
1.316 cirnatda 9444: under this operating system.</p>
1.299 rillig 9445: <p>This chapter is aimed at pkgsrc developers and other people
9446: interested in helping our GNOME porting and packaging efforts. It
9447: provides instructions on how to manage the existing packages and some
9448: important information regarding their internals.</p>
9449: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9450: <h3 class="title">We need your help!</h3>
9451: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9452: and GNOME and are willing to learn new exciting stuff, please jump
9453: straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9454: work</a> list! There is still a long way to go to get a
9455: fully-functional GNOME desktop under NetBSD and we need your help to
9456: achieve it!</p>
9457: </div>
9458: <div class="sect1">
9459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9460: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9461: <p>pkgsrc includes three GNOME-related meta packages:</p>
9462: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.322 leot 9463: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/index.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.299 rillig 9464: the core GNOME desktop environment. It only includes the necessary
9465: bits to get it to boot correctly, although it may lack important
9466: functionality for daily operation. The idea behind this package is
9467: to let end users build their own configurations on top of this one,
9468: first installing this meta package to achieve a functional setup and
9469: then adding individual applications.</p></li>
1.322 leot 9470: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.299 rillig 9471: complete installation of the GNOME platform and desktop as defined
9472: by the GNOME project; this is based on the components distributed in
9473: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9474: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9475: official FTP server. Developer-only tools found in those
9476: directories are not installed unless required by some other
9477: component to work properly. Similarly, packages from the bindings
9478: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9479: in unless required as a dependency for an end-user component. This
1.322 leot 9480: package "extends" <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/index.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
9481: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.299 rillig 9482: Installs all the tools required to build a GNOME component when
9483: fetched from the CVS repository. These are required to let the
9484: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9485: </ul></div>
9486: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9487: sorted in a way that eases updates: a package may depend on other
9488: packages listed before it but not on any listed after it. It is very
9489: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9490: change it to alphabetical sorting!</em></span></p>
9491: </div>
9492: <div class="sect1">
9493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9494: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9495: <p>Almost all GNOME applications are written in C and use a common
9496: set of tools as their build system. Things get different with the new
9497: bindings to other languages (such as Python), but the following will
9498: give you a general idea on the minimum required tools:</p>
9499: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9500: <li class="listitem">
9501: <p>Almost all GNOME applications use the GNU Autotools as their
9502: build system. As a general rule you will need to tell this to your
9503: package:</p>
9504: <pre class="programlisting">
9505: GNU_CONFIGURE=yes
9506: USE_LIBTOOL=yes
9507: USE_TOOLS+=gmake
9508: </pre>
9509: </li>
9510: <li class="listitem">
9511: <p>If the package uses pkg-config to detect dependencies, add this
9512: tool to the list of required utilities:</p>
9513: <pre class="programlisting">
9514: USE_TOOLS+=pkg-config
9515: </pre>
1.322 leot 9516: <p>Also use <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/index.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.299 rillig 9517: the end of the build process to ensure that you did not miss to
9518: specify any dependency in your package and that the version
9519: requirements are all correct.</p>
9520: </li>
9521: <li class="listitem"><p>If the package uses intltool, be sure to add
9522: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9523: to handle dependencies and to force the package to use the latest
9524: available version.</p></li>
9525: <li class="listitem">
9526: <p>If the package uses gtk-doc (a documentation generation
9527: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9528: tool is rather big and the distfile should come with pregenerated
9529: documentation anyway; if it does not, it is a bug that you ought to
9530: report. For such packages you should disable gtk-doc (unless it is
9531: the default):</p>
9532: <pre class="programlisting">
9533: CONFIGURE_ARGS+=--disable-gtk-doc
9534: </pre>
9535: <p>The default location of installed HTML files
9536: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9537: and should not be changed unless the package insists on installing
9538: them somewhere else. Otherwise programs as
9539: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9540: do that with an entry similar to:</p>
9541: <pre class="programlisting">
9542: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9543: </pre>
9544: </li>
9545: </ul></div>
9546: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9547: files under the installation prefix to maintain databases. In this
9548: context, shared means that those exact same directories and files are
9549: used among several different packages, leading to conflicts in the
9550: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9551: handle the most common cases, so you have to forget about using
9552: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9553: omitting shared files from them. If you find yourself doing those,
9554: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9555: <p>The following table lists the common situations that result in
9556: using shared directories or files. For each of them, the appropriate
9557: solution is given. After applying the solution be sure to
9558: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9559: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9560: <div class="table">
9561: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9562: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9563: <colgroup>
9564: <col>
9565: <col>
9566: </colgroup>
9567: <thead><tr>
9568: <th>If the package...</th>
9569: <th>Then...</th>
9570: </tr></thead>
9571: <tbody>
9572: <tr>
9573: <td>Installs icons under the
9574: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9575: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.318 nia 9576: <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 9577: </tr>
9578: <tr>
9579: <td>Installs files under
9580: <code class="filename">share/mime/packages</code>.</td>
1.318 nia 9581: <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 9582: </tr>
9583: <tr>
9584: <td>Installs <code class="filename">.desktop</code> files under
9585: <code class="filename">share/applications</code> and these include MIME
9586: information.</td>
1.318 nia 9587: <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 9588: </tr>
9589: </tbody>
9590: </table></div>
1.75 rillig 9591: </div>
1.299 rillig 9592: <br class="table-break">
1.75 rillig 9593: </div>
1.148 asau 9594: <div class="sect1">
1.87 wiz 9595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 9596: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9597: <p>When seeing GNOME as a whole, there are two kinds of
9598: updates:</p>
9599: <div class="variablelist"><dl class="variablelist">
9600: <dt><span class="term">Major update</span></dt>
9601: <dd>
9602: <p>Given that there is still a very long way for GNOME 3 (if it
9603: ever appears), we consider a major update one that goes from a
9604: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9605: where <code class="literal">Y</code> is even and greater than
9606: <code class="literal">X</code>. These are hard to achieve because they
9607: introduce lots of changes in the components' code and almost all
9608: GNOME distfiles are updated to newer versions. Some of them can
9609: even break API and ABI compatibility with the previous major
9610: version series. As a result, the update needs to be done all at
9611: once to minimize breakage.</p>
9612: <p>A major update typically consists of around 80 package
9613: updates and the addition of some new ones.</p>
9614: </dd>
9615: <dt><span class="term">Minor update</span></dt>
9616: <dd>
9617: <p>We consider a minor update one that goes from a
9618: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9619: one where <code class="literal">Y</code> is greater than
9620: <code class="literal">X</code>. These are easy to achieve because they do
9621: not update all GNOME components, can be done in an incremental way
9622: and do not break API nor ABI compatibility.</p>
9623: <p>A minor update typically consists of around 50 package
9624: updates, although the numbers here may vary a lot.</p>
9625: </dd>
9626: </dl></div>
9627: <p>In order to update the GNOME components in pkgsrc to a new stable
9628: release (either major or minor), the following steps should be
9629: followed:</p>
9630: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128 wiz 9631: <li class="listitem">
1.299 rillig 9632: <p>Get a list of all the tarballs that form the new release by
9633: using the following commands. These will leave the full list of the
9634: components' distfiles into the <code class="filename">list.txt</code>
9635: file:</p>
9636: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9637: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9638: awk '{ print $9 }' >list.txt</code></strong>
9639: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9640: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9641: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.75 rillig 9642: </li>
1.299 rillig 9643: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9644: bump their version to the release you are updating them to. The
9645: three meta packages should be always consistent with versioning.
9646: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9647: in them.</p></li>
1.128 wiz 9648: <li class="listitem">
1.299 rillig 9649: <p>For each meta package, update all its
9650: <code class="varname">DEPENDS</code> lines to match the latest versions as
9651: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9652: newer version (even if found in the FTP) because the meta packages
9653: are supposed to list the exact versions that form a specific GNOME
9654: release. Exceptions are permitted here if a newer version solves a
9655: serious issue in the overall desktop experience; these typically
9656: come in the form of a revision bump in pkgsrc, not in newer versions
9657: from the developers.</p>
9658: <p>Packages not listed in the <code class="filename">list.txt</code> file
9659: should be updated to the latest version available (if found in
9660: pkgsrc). This is the case, for example, of the dependencies on the
1.322 leot 9661: GNU Autotools in the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.75 rillig 9662: </li>
1.128 wiz 9663: <li class="listitem">
1.299 rillig 9664: <p>Generate a patch from the modified meta packages and extract the
9665: list of "new" lines. This will provide you an outline on what
9666: packages need to be updated in pkgsrc and in what order:</p>
9667: <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 9668: </li>
1.299 rillig 9669: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9670: installed packages and start over from scratch at this point.</p></li>
9671: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9672: of <code class="filename">todo.txt</code> and update the packages listed in
9673: it in order. For major desktop updates none of these should be
9674: committed until the entire set is completed because there are chances
9675: of breaking not-yet-updated packages.</p></li>
9676: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9677: the tree one by one with appropriate log messages. At the end,
9678: commit the three meta package updates and all the corresponding
9679: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9680: <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>
9681: </ol></div>
9682: </div>
9683: <div class="sect1">
9684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9685: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9686: <p>GNOME is a very big component in pkgsrc which approaches 100
9687: packages. Please, it is very important that you always, always,
9688: <span class="strong"><strong>always</strong></span> feed back any portability
9689: 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
9690: their attention on portability issues and to ensure that future versions
9691: can be built out-of-the box on NetBSD. The less custom patches in
9692: pkgsrc, the easier further updates are. Those developers in charge of
9693: issuing major GNOME updates will be grateful if you do that.</p>
1.315 cirnatda 9694: <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
9695: GitLab</a>. Not all components use these to track bugs, but most
1.299 rillig 9696: of them do. Do not be short on your reports: always provide detailed
9697: explanations of the current failure, how it can be improved to achieve
1.315 cirnatda 9698: maximum portability and, if at all possible, provide a patch against the
9699: main Git branch. The more verbose you are, the higher chances of your
9700: patch being accepted.</p>
1.299 rillig 9701: <p>Also, please avoid using preprocessor magic to fix portability
9702: issues. While the FreeBSD GNOME people are doing a great job in porting
9703: GNOME to their operating system, the official GNOME sources are now
9704: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9705: and similar macros. This hurts portability. Please see our patching
9706: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9707: details.</p>
9708: </div>
1.75 rillig 9709: </div>
1.148 asau 9710: <div class="chapter">
1.75 rillig 9711: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9712: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75 rillig 9713: <div class="toc">
9714: <p><b>Table of Contents</b></p>
1.210 leot 9715: <dl class="toc">
1.267 rillig 9716: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9717: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9718: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9719: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9720: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9721: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9722: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9723: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9724: </dl>
9725: </div>
1.148 asau 9726: <div class="sect1">
1.75 rillig 9727: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9728: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9729: <p>Our policy is that we accept binaries only from pkgsrc
9730: developers to guarantee that the packages don't contain any
9731: trojan horses etc. This is not to annoy anyone but rather to
9732: protect our users! You're still free to put up your home-made
9733: binary packages and tell the world where to get them. NetBSD
9734: developers doing bulk builds and wanting to upload them please
1.267 rillig 9735: 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 9736: builds)</i></a>.</p>
1.75 rillig 9737: </div>
1.148 asau 9738: <div class="sect1">
1.75 rillig 9739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9740: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9741: <p>First, check that your package is complete, compiles and
1.299 rillig 9742: 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.322 leot 9743: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82 rillig 9744: archive that contains all files that make up the package.
1.87 wiz 9745: Finally, send this package to the pkgsrc bug tracking system,
1.322 leot 9746: either with the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87 wiz 9747: that, go to the web page
1.289 leot 9748: <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 9749: which contains some instructions and a link to a form where you
9750: can submit packages. The
1.322 leot 9751: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/index.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.124 snj 9752: also available as a substitute for either of the above two tools.
9753: </p>
1.87 wiz 9754: <p>In the form of the problem report, the category should be
1.128 wiz 9755: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 9756: and version number, and the description field should contain a
9757: short description of your package (contents of the COMMENT
9758: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 9759: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 9760: <p>If you want to submit several packages, please send a
9761: separate PR for each one, it's easier for us to track things
9762: that way.</p>
9763: <p>Alternatively, you can also import new packages into
1.128 wiz 9764: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.289 leot 9765: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
1.75 rillig 9766: for details.</p>
9767: </div>
1.148 asau 9768: <div class="sect1">
1.75 rillig 9769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9770: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9771: <p>Please note all package additions, updates, moves, and
1.93 rillig 9772: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9773: important to keep this file up to date and conforming to the
9774: existing format, because it will be used by scripts to
1.289 leot 9775: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9776: sites. Additionally, check the
1.76 rillig 9777: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9778: for the package you updated or removed, in case it was mentioned
9779: there.</p>
9780: <p>When the <code class="varname">PKGREVISION</code> of a package is
9781: bumped, the change should appear in
1.93 rillig 9782: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9783: related or otherwise relevant. Mass bumps that result from a
9784: dependency being updated should not be mentioned. In all other
9785: cases it's the developer's decision.</p>
9786: <p>There is a make target that helps in creating proper
1.110 hubertf 9787: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9788: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9789: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9790: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9791: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9792: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9793: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9794: For new packages, or package moves or removals, set the
9795: <code class="varname">CTYPE</code> variable on the command line to "Added",
9796: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9797: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 9798: not the same as your NetBSD login name. The target also automatically
9799: removes possibly existing entries for the package in the
9800: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 9801: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 9802: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 9803: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9804: makes the cvs commands use the main repository.
9805: </p>
1.75 rillig 9806: </div>
1.148 asau 9807: <div class="sect1">
1.75 rillig 9808: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9809: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243 wiz 9810: <p>For several years, there have been mirrors of pkgsrc in
9811: fossil, git, and hg. Standard practise when using these tools is to
9812: make the first line of a commit message function as a summary that
9813: can be read without the rest, such as is commonly done with "git log
9814: --oneline". For this reason, we have the following guidelines for
9815: pkgsrc commit messages:</p>
9816: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9817: <li class="listitem"><p>Start the commit message with a line that explains the
1.244 wiz 9818: big picture in 65 characters or less. When a commit is for one
1.243 wiz 9819: package, include the name of the package. For updates, include the
9820: version to which it is updated.</p></li>
9821: <li class="listitem"><p>Leave the next line empty.</p></li>
9822: <li class="listitem"><p>Then come the details for the commit (changes in that
9823: package, reason for a change) and any relevant PRs. Wrap this
9824: section.</p></li>
9825: </ul></div>
9826: <p>Here is an example:
9827: </p>
9828: <pre class="programlisting">
9829: libxslt: update to 1.0.30
9830:
9831: Changes since 1.0.29:
9832: ...
9833: </pre>
9834: <p>
9835: </p>
9836: <p>Here is another example:
9837: </p>
9838: <pre class="programlisting">
9839: mk/bsd.pkg.mk: enable SSP by default on NetBSD
9840:
9841: (rationale)
9842: </pre>
9843: <p>
9844: </p>
9845: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
9846: allowed on the pkgsrc repository to change commit messages.</p>
9847: </div>
9848: <div class="sect1">
9849: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9850: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 9851: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 9852: access to the pkgsrc repository.</p>
9853: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9854: Start by adding the directory and then files in the directory. Don't
9855: forget to add the new package to the category's
9856: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9857: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9858: <pre class="programlisting">
9859: <code class="prompt">$</code> cd .../pkgsrc/category
9860: <code class="prompt">$</code> cvs add pkgname
9861: <code class="prompt">$</code> cd pkgname
9862: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9863: <code class="prompt">$</code> cvs add patches/p*
9864: <code class="prompt">$</code> cvs status | less
1.141 wiz 9865: <code class="prompt">$</code> cvs commit
1.140 wiz 9866: <code class="prompt">$</code> cd ..
9867: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 9868: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 9869: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 9870: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 9871: </pre>
1.87 wiz 9872: <p>The commit message of the initial import should include part of the
1.76 rillig 9873: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9874: what the package is/does.</p>
1.140 wiz 9875: <p>Also mention the new package in
9876: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9877: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9878: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 9879: </div>
1.148 asau 9880: <div class="sect1">
1.75 rillig 9881: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9882: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9883: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9884: changes between old and new versions into the commit log when updating
1.87 wiz 9885: a package. There are various reasons for this:</p>
1.148 asau 9886: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9887: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 9888: or its information may be overwritten by newer information.</p></li>
1.128 wiz 9889: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 9890: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 9891: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 9892: repository is very useful for people who read the pkgsrc-changes mailing
9893: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9894: the package.</p></li>
1.75 rillig 9895: </ul></div>
1.87 wiz 9896: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9897: has been released, it should not automatically be upgraded in the CVS
9898: repository. We prefer to be conservative in the packages that are
9899: included in pkgsrc - development or beta packages are not really the
9900: best thing for most places in which pkgsrc is used. Please use your
9901: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9902: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9903: </div>
1.148 asau 9904: <div class="sect1">
1.75 rillig 9905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9906: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122 reed 9907: <p>Renaming packages is not recommended.</p>
1.290 gutterid 9908: <p>When renaming packages, be sure to fix any references to the old name
1.122 reed 9909: in other Makefiles, options, buildlink files, etc.</p>
1.282 leot 9910: <p>
1.290 gutterid 9911: Also, when renaming a package, please add
1.282 leot 9912: the package name and version pattern(s) of the previous package
9913: to <code class="varname">SUPERSEDES</code>.
1.122 reed 9914: This may be repeated for multiple renames.
9915: The new package would be an exact replacement.
1.282 leot 9916: Example:
1.122 reed 9917: </p>
1.282 leot 9918: <pre class="programlisting">
9919: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
9920: SUPERSEDES+= optcomp-[0-9]*
9921: </pre>
1.128 wiz 9922: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 9923: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9924: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9925: not be an exact replacement but is a suggestion for the replaced
9926: functionality.</p>
9927: </div>
1.148 asau 9928: <div class="sect1">
1.122 reed 9929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9930: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122 reed 9931: <p>It is preferred that packages are not renamed or moved, but if needed
9932: please follow these steps.
9933: </p>
1.128 wiz 9934: <div class="orderedlist"><ol class="orderedlist" type="1">
9935: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9936: <li class="listitem">
1.75 rillig 9937: <p>Remove all CVS dirs.</p>
1.87 wiz 9938: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9939: <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 9940: <p>and use that for further work.</p>
1.75 rillig 9941: </li>
1.128 wiz 9942: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9943: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9944: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9945: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 9946: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9947: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9948: for doing an update using pkgsrc building; for example, it can
1.322 leot 9949: search the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122 reed 9950: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9951: new <code class="varname">PKGPATH</code> for that moved package. Note that
9952: it may have multiple matches, so the tool should also check on the
9953: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9954: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9955: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 9956: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9957: place.</p></li>
1.128 wiz 9958: <li class="listitem">
1.75 rillig 9959: <p>Check if any package depends on it:
9960: </p>
9961: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9962: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9963: </li>
1.128 wiz 9964: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9965: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9966: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9967: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9968: <li class="listitem">
1.75 rillig 9969: <p>Commit the changed and removed files:</p>
9970: <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 9971: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9972: </li>
9973: </ol></div>
9974: </div>
9975: </div>
1.148 asau 9976: <div class="chapter">
1.75 rillig 9977: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9978: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9979: <p>This section contains the answers to questions that may
9980: arise when you are writing a package. If you don't find your
9981: question answered here, first have a look in the other chapters,
9982: and if you still don't have the answer, ask on the
9983: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 9984: <div class="qandaset">
1.289 leot 9985: <a name="devfaq.qandaset"></a><dl>
1.267 rillig 9986: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9987: MAKEFLAGS, .MAKEFLAGS and
9988: MAKE_FLAGS?</a>
9989: </dt>
1.267 rillig 9990: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9991: MAKE, GMAKE and
9992: MAKE_PROGRAM?</a>
9993: </dt>
1.267 rillig 9994: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9995: CC, PKG_CC and
9996: PKGSRC_COMPILER?</a>
9997: </dt>
1.267 rillig 9998: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9999: BUILDLINK_LDFLAGS,
10000: BUILDLINK_LDADD and
10001: BUILDLINK_LIBS?</a>
10002: </dt>
1.267 rillig 10003: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 10004: VARNAME=BUILDLINK_PREFIX.foo
10005: say it's empty?</a>
10006: </dt>
1.267 rillig 10007: <dt>24.6. <a href="#devfaq.master_sites">What does
1.78 rillig 10008: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
10009: don't understand the := inside
10010: it.</a>
10011: </dt>
1.267 rillig 10012: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 10013: developers?</a>
10014: </dt>
1.267 rillig 10015: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 10016: documentation?</a>
10017: </dt>
1.289 leot 10018: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill.
10019: What shall I do?</a>
1.92 rillig 10020: </dt>
1.75 rillig 10021: </dl>
1.148 asau 10022: <table border="0" style="width: 100%;">
10023: <colgroup>
1.75 rillig 10024: <col align="left" width="1%">
1.128 wiz 10025: <col>
1.148 asau 10026: </colgroup>
1.75 rillig 10027: <tbody>
1.148 asau 10028: <tr class="question">
1.75 rillig 10029: <td align="left" valign="top">
1.289 leot 10030: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75 rillig 10031: </td>
10032: <td align="left" valign="top"><p>What is the difference between
10033: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10034: <code class="varname">MAKE_FLAGS</code>?</p></td>
10035: </tr>
10036: <tr class="answer">
1.91 rillig 10037: <td align="left" valign="top"></td>
1.75 rillig 10038: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.322 leot 10039: to the pkgsrc-internal invocations of <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75 rillig 10040: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
10041: the <code class="varname">MAKE_PROGRAM</code> when building the
10042: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
10043: </tr>
1.148 asau 10044: <tr class="question">
1.75 rillig 10045: <td align="left" valign="top">
1.289 leot 10046: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75 rillig 10047: </td>
10048: <td align="left" valign="top"><p>What is the difference between
10049: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10050: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10051: </tr>
10052: <tr class="answer">
1.91 rillig 10053: <td align="left" valign="top"></td>
1.75 rillig 10054: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.322 leot 10055: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75 rillig 10056: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
10057: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
10058: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
10059: Make program that is used for building the
10060: package.</p></td>
10061: </tr>
1.148 asau 10062: <tr class="question">
1.75 rillig 10063: <td align="left" valign="top">
1.289 leot 10064: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75 rillig 10065: </td>
10066: <td align="left" valign="top"><p>What is the difference between
10067: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10068: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10069: </tr>
10070: <tr class="answer">
1.91 rillig 10071: <td align="left" valign="top"></td>
1.75 rillig 10072: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
10073: compiler, which can be configured by the pkgsrc user.
10074: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
10075: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
10076: path to a compiler, but the type of compiler that should be
1.76 rillig 10077: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 10078: information about the latter variable.</p></td>
10079: </tr>
1.148 asau 10080: <tr class="question">
1.75 rillig 10081: <td align="left" valign="top">
1.289 leot 10082: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.75 rillig 10083: </td>
10084: <td align="left" valign="top"><p>What is the difference between
10085: <code class="varname">BUILDLINK_LDFLAGS</code>,
10086: <code class="varname">BUILDLINK_LDADD</code> and
10087: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
10088: </tr>
10089: <tr class="answer">
1.91 rillig 10090: <td align="left" valign="top"></td>
1.75 rillig 10091: <td align="left" valign="top"><p>[FIXME]</p></td>
10092: </tr>
1.148 asau 10093: <tr class="question">
1.75 rillig 10094: <td align="left" valign="top">
1.289 leot 10095: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.75 rillig 10096: </td>
1.110 hubertf 10097: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 10098: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10099: say it's empty?</p></td>
10100: </tr>
10101: <tr class="answer">
1.91 rillig 10102: <td align="left" valign="top"></td>
1.75 rillig 10103: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 10104: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10105: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 10106: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 10107: command.</p></td>
10108: </tr>
1.148 asau 10109: <tr class="question">
1.78 rillig 10110: <td align="left" valign="top">
1.289 leot 10111: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.78 rillig 10112: </td>
10113: <td align="left" valign="top"><p>What does
1.220 wiz 10114: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10115: don't understand the <code class="code">:=</code> inside
1.78 rillig 10116: it.</p></td>
10117: </tr>
10118: <tr class="answer">
1.91 rillig 10119: <td align="left" valign="top"></td>
1.220 wiz 10120: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
10121: assignment operator, although it looks like it.
1.78 rillig 10122: Instead, it is a degenerate form of
1.220 wiz 10123: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.322 leot 10124: which is documented in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220 wiz 10125: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78 rillig 10126: case of <code class="varname">MASTER_SITE_*</code>,
10127: <em class="replaceable"><code>old_string</code></em> is the empty string and
10128: <em class="replaceable"><code>new_string</code></em> is
1.220 wiz 10129: <code class="code">package/</code>. That's where the
10130: <code class="code">:</code> and the <code class="code">=</code> fall
1.78 rillig 10131: together.</p></td>
10132: </tr>
1.148 asau 10133: <tr class="question">
1.78 rillig 10134: <td align="left" valign="top">
1.289 leot 10135: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.78 rillig 10136: </td>
10137: <td align="left" valign="top"><p>Which mailing lists are there for package
10138: developers?</p></td>
10139: </tr>
10140: <tr class="answer">
1.91 rillig 10141: <td align="left" valign="top"></td>
1.148 asau 10142: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289 leot 10143: <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 10144: <dd><p>This is a list for technical discussions related
10145: to pkgsrc development, e.g. soliciting feedback for changes to
10146: pkgsrc infrastructure, proposed new features, questions related
10147: to porting pkgsrc to a new platform, advice for maintaining a
10148: package, patches that affect many packages, help requests moved
10149: from pkgsrc-users when an infrastructure bug is found,
10150: etc.</p></dd>
1.289 leot 10151: <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 10152: <dd><p>All bug reports in category "pkg" sent with
1.322 leot 10153: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78 rillig 10154: directly; use one of the other mailing
10155: lists.</p></dd>
10156: </dl></div></td>
10157: </tr>
1.148 asau 10158: <tr class="question">
1.80 rillig 10159: <td align="left" valign="top">
1.289 leot 10160: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.80 rillig 10161: </td>
10162: <td align="left" valign="top"><p>Where is the pkgsrc
10163: documentation?</p></td>
10164: </tr>
10165: <tr class="answer">
1.91 rillig 10166: <td align="left" valign="top"></td>
1.80 rillig 10167: <td align="left" valign="top">
10168: <p>There are many places where you can find
10169: documentation about pkgsrc:</p>
1.148 asau 10170: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10171: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 10172: of chapters that explain large parts of pkgsrc, but some
10173: chapters tend to be outdated. Which ones they are is hard to
10174: say.</p></li>
1.289 leot 10175: <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 10176: about certain features, announcements of new parts of the pkgsrc
10177: infrastructure and sometimes even announcements that a certain
10178: feature has been marked as obsolete. The benefit here is that
10179: each message has a date appended to it.</p></li>
1.128 wiz 10180: <li class="listitem"><p>Many of the files in the
1.80 rillig 10181: <code class="filename">mk/</code> directory start with a comment that
10182: describes the purpose of the file and how it can be used by the
1.92 rillig 10183: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 10184: documentation is to run <span class="command"><strong>bmake
1.92 rillig 10185: help</strong></span>.</p></li>
1.128 wiz 10186: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 10187: information, but they tend to be highly abbreviated, especially
10188: for actions that occur often. Some contain a detailed
10189: description of what has changed, but they are geared towards the
10190: other pkgsrc developers, not towards an average pkgsrc user.
10191: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10192: don't know what has been before, these messages may not be worth
10193: too much to you.</p></li>
1.128 wiz 10194: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10195: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 10196: mind of the developer who wrote the code. To get this
1.110 hubertf 10197: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 10198: to see who has written it and ask on the
10199: <code class="literal">tech-pkg</code> mailing list, so that others can
10200: find your questions later (see above). To be sure that the
10201: developer in charge reads the mail, you may CC him or
10202: her.</p></li>
10203: </ul></div>
1.299 rillig 10204: </td>
10205: </tr>
10206: <tr class="question">
10207: <td align="left" valign="top">
10208: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
10209: </td>
10210: <td align="left" valign="top"><p>I have a little time to kill.
10211: What shall I do?</p></td>
10212: </tr>
10213: <tr class="answer">
10214: <td align="left" valign="top"></td>
10215: <td align="left" valign="top">
10216: <p>This is not really an FAQ yet, but here's the answer
10217: anyway.</p>
1.148 asau 10218: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299 rillig 10219: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.322 leot 10220: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.299 rillig 10221: will tell you about newer versions of installed packages that are
10222: available, but not yet updated in pkgsrc.</p></li>
10223: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10224: — it contains a list of suggested new packages and a list of
10225: cleanups and enhancements for pkgsrc that would be nice to
10226: have.</p></li>
10227: <li class="listitem"><p>Review packages for which review was requested on
10228: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10229: mailing list.</p></li>
1.85 jmmv 10230: </ul></div>
1.299 rillig 10231: </td>
1.85 jmmv 10232: </tr>
10233: </tbody>
1.299 rillig 10234: </table>
1.85 jmmv 10235: </div>
10236: </div>
1.75 rillig 10237: </div>
1.148 asau 10238: <div class="part">
1.75 rillig 10239: <div class="titlepage"><div><div><h1 class="title">
10240: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 10241: <div class="partintro">
1.75 rillig 10242: <div></div>
10243: <p>This part of the guide deals with everything
10244: from the infrastructure that is behind the interfaces described
10245: in the developer's guide. A casual package maintainer should not
10246: need anything from this part.</p>
10247: <div class="toc">
10248: <p><b>Table of Contents</b></p>
1.210 leot 10249: <dl class="toc">
1.299 rillig 10250: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10251: <dd><dl>
1.299 rillig 10252: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10253: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10254: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.75 rillig 10255: <dd><dl>
1.299 rillig 10256: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10257: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.75 rillig 10258: </dl></dd>
1.299 rillig 10259: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10260: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10261: <dd><dl>
1.299 rillig 10262: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10263: <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 10264: </dl></dd>
1.299 rillig 10265: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10266: <dd><dl>
1.299 rillig 10267: <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>
10268: <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 10269: </dl></dd>
10270: </dl></dd>
1.299 rillig 10271: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75 rillig 10272: <dd><dl>
1.299 rillig 10273: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10274: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10275: <dd><dl>
1.299 rillig 10276: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10277: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10278: </dl></dd>
10279: </dl></dd>
1.299 rillig 10280: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10281: <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 10282: </dl>
10283: </div>
10284: </div>
1.148 asau 10285: <div class="chapter">
1.75 rillig 10286: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10287: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10288: <div class="toc">
10289: <p><b>Table of Contents</b></p>
1.210 leot 10290: <dl class="toc">
1.299 rillig 10291: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10292: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10293: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81 rillig 10294: <dd><dl>
1.299 rillig 10295: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10296: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81 rillig 10297: </dl></dd>
1.299 rillig 10298: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10299: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10300: <dd><dl>
1.299 rillig 10301: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10302: <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 10303: </dl></dd>
1.299 rillig 10304: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10305: <dd><dl>
1.299 rillig 10306: <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>
10307: <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 10308: </dl></dd>
10309: </dl>
10310: </div>
10311: <p>The pkgsrc infrastructure consists of many small Makefile
10312: fragments. Each such fragment needs a properly specified
10313: interface. This chapter explains how such an interface looks
10314: like.</p>
1.148 asau 10315: <div class="sect1">
1.75 rillig 10316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10317: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10318: <p>Whenever a variable is defined in the pkgsrc
10319: infrastructure, the location and the way of definition provide
10320: much information about the intended use of that variable.
10321: Additionally, more documentation may be found in a header
10322: comment or in this pkgsrc guide.</p>
10323: <p>A special file is
10324: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10325: variables that are intended to be user-defined. They are either
10326: defined using the <code class="literal">?=</code> operator or they are
10327: left undefined because defining them to anything would
1.128 wiz 10328: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 10329: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10330: file.</p>
10331: <p>Outside this file, the following conventions apply:
10332: Variables that are defined using the <code class="literal">?=</code>
10333: operator may be overridden by a package.</p>
10334: <p>Variables that are defined using the <code class="literal">=</code>
10335: operator may be used read-only at run-time.</p>
10336: <p>Variables whose name starts with an underscore must not be
10337: accessed outside the pkgsrc infrastructure at all. They may
10338: change without further notice.</p>
1.148 asau 10339: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 10340: <h3 class="title">Note</h3>
10341: <p>These conventions are currently not applied
10342: consistently to the complete pkgsrc
10343: infrastructure.</p>
10344: </div>
10345: </div>
1.148 asau 10346: <div class="sect1">
1.81 rillig 10347: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10348: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10349: <p>All variables that contain lists of things should default
10350: to being empty. Two examples that do not follow this rule are
10351: <code class="varname">USE_LANGUAGES</code> and
10352: <code class="varname">DISTFILES</code>. These variables cannot simply be
10353: modified using the <code class="literal">+=</code> operator in package
10354: <code class="filename">Makefile</code>s (or other files included by
10355: them), since there is no guarantee whether the variable is
10356: already set or not, and what its value is. In the case of
1.128 wiz 10357: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 10358: the default value and just define it as in the following
10359: example.</p>
10360: <pre class="programlisting">
1.100 rillig 10361: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10362: </pre>
10363: <p>Because of the selection of this default value, the same
10364: value appears in many package Makefiles. Similarly for
10365: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 10366: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 10367: doesn't stand out. Nevertheless it is mentioned in many
10368: files.</p>
10369: </div>
1.148 asau 10370: <div class="sect1">
1.81 rillig 10371: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10372: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.148 asau 10373: <div class="sect2">
1.75 rillig 10374: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10375: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.75 rillig 10376: <p>Variable evaluation takes place either at load time or at
10377: runtime, depending on the context in which they occur. The
10378: contexts where variables are evaluated at load time are:</p>
1.148 asau 10379: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10380: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 10381: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 10382: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 10383: <code class="literal">.for</code>,</p></li>
1.128 wiz 10384: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 10385: </ul></div>
10386: <p>A special exception are references to the iteration
10387: variables of <code class="literal">.for</code> loops, which are expanded
10388: inline, no matter in which context they appear.</p>
10389: <p>As the values of variables may change during load time,
10390: care must be taken not to evaluate them by accident. Typical
10391: examples for variables that should not be evaluated at load time
10392: are <code class="varname">DEPENDS</code> and
10393: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10394: clear, here is an example:</p>
10395: <pre class="programlisting">
1.100 rillig 10396: CONFIGURE_ARGS= # none
10397: CFLAGS= -O
10398: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10399:
1.100 rillig 10400: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10401:
1.100 rillig 10402: CFLAGS+= -Wall
1.222 sevan 10403: </pre>
1.75 rillig 10404: <p>This code shows how the use of the <code class="literal">:=</code>
10405: operator can quickly lead to unexpected results. The first
10406: paragraph is fairly common code. The second paragraph evaluates
10407: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10408: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10409: <code class="literal">-Wall</code> is appended to the
10410: <code class="varname">CFLAGS</code>, but this addition will not appear in
10411: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10412: paragraphs from above typically occur in completely unrelated
10413: files.</p>
10414: </div>
1.148 asau 10415: <div class="sect2">
1.75 rillig 10416: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10417: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.75 rillig 10418: <p>After all the files have been loaded, the values of the
10419: variables cannot be changed anymore. Variables that are used in
10420: the shell commands are expanded at this point.</p>
10421: </div>
10422: </div>
1.148 asau 10423: <div class="sect1">
1.75 rillig 10424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10425: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10426: <p>There are many ways in which the definition and use of a
1.218 rillig 10427: variable can be restricted in order to detect bugs and violations
10428: of the (mostly unwritten) policies. A package can be checked with
10429: <code class="literal">pkglint -Wall</code> to see whether it meets these
10430: rules.</p>
1.78 rillig 10431: </div>
1.148 asau 10432: <div class="sect1">
1.78 rillig 10433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10434: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10435: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10436: of the following classes. Cases where a file falls into more
10437: than one class should be avoided as it often leads to subtle
10438: bugs.</p>
1.148 asau 10439: <div class="sect2">
1.75 rillig 10440: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10441: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10442: <p>In a traditional imperative programming language some of
1.76 rillig 10443: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 10444: procedures. They take some input parameters and—after
10445: inclusion—provide a result in output parameters. Since all
1.76 rillig 10446: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10447: care must be taken not to use parameter names that have already
10448: another meaning. For example, <code class="varname">PKGNAME</code> is a
10449: bad choice for a parameter name.</p>
10450: <p>Procedures are completely evaluated at preprocessing time.
10451: That is, when calling a procedure all input parameters must be
10452: completely resolvable. For example,
10453: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10454: parameter since it is very likely that further text will be
10455: added after calling the procedure, which would effectively apply
10456: the procedure to only a part of the variable. Also, references
1.218 rillig 10457: to other variables will be modified after calling the
1.75 rillig 10458: procedure.</p>
10459: <p>A procedure can declare its output parameters either as
10460: suitable for use in preprocessing directives or as only
10461: available at runtime. The latter alternative is for variables
10462: that contain references to other runtime variables.</p>
10463: <p>Procedures shall be written such that it is possible to
10464: call the procedure more than once. That is, the file must not
10465: contain multiple-inclusion guards.</p>
10466: <p>Examples for procedures are
1.76 rillig 10467: <code class="filename">mk/bsd.options.mk</code> and
10468: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10469: that the parameters are evaluated at load time, they should be
10470: assigned using the <code class="literal">:=</code> operator, which should
10471: be used only for this purpose.</p>
10472: </div>
1.148 asau 10473: <div class="sect2">
1.75 rillig 10474: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10475: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10476: <p>Action files take some input parameters and may define
10477: runtime variables. They shall not define loadtime variables.
10478: There are action files that are included implicitly by the
10479: pkgsrc infrastructure, while other must be included
10480: explicitly.</p>
10481: <p>An example for action files is
1.76 rillig 10482: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10483: </div>
10484: </div>
1.148 asau 10485: <div class="sect1">
1.81 rillig 10486: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10487: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10488: <p>Package <code class="filename">Makefile</code>s usually consist of
10489: a set of variable definitions, and include the file
10490: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10491: Before that, they may also include various other
10492: <code class="filename">*.mk</code> files if they need to query the
10493: availability of certain features like the type of compiler or
10494: the X11 implementation. Due to the heavy use of preprocessor
10495: directives like <code class="literal">.if</code> and
10496: <code class="literal">.for</code>, the order in which the files are loaded
10497: matters.</p>
10498: <p>This section describes at which point the various files
10499: are loaded and gives reasons for that order.</p>
1.148 asau 10500: <div class="sect2">
1.81 rillig 10501: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10502: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10503: </h3></div></div></div>
10504: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10505: is to define some essential variables like
10506: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10507: <code class="varname">MACHINE_ARCH</code>.</p>
10508: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10509: 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 10510: After that, those variables
1.81 rillig 10511: that have not been overridden by the user are loaded from
10512: <code class="filename">mk/defaults/mk.conf</code>.</p>
10513: <p>After the user settings, the system settings and platform
10514: settings are loaded, which may override the user
10515: settings.</p>
10516: <p>Then, the tool definitions are loaded. The tool wrappers
10517: are not yet in effect. This only happens when building a
10518: package, so the proper variables must be used instead of the
10519: direct tool names.</p>
10520: <p>As the last steps, some essential variables from the
10521: wrapper and the package system flavor are loaded, as well as the
10522: variables that have been cached in earlier phases of a package
10523: build.</p>
10524: </div>
1.148 asau 10525: <div class="sect2">
1.81 rillig 10526: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10527: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10528: </h3></div></div></div>
1.81 rillig 10529: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10530: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10531: loaded, which fill default values for those variables that have
1.93 rillig 10532: not been defined by the package. These variables may later
1.81 rillig 10533: be used even in unrelated files.</p>
10534: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10535: provides the target <code class="literal">error-check</code> that is added
10536: as a special dependency to all other targets that use
10537: <code class="varname">DELAYED_ERROR_MSG</code> or
10538: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10539: <p>Then, the package-specific hacks from
10540: <code class="filename">hacks.mk</code> are included.</p>
10541: <p>Then, various other files follow. Most of them don't have
10542: any dependencies on what they need to have included before or
10543: after them, though some do.</p>
10544: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10545: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10546: restricts the use of these variables to all the files that have
10547: been included before. Appearances in later files will be
10548: silently ignored.</p>
10549: <p>Then, the files for the main targets are included, in the
10550: order of later execution, though the actual order should not
10551: matter.</p>
10552: <p>At last, some more files are included that don't set any
10553: interesting variables but rather just define make targets to be
10554: executed.</p>
10555: </div>
10556: </div>
1.75 rillig 10557: </div>
1.148 asau 10558: <div class="chapter">
1.75 rillig 10559: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10560: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.75 rillig 10561: <div class="toc">
10562: <p><b>Table of Contents</b></p>
1.210 leot 10563: <dl class="toc">
1.299 rillig 10564: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10565: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75 rillig 10566: <dd><dl>
1.299 rillig 10567: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10568: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75 rillig 10569: </dl></dd>
10570: </dl>
10571: </div>
10572: <p>The pkgsrc infrastructure consists of a large codebase,
10573: and there are many corners where every little bit of a file is
10574: well thought out, making pkgsrc likely to fail as soon as
10575: anything is changed near those parts. To prevent most changes
10576: from breaking anything, a suite of regression tests should go
10577: along with every important part of the pkgsrc infrastructure.
10578: This chapter describes how regression tests work in pkgsrc and
10579: how you can add new tests.</p>
1.148 asau 10580: <div class="sect1">
1.75 rillig 10581: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10582: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.322 leot 10583: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/index.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110 hubertf 10584: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10585: can simply run that command, which will run all tests in the
1.283 rillig 10586: <code class="filename">regress/</code> directory.</p>
1.75 rillig 10587: </div>
1.148 asau 10588: <div class="sect1">
1.75 rillig 10589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10590: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.283 rillig 10591: <p>Every directory in the <code class="filename">regress/</code>
10592: directory that contains a file called <code class="filename">spec</code>
1.75 rillig 10593: is considered a regression test. This file is a shell program
1.110 hubertf 10594: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10595: The following functions can be overridden to suit your
10596: needs.</p>
1.148 asau 10597: <div class="sect2">
1.75 rillig 10598: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10599: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.218 rillig 10600: <p>These functions do not take any parameters. Although they
10601: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.289 leot 10602: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218 rillig 10603: question</a> for details.</p>
1.148 asau 10604: <div class="variablelist"><dl class="variablelist">
1.218 rillig 10605: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75 rillig 10606: <dd><p>This function prepares the environment for the
10607: test. By default it does nothing.</p></dd>
1.218 rillig 10608: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10609: <dd>
10610: <p>This function runs the actual test. By default,
1.75 rillig 10611: it calls <code class="varname">TEST_MAKE</code> with the arguments
10612: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10613: error messages into the file
1.218 rillig 10614: <code class="varname">TEST_OUTFILE</code>.</p>
10615: <p>When defining this function, make sure that all output that
10616: needs to be checked is written to the correct output file.
10617: Example:</p>
10618: <pre class="programlisting">
10619: do_test() {
1.223 rillig 10620: echo "Example output"
1.218 rillig 10621: } 1>$TEST_OUTFILE 2>&1
10622: </pre>
10623: </dd>
10624: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10625: <dd>
10626: <p>This function is run after the test and is
1.75 rillig 10627: typically used to compare the actual output from the one that is
10628: expected. It can make use of the various helper functions from
1.218 rillig 10629: the next section. Example:</p>
10630: <pre class="programlisting">
10631: check_result() {
1.223 rillig 10632: exit_status 0
10633: output_require "Example"
10634: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10635: output_prohibit "no such file or directory"
1.283 rillig 10636: regress_fail "expected $expected but got $actual for input $input"
1.218 rillig 10637: }
10638: </pre>
10639: </dd>
10640: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75 rillig 10641: <dd><p>This function cleans everything up after the
10642: test has been run. By default it does nothing.</p></dd>
10643: </dl></div>
10644: </div>
1.148 asau 10645: <div class="sect2">
1.75 rillig 10646: <div class="titlepage"><div><div><h3 class="title">
1.299 rillig 10647: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.148 asau 10648: <div class="variablelist"><dl class="variablelist">
1.283 rillig 10649: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10650: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218 rillig 10651: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75 rillig 10652: <dd><p>This function compares the exitcode of the
1.218 rillig 10653: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75 rillig 10654: If they differ, the test will fail.</p></dd>
1.218 rillig 10655: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10656: <dd>
10657: <p>This function checks for each of its parameters
10658: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75 rillig 10659: extended regular expression. If it does not, the test will
1.218 rillig 10660: fail. Example:</p>
10661: <pre class="programlisting">
1.219 rillig 10662: output_require "looks fine"
10663: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218 rillig 10664: </pre>
10665: </dd>
1.292 leot 10666: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75 rillig 10667: <dd><p>This function checks for each of its parameters
1.110 hubertf 10668: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10669: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10670: If any of the regular expressions matches, the test will
10671: fail.</p></dd>
10672: </dl></div>
10673: </div>
10674: </div>
10675: </div>
1.148 asau 10676: <div class="chapter">
1.75 rillig 10677: <div class="titlepage"><div><div><h2 class="title">
1.299 rillig 10678: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10679: <div class="toc">
10680: <p><b>Table of Contents</b></p>
1.299 rillig 10681: <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 10682: </div>
10683: <p>The pkgsrc system has already been ported to many
10684: operating systems, hardware architectures and compilers. This
10685: chapter explains the necessary steps to make pkgsrc even more
10686: portable.</p>
1.148 asau 10687: <div class="sect1">
1.75 rillig 10688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299 rillig 10689: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10690: <p>To port pkgsrc to a new operating system (called
10691: <code class="literal">MyOS</code> in this example), you need to touch the
10692: following files:</p>
1.148 asau 10693: <div class="variablelist"><dl class="variablelist">
1.93 rillig 10694: <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 10695: <dd><p>This file contains some basic definitions, for
10696: example the name of the C
10697: compiler.</p></dd>
1.76 rillig 10698: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10699: <dd><p>Insert code that defines the variables
10700: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.327 wiz 10701: <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.75 rillig 10702: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10703: <code class="varname">APPEND_ELF</code>, and the other variables that
10704: appear in this file.</p></dd>
1.93 rillig 10705: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10706: <dd><p>This file contains the platform-specific
10707: definitions that are used by pkgsrc. Start by copying one of the
10708: other files and edit it to your
10709: needs.</p></dd>
1.93 rillig 10710: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10711: <dd><p>This file defines the paths to all the tools
10712: that are needed by one or the other package in pkgsrc, as well
10713: as by pkgsrc itself. Find out where these tools are on your
10714: platform and add them.</p></dd>
10715: </dl></div>
10716: <p>Now, you should be able to build some basic packages, like
1.322 leot 10717: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/index.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/index.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75 rillig 10718: </div>
10719: </div>
10720: </div>
1.148 asau 10721: <div class="appendix">
10722: <div class="titlepage"><div><div><h1 class="title">
10723: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10724: <div class="toc">
10725: <p><b>Table of Contents</b></p>
1.210 leot 10726: <dl class="toc">
1.75 rillig 10727: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10728: <dd><dl>
10729: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10730: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10731: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287 rillig 10732: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75 rillig 10733: </dl></dd>
10734: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10735: </dl>
10736: </div>
10737: <p>We checked to find a piece of software that wasn't in the packages
10738: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10739: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10740: present in the tree is beyond us, but it's useful for the purposes of
10741: this exercise.</p>
1.148 asau 10742: <div class="sect1">
1.75 rillig 10743: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10744: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10745: <div class="sect2">
1.75 rillig 10746: <div class="titlepage"><div><div><h3 class="title">
10747: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10748: <pre class="programlisting">
1.100 rillig 10749: # $NetBSD$
10750: #
1.1 grant 10751:
1.100 rillig 10752: DISTNAME= bison-1.25
10753: CATEGORIES= devel
1.286 rillig 10754: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 grant 10755:
1.136 dholland 10756: MAINTAINER= pkgsrc-users@NetBSD.org
1.289 leot 10757: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.100 rillig 10758: COMMENT= GNU yacc clone
1.1 grant 10759:
1.100 rillig 10760: GNU_CONFIGURE= yes
1.152 wiz 10761: INFO_FILES= yes
1.1 grant 10762:
1.100 rillig 10763: .include "../../mk/bsd.pkg.mk"
1.1 grant 10764: </pre>
1.75 rillig 10765: </div>
1.148 asau 10766: <div class="sect2">
1.75 rillig 10767: <div class="titlepage"><div><div><h3 class="title">
10768: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10769: <pre class="programlisting">
1.100 rillig 10770: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.322 leot 10771: improvements. Why you would want this when Berkeley <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100 rillig 10772: of the NetBSD source tree is beyond me.
1.1 grant 10773: </pre>
1.75 rillig 10774: </div>
1.148 asau 10775: <div class="sect2">
1.75 rillig 10776: <div class="titlepage"><div><div><h3 class="title">
10777: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10778: <pre class="programlisting">
1.100 rillig 10779: @comment $NetBSD$
10780: bin/bison
10781: man/man1/bison.1.gz
10782: share/bison.simple
10783: share/bison.hairy
1.1 grant 10784: </pre>
1.75 rillig 10785: </div>
1.148 asau 10786: <div class="sect2">
1.75 rillig 10787: <div class="titlepage"><div><div><h3 class="title">
1.287 rillig 10788: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75 rillig 10789: <p>The NetBSD package system comes with
1.322 leot 10790: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75 rillig 10791: which helps to check the contents of these
10792: files. After installation it is quite easy to use, just change to the
1.286 rillig 10793: directory of the package you wish to examine and run
1.110 hubertf 10794: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10795: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286 rillig 10796: ERROR: Makefile: Each package must define its LICENSE.
10797: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10798: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10799: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10800: 1 error, 2 warnings and 1 note found.
10801: (Run "pkglint -e" to show explanations.)
10802: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287 rillig 10803: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75 rillig 10804: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285 rillig 10805: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75 rillig 10806: -Wall</strong></span> for a very thorough check.</p>
10807: </div>
10808: </div>
1.148 asau 10809: <div class="sect1">
1.75 rillig 10810: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10811: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10812: <p>Create the directory where the package lives,
10813: plus any auxiliary directories:</p>
10814: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10815: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10816: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10817: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10818: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299 rillig 10819: <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 10820: then continue with fetching the distfile:</p>
10821: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10822: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10823: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10824: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10825: ftp: Error retrieving file: 500 Internal error
10826:
10827: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10828: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10829: ftp: Error retrieving file: 500 Internal error
10830:
10831: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10832: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10833: Successfully retrieved file.</pre>
10834: <p>Generate the checksum of the distfile into
1.76 rillig 10835: <code class="filename">distinfo</code>:</p>
1.88 wiz 10836: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10837: <p>Now compile:</p>
10838: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10839: >> Checksum OK for bison-1.25.tar.gz.
10840: ===> Extracting for bison-1.25
10841: ===> Patching for bison-1.25
10842: ===> Ignoring empty patch directory
10843: ===> Configuring for bison-1.25
10844: creating cache ./config.cache
10845: checking for gcc... cc
10846: checking whether we are using GNU C... yes
10847: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10848: checking how to run the C preprocessor... cc -E
10849: checking for minix/config.h... no
10850: checking for POSIXized ISC... no
10851: checking whether cross-compiling... no
10852: checking for ANSI C header files... yes
10853: checking for string.h... yes
10854: checking for stdlib.h... yes
10855: checking for memory.h... yes
10856: checking for working const... yes
10857: checking for working alloca.h... no
10858: checking for alloca... yes
10859: checking for strerror... yes
10860: updating cache ./config.cache
10861: creating ./config.status
10862: creating Makefile
10863: ===> Building for bison-1.25
10864: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
10865: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
10866: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
10867: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
10868: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 10869: 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 10870: 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
10871: 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
10872: 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
10873: 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
10874: 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
10875: 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
10876: 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
10877: 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
10878: 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
10879: 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
10880: 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
10881: 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
10882: 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
10883: 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
10884: 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
10885: 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
10886: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10887: rm -f bison.s1
1.75 rillig 10888: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10889: <p>Everything seems OK, so install the files:</p>
10890: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10891: >> Checksum OK for bison-1.25.tar.gz.
10892: ===> Installing for bison-1.25
10893: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10894: rm -f /usr/pkg/bin/bison
10895: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10896: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10897: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10898: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10899: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10900: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10901: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10902: ===> Registering installation for bison-1.25</pre>
10903: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10904: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10905: binary package, do this now:</p>
10906: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10907: >> Checksum OK for bison-1.25.tar.gz.
10908: ===> Building package for bison-1.25
10909: Creating package bison-1.25.tgz
10910: Registering depends:.
1.75 rillig 10911: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10912: <p>Now that you don't need the source and object files
10913: any more, clean up:</p>
10914: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10915: ===> Cleaning for bison-1.25</pre>
10916: </div>
10917: </div>
1.148 asau 10918: <div class="appendix">
10919: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 10920: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.75 rillig 10921: <div class="toc">
10922: <p><b>Table of Contents</b></p>
1.210 leot 10923: <dl class="toc">
1.322 leot 10924: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
10925: <dd><dl>
10926: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
10927: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
10928: </dl></dd>
10929: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
10930: <dd><dl>
10931: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
10932: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
10933: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
10934: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
10935: </dl></dd>
10936: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
10937: <dd><dl>
10938: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
10939: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
10940: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
10941: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
10942: </dl></dd>
1.75 rillig 10943: </dl>
10944: </div>
1.322 leot 10945: <p>
10946: A number of mechanisms are available in pkgsrc to improve the security of the
10947: resulting system. This page describes the mechanisms, and gives hints
10948: about detecting and fixing problems.
10949: </p>
10950: <p>
10951: Mechanisms can be enabled individually in
10952: <code class="filename">mk.conf</code>, and are
10953: individually described below.
10954: </p>
10955: <p>
10956: Typically, a feature will cause some programs to fail to build or work
10957: when first enabled. This can be due to latent problems in the
10958: program, and can be due to other reasons. After enough testing to
10959: have confidence that user problems will be quite rare, individual
10960: mechanisms will be enabled by default.
10961: </p>
10962: <p>
10963: For each mechanism, see the Caveats section below for an explanation
10964: of what might go wrong at compile time and at run time, and how to
10965: notice and address these problems.
10966: </p>
1.148 asau 10967: <div class="sect1">
1.75 rillig 10968: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 10969: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
10970: <div class="sect2">
10971: <div class="titlepage"><div><div><h3 class="title">
10972: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
10973: <div class="sect3">
10974: <div class="titlepage"><div><div><h4 class="title">
10975: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
10976: <p>
10977: This allows substitute wrappers to be used for some commonly used
10978: library functions that do not have built-in bounds checking - but
10979: could in some cases.
10980: </p>
10981: <p>
10982: Two mitigation levels are available:
10983: </p>
10984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10985: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
10986: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
10987: </ul></div>
10988: <p>
10989: "strong" has been enabled by default since pkgsrc-2017Q3.
10990: </p>
10991: </div>
10992: <div class="sect3">
10993: <div class="titlepage"><div><div><h4 class="title">
10994: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
10995: <p>
10996: This enables a stack-smashing protection mitigation. It is done by adding a
10997: guard variable to functions with vulnerable objects. The guards are initialized
10998: when a function is entered and then checked when the function exits. The guard
10999: check will fail and the program forcibly exited if the variable was modified in
11000: the meantime. This can happen in case of buffer overflows or memory corruption,
11001: and therefore exposing these bugs.
11002: </p>
11003: <p>
11004: Different mitigation levels are available:
11005: </p>
11006: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11007: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
11008: by the compiler;</p></li>
11009: <li class="listitem"><p>"all", which will protect every function;</p></li>
11010: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
11011: two settings above.</p></li>
11012: </ul></div>
11013: <p>
11014: This mitigation is supported by both GCC and clang. It may be supported in
11015: additional compilers, possibly under a different name. It is particularly useful
11016: for unsafe programming languages, such as C/C++.
11017: </p>
11018: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11019: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
11020: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
11021: </ul></div>
11022: <p>More details can be found here:</p>
11023: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11024: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
11025: </p></li></ul></div>
11026: </div>
11027: <div class="sect3">
11028: <div class="titlepage"><div><div><h4 class="title">
11029: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
11030: <p>
11031: This requests the creation of PIE (Position Independent Executables) for all
11032: executables. The PIE mechanism is normally used for shared libraries, so that
11033: they can be loaded at differing addresses at runtime. PIE itself does not have
11034: useful security properties; however, it is necessary to fully leverage some,
11035: such as ASLR. Some operating systems support Address Space Layout Randomization
11036: (ASLR), which causes different addresses to be used each time a program is run.
11037: This makes it more difficult for an attacker to guess addresses and thus makes
11038: exploits harder to construct. With PIE, ASLR can really be applied to the entire
11039: program, instead of the stack and heap only.
11040: </p>
11041: <p>
11042: PIE executables will only be built for toolchains that are known to support PIE.
11043: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
11044: </p>
11045: <p>
11046: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
11047: </p>
1.75 rillig 11048: </div>
1.325 gutterid 11049: </div>
11050: <div class="sect2">
11051: <div class="titlepage"><div><div><h3 class="title">
11052: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
11053: <div class="sect3">
11054: <div class="titlepage"><div><div><h4 class="title">
11055: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
11056: <p>
11057: With this option, pkgsrc will try to build packages reproducibly. This allows
11058: packages built from the same tree and with the same options, to produce
11059: identical results bit by bit. This option should be combined with ASLR and
11060: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
11061: attackers attempting to exploit security vulnerabilities.
11062: </p>
11063: <p>
11064: More details can be found here:
11065: </p>
11066: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11067: <a class="ulink" href="https://reproducible-builds.org/" target="_top">Reproducible Builds - a set of software development practices that create an independently-verifiable path from source to binary code</a>
11068: </p></li></ul></div>
11069: <p>
11070: More work likely needs to be done before pkgsrc is fully reproducible.
11071: </p>
11072: </div>
1.322 leot 11073: <div class="sect3">
11074: <div class="titlepage"><div><div><h4 class="title">
1.325 gutterid 11075: <a name="hardening.mechanisms.enabled.relro"></a>B.1.2.2. PKGSRC_USE_RELRO</h4></div></div></div>
1.322 leot 11076: <p>
11077: This also makes the exploitation of some security vulnerabilities more
11078: difficult in some cases.
11079: </p>
11080: <p>Two different mitigation levels are available:</p>
11081: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11082: <li class="listitem"><p>
11083: partial: the ELF sections are reordered so that internal data sections
11084: precede the program's own data sections, and non-PLT GOT is read-only;
11085: </p></li>
11086: <li class="listitem"><p>
11087: full: in addition to partial RELRO, every relocation is performed immediately
11088: when starting the program (with a slight performance impact), allowing the
11089: entire GOT to be read-only.
11090: </p></li>
11091: </ul></div>
11092: <p>
11093: This is currently supported by GCC. Many software distributions now enable this
1.325 gutterid 11094: feature by default, at the "partial" level. However, it cannot yet be enforced
11095: globally in pkgsrc through cwrappers.
1.322 leot 11096: </p>
11097: <p>
11098: More details can be found here:
11099: </p>
11100: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11101: <a class="ulink" href="https://www.redhat.com/en/blog/hardening-elf-binaries-using-relocation-read-only-relro" target="_top">Hardening ELF binaries using Relocation Read-Only (RELRO)</a>
11102: </p></li></ul></div>
1.75 rillig 11103: </div>
1.322 leot 11104: <div class="sect3">
11105: <div class="titlepage"><div><div><h4 class="title">
1.325 gutterid 11106: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.3. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.322 leot 11107: <p>
11108: This uses <code class="literal">-fstack-check</code> with GCC for
11109: another stack protection mitigation.
11110: </p>
11111: <p>
11112: It asks the compiler to generate code verifying that it does not corrupt the
11113: stack. According to GCC's manual page, this is really only useful for
11114: multi-threaded programs.
11115: </p>
1.76 rillig 11116: </div>
11117: </div>
11118: </div>
1.148 asau 11119: <div class="sect1">
1.76 rillig 11120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11121: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
11122: <div class="sect2">
11123: <div class="titlepage"><div><div><h3 class="title">
11124: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
11125: <div class="sect3">
11126: <div class="titlepage"><div><div><h4 class="title">
11127: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
11128: <p>
11129: A number of packages may fail to build with this option enabled. The
11130: failures are often related to the absence of the <code class="literal">-fPIC</code>
11131: compilation flag when building libraries or executables (or ideally
11132: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
11133: <code class="varname">CFLAGS</code> already, but requires the package to
11134: actually support it.
11135: </p>
11136: <div class="sect4">
11137: <div class="titlepage"><div><div><h5 class="title">
11138: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
11139: <p>
11140: These instructions are meant as a reference only; they likely need to be adapted
11141: for many packages individually.
11142: </p>
11143: <p>
11144: For packages using <code class="filename">Makefiles</code>:
11145: </p>
11146: <pre class="programlisting">
11147: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
11148: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
11149: </pre>
11150: <p>
11151: For packages using <code class="filename">Imakefiles</code>:
11152: </p>
11153: <pre class="programlisting">
11154: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
11155: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
11156: </pre>
11157: </div>
11158: </div>
11159: <div class="sect3">
11160: <div class="titlepage"><div><div><h4 class="title">
11161: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
11162: <p>
11163: Some programs may fail to run, or crash at random times once built as PIE. Two
11164: scenarios are essentially possible. This is nearly always due to a bug in
11165: the program being exposed due to ASLR.
11166: </p>
11167: </div>
11168: <div class="sect3">
11169: <div class="titlepage"><div><div><h4 class="title">
11170: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
11171: <p>
11172: Ideally, packages should be fixed for compatibility with MKPIE.
11173: However, in some cases this is very difficult, due to complex build systems,
11174: packages using non-standard toolchains, or programming languages with odd
11175: bootstrapping mechanisms.
11176: </p>
11177: <p>
11178: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
11179: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
11180: <code class="filename">bsd.prefs.mk</code> is included.
11181: </p>
11182: </div>
11183: </div>
11184: <div class="sect2">
11185: <div class="titlepage"><div><div><h3 class="title">
11186: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
11187: <div class="sect3">
11188: <div class="titlepage"><div><div><h4 class="title">
11189: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
11190: <p>
11191: This feature makes use of pre-processing directives to look for hardened,
11192: alternative implementations of essential library calls. Some programs may fail
11193: to build as a result; this usually happens for those trying too hard to be
11194: portable, or otherwise abusing definitions in the standard library.
11195: </p>
11196: </div>
11197: <div class="sect3">
11198: <div class="titlepage"><div><div><h4 class="title">
11199: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
11200: <p>
11201: This feature may cause some programs to crash, usually indicating an
11202: actual bug in the program. The fix will typically involve patching the
11203: original program's source code.
11204: </p>
11205: </div>
11206: <div class="sect3">
11207: <div class="titlepage"><div><div><h4 class="title">
11208: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
11209: <p>
11210: At least in the case of GCC, FORTIFY will only be applied if optimization is
11211: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
11212: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
11213: optimization level. This cannot easily be applied globally, as some packages
11214: may require specific optimization levels.
11215: </p>
11216: </div>
11217: <div class="sect3">
11218: <div class="titlepage"><div><div><h4 class="title">
11219: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
11220: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11221: <h3 class="title">Note</h3>
11222: <p>FORTIFY should not be disabled to work around runtime crashes in
11223: the program! This is a very bad idea and will expose you to security
11224: vulnerabilities.
11225: </p>
11226: </div>
11227: <p>
11228: To disable FORTIFY on a per-package basis, set the following
11229: in the package's <code class="filename">Makefile</code>
11230: before <code class="filename">bsd.prefs.mk</code> is included:
11231: </p>
11232: <pre class="programlisting">
11233: FORTIFY_SUPPORTED= no
11234: </pre>
11235: </div>
11236: </div>
11237: <div class="sect2">
11238: <div class="titlepage"><div><div><h3 class="title">
11239: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
11240: <div class="sect3">
11241: <div class="titlepage"><div><div><h4 class="title">
11242: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
11243: <p>
11244: For better protection, full RELRO requires every symbol to be resolved when the
11245: program starts, rather than simply when required at run-time. This will have
11246: more impact on programs using a lot of symbols, or linked to libraries exposing
11247: a lot of symbols. Therefore, daemons or programs otherwise running in
11248: background are affected only when started. Programs loading plug-ins at
11249: run-time are affected when loading the plug-ins.
11250: </p>
11251: <p>
11252: The impact is not expected to be noticeable on modern hardware, except in some
11253: cases for big programs.
11254: </p>
11255: </div>
11256: <div class="sect3">
11257: <div class="titlepage"><div><div><h4 class="title">
11258: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
11259: <p>
11260: Some programs handle plug-ins and dependencies in a way that conflicts with
11261: RELRO: for instance, with an initialization routine listing any other plug-in
11262: required. With full RELRO, the missing symbols are resolved before the
11263: initialization routine can run, and the dynamic loader will not be able to find
11264: them directly and abort as a result. Unfortunately, this is how Xorg loads its
11265: drivers. Partial RELRO can be applied instead in this case.
11266: </p>
11267: </div>
11268: <div class="sect3">
11269: <div class="titlepage"><div><div><h4 class="title">
11270: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
11271: <p>
11272: To disable RELRO on a per-package basis, set the following
11273: in the package's <code class="filename">Makefile</code>
11274: before <code class="filename">bsd.prefs.mk</code> is included:
11275: </p>
11276: <pre class="programlisting">
11277: RELRO_SUPPORTED= no
11278: </pre>
1.324 nia 11279: <p>
11280: It is also possible to at most enable partial RELRO, by
11281: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
11282: </p>
1.322 leot 11283: </div>
11284: </div>
11285: <div class="sect2">
11286: <div class="titlepage"><div><div><h3 class="title">
11287: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
11288: <div class="sect3">
11289: <div class="titlepage"><div><div><h4 class="title">
11290: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
11291: <p>
11292: The stack-smashing protection provided by this option does not work for some
11293: programs. The most common situation in which this happens is when the program
11294: allocates variables on the stack, with the size determined at run-time.
11295: </p>
11296: </div>
11297: <div class="sect3">
11298: <div class="titlepage"><div><div><h4 class="title">
11299: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
11300: <p>
11301: Again, this feature may cause some programs to crash via a
11302: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
11303: </p>
11304: <p>
11305: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
11306: messages are sent and - by default -
11307: appended to <code class="filename">/var/log/messages</code>, e.g.:
11308: </p>
11309: <pre class="programlisting">
11310: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
11311: </pre>
11312: <p>
11313: (where <code class="literal">hostname</code> is the hostname(1) and
11314: <code class="literal">program</code> is the basename(1) of the program crashed).
11315: </p>
11316: <p>
11317: Patching the original program is then required.
11318: </p>
11319: <p>
11320: Rebuilding the package via:
11321: </p>
11322: <pre class="programlisting">
11323: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
11324: </pre>
11325: <p>
11326: and inspecting the backtrace of the coredump via the debugger
11327: should point out the problematic call by inspecting the frame
11328: calling the _chk() (SSP) function.
11329: </p>
11330: </div>
11331: <div class="sect3">
11332: <div class="titlepage"><div><div><h4 class="title">
11333: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
11334: <p>
11335: The compiler emits extra code when using this feature: a check for buffer
11336: overflows is performed when entering and exiting functions, requiring an extra
11337: variable on the stack. The level of protection can otherwise be adjusted to
11338: affect only those functions considered more sensitive by the compiler (with
11339: -fstack-protector instead of -fstack-protector-all).
11340: </p>
11341: <p>
11342: The impact is not expected to be noticeable on modern hardware. However,
11343: programs with a hard requirement to run at the fastest possible speed should
11344: avoid using this feature, or using libraries built with this feature.
11345: </p>
11346: </div>
11347: <div class="sect3">
11348: <div class="titlepage"><div><div><h4 class="title">
11349: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
11350: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11351: <h3 class="title">Note</h3>
11352: <p>SSP should not be disabled to work around runtime crashes in
11353: the program! This is a very bad idea and will expose you to security
11354: vulnerabilities.</p>
11355: </div>
11356: <p>
11357: To disable SSP on a per-package basis, set the following
11358: in the package's <code class="filename">Makefile</code>
11359: before <code class="filename">bsd.prefs.mk</code> is included:
11360: </p>
11361: <pre class="programlisting">
11362: SSP_SUPPORTED= no
11363: </pre>
11364: </div>
11365: </div>
11366: </div>
11367: <div class="sect1">
11368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11369: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
11370: <p>
11371: The illusion of security is worse than having no security at all. This section
11372: lists a number of ways to ensure the security features requested are actually
11373: effective.
11374: </p>
11375: <p>
11376: These instructions were obtained and tested on a system derived from NetBSD 7
11377: (amd64). YMMV.
11378: </p>
11379: <div class="sect2">
11380: <div class="titlepage"><div><div><h3 class="title">
11381: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
11382: <p>
11383: The ELF executable type in use changes for binaries built as PIE; without:
11384: </p>
11385: <pre class="programlisting">
11386: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
11387: /path/to/bin/ary: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for NetBSD 7.0, not stripped
11388: </pre>
11389: <p>as opposed to the following binary, built as PIE:</p>
11390: <pre class="programlisting">
11391: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
11392: /path/to/pie/bin/ary: ELF 64-bit LSB shared object, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for NetBSD 7.0, not stripped
11393: </pre>
11394: <p>
11395: The latter result is then what is expected.
11396: </p>
11397: </div>
11398: <div class="sect2">
11399: <div class="titlepage"><div><div><h3 class="title">
11400: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
11401: <p>
11402: The following command should list a section called RELRO:
11403: </p>
11404: <pre class="programlisting">
11405: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
11406:
11407: /path/to/bin/ary: file format elf64-x86-64
11408:
11409: Program Header:
11410: [...]
11411: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
11412: </pre>
11413: <p>
11414: This check is now performed automatically if
11415: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
11416: </p>
11417: </div>
11418: <div class="sect2">
11419: <div class="titlepage"><div><div><h3 class="title">
11420: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
11421: <p>
11422: The dynamic loader will apply RELRO immediately when detecting the presence of
11423: the <code class="varname">BIND_NOW</code> flag:
11424: </p>
11425: <pre class="programlisting">
11426: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
11427:
11428: /path/to/bin/ary: file format elf64-x86-64
11429:
11430: Dynamic Section:
11431: [...]
11432: BIND_NOW 0x0000000000000000
11433: </pre>
11434: <p>
11435: This has to be combined with partial RELRO (see above) to be fully efficient.
11436: </p>
11437: <p>
11438: This check is now performed automatically (where supported) if
11439: <code class="varname">PKG_DEVELOPER</code> is set.
11440: </p>
11441: </div>
11442: <div class="sect2">
11443: <div class="titlepage"><div><div><h3 class="title">
11444: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.323 nia 11445: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11446: <h3 class="title">Note</h3>
11447: <p>
11448: Checking for SSP using this method only works where the operating system
11449: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
11450: on recent NetBSD/FreeBSD/Linux versions.
11451: </p>
11452: </div>
1.322 leot 11453: <p>
11454: Building objects, binaries and libraries with SSP will affect the presence of
11455: additional symbols in the resulting file:
11456: </p>
11457: <pre class="programlisting">
11458: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
11459: [...]
11460: U __stack_chk_fail
11461: 0000000000600ea0 B __stack_chk_guard
11462: </pre>
11463: <p>
11464: This is an indicator that the program was indeed built with support for SSP.
11465: </p>
11466: <p>
11467: This check is now performed automatically (where supported) if
11468: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
11469: </p>
11470: </div>
11471: </div>
11472: </div>
11473: <div class="appendix">
11474: <div class="titlepage"><div><div><h1 class="title">
11475: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
11476: <div class="toc">
11477: <p><b>Table of Contents</b></p>
11478: <dl class="toc">
11479: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
11480: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
11481: </dl>
11482: </div>
11483: <div class="sect1">
11484: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11485: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
11486: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11487: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11488: => figlet221.tar.gz doesn't seem to exist on this system.
11489: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11490: => [172219 bytes]
11491: Connected to ftp.plig.net.
11492: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11493: 331 Guest login ok, send your complete e-mail address as password.
11494: 230-You are user #5 of 500 simultaneous users allowed.
11495: 230-
11496: 230- ___ _ _ _
11497: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11498: 230- | _| _| . |_| . | | | . |_| . | _| . |
11499: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11500: 230- |_| |_| |___| |___|
11501: 230-
11502: 230-** Welcome to ftp.plig.org **
11503: 230-
11504: 230-Please note that all transfers from this FTP site are logged. If you
11505: 230-do not like this, please disconnect now.
11506: 230-
11507: 230-This archive is available via
11508: 230-
11509: 230-HTTP: http://ftp.plig.org/
11510: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11511: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11512: 230-
11513: 230-Please email comments, bug reports and requests for packages to be
11514: 230-mirrored to ftp-admin@plig.org.
11515: 230-
11516: 230-
11517: 230 Logged in anonymously.
11518: Remote system type is UNIX.
11519: Using binary mode to transfer files.
11520: 200 Type okay.
11521: 250 "/pub" is new cwd.
11522: 250-"/pub/figlet" is new cwd.
11523: 250-
11524: 250-Welcome to the figlet archive at ftp.figlet.org
11525: 250-
11526: 250- ftp://ftp.figlet.org/pub/figlet/
11527: 250-
11528: 250-The official FIGlet web page is:
11529: 250- http://www.figlet.org/
11530: 250-
11531: 250-If you have questions, please mailto:info@figlet.org. If you want to
11532: 250-contribute a font or something else, you can email us.
11533: 250
11534: 250 "/pub/figlet/program" is new cwd.
11535: 250 "/pub/figlet/program/unix" is new cwd.
11536: local: figlet221.tar.gz remote: figlet221.tar.gz
11537: 502 Unimplemented command.
11538: 227 Entering Passive Mode (195,40,6,41,246,104)
11539: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11540: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11541: 226 Transfer completed.
11542: 172219 bytes received in 00:02 (75.99 KB/s)
11543: 221 Goodbye.
11544: => Checksum OK for figlet221.tar.gz.
11545: ===> Extracting for figlet-2.2.1nb2
11546: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11547: ===> Patching for figlet-2.2.1nb2
11548: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11549: ===> Overriding tools for figlet-2.2.1nb2
11550: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11551: ===> Configuring for figlet-2.2.1nb2
11552: ===> Building for figlet-2.2.1nb2
11553: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11554: chmod a+x figlet
11555: gcc -O2 -o chkfont chkfont.c
11556: => Unwrapping files-to-be-installed.
11557: <code class="prompt">#</code>
11558: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11559: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11560: ===> Installing for figlet-2.2.1nb2
11561: install -d -o root -g wheel -m 755 /usr/pkg/bin
11562: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11563: mkdir -p /usr/pkg/share/figlet
11564: cp figlet /usr/pkg/bin
11565: cp chkfont /usr/pkg/bin
11566: chmod 555 figlist showfigfonts
11567: cp figlist /usr/pkg/bin
11568: cp showfigfonts /usr/pkg/bin
11569: cp fonts/*.flf /usr/pkg/share/figlet
11570: cp fonts/*.flc /usr/pkg/share/figlet
11571: cp figlet.6 /usr/pkg/man/man6
11572: ===> Registering installation for figlet-2.2.1nb2
11573: <code class="prompt">#</code></pre>
11574: </div>
11575: <div class="sect1">
11576: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11577: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
11578: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11579: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11580: ===> Packaging figlet-2.2.1nb2
11581: ===> Building binary package for figlet-2.2.1nb2
11582: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11583: Using SrcDir value of /usr/pkg
11584: Registering depends:.
11585: <code class="prompt">#</code></pre>
11586: </div>
11587: </div>
11588: <div class="appendix">
11589: <div class="titlepage"><div><div><h1 class="title">
11590: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
11591: <div class="toc">
11592: <p><b>Table of Contents</b></p>
11593: <dl class="toc">
11594: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11595: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11596: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11597: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11598: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
11599: <code class="filename">stable</code>,
11600: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11601: source packages</a></span></dt>
11602: </dl>
11603: </div>
11604: <p>As in other big projects, the directory layout of pkgsrc
11605: is quite complex for newbies. This chapter explains where you
11606: find things on the FTP server. The base directory on
11607: <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>.
11608: On other servers it may be different, but inside this directory,
11609: everything should look the same, no matter on which server you
11610: are. This directory contains some subdirectories, which are
11611: explained below.</p>
11612: <div class="sect1">
11613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11614: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
11615: <p>The directory <code class="filename">distfiles</code> contains lots
11616: of archive files from all pkgsrc packages, which are mirrored
11617: here. The subdirectories are called after their package names
11618: and are used when the distributed files have names that don't
11619: explicitly contain a version number or are otherwise too generic
11620: (for example <code class="filename">release.tar.gz</code>).</p>
11621: </div>
11622: <div class="sect1">
11623: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11624: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
11625: <p>This directory contains things that individual pkgsrc
11626: developers find worth publishing.</p>
11627: </div>
11628: <div class="sect1">
11629: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11630: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
11631: <p>This directory contains binary packages for the various
11632: platforms that are supported by pkgsrc.
11633: 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>
11634: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11635: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
11636: operating system for which the packages have been built. The
11637: name is taken from the output of the <span class="command"><strong>uname</strong></span>
11638: command, so it may differ from the one you are used to
11639: hear.</p></li>
11640: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
11641: architecture of the platform for which the packages have been
11642: built. It also includes the <code class="varname">ABI</code> (Application
11643: Binary Interface) for platforms that have several of
11644: them.</p></li>
11645: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
11646: the operating system. For version numbers that change often (for
11647: example NetBSD-current), the often-changing part should be
11648: replaced with an <code class="literal">x</code>, for example
11649: <code class="literal">4.99.x</code>.</p></li>
11650: <li class="listitem"><p><code class="varname">TAG</code> is either
11651: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11652: for a stable branch, or <code class="literal">head</code> for packages
11653: built from the HEAD branch. The latter should only be used when
11654: the packages are updated on a regular basis. Otherwise the date
11655: from checking out pkgsrc should be appended, for example
11656: <code class="literal">head_20071015</code>.</p></li>
11657: </ul></div>
11658: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11659: can quickly click through the directories on the
11660: server and find the best binary packages for their machines. Since they
11661: usually know the operating system and the hardware architecture, OPSYS
11662: and ARCH are placed first. After these choices, they can select the
11663: best combination of OSVERSION and TAG together, since it is usually the
11664: case that packages stay compatible between different version of the
11665: operating system.</p>
11666: <p>In each of these directories, there is a
11667: whole binary packages collection for a specific platform. It has a directory called
11668: <code class="filename">All</code> which contains all binary packages.
11669: Besides that, there are various category directories that
11670: contain symbolic links to the real binary packages.</p>
11671: </div>
11672: <div class="sect1">
11673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11674: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 11675: <p>Here are the reports from bulk builds, for those who want
11676: to fix packages that didn't build on some of the platforms. The
1.322 leot 11677: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="D.3. packages: Binary packages">Section D.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.108 rillig 11678: </div>
1.148 asau 11679: <div class="sect1">
1.108 rillig 11680: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 11681: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.261 leot 11682: <code class="filename">stable</code>,
1.126 jakllsch 11683: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 11684: source packages</h2></div></div></div>
1.128 wiz 11685: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 11686: that is the files that define how to create binary packages from
11687: source archives.</p>
1.262 leot 11688: <p>Each of the <code class="filename">current</code>,
11689: <code class="filename">stable</code> and
11690: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11691: directories share the same structure. They each contain a
11692: <code class="filename">pkgsrc</code> directory and
11693: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76 rillig 11694: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 11695: snapshot of the CVS repository, which is updated regularly. The
1.262 leot 11696: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11697: as the directory, ready to be downloaded as a whole.</p>
11698: <p>The <code class="filename">current</code> directory contains files
11699: related to the HEAD branch of the CVS repository.
11700: In this directory there is an additional file called
11701: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11702: all pkgsrc <code class="filename">README</code>s with information about
11703: categories and packages.
11704: </p>
11705: <p>The <code class="filename">stable</code> directory is a symlink to
11706: the latest
11707: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11708: </p>
11709: <p>The
11710: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11711: directories contain files related to the
11712: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11713: stable branch of the CVS repository. In these directories there is
11714: an additional file called
11715: <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 11716: which contains the state of pkgsrc when it was branched.</p>
11717: </div>
1.75 rillig 11718: </div>
1.148 asau 11719: <div class="appendix">
11720: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 11721: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.267 rillig 11722: <p>
11723: The following list contains all help topics that are available
11724: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11725: </p>
1.269 leot 11726: <table border="0" summary="Simple list" class="simplelist">
11727: <tr>
11728: <td>#!</td>
11729: <td>-lintl</td>
11730: </tr>
11731: <tr>
1.320 wiz 11732: <td>32bit</td>
1.269 leot 11733: <td>64bit</td>
1.320 wiz 11734: </tr>
11735: <tr>
1.269 leot 11736: <td>ABI</td>
1.320 wiz 11737: <td>ACCEPTABLE_LICENSES</td>
1.269 leot 11738: </tr>
11739: <tr>
11740: <td>ACROREAD_FONTPATH</td>
1.320 wiz 11741: <td>ADDITIONAL</td>
1.269 leot 11742: </tr>
11743: <tr>
11744: <td>AFAIK</td>
1.320 wiz 11745: <td>AIX</td>
1.269 leot 11746: </tr>
11747: <tr>
11748: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.320 wiz 11749: <td>ALL_ENV</td>
1.269 leot 11750: </tr>
11751: <tr>
1.315 cirnatda 11752: <td>ALTERNATIVES_SRC</td>
1.328 ! jnemeth 11753: <td>AMANDA_TMP</td>
1.327 wiz 11754: </tr>
11755: <tr>
11756: <td>AMANDA_USER</td>
1.328 ! jnemeth 11757: <td>AMANDA_VAR</td>
1.311 leot 11758: </tr>
11759: <tr>
1.327 wiz 11760: <td>APACHE_GROUP</td>
1.328 ! jnemeth 11761: <td>APACHE_MODULE_NAME</td>
1.292 leot 11762: </tr>
11763: <tr>
1.327 wiz 11764: <td>APACHE_MODULE_SRC</td>
1.328 ! jnemeth 11765: <td>APACHE_MODULE_SRCDIR</td>
1.274 rillig 11766: </tr>
11767: <tr>
1.327 wiz 11768: <td>APACHE_PKG_PREFIX</td>
1.328 ! jnemeth 11769: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.269 leot 11770: </tr>
11771: <tr>
1.327 wiz 11772: <td>APACHE_SUEXEC_DOCROOT</td>
1.328 ! jnemeth 11773: <td>APACHE_USER</td>
1.269 leot 11774: </tr>
11775: <tr>
1.327 wiz 11776: <td>APPEND_ABI</td>
1.328 ! jnemeth 11777: <td>APPEND_ELF</td>
1.269 leot 11778: </tr>
11779: <tr>
1.327 wiz 11780: <td>ARLA_CACHE</td>
1.328 ! jnemeth 11781: <td>AUDIT_PACKAGES_FLAGS</td>
1.269 leot 11782: </tr>
11783: <tr>
1.327 wiz 11784: <td>AUTOCONF_REQD</td>
1.328 ! jnemeth 11785: <td>AUTOMAKE_OVERRIDE</td>
1.269 leot 11786: </tr>
11787: <tr>
1.327 wiz 11788: <td>AUTOMAKE_REQD</td>
1.328 ! jnemeth 11789: <td>AUTO_MKDIRS</td>
1.269 leot 11790: </tr>
11791: <tr>
1.327 wiz 11792: <td>BDB185_DEFAULT</td>
1.328 ! jnemeth 11793: <td>BDBBASE</td>
1.269 leot 11794: </tr>
11795: <tr>
1.327 wiz 11796: <td>BDB_ACCEPTED</td>
1.328 ! jnemeth 11797: <td>BDB_DEFAULT</td>
1.269 leot 11798: </tr>
11799: <tr>
1.327 wiz 11800: <td>BDB_LIBS</td>
1.328 ! jnemeth 11801: <td>BDB_TYPE</td>
1.269 leot 11802: </tr>
11803: <tr>
1.327 wiz 11804: <td>BINCIMAP_GROUP</td>
1.328 ! jnemeth 11805: <td>BINCIMAP_USER</td>
1.269 leot 11806: </tr>
11807: <tr>
1.327 wiz 11808: <td>BIND_DIR</td>
1.328 ! jnemeth 11809: <td>BIND_GROUP</td>
1.269 leot 11810: </tr>
11811: <tr>
1.327 wiz 11812: <td>BIND_USER</td>
1.328 ! jnemeth 11813: <td>BINOWN</td>
1.312 gdt 11814: </tr>
11815: <tr>
1.327 wiz 11816: <td>BINPKG_SITES</td>
1.328 ! jnemeth 11817: <td>BIN_INSTALL_FLAGS</td>
1.269 leot 11818: </tr>
11819: <tr>
1.327 wiz 11820: <td>BISON_PKGDATADIR</td>
1.328 ! jnemeth 11821: <td>BLAS</td>
1.269 leot 11822: </tr>
11823: <tr>
1.327 wiz 11824: <td>BLAS_ACCEPTED</td>
1.328 ! jnemeth 11825: <td>BLAS_C_INTERFACE</td>
1.303 bacon 11826: </tr>
11827: <tr>
1.327 wiz 11828: <td>BLAS_INCLUDES</td>
1.328 ! jnemeth 11829: <td>BLAS_INDEX64</td>
1.320 wiz 11830: </tr>
11831: <tr>
1.327 wiz 11832: <td>BLAS_LIBS</td>
1.328 ! jnemeth 11833: <td>BLAS_TYPE</td>
1.320 wiz 11834: </tr>
11835: <tr>
1.327 wiz 11836: <td>BOOTSTRAP_DEPENDS</td>
1.328 ! jnemeth 11837: <td>BOOTSTRAP_SETUPTOOLS</td>
1.269 leot 11838: </tr>
11839: <tr>
1.327 wiz 11840: <td>BROKEN</td>
1.328 ! jnemeth 11841: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.292 leot 11842: </tr>
11843: <tr>
1.327 wiz 11844: <td>BROKEN_ON_PLATFORM</td>
1.328 ! jnemeth 11845: <td>BSDSRCDIR</td>
1.269 leot 11846: </tr>
11847: <tr>
1.327 wiz 11848: <td>BSDXSRCDIR</td>
1.328 ! jnemeth 11849: <td>BSD_MAKE_ENV</td>
1.269 leot 11850: </tr>
11851: <tr>
1.327 wiz 11852: <td>BUILDLINK_AUTO_DIRS</td>
1.328 ! jnemeth 11853: <td>BUILDLINK_AUTO_VARS</td>
1.269 leot 11854: </tr>
11855: <tr>
1.327 wiz 11856: <td>BUILDLINK_CFLAGS</td>
1.328 ! jnemeth 11857: <td>BUILDLINK_CONTENTS_FILTER</td>
1.269 leot 11858: </tr>
11859: <tr>
1.327 wiz 11860: <td>BUILDLINK_CPPFLAGS</td>
1.269 leot 11861: <td>BUILDLINK_FILES</td>
1.320 wiz 11862: </tr>
11863: <tr>
1.303 bacon 11864: <td>BUILDLINK_FILES_CMD</td>
1.320 wiz 11865: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.269 leot 11866: </tr>
11867: <tr>
1.303 bacon 11868: <td>BUILDLINK_LDFLAGS</td>
1.320 wiz 11869: <td>BUILDLINK_LIBS</td>
1.269 leot 11870: </tr>
11871: <tr>
1.303 bacon 11872: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.320 wiz 11873: <td>BUILDLINK_PKGNAME</td>
1.269 leot 11874: </tr>
11875: <tr>
1.303 bacon 11876: <td>BUILDLINK_PREFIX</td>
1.320 wiz 11877: <td>BUILDLINK_RPATHDIRS</td>
1.269 leot 11878: </tr>
11879: <tr>
1.303 bacon 11880: <td>BUILDLINK_TREE</td>
1.320 wiz 11881: <td>BUILD_DEFS</td>
1.269 leot 11882: </tr>
11883: <tr>
1.303 bacon 11884: <td>BUILD_DEFS_EFFECTS</td>
1.320 wiz 11885: <td>BUILD_DEPENDS</td>
1.269 leot 11886: </tr>
11887: <tr>
1.303 bacon 11888: <td>BUILD_DIRS</td>
1.320 wiz 11889: <td>BUILD_ENV_SHELL</td>
1.269 leot 11890: </tr>
11891: <tr>
1.303 bacon 11892: <td>BUILD_MAKE_CMD</td>
1.320 wiz 11893: <td>BUILD_MAKE_FLAGS</td>
1.269 leot 11894: </tr>
11895: <tr>
1.303 bacon 11896: <td>BUILD_TARGET</td>
1.320 wiz 11897: <td>BUILTIN_FIND_FILES</td>
1.269 leot 11898: </tr>
11899: <tr>
1.303 bacon 11900: <td>BUILTIN_FIND_FILES_VAR</td>
1.320 wiz 11901: <td>BUILTIN_FIND_GREP</td>
1.269 leot 11902: </tr>
11903: <tr>
1.303 bacon 11904: <td>BUILTIN_FIND_HEADERS</td>
1.320 wiz 11905: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.269 leot 11906: </tr>
11907: <tr>
1.309 gutterid 11908: <td>BUILTIN_FIND_PKGCONFIG</td>
1.320 wiz 11909: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.309 gutterid 11910: </tr>
11911: <tr>
1.303 bacon 11912: <td>BUILTIN_PKG</td>
1.320 wiz 11913: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.269 leot 11914: </tr>
11915: <tr>
1.303 bacon 11916: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.320 wiz 11917: <td>BUILTIN_VERSION_SCRIPT</td>
1.269 leot 11918: </tr>
11919: <tr>
1.303 bacon 11920: <td>BUILTIN_X11_TYPE</td>
1.320 wiz 11921: <td>BUILTIN_X11_VERSION</td>
1.269 leot 11922: </tr>
11923: <tr>
1.303 bacon 11924: <td>CACTI_GROUP</td>
1.320 wiz 11925: <td>CACTI_USER</td>
1.269 leot 11926: </tr>
11927: <tr>
1.303 bacon 11928: <td>CANNA_GROUP</td>
1.320 wiz 11929: <td>CANNA_USER</td>
1.269 leot 11930: </tr>
11931: <tr>
1.303 bacon 11932: <td>CAT</td>
1.320 wiz 11933: <td>CBLAS_LIBS</td>
1.269 leot 11934: </tr>
11935: <tr>
11936: <td>CCACHE_BASE</td>
1.303 bacon 11937: <td>CCACHE_DIR</td>
1.269 leot 11938: </tr>
11939: <tr>
11940: <td>CCACHE_LOGFILE</td>
1.303 bacon 11941: <td>CC_VERSION</td>
1.269 leot 11942: </tr>
11943: <tr>
11944: <td>CC_VERSION_STRING</td>
1.303 bacon 11945: <td>CDRECORD_CONF</td>
1.269 leot 11946: </tr>
11947: <tr>
11948: <td>CDROM_PKG_URL_DIR</td>
1.303 bacon 11949: <td>CDROM_PKG_URL_HOST</td>
1.269 leot 11950: </tr>
11951: <tr>
1.303 bacon 11952: <td>CHECK_COMPILER</td>
1.328 ! jnemeth 11953: <td>CHECK_FAKEHOME</td>
1.327 wiz 11954: </tr>
11955: <tr>
11956: <td>CHECK_FILES</td>
1.328 ! jnemeth 11957: <td>CHECK_FILES_SKIP</td>
1.320 wiz 11958: </tr>
11959: <tr>
1.327 wiz 11960: <td>CHECK_FILES_STRICT</td>
1.328 ! jnemeth 11961: <td>CHECK_HEADERS</td>
1.311 leot 11962: </tr>
11963: <tr>
1.327 wiz 11964: <td>CHECK_HEADERS_SKIP</td>
1.328 ! jnemeth 11965: <td>CHECK_INTERPRETER</td>
1.292 leot 11966: </tr>
11967: <tr>
1.327 wiz 11968: <td>CHECK_INTERPRETER_SKIP</td>
1.328 ! jnemeth 11969: <td>CHECK_PERMS</td>
1.274 rillig 11970: </tr>
11971: <tr>
1.327 wiz 11972: <td>CHECK_PERMS_AUTOFIX</td>
1.328 ! jnemeth 11973: <td>CHECK_PERMS_SKIP</td>
1.269 leot 11974: </tr>
11975: <tr>
1.327 wiz 11976: <td>CHECK_PORTABILITY</td>
1.328 ! jnemeth 11977: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.269 leot 11978: </tr>
11979: <tr>
1.327 wiz 11980: <td>CHECK_PORTABILITY_SKIP</td>
1.328 ! jnemeth 11981: <td>CHECK_RELRO</td>
1.269 leot 11982: </tr>
11983: <tr>
1.327 wiz 11984: <td>CHECK_RELRO_SKIP</td>
1.328 ! jnemeth 11985: <td>CHECK_RELRO_SUPPORTED</td>
1.269 leot 11986: </tr>
11987: <tr>
1.327 wiz 11988: <td>CHECK_SHLIBS</td>
1.328 ! jnemeth 11989: <td>CHECK_SHLIBS_SKIP</td>
1.269 leot 11990: </tr>
11991: <tr>
1.327 wiz 11992: <td>CHECK_SHLIBS_SUPPORTED</td>
1.328 ! jnemeth 11993: <td>CHECK_SHLIBS_TOXIC</td>
1.269 leot 11994: </tr>
11995: <tr>
1.327 wiz 11996: <td>CHECK_SSP</td>
1.328 ! jnemeth 11997: <td>CHECK_SSP_SKIP</td>
1.269 leot 11998: </tr>
11999: <tr>
1.327 wiz 12000: <td>CHECK_SSP_SUPPORTED</td>
1.328 ! jnemeth 12001: <td>CHECK_STRIPPED</td>
1.269 leot 12002: </tr>
12003: <tr>
1.327 wiz 12004: <td>CHECK_STRIPPED_SKIP</td>
1.328 ! jnemeth 12005: <td>CHECK_WRKREF</td>
1.269 leot 12006: </tr>
12007: <tr>
1.327 wiz 12008: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.328 ! jnemeth 12009: <td>CHECK_WRKREF_SKIP</td>
1.269 leot 12010: </tr>
12011: <tr>
1.327 wiz 12012: <td>CLAMAV_DBDIR</td>
1.328 ! jnemeth 12013: <td>CLAMAV_GROUP</td>
1.269 leot 12014: </tr>
12015: <tr>
1.327 wiz 12016: <td>CLAMAV_USER</td>
1.328 ! jnemeth 12017: <td>CLANGBASE</td>
1.269 leot 12018: </tr>
12019: <tr>
1.327 wiz 12020: <td>CLEANDEPENDS</td>
1.328 ! jnemeth 12021: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.269 leot 12022: </tr>
12023: <tr>
1.327 wiz 12024: <td>CMAKE_INSTALL_NAME_DIR</td>
1.328 ! jnemeth 12025: <td>CMAKE_INSTALL_PREFIX</td>
1.269 leot 12026: </tr>
12027: <tr>
1.327 wiz 12028: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.328 ! jnemeth 12029: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.269 leot 12030: </tr>
12031: <tr>
1.327 wiz 12032: <td>CMAKE_PREFIX_PATH</td>
1.305 bacon 12033: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.292 leot 12034: </tr>
12035: <tr>
1.305 bacon 12036: <td>COMPILER_RPATH_FLAG</td>
1.269 leot 12037: <td>COMPILER_USE_SYMLINKS</td>
12038: </tr>
12039: <tr>
1.305 bacon 12040: <td>CONFIGURE_ARGS</td>
1.269 leot 12041: <td>CONFIGURE_DIRS</td>
12042: </tr>
12043: <tr>
1.305 bacon 12044: <td>CONFIGURE_ENV</td>
1.287 rillig 12045: <td>CONFIGURE_ENV_SHELL</td>
1.269 leot 12046: </tr>
12047: <tr>
1.305 bacon 12048: <td>CONFIGURE_HAS_INFODIR</td>
1.269 leot 12049: <td>CONFIGURE_HAS_MANDIR</td>
12050: </tr>
12051: <tr>
1.305 bacon 12052: <td>CONFIGURE_SCRIPT</td>
1.269 leot 12053: <td>CONFIG_SHELL</td>
12054: </tr>
12055: <tr>
1.305 bacon 12056: <td>CONFIG_SHELL_FLAGS</td>
1.269 leot 12057: <td>CONF_FILES</td>
12058: </tr>
12059: <tr>
1.305 bacon 12060: <td>CONF_FILES_MODE</td>
1.269 leot 12061: <td>CONF_FILES_PERMS</td>
12062: </tr>
12063: <tr>
1.305 bacon 12064: <td>CONSERVER_DEFAULTHOST</td>
1.269 leot 12065: <td>CONSERVER_DEFAULTPORT</td>
12066: </tr>
12067: <tr>
1.305 bacon 12068: <td>CP</td>
1.269 leot 12069: <td>CPP</td>
12070: </tr>
12071: <tr>
1.305 bacon 12072: <td>CPP_PRECOMP_FLAGS</td>
1.269 leot 12073: <td>CREATE_WRKDIR_SYMLINK</td>
12074: </tr>
12075: <tr>
1.305 bacon 12076: <td>CROSSBASE</td>
1.269 leot 12077: <td>CTFCONVERT</td>
12078: </tr>
12079: <tr>
1.305 bacon 12080: <td>CTF_FILES_SKIP</td>
1.269 leot 12081: <td>CTF_SUPPORTED</td>
12082: </tr>
12083: <tr>
1.305 bacon 12084: <td>CTYPE</td>
1.269 leot 12085: <td>CUPS_GROUP</td>
12086: </tr>
12087: <tr>
1.305 bacon 12088: <td>CUPS_SYSTEM_GROUPS</td>
1.269 leot 12089: <td>CUPS_USER</td>
12090: </tr>
12091: <tr>
1.305 bacon 12092: <td>CURSES_DEFAULT</td>
1.269 leot 12093: <td>CURSES_TYPE</td>
1.292 leot 12094: </tr>
12095: <tr>
1.273 brook 12096: <td>CXX</td>
1.328 ! jnemeth 12097: <td>CYRUS_GROUP</td>
1.327 wiz 12098: </tr>
12099: <tr>
12100: <td>CYRUS_IDLE</td>
1.328 ! jnemeth 12101: <td>CYRUS_USER</td>
1.320 wiz 12102: </tr>
12103: <tr>
1.327 wiz 12104: <td>DAEMONTOOLS_GROUP</td>
1.328 ! jnemeth 12105: <td>DAEMONTOOLS_LOG_USER</td>
1.311 leot 12106: </tr>
12107: <tr>
1.327 wiz 12108: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.328 ! jnemeth 12109: <td>DARWIN_REQUIRES_FILTER</td>
1.269 leot 12110: </tr>
12111: <tr>
1.327 wiz 12112: <td>DBUS_GROUP</td>
1.328 ! jnemeth 12113: <td>DBUS_USER</td>
1.269 leot 12114: </tr>
12115: <tr>
1.327 wiz 12116: <td>DEFANG_GROUP</td>
1.328 ! jnemeth 12117: <td>DEFANG_USER</td>
1.269 leot 12118: </tr>
12119: <tr>
1.327 wiz 12120: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.328 ! jnemeth 12121: <td>DEFAULT_DISTFILES</td>
1.309 gutterid 12122: </tr>
12123: <tr>
1.327 wiz 12124: <td>DEFAULT_IRC_SERVER</td>
1.328 ! jnemeth 12125: <td>DEFAULT_SERIAL_DEVICE</td>
1.269 leot 12126: </tr>
12127: <tr>
1.327 wiz 12128: <td>DEF_UMASK</td>
1.328 ! jnemeth 12129: <td>DEINSTALLDEPENDS</td>
1.269 leot 12130: </tr>
12131: <tr>
1.327 wiz 12132: <td>DEINSTALL_SRC</td>
1.328 ! jnemeth 12133: <td>DEINSTALL_TEMPLATES</td>
1.269 leot 12134: </tr>
12135: <tr>
1.327 wiz 12136: <td>DELAYED_ERROR_MSG</td>
1.328 ! jnemeth 12137: <td>DELAYED_WARNING_MSG</td>
1.269 leot 12138: </tr>
12139: <tr>
1.327 wiz 12140: <td>DEPENDS</td>
1.328 ! jnemeth 12141: <td>DEPENDS_TARGET</td>
1.269 leot 12142: </tr>
12143: <tr>
1.327 wiz 12144: <td>DEPENDS_TYPE</td>
1.328 ! jnemeth 12145: <td>DESTDIR</td>
1.269 leot 12146: </tr>
12147: <tr>
1.327 wiz 12148: <td>DESTDIR_VARNAME</td>
1.328 ! jnemeth 12149: <td>DIALER_GROUP</td>
1.269 leot 12150: </tr>
12151: <tr>
1.327 wiz 12152: <td>DIGEST_REQD</td>
1.328 ! jnemeth 12153: <td>DISTDIR</td>
1.269 leot 12154: </tr>
12155: <tr>
1.327 wiz 12156: <td>DISTFILES</td>
1.328 ! jnemeth 12157: <td>DISTINFO_FILE</td>
1.269 leot 12158: </tr>
12159: <tr>
1.327 wiz 12160: <td>DISTNAME</td>
1.328 ! jnemeth 12161: <td>DIST_PATH</td>
1.269 leot 12162: </tr>
12163: <tr>
1.327 wiz 12164: <td>DIST_SUBDIR</td>
1.328 ! jnemeth 12165: <td>DJBDNS_AXFR_USER</td>
1.269 leot 12166: </tr>
12167: <tr>
1.327 wiz 12168: <td>DJBDNS_CACHE_USER</td>
1.328 ! jnemeth 12169: <td>DJBDNS_DJBDNS_GROUP</td>
1.269 leot 12170: </tr>
12171: <tr>
1.327 wiz 12172: <td>DJBDNS_LOG_USER</td>
1.328 ! jnemeth 12173: <td>DJBDNS_RBL_USER</td>
1.269 leot 12174: </tr>
12175: <tr>
1.327 wiz 12176: <td>DJBDNS_TINY_USER</td>
1.328 ! jnemeth 12177: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.269 leot 12178: </tr>
12179: <tr>
1.327 wiz 12180: <td>DL_AUTO_VARS</td>
1.328 ! jnemeth 12181: <td>DL_CFLAGS</td>
1.269 leot 12182: </tr>
12183: <tr>
1.327 wiz 12184: <td>DL_LDFLAGS</td>
1.328 ! jnemeth 12185: <td>DL_LIBS</td>
1.269 leot 12186: </tr>
12187: <tr>
1.327 wiz 12188: <td>DNS</td>
1.328 ! jnemeth 12189: <td>DOCOWN</td>
1.269 leot 12190: </tr>
12191: <tr>
1.327 wiz 12192: <td>DOWNLOADED_DISTFILE</td>
1.328 ! jnemeth 12193: <td>DT_LAYOUT</td>
1.269 leot 12194: </tr>
12195: <tr>
1.327 wiz 12196: <td>DYNAMIC_SITES_CMD</td>
1.328 ! jnemeth 12197: <td>DYNAMIC_SITES_SCRIPT</td>
1.269 leot 12198: </tr>
12199: <tr>
1.327 wiz 12200: <td>ECHO</td>
1.328 ! jnemeth 12201: <td>ECHO_N</td>
1.269 leot 12202: </tr>
12203: <tr>
1.327 wiz 12204: <td>ELK_GUI</td>
1.328 ! jnemeth 12205: <td>EMACS_TYPE</td>
1.269 leot 12206: </tr>
12207: <tr>
1.327 wiz 12208: <td>EMULDIR</td>
1.328 ! jnemeth 12209: <td>EMULSUBDIR</td>
1.269 leot 12210: </tr>
12211: <tr>
1.327 wiz 12212: <td>EMULSUBDIRSLASH</td>
1.328 ! jnemeth 12213: <td>EMUL_ARCH</td>
1.269 leot 12214: </tr>
12215: <tr>
1.327 wiz 12216: <td>EMUL_DISTRO</td>
1.328 ! jnemeth 12217: <td>EMUL_EXEC_FMT</td>
1.269 leot 12218: </tr>
12219: <tr>
1.327 wiz 12220: <td>EMUL_IS_NATIVE</td>
1.328 ! jnemeth 12221: <td>EMUL_MODULES</td>
1.269 leot 12222: </tr>
12223: <tr>
1.327 wiz 12224: <td>EMUL_OPSYS</td>
1.328 ! jnemeth 12225: <td>EMUL_PKG_FMT</td>
1.269 leot 12226: </tr>
12227: <tr>
1.327 wiz 12228: <td>EMUL_PLATFORM</td>
1.328 ! jnemeth 12229: <td>EMUL_PLATFORMS</td>
1.269 leot 12230: </tr>
12231: <tr>
1.327 wiz 12232: <td>EMUL_PREFER</td>
1.328 ! jnemeth 12233: <td>EMUL_REQD</td>
1.269 leot 12234: </tr>
12235: <tr>
1.327 wiz 12236: <td>EMUL_TYPE</td>
1.328 ! jnemeth 12237: <td>ERROR_MSG</td>
1.269 leot 12238: </tr>
12239: <tr>
1.327 wiz 12240: <td>EXIM_GROUP</td>
1.328 ! jnemeth 12241: <td>EXIM_USER</td>
1.269 leot 12242: </tr>
12243: <tr>
1.327 wiz 12244: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.328 ! jnemeth 12245: <td>EXTRACTOR</td>
1.269 leot 12246: </tr>
12247: <tr>
1.327 wiz 12248: <td>EXTRACT_CMD</td>
1.328 ! jnemeth 12249: <td>EXTRACT_CMD_DEFAULT</td>
1.269 leot 12250: </tr>
12251: <tr>
1.327 wiz 12252: <td>EXTRACT_DIR</td>
1.328 ! jnemeth 12253: <td>EXTRACT_ELEMENTS</td>
1.269 leot 12254: </tr>
12255: <tr>
1.327 wiz 12256: <td>EXTRACT_ENV</td>
1.328 ! jnemeth 12257: <td>EXTRACT_ONLY</td>
1.269 leot 12258: </tr>
12259: <tr>
1.327 wiz 12260: <td>EXTRACT_OPTS</td>
1.328 ! jnemeth 12261: <td>EXTRACT_SUFX</td>
1.269 leot 12262: </tr>
12263: <tr>
1.327 wiz 12264: <td>EXTRACT_USING</td>
1.328 ! jnemeth 12265: <td>FAIL</td>
1.269 leot 12266: </tr>
12267: <tr>
1.327 wiz 12268: <td>FAILOVER_FETCH</td>
1.328 ! jnemeth 12269: <td>FAIL_MSG</td>
1.269 leot 12270: </tr>
12271: <tr>
1.327 wiz 12272: <td>FAKE_NCURSES</td>
1.328 ! jnemeth 12273: <td>FAM</td>
1.269 leot 12274: </tr>
12275: <tr>
1.327 wiz 12276: <td>FAM_ACCEPTED</td>
1.328 ! jnemeth 12277: <td>FAM_DEFAULT</td>
1.292 leot 12278: </tr>
12279: <tr>
1.327 wiz 12280: <td>FAM_SERVER</td>
1.328 ! jnemeth 12281: <td>FCPATH</td>
1.269 leot 12282: </tr>
12283: <tr>
1.327 wiz 12284: <td>FEATURE_CPPFLAGS</td>
1.328 ! jnemeth 12285: <td>FEATURE_LDFLAGS</td>
1.269 leot 12286: </tr>
12287: <tr>
1.327 wiz 12288: <td>FEATURE_LIBS</td>
1.328 ! jnemeth 12289: <td>FETCH_AFTER_ARGS</td>
1.269 leot 12290: </tr>
12291: <tr>
1.327 wiz 12292: <td>FETCH_BEFORE_ARGS</td>
1.328 ! jnemeth 12293: <td>FETCH_CMD</td>
1.269 leot 12294: </tr>
12295: <tr>
1.327 wiz 12296: <td>FETCH_OUTPUT_ARGS</td>
1.328 ! jnemeth 12297: <td>FETCH_PROXY</td>
1.269 leot 12298: </tr>
12299: <tr>
1.327 wiz 12300: <td>FETCH_RESUME_ARGS</td>
1.328 ! jnemeth 12301: <td>FETCH_TIMEOUT</td>
1.269 leot 12302: </tr>
12303: <tr>
1.327 wiz 12304: <td>FETCH_USE_IPV4_ONLY</td>
1.328 ! jnemeth 12305: <td>FETCH_USING</td>
1.269 leot 12306: </tr>
12307: <tr>
1.327 wiz 12308: <td>FILES_SUBST</td>
1.328 ! jnemeth 12309: <td>FILES_SUBST_SED</td>
1.269 leot 12310: </tr>
12311: <tr>
1.327 wiz 12312: <td>FIX_SYSTEM_HEADERS</td>
1.328 ! jnemeth 12313: <td>FLUXBOX_USE_GNOME</td>
1.303 bacon 12314: </tr>
12315: <tr>
1.327 wiz 12316: <td>FLUXBOX_USE_KDE</td>
1.328 ! jnemeth 12317: <td>FLUXBOX_USE_XFT</td>
1.269 leot 12318: </tr>
12319: <tr>
1.327 wiz 12320: <td>FLUXBOX_USE_XINERAMA</td>
1.295 rillig 12321: <td>FONTS_DIRS</td>
1.274 rillig 12322: </tr>
12323: <tr>
1.305 bacon 12324: <td>FONTS_VERBOSE</td>
1.295 rillig 12325: <td>FOO_HACKS_MK</td>
1.292 leot 12326: </tr>
12327: <tr>
1.305 bacon 12328: <td>FOX_USE_XUNICODE</td>
1.295 rillig 12329: <td>FREEWNN_GROUP</td>
1.269 leot 12330: </tr>
12331: <tr>
1.305 bacon 12332: <td>FREEWNN_USER</td>
1.295 rillig 12333: <td>FTP_PKG_URL_DIR</td>
1.269 leot 12334: </tr>
12335: <tr>
1.305 bacon 12336: <td>FTP_PKG_URL_HOST</td>
1.295 rillig 12337: <td>GAMEDATAMODE</td>
1.269 leot 12338: </tr>
12339: <tr>
1.305 bacon 12340: <td>GAMEDATA_PERMS</td>
1.295 rillig 12341: <td>GAMEDIRMODE</td>
1.269 leot 12342: </tr>
12343: <tr>
1.305 bacon 12344: <td>GAMEDIR_PERMS</td>
1.295 rillig 12345: <td>GAMEGRP</td>
1.269 leot 12346: </tr>
12347: <tr>
1.305 bacon 12348: <td>GAMEMODE</td>
1.295 rillig 12349: <td>GAMEOWN</td>
1.269 leot 12350: </tr>
12351: <tr>
1.305 bacon 12352: <td>GAMES_GROUP</td>
1.295 rillig 12353: <td>GAMES_USER</td>
1.269 leot 12354: </tr>
12355: <tr>
1.305 bacon 12356: <td>GCC</td>
1.295 rillig 12357: <td>GCCBASE</td>
1.269 leot 12358: </tr>
12359: <tr>
1.305 bacon 12360: <td>GCC_REQD</td>
1.295 rillig 12361: <td>GCC_VERSION_SUFFIX</td>
1.269 leot 12362: </tr>
12363: <tr>
1.305 bacon 12364: <td>GEM_BUILD</td>
1.295 rillig 12365: <td>GEM_CLEANBUILD</td>
1.269 leot 12366: </tr>
12367: <tr>
1.305 bacon 12368: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.295 rillig 12369: <td>GEM_DOCDIR</td>
1.269 leot 12370: </tr>
12371: <tr>
1.305 bacon 12372: <td>GEM_EXTSDIR</td>
1.295 rillig 12373: <td>GEM_HOME</td>
1.292 leot 12374: </tr>
12375: <tr>
1.305 bacon 12376: <td>GEM_KEEPBUILD</td>
1.295 rillig 12377: <td>GEM_LIBDIR</td>
1.269 leot 12378: </tr>
12379: <tr>
1.305 bacon 12380: <td>GEM_NAME</td>
1.295 rillig 12381: <td>GEM_PATH</td>
1.269 leot 12382: </tr>
12383: <tr>
1.312 gdt 12384: <td>GEM_PLUGINSDIR</td>
1.305 bacon 12385: <td>GEM_SPECFILE</td>
1.269 leot 12386: </tr>
12387: <tr>
1.312 gdt 12388: <td>GENERATE_PLIST</td>
1.316 cirnatda 12389: <td>GHC</td>
1.269 leot 12390: </tr>
12391: <tr>
1.316 cirnatda 12392: <td>GHOSTSCRIPT_REQD</td>
1.312 gdt 12393: <td>GITHUB_PROJECT</td>
1.292 leot 12394: </tr>
12395: <tr>
1.316 cirnatda 12396: <td>GITHUB_RELEASE</td>
1.315 cirnatda 12397: <td>GITHUB_SUBMODULES</td>
1.311 leot 12398: </tr>
12399: <tr>
1.316 cirnatda 12400: <td>GITHUB_TAG</td>
1.313 leot 12401: <td>GITHUB_TYPE</td>
1.269 leot 12402: </tr>
12403: <tr>
1.316 cirnatda 12404: <td>GNU</td>
1.313 leot 12405: <td>GNU_CONFIGURE</td>
1.269 leot 12406: </tr>
12407: <tr>
1.316 cirnatda 12408: <td>GNU_CONFIGURE_INFODIR</td>
1.313 leot 12409: <td>GNU_CONFIGURE_MANDIR</td>
1.269 leot 12410: </tr>
12411: <tr>
1.316 cirnatda 12412: <td>GNU_CONFIGURE_QUIET</td>
1.313 leot 12413: <td>GNU_CONFIGURE_STRICT</td>
1.269 leot 12414: </tr>
12415: <tr>
1.316 cirnatda 12416: <td>GODEP_REDIRECTS</td>
1.313 leot 12417: <td>GO_BUILD_PATTERN</td>
1.276 leot 12418: </tr>
12419: <tr>
1.316 cirnatda 12420: <td>GO_DEPS</td>
1.313 leot 12421: <td>GO_DIST_BASE</td>
1.269 leot 12422: </tr>
12423: <tr>
1.324 nia 12424: <td>GO_EXTRA_MOD_DIRS</td>
1.316 cirnatda 12425: <td>GO_MODULE_FILES</td>
1.269 leot 12426: </tr>
12427: <tr>
1.324 nia 12428: <td>GO_SRCPATH</td>
1.316 cirnatda 12429: <td>GO_VERSION_DEFAULT</td>
1.269 leot 12430: </tr>
12431: <tr>
1.324 nia 12432: <td>GROUP_SPECIFIC_PKGS</td>
1.316 cirnatda 12433: <td>GRUB_NETWORK_CARDS</td>
1.311 leot 12434: </tr>
12435: <tr>
1.324 nia 12436: <td>GRUB_PRESET_COMMAND</td>
1.316 cirnatda 12437: <td>GRUB_SCAN_ARGS</td>
1.269 leot 12438: </tr>
12439: <tr>
1.324 nia 12440: <td>GZIP</td>
1.328 ! jnemeth 12441: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.327 wiz 12442: </tr>
12443: <tr>
12444: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.328 ! jnemeth 12445: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.320 wiz 12446: </tr>
12447: <tr>
1.327 wiz 12448: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.328 ! jnemeth 12449: <td>HAS_CONFIGURE</td>
1.269 leot 12450: </tr>
12451: <tr>
1.327 wiz 12452: <td>HEADER_TEMPLATES</td>
1.316 cirnatda 12453: <td>HOMEPAGE</td>
1.269 leot 12454: </tr>
12455: <tr>
1.324 nia 12456: <td>HOST_PKGTOOLS_ARGS</td>
1.316 cirnatda 12457: <td>HOST_SPECIFIC_PKGS</td>
1.305 bacon 12458: </tr>
12459: <tr>
1.324 nia 12460: <td>HOWL_GROUP</td>
1.316 cirnatda 12461: <td>HOWL_USER</td>
1.269 leot 12462: </tr>
12463: <tr>
1.324 nia 12464: <td>ICCBASE</td>
1.316 cirnatda 12465: <td>ICECAST_CHROOTDIR</td>
1.269 leot 12466: </tr>
12467: <tr>
1.324 nia 12468: <td>ICON_THEMES</td>
1.316 cirnatda 12469: <td>IDOBASE</td>
1.269 leot 12470: </tr>
12471: <tr>
1.324 nia 12472: <td>IGNORE_CCACHE</td>
1.316 cirnatda 12473: <td>IGNORE_INFO_DIRS</td>
1.269 leot 12474: </tr>
12475: <tr>
1.324 nia 12476: <td>IGNORE_INTERACTIVE_FETCH</td>
1.316 cirnatda 12477: <td>IMAKE</td>
1.269 leot 12478: </tr>
12479: <tr>
1.324 nia 12480: <td>IMAKEOPTS</td>
1.316 cirnatda 12481: <td>IMAKE_MAKE</td>
1.269 leot 12482: </tr>
12483: <tr>
1.324 nia 12484: <td>IMAKE_MANINSTALL</td>
1.316 cirnatda 12485: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.269 leot 12486: </tr>
12487: <tr>
1.324 nia 12488: <td>IMDICTDIR</td>
1.316 cirnatda 12489: <td>INCOMPAT_CURSES</td>
1.269 leot 12490: </tr>
12491: <tr>
1.324 nia 12492: <td>INFO_DIR</td>
1.316 cirnatda 12493: <td>INFO_FILES</td>
1.269 leot 12494: </tr>
12495: <tr>
1.324 nia 12496: <td>INFO_FILES_VERBOSE</td>
1.316 cirnatda 12497: <td>INFO_MSG</td>
1.287 rillig 12498: </tr>
12499: <tr>
1.324 nia 12500: <td>INIT_SYSTEM</td>
1.316 cirnatda 12501: <td>INN_DATA_DIR</td>
1.269 leot 12502: </tr>
12503: <tr>
1.324 nia 12504: <td>INN_GROUP</td>
1.316 cirnatda 12505: <td>INN_USER</td>
1.269 leot 12506: </tr>
12507: <tr>
1.324 nia 12508: <td>INSTALLATION_DIRS</td>
1.316 cirnatda 12509: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.269 leot 12510: </tr>
12511: <tr>
1.324 nia 12512: <td>INSTALL_ENV</td>
1.316 cirnatda 12513: <td>INSTALL_SH_OVERRIDE</td>
1.269 leot 12514: </tr>
12515: <tr>
1.324 nia 12516: <td>INSTALL_SRC</td>
1.316 cirnatda 12517: <td>INSTALL_TEMPLATES</td>
1.269 leot 12518: </tr>
12519: <tr>
1.324 nia 12520: <td>INSTALL_UNSTRIPPED</td>
1.316 cirnatda 12521: <td>IRCD_HYBRID_IRC_GROUP</td>
1.269 leot 12522: </tr>
12523: <tr>
1.324 nia 12524: <td>IRCD_HYBRID_IRC_USER</td>
1.316 cirnatda 12525: <td>IRCD_HYBRID_MAXCONN</td>
1.269 leot 12526: </tr>
12527: <tr>
1.324 nia 12528: <td>IRCD_HYBRID_NICLEN</td>
1.316 cirnatda 12529: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.269 leot 12530: </tr>
12531: <tr>
1.324 nia 12532: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.316 cirnatda 12533: <td>IRCD_HYBRID_TOPICLEN</td>
1.269 leot 12534: </tr>
12535: <tr>
1.324 nia 12536: <td>IRIX</td>
1.316 cirnatda 12537: <td>IRRD_USE_PGP</td>
1.269 leot 12538: </tr>
12539: <tr>
1.324 nia 12540: <td>JABBERD_GROUP</td>
1.316 cirnatda 12541: <td>JABBERD_LOGDIR</td>
1.292 leot 12542: </tr>
12543: <tr>
1.324 nia 12544: <td>JABBERD_PIDDIR</td>
1.316 cirnatda 12545: <td>JABBERD_SPOOLDIR</td>
1.311 leot 12546: </tr>
12547: <tr>
1.324 nia 12548: <td>JABBERD_USER</td>
1.316 cirnatda 12549: <td>JAKARTA_HOME</td>
1.320 wiz 12550: </tr>
12551: <tr>
1.324 nia 12552: <td>JAVA_BINPREFIX</td>
1.316 cirnatda 12553: <td>JAVA_CLASSPATH</td>
1.269 leot 12554: </tr>
12555: <tr>
1.324 nia 12556: <td>JAVA_HOME</td>
1.316 cirnatda 12557: <td>JAVA_LD_LIBRARY_PATH</td>
1.269 leot 12558: </tr>
12559: <tr>
1.324 nia 12560: <td>JAVA_NAME</td>
1.316 cirnatda 12561: <td>JAVA_UNLIMIT</td>
1.269 leot 12562: </tr>
12563: <tr>
1.324 nia 12564: <td>JAVA_WRAPPERS</td>
1.316 cirnatda 12565: <td>JPEG_ACCEPTED</td>
1.269 leot 12566: </tr>
12567: <tr>
1.324 nia 12568: <td>JPEG_DEFAULT</td>
1.316 cirnatda 12569: <td>KERBEROS</td>
1.269 leot 12570: </tr>
12571: <tr>
1.324 nia 12572: <td>KERMIT_SUID_UUCP</td>
1.316 cirnatda 12573: <td>KJS_USE_PCRE</td>
1.292 leot 12574: </tr>
12575: <tr>
1.324 nia 12576: <td>KNEWS_DOMAIN_FILE</td>
1.316 cirnatda 12577: <td>KNEWS_DOMAIN_NAME</td>
1.271 brook 12578: </tr>
12579: <tr>
1.324 nia 12580: <td>KRB5_ACCEPTED</td>
1.316 cirnatda 12581: <td>KRB5_DEFAULT</td>
1.269 leot 12582: </tr>
12583: <tr>
1.324 nia 12584: <td>LANGUAGES</td>
1.320 wiz 12585: <td>LAPACKE_LIBS</td>
1.269 leot 12586: </tr>
12587: <tr>
1.324 nia 12588: <td>LAPACK_LIBS</td>
1.320 wiz 12589: <td>LATEX2HTML_ICONPATH</td>
1.269 leot 12590: </tr>
12591: <tr>
1.324 nia 12592: <td>LDCONFIG_ADD_CMD</td>
1.320 wiz 12593: <td>LDCONFIG_REMOVE_CMD</td>
1.269 leot 12594: </tr>
12595: <tr>
1.327 wiz 12596: <td>LDD</td>
1.324 nia 12597: <td>LEAFNODE_DATA_DIR</td>
1.320 wiz 12598: </tr>
12599: <tr>
1.327 wiz 12600: <td>LEAFNODE_GROUP</td>
1.324 nia 12601: <td>LEAFNODE_USER</td>
1.270 leot 12602: </tr>
12603: <tr>
1.327 wiz 12604: <td>LIBDVDCSS_HOMEPAGE</td>
1.324 nia 12605: <td>LIBDVDCSS_MASTER_SITES</td>
1.327 wiz 12606: </tr>
12607: <tr>
1.313 leot 12608: <td>LIBRSVG_TYPE</td>
1.327 wiz 12609: <td>LIBTOOL</td>
1.269 leot 12610: </tr>
12611: <tr>
1.313 leot 12612: <td>LIBTOOLIZE_PLIST</td>
1.327 wiz 12613: <td>LIBTOOL_M4_OVERRIDE</td>
1.292 leot 12614: </tr>
12615: <tr>
1.313 leot 12616: <td>LIBUSB_TYPE</td>
1.327 wiz 12617: <td>LICENSE</td>
1.269 leot 12618: </tr>
12619: <tr>
1.313 leot 12620: <td>LINKER_RPATH_FLAG</td>
1.327 wiz 12621: <td>LINK_RPATH_FLAG</td>
1.311 leot 12622: </tr>
12623: <tr>
1.325 gutterid 12624: <td>LINUX_LOCALES</td>
1.328 ! jnemeth 12625: <td>LOCALBASE</td>
1.269 leot 12626: </tr>
12627: <tr>
1.325 gutterid 12628: <td>LOCALBASE_LOCKTYPE</td>
1.328 ! jnemeth 12629: <td>LOCALPATCHES</td>
1.269 leot 12630: </tr>
12631: <tr>
1.325 gutterid 12632: <td>LOVE_DATA</td>
1.328 ! jnemeth 12633: <td>LOVE_GAME</td>
1.269 leot 12634: </tr>
12635: <tr>
1.325 gutterid 12636: <td>LOVE_VERSION</td>
1.328 ! jnemeth 12637: <td>LP32PLATFORMS</td>
1.269 leot 12638: </tr>
12639: <tr>
1.325 gutterid 12640: <td>LP64PLATFORMS</td>
1.328 ! jnemeth 12641: <td>MACHINE_PLATFORM</td>
1.320 wiz 12642: </tr>
12643: <tr>
1.325 gutterid 12644: <td>MAILAGENT_DOMAIN</td>
1.328 ! jnemeth 12645: <td>MAILAGENT_EMAIL</td>
1.269 leot 12646: </tr>
12647: <tr>
1.325 gutterid 12648: <td>MAILAGENT_FQDN</td>
1.328 ! jnemeth 12649: <td>MAILAGENT_ORGANIZATION</td>
1.269 leot 12650: </tr>
12651: <tr>
1.324 nia 12652: <td>MAJORDOMO_HOMEDIR</td>
12653: <td>MAKEINFO_ARGS</td>
1.327 wiz 12654: </tr>
12655: <tr>
1.316 cirnatda 12656: <td>MAKE_DIRS</td>
1.327 wiz 12657: <td>MAKE_DIRS_PERMS</td>
1.269 leot 12658: </tr>
12659: <tr>
1.316 cirnatda 12660: <td>MAKE_ENV</td>
1.327 wiz 12661: <td>MAKE_FILE</td>
1.269 leot 12662: </tr>
12663: <tr>
1.316 cirnatda 12664: <td>MAKE_FLAGS</td>
1.327 wiz 12665: <td>MAKE_JOBS</td>
1.269 leot 12666: </tr>
12667: <tr>
1.316 cirnatda 12668: <td>MAKE_JOBS_SAFE</td>
1.327 wiz 12669: <td>MAKE_PROGRAM</td>
1.303 bacon 12670: </tr>
12671: <tr>
1.316 cirnatda 12672: <td>MANCOMPRESSED_IF_MANZ</td>
1.327 wiz 12673: <td>MANINSTALL</td>
1.269 leot 12674: </tr>
12675: <tr>
1.316 cirnatda 12676: <td>MANZ</td>
1.327 wiz 12677: <td>MASTER_SITES</td>
1.269 leot 12678: </tr>
12679: <tr>
1.316 cirnatda 12680: <td>MASTER_SITE_BACKUP</td>
1.327 wiz 12681: <td>MASTER_SITE_LOCAL</td>
1.269 leot 12682: </tr>
12683: <tr>
1.316 cirnatda 12684: <td>MASTER_SITE_MOZILLA</td>
1.327 wiz 12685: <td>MASTER_SITE_OVERRIDE</td>
1.269 leot 12686: </tr>
12687: <tr>
1.316 cirnatda 12688: <td>MASTER_SITE_PERL_CPAN</td>
1.327 wiz 12689: <td>MASTER_SORT</td>
1.269 leot 12690: </tr>
12691: <tr>
1.316 cirnatda 12692: <td>MASTER_SORT_RANDOM</td>
1.327 wiz 12693: <td>MASTER_SORT_REGEX</td>
1.269 leot 12694: </tr>
12695: <tr>
1.316 cirnatda 12696: <td>MECAB_CHARSET</td>
1.327 wiz 12697: <td>MEDIATOMB_GROUP</td>
1.269 leot 12698: </tr>
12699: <tr>
1.316 cirnatda 12700: <td>MEDIATOMB_USER</td>
1.327 wiz 12701: <td>MIPSPROBASE</td>
1.269 leot 12702: </tr>
12703: <tr>
1.316 cirnatda 12704: <td>MIREDO_GROUP</td>
1.327 wiz 12705: <td>MIREDO_USER</td>
1.269 leot 12706: </tr>
12707: <tr>
1.316 cirnatda 12708: <td>MISSING_FEATURES</td>
1.327 wiz 12709: <td>MKDIR</td>
1.269 leot 12710: </tr>
12711: <tr>
1.322 leot 12712: <td>MKPIE_SUPPORTED</td>
1.327 wiz 12713: <td>MLDONKEY_GROUP</td>
1.322 leot 12714: </tr>
12715: <tr>
1.313 leot 12716: <td>MLDONKEY_HOME</td>
1.327 wiz 12717: <td>MLDONKEY_USER</td>
1.269 leot 12718: </tr>
12719: <tr>
1.313 leot 12720: <td>MONOTONE_GROUP</td>
1.327 wiz 12721: <td>MONOTONE_USER</td>
1.269 leot 12722: </tr>
12723: <tr>
1.313 leot 12724: <td>MOTIFBASE</td>
1.327 wiz 12725: <td>MOTIF_TYPE</td>
1.269 leot 12726: </tr>
12727: <tr>
1.313 leot 12728: <td>MOTIF_TYPE_DEFAULT</td>
1.327 wiz 12729: <td>MPI_TYPE</td>
1.269 leot 12730: </tr>
12731: <tr>
1.313 leot 12732: <td>MSGFMT_STRIP_MSGCTXT</td>
1.327 wiz 12733: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.311 leot 12734: </tr>
12735: <tr>
1.313 leot 12736: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.328 ! jnemeth 12737: <td>MV</td>
1.269 leot 12738: </tr>
12739: <tr>
1.325 gutterid 12740: <td>MYSQL_CHARSET</td>
1.328 ! jnemeth 12741: <td>MYSQL_DATADIR</td>
1.320 wiz 12742: </tr>
12743: <tr>
1.325 gutterid 12744: <td>MYSQL_EXTRA_CHARSET</td>
1.328 ! jnemeth 12745: <td>MYSQL_GROUP</td>
1.269 leot 12746: </tr>
12747: <tr>
1.325 gutterid 12748: <td>MYSQL_USER</td>
1.328 ! jnemeth 12749: <td>MYSQL_VERSION</td>
1.269 leot 12750: </tr>
12751: <tr>
1.325 gutterid 12752: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.328 ! jnemeth 12753: <td>MYSQL_VERSIONS_ALL</td>
1.269 leot 12754: </tr>
12755: <tr>
1.325 gutterid 12756: <td>MYSQL_VERSION_DEFAULT</td>
1.328 ! jnemeth 12757: <td>NAGIOSCMD_GROUP</td>
1.309 gutterid 12758: </tr>
12759: <tr>
1.325 gutterid 12760: <td>NAGIOSDIR</td>
1.328 ! jnemeth 12761: <td>NAGIOS_GROUP</td>
1.269 leot 12762: </tr>
12763: <tr>
1.325 gutterid 12764: <td>NAGIOS_USER</td>
1.328 ! jnemeth 12765: <td>NATIVE_APPEND_ABI</td>
1.269 leot 12766: </tr>
12767: <tr>
1.325 gutterid 12768: <td>NATIVE_APPEND_ELF</td>
1.328 ! jnemeth 12769: <td>NATIVE_EXEC_FMT</td>
1.269 leot 12770: </tr>
12771: <tr>
1.325 gutterid 12772: <td>NATIVE_MACHINE_PLATFORM</td>
1.328 ! jnemeth 12773: <td>NATIVE_OBJECT_FMT</td>
1.269 leot 12774: </tr>
12775: <tr>
1.325 gutterid 12776: <td>NBPAX_PROGRAM_PREFIX</td>
1.328 ! jnemeth 12777: <td>NETBSD_LOGIN_NAME</td>
1.269 leot 12778: </tr>
12779: <tr>
1.325 gutterid 12780: <td>NMH_EDITOR</td>
1.328 ! jnemeth 12781: <td>NMH_MTA</td>
1.269 leot 12782: </tr>
12783: <tr>
1.325 gutterid 12784: <td>NMH_PAGER</td>
1.328 ! jnemeth 12785: <td>NOLOGIN</td>
1.293 rillig 12786: </tr>
12787: <tr>
1.325 gutterid 12788: <td>NOTE</td>
1.328 ! jnemeth 12789: <td>NOT_FOR_PLATFORM</td>
1.269 leot 12790: </tr>
12791: <tr>
1.325 gutterid 12792: <td>NOT_PAX_ASLR_SAFE</td>
1.328 ! jnemeth 12793: <td>NOT_PAX_MPROTECT_SAFE</td>
1.269 leot 12794: </tr>
12795: <tr>
1.325 gutterid 12796: <td>NO_BUILD</td>
1.328 ! jnemeth 12797: <td>NO_CHECKSUM</td>
1.269 leot 12798: </tr>
12799: <tr>
1.325 gutterid 12800: <td>NO_CONFIGURE</td>
1.328 ! jnemeth 12801: <td>NO_SKIP</td>
1.269 leot 12802: </tr>
12803: <tr>
1.325 gutterid 12804: <td>NS_PREFERRED</td>
1.328 ! jnemeth 12805: <td>NULLMAILER_GROUP</td>
1.269 leot 12806: </tr>
12807: <tr>
1.325 gutterid 12808: <td>NULLMAILER_USER</td>
1.328 ! jnemeth 12809: <td>OASIS</td>
1.269 leot 12810: </tr>
12811: <tr>
1.325 gutterid 12812: <td>OASIS_BUILD_ARGS</td>
1.328 ! jnemeth 12813: <td>OBJHOSTNAME</td>
1.269 leot 12814: </tr>
12815: <tr>
1.325 gutterid 12816: <td>OBJMACHINE</td>
1.328 ! jnemeth 12817: <td>OCAML_FINDLIB_DIRS</td>
1.269 leot 12818: </tr>
12819: <tr>
1.325 gutterid 12820: <td>OCAML_FINDLIB_REGISTER</td>
1.328 ! jnemeth 12821: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.269 leot 12822: </tr>
12823: <tr>
1.325 gutterid 12824: <td>OCAML_SITELIBDIR</td>
1.328 ! jnemeth 12825: <td>OCAML_TOPKG_DOCDIR</td>
1.269 leot 12826: </tr>
12827: <tr>
1.325 gutterid 12828: <td>OCAML_USE_DUNE</td>
1.328 ! jnemeth 12829: <td>OCAML_USE_FINDLIB</td>
1.269 leot 12830: </tr>
12831: <tr>
1.325 gutterid 12832: <td>OCAML_USE_JBUILDER</td>
1.328 ! jnemeth 12833: <td>OCAML_USE_OASIS</td>
1.269 leot 12834: </tr>
12835: <tr>
1.325 gutterid 12836: <td>OCAML_USE_OASIS_DYNRUN</td>
1.328 ! jnemeth 12837: <td>OCAML_USE_OPAM</td>
1.269 leot 12838: </tr>
12839: <tr>
1.325 gutterid 12840: <td>OCAML_USE_OPT_COMPILER</td>
1.328 ! jnemeth 12841: <td>OCAML_USE_TOPKG</td>
1.269 leot 12842: </tr>
12843: <tr>
1.325 gutterid 12844: <td>OMF</td>
1.328 ! jnemeth 12845: <td>ONLY_FOR_COMPILER</td>
1.269 leot 12846: </tr>
12847: <tr>
1.325 gutterid 12848: <td>ONLY_FOR_PLATFORM</td>
1.328 ! jnemeth 12849: <td>OPENSSH_CHROOT</td>
1.269 leot 12850: </tr>
12851: <tr>
1.325 gutterid 12852: <td>OPENSSH_GROUP</td>
1.328 ! jnemeth 12853: <td>OPENSSH_USER</td>
1.269 leot 12854: </tr>
12855: <tr>
1.325 gutterid 12856: <td>OPSYS</td>
1.328 ! jnemeth 12857: <td>OPSYS_EMULDIR</td>
1.269 leot 12858: </tr>
12859: <tr>
1.327 wiz 12860: <td>OPSYS_VERSION</td>
1.328 ! jnemeth 12861: <td>OS</td>
1.327 wiz 12862: </tr>
12863: <tr>
12864: <td>OSS_TYPE</td>
1.328 ! jnemeth 12865: <td>OSX</td>
1.269 leot 12866: </tr>
12867: <tr>
1.327 wiz 12868: <td>OSX_TOLERATE_SDK_SKEW</td>
1.328 ! jnemeth 12869: <td>OS_VARIANT</td>
1.327 wiz 12870: </tr>
12871: <tr>
12872: <td>OS_VERSION</td>
1.328 ! jnemeth 12873: <td>OTF_FONTS_DIR</td>
1.320 wiz 12874: </tr>
12875: <tr>
1.327 wiz 12876: <td>OVERRIDE_DIRDEPTH</td>
1.328 ! jnemeth 12877: <td>OVERRIDE_GEMSPEC</td>
1.311 leot 12878: </tr>
12879: <tr>
1.327 wiz 12880: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.313 leot 12881: <td>OWN_DIRS</td>
1.269 leot 12882: </tr>
12883: <tr>
1.324 nia 12884: <td>OWN_DIRS_PERMS</td>
1.313 leot 12885: <td>P4GROUP</td>
1.269 leot 12886: </tr>
12887: <tr>
1.324 nia 12888: <td>P4PORT</td>
1.313 leot 12889: <td>P4ROOT</td>
1.269 leot 12890: </tr>
12891: <tr>
1.324 nia 12892: <td>P4USER</td>
1.313 leot 12893: <td>PACKAGES</td>
1.269 leot 12894: </tr>
12895: <tr>
1.324 nia 12896: <td>PALMOS_DEFAULT_SDK</td>
1.313 leot 12897: <td>PAMBASE</td>
1.269 leot 12898: </tr>
12899: <tr>
1.324 nia 12900: <td>PAM_DEFAULT</td>
1.313 leot 12901: <td>PAPERSIZE</td>
1.269 leot 12902: </tr>
12903: <tr>
1.324 nia 12904: <td>PASSIVE_FETCH</td>
1.313 leot 12905: <td>PATCHDIR</td>
1.324 nia 12906: </tr>
12907: <tr>
1.322 leot 12908: <td>PATCHFILES</td>
1.324 nia 12909: <td>PATCH_ARGS</td>
1.269 leot 12910: </tr>
12911: <tr>
1.322 leot 12912: <td>PATCH_DEBUG</td>
1.324 nia 12913: <td>PATCH_DIST_ARGS</td>
1.269 leot 12914: </tr>
12915: <tr>
1.322 leot 12916: <td>PATCH_DIST_CAT</td>
1.324 nia 12917: <td>PATCH_DIST_STRIP</td>
1.284 rillig 12918: </tr>
12919: <tr>
1.322 leot 12920: <td>PATCH_FUZZ_FACTOR</td>
1.324 nia 12921: <td>PATCH_STRIP</td>
1.269 leot 12922: </tr>
12923: <tr>
1.322 leot 12924: <td>PATH</td>
1.324 nia 12925: <td>PCCBASE</td>
1.316 cirnatda 12926: </tr>
12927: <tr>
1.322 leot 12928: <td>PEAR_CMD</td>
1.324 nia 12929: <td>PEAR_LIB</td>
1.320 wiz 12930: </tr>
12931: <tr>
1.322 leot 12932: <td>PEAR_PACKAGE_XML</td>
1.324 nia 12933: <td>PERL5</td>
1.292 leot 12934: </tr>
12935: <tr>
1.322 leot 12936: <td>PERL5_CONFIGURE</td>
1.324 nia 12937: <td>PERL5_CONFIGURE_DIRS</td>
1.274 rillig 12938: </tr>
12939: <tr>
1.322 leot 12940: <td>PERL5_LDFLAGS</td>
1.324 nia 12941: <td>PERL5_LICENSE</td>
1.274 rillig 12942: </tr>
12943: <tr>
1.322 leot 12944: <td>PERL5_MODULE_TYPE</td>
1.324 nia 12945: <td>PERL5_PACKLIST</td>
1.269 leot 12946: </tr>
12947: <tr>
1.322 leot 12948: <td>PERL5_PACKLIST_DIR</td>
1.324 nia 12949: <td>PERL5_PERLBASE</td>
1.269 leot 12950: </tr>
12951: <tr>
1.322 leot 12952: <td>PERL5_SITEBASE</td>
1.324 nia 12953: <td>PERL5_USE_PACKLIST</td>
1.269 leot 12954: </tr>
12955: <tr>
1.322 leot 12956: <td>PERL5_VENDORBASE</td>
1.324 nia 12957: <td>PFCTL</td>
1.269 leot 12958: </tr>
12959: <tr>
1.322 leot 12960: <td>PFVAR_H</td>
1.324 nia 12961: <td>PF_VERSION</td>
1.269 leot 12962: </tr>
12963: <tr>
1.322 leot 12964: <td>PGGROUP</td>
1.324 nia 12965: <td>PGHOME</td>
1.269 leot 12966: </tr>
12967: <tr>
1.322 leot 12968: <td>PGPKGSRCDIR</td>
1.324 nia 12969: <td>PGSQL_TYPE</td>
1.269 leot 12970: </tr>
12971: <tr>
1.322 leot 12972: <td>PGSQL_VERSION</td>
1.324 nia 12973: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.269 leot 12974: </tr>
12975: <tr>
1.322 leot 12976: <td>PGSQL_VERSION_DEFAULT</td>
1.324 nia 12977: <td>PGUSER</td>
1.269 leot 12978: </tr>
12979: <tr>
1.322 leot 12980: <td>PG_LIB_EXT</td>
1.324 nia 12981: <td>PHP</td>
1.269 leot 12982: </tr>
12983: <tr>
1.322 leot 12984: <td>PHPCOMMON_MK</td>
1.324 nia 12985: <td>PHPPKGSRCDIR</td>
1.269 leot 12986: </tr>
12987: <tr>
1.322 leot 12988: <td>PHP_BASE_VERS</td>
1.324 nia 12989: <td>PHP_CHECK_INSTALLED</td>
1.269 leot 12990: </tr>
12991: <tr>
1.322 leot 12992: <td>PHP_EXTENSION_DIR</td>
1.324 nia 12993: <td>PHP_INITIAL_TEENY</td>
1.269 leot 12994: </tr>
12995: <tr>
1.322 leot 12996: <td>PHP_PKG_PREFIX</td>
1.324 nia 12997: <td>PHP_VERSION</td>
1.269 leot 12998: </tr>
12999: <tr>
1.322 leot 13000: <td>PHP_VERSIONS_ACCEPTED</td>
1.324 nia 13001: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.269 leot 13002: </tr>
13003: <tr>
1.322 leot 13004: <td>PHP_VERSION_DEFAULT</td>
1.324 nia 13005: <td>PHP_VERSION_REQD</td>
1.269 leot 13006: </tr>
13007: <tr>
1.322 leot 13008: <td>PILRC_USE_GTK</td>
1.324 nia 13009: <td>PKGCONFIG_BASE</td>
1.269 leot 13010: </tr>
13011: <tr>
1.322 leot 13012: <td>PKGCONFIG_FILE</td>
1.324 nia 13013: <td>PKGCONFIG_OVERRIDE</td>
1.269 leot 13014: </tr>
13015: <tr>
1.322 leot 13016: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.324 nia 13017: <td>PKGDIR</td>
1.269 leot 13018: </tr>
13019: <tr>
1.322 leot 13020: <td>PKGGNUDIR</td>
1.324 nia 13021: <td>PKGINFODIR</td>
1.269 leot 13022: </tr>
13023: <tr>
1.322 leot 13024: <td>PKGLOCALEDIR</td>
1.324 nia 13025: <td>PKGMANDIR</td>
1.269 leot 13026: </tr>
13027: <tr>
1.322 leot 13028: <td>PKGNAME</td>
1.324 nia 13029: <td>PKGNAME_REQD</td>
1.269 leot 13030: </tr>
13031: <tr>
1.322 leot 13032: <td>PKGPATH</td>
1.324 nia 13033: <td>PKGREVISION</td>
1.269 leot 13034: </tr>
13035: <tr>
1.322 leot 13036: <td>PKGSRC_BLAS_TYPES</td>
1.324 nia 13037: <td>PKGSRC_CHANGES</td>
1.269 leot 13038: </tr>
13039: <tr>
1.322 leot 13040: <td>PKGSRC_COMPILER</td>
1.324 nia 13041: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.292 leot 13042: </tr>
13043: <tr>
1.322 leot 13044: <td>PKGSRC_LOCKTYPE</td>
1.324 nia 13045: <td>PKGSRC_MAKE_ENV</td>
1.269 leot 13046: </tr>
13047: <tr>
1.322 leot 13048: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.324 nia 13049: <td>PKGSRC_MKPIE</td>
1.274 rillig 13050: </tr>
13051: <tr>
1.322 leot 13052: <td>PKGSRC_MKREPRO</td>
1.324 nia 13053: <td>PKGSRC_RUN_TEST</td>
1.269 leot 13054: </tr>
13055: <tr>
1.322 leot 13056: <td>PKGSRC_SETENV</td>
1.324 nia 13057: <td>PKGSRC_SLEEPSECS</td>
1.269 leot 13058: </tr>
13059: <tr>
1.322 leot 13060: <td>PKGSRC_TODO</td>
1.324 nia 13061: <td>PKGSRC_USE_CTF</td>
1.269 leot 13062: </tr>
13063: <tr>
1.322 leot 13064: <td>PKGSRC_USE_FORTIFY</td>
1.324 nia 13065: <td>PKGSRC_USE_RELRO</td>
1.269 leot 13066: </tr>
13067: <tr>
1.322 leot 13068: <td>PKGSRC_USE_SSP</td>
1.324 nia 13069: <td>PKGSRC_USE_STACK_CHECK</td>
1.269 leot 13070: </tr>
13071: <tr>
1.322 leot 13072: <td>PKGTASKS_DATAFILE</td>
1.324 nia 13073: <td>PKGTOOLS_ARGS</td>
1.269 leot 13074: </tr>
13075: <tr>
1.322 leot 13076: <td>PKGTOOLS_ENV</td>
1.324 nia 13077: <td>PKG_ALTERNATIVES</td>
1.269 leot 13078: </tr>
13079: <tr>
1.322 leot 13080: <td>PKG_APACHE</td>
1.324 nia 13081: <td>PKG_APACHE_ACCEPTED</td>
1.269 leot 13082: </tr>
13083: <tr>
1.322 leot 13084: <td>PKG_APACHE_DEFAULT</td>
1.324 nia 13085: <td>PKG_BEST_EXISTS</td>
1.269 leot 13086: </tr>
13087: <tr>
1.322 leot 13088: <td>PKG_BUILD_OPTIONS</td>
1.324 nia 13089: <td>PKG_COMPRESSION</td>
1.269 leot 13090: </tr>
13091: <tr>
1.322 leot 13092: <td>PKG_CONFIG</td>
1.324 nia 13093: <td>PKG_CONFIG_PERMS</td>
1.269 leot 13094: </tr>
13095: <tr>
1.322 leot 13096: <td>PKG_CREATE_USERGROUP</td>
1.324 nia 13097: <td>PKG_DB_TMPDIR</td>
1.269 leot 13098: </tr>
13099: <tr>
1.322 leot 13100: <td>PKG_DEBUG_LEVEL</td>
1.324 nia 13101: <td>PKG_DEFAULT_OPTIONS</td>
1.269 leot 13102: </tr>
13103: <tr>
1.322 leot 13104: <td>PKG_DESTDIR_SUPPORT</td>
1.324 nia 13105: <td>PKG_DEVELOPER</td>
1.269 leot 13106: </tr>
13107: <tr>
1.322 leot 13108: <td>PKG_DISABLED_OPTIONS</td>
1.324 nia 13109: <td>PKG_FATAL_ERRORS</td>
1.269 leot 13110: </tr>
13111: <tr>
1.322 leot 13112: <td>PKG_FC</td>
1.324 nia 13113: <td>PKG_FILELIST_CMD</td>
1.269 leot 13114: </tr>
13115: <tr>
1.322 leot 13116: <td>PKG_GECOS</td>
1.324 nia 13117: <td>PKG_GID</td>
1.269 leot 13118: </tr>
13119: <tr>
1.322 leot 13120: <td>PKG_GROUPS</td>
1.324 nia 13121: <td>PKG_GROUPS_VARS</td>
1.269 leot 13122: </tr>
13123: <tr>
1.322 leot 13124: <td>PKG_HOME</td>
1.324 nia 13125: <td>PKG_INIT_SCRIPTS</td>
1.269 leot 13126: </tr>
13127: <tr>
1.322 leot 13128: <td>PKG_JAVA_HOME</td>
1.324 nia 13129: <td>PKG_JVM</td>
1.269 leot 13130: </tr>
13131: <tr>
1.322 leot 13132: <td>PKG_JVMS_ACCEPTED</td>
1.324 nia 13133: <td>PKG_JVM_DEFAULT</td>
1.269 leot 13134: </tr>
13135: <tr>
1.322 leot 13136: <td>PKG_LEGACY_OPTIONS</td>
1.324 nia 13137: <td>PKG_LIBTOOL</td>
1.269 leot 13138: </tr>
13139: <tr>
1.322 leot 13140: <td>PKG_OPTIONS</td>
1.324 nia 13141: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.269 leot 13142: </tr>
13143: <tr>
1.322 leot 13144: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.324 nia 13145: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.269 leot 13146: </tr>
13147: <tr>
1.322 leot 13148: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.324 nia 13149: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.269 leot 13150: </tr>
13151: <tr>
1.322 leot 13152: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.324 nia 13153: <td>PKG_OPTIONS_VAR</td>
1.269 leot 13154: </tr>
13155: <tr>
1.322 leot 13156: <td>PKG_PHP</td>
1.324 nia 13157: <td>PKG_PHP_MAJOR_VERS</td>
1.269 leot 13158: </tr>
13159: <tr>
1.322 leot 13160: <td>PKG_PHP_VERSION</td>
1.324 nia 13161: <td>PKG_RCD_SCRIPTS</td>
1.269 leot 13162: </tr>
13163: <tr>
1.322 leot 13164: <td>PKG_REFCOUNT_DBDIR</td>
1.324 nia 13165: <td>PKG_REGISTER_SHELLS</td>
1.269 leot 13166: </tr>
13167: <tr>
1.322 leot 13168: <td>PKG_RESUME_TRANSFERS</td>
1.324 nia 13169: <td>PKG_SHELL</td>
1.269 leot 13170: </tr>
13171: <tr>
1.322 leot 13172: <td>PKG_SUGGESTED_OPTIONS</td>
1.324 nia 13173: <td>PKG_SUPPORTED_OPTIONS</td>
1.269 leot 13174: </tr>
13175: <tr>
1.322 leot 13176: <td>PKG_SYSCONFBASE</td>
1.324 nia 13177: <td>PKG_SYSCONFBASEDIR</td>
1.269 leot 13178: </tr>
13179: <tr>
1.322 leot 13180: <td>PKG_SYSCONFDIR</td>
1.324 nia 13181: <td>PKG_SYSCONFDIR_PERMS</td>
1.269 leot 13182: </tr>
13183: <tr>
1.322 leot 13184: <td>PKG_SYSCONFSUBDIR</td>
1.324 nia 13185: <td>PKG_SYSCONFVAR</td>
1.269 leot 13186: </tr>
13187: <tr>
1.322 leot 13188: <td>PKG_TOOLS_BIN</td>
1.324 nia 13189: <td>PKG_UID</td>
1.269 leot 13190: </tr>
13191: <tr>
1.322 leot 13192: <td>PKG_UPDATE_FONTS_DB</td>
1.324 nia 13193: <td>PKG_USERS</td>
1.269 leot 13194: </tr>
13195: <tr>
1.322 leot 13196: <td>PKG_USERS_VARS</td>
1.324 nia 13197: <td>PKG_VERBOSE</td>
1.269 leot 13198: </tr>
13199: <tr>
1.322 leot 13200: <td>PLEASE</td>
1.324 nia 13201: <td>PLIST</td>
1.269 leot 13202: </tr>
13203: <tr>
1.322 leot 13204: <td>PLIST_AWK</td>
1.324 nia 13205: <td>PLIST_AWK_ENV</td>
1.269 leot 13206: </tr>
13207: <tr>
1.322 leot 13208: <td>PLIST_SRC</td>
1.324 nia 13209: <td>PLIST_SUBST</td>
1.269 leot 13210: </tr>
13211: <tr>
1.322 leot 13212: <td>PLIST_TYPE</td>
1.324 nia 13213: <td>PLIST_VARS</td>
1.269 leot 13214: </tr>
13215: <tr>
1.322 leot 13216: <td>POPTOP_USE_MPPE</td>
1.324 nia 13217: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.269 leot 13218: </tr>
13219: <tr>
1.322 leot 13220: <td>POST_FETCH_HOOK</td>
1.324 nia 13221: <td>PREFER</td>
1.269 leot 13222: </tr>
13223: <tr>
1.322 leot 13224: <td>PREFER_NATIVE</td>
1.324 nia 13225: <td>PREFER_NATIVE_PTHREADS</td>
1.269 leot 13226: </tr>
13227: <tr>
1.322 leot 13228: <td>PREFER_PKGSRC</td>
1.324 nia 13229: <td>PREFIX</td>
1.269 leot 13230: </tr>
13231: <tr>
1.322 leot 13232: <td>PREPEND_PATH</td>
1.324 nia 13233: <td>PRE_ROOT_CMD</td>
1.269 leot 13234: </tr>
13235: <tr>
1.322 leot 13236: <td>PRIVILEGED_STAGES</td>
1.324 nia 13237: <td>PS</td>
1.269 leot 13238: </tr>
13239: <tr>
1.322 leot 13240: <td>PTHREAD_AUTO_VARS</td>
1.324 nia 13241: <td>PTHREAD_CFLAGS</td>
1.269 leot 13242: </tr>
13243: <tr>
1.322 leot 13244: <td>PTHREAD_LDFLAGS</td>
1.324 nia 13245: <td>PTHREAD_LIBS</td>
1.269 leot 13246: </tr>
13247: <tr>
1.322 leot 13248: <td>PTHREAD_OPTS</td>
1.324 nia 13249: <td>PTHREAD_TYPE</td>
1.269 leot 13250: </tr>
13251: <tr>
1.322 leot 13252: <td>PVM_SSH</td>
1.324 nia 13253: <td>PYPKGPREFIX</td>
1.269 leot 13254: </tr>
13255: <tr>
1.322 leot 13256: <td>PYTHON_FOR_BUILD_ONLY</td>
1.324 nia 13257: <td>PYTHON_SELF_CONFLICT</td>
1.269 leot 13258: </tr>
13259: <tr>
1.322 leot 13260: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.324 nia 13261: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.269 leot 13262: </tr>
13263: <tr>
1.322 leot 13264: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.324 nia 13265: <td>PYTHON_VERSION_DEFAULT</td>
1.269 leot 13266: </tr>
13267: <tr>
1.322 leot 13268: <td>PYTHON_VERSION_REQD</td>
1.324 nia 13269: <td>PYVERSSUFFIX</td>
1.269 leot 13270: </tr>
13271: <tr>
1.322 leot 13272: <td>PY_NO_EGG</td>
1.324 nia 13273: <td>QMAILDIR</td>
1.269 leot 13274: </tr>
13275: <tr>
1.322 leot 13276: <td>QMAIL_ALIAS_USER</td>
1.324 nia 13277: <td>QMAIL_DAEMON_USER</td>
1.269 leot 13278: </tr>
13279: <tr>
1.322 leot 13280: <td>QMAIL_LOG_USER</td>
1.324 nia 13281: <td>QMAIL_NOFILES_GROUP</td>
1.269 leot 13282: </tr>
13283: <tr>
1.322 leot 13284: <td>QMAIL_PASSWD_USER</td>
1.324 nia 13285: <td>QMAIL_QMAIL_GROUP</td>
1.269 leot 13286: </tr>
13287: <tr>
1.322 leot 13288: <td>QMAIL_QUEUE_DIR</td>
1.324 nia 13289: <td>QMAIL_QUEUE_EXTRA</td>
1.269 leot 13290: </tr>
13291: <tr>
1.322 leot 13292: <td>QMAIL_QUEUE_USER</td>
1.324 nia 13293: <td>QMAIL_REMOTE_USER</td>
1.269 leot 13294: </tr>
13295: <tr>
1.322 leot 13296: <td>QMAIL_ROOT_USER</td>
1.324 nia 13297: <td>QMAIL_SEND_USER</td>
1.269 leot 13298: </tr>
13299: <tr>
1.322 leot 13300: <td>QPOPPER_FAC</td>
1.324 nia 13301: <td>QPOPPER_SPOOL_DIR</td>
1.269 leot 13302: </tr>
13303: <tr>
1.322 leot 13304: <td>QPOPPER_USER</td>
1.324 nia 13305: <td>RAKE_NAME</td>
1.269 leot 13306: </tr>
13307: <tr>
1.322 leot 13308: <td>RASMOL_DEPTH</td>
1.324 nia 13309: <td>RCD_SCRIPTS</td>
1.320 wiz 13310: </tr>
13311: <tr>
1.322 leot 13312: <td>RCD_SCRIPTS_DIR</td>
1.324 nia 13313: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.292 leot 13314: </tr>
13315: <tr>
1.322 leot 13316: <td>RCD_SCRIPTS_MODE</td>
1.324 nia 13317: <td>RCD_SCRIPTS_SHELL</td>
1.269 leot 13318: </tr>
13319: <tr>
1.322 leot 13320: <td>RCD_SCRIPT_SRC</td>
1.328 ! jnemeth 13321: <td>RDOC</td>
1.327 wiz 13322: </tr>
13323: <tr>
13324: <td>READLINE_DEFAULT</td>
1.328 ! jnemeth 13325: <td>READLINE_TYPE</td>
1.269 leot 13326: </tr>
13327: <tr>
1.327 wiz 13328: <td>REAL_ROOT_GROUP</td>
1.328 ! jnemeth 13329: <td>REAL_ROOT_USER</td>
1.320 wiz 13330: </tr>
13331: <tr>
1.327 wiz 13332: <td>RECURSIVE_MAKE</td>
1.328 ! jnemeth 13333: <td>RELAY_CTRL_DIR</td>
1.311 leot 13334: </tr>
13335: <tr>
1.327 wiz 13336: <td>RELRO_SUPPORTED</td>
1.328 ! jnemeth 13337: <td>REPLACE_AWK</td>
1.269 leot 13338: </tr>
13339: <tr>
1.327 wiz 13340: <td>REPLACE_BASH</td>
1.328 ! jnemeth 13341: <td>REPLACE_CSH</td>
1.269 leot 13342: </tr>
13343: <tr>
1.327 wiz 13344: <td>REPLACE_KSH</td>
1.328 ! jnemeth 13345: <td>REPLACE_PERL</td>
1.269 leot 13346: </tr>
13347: <tr>
1.327 wiz 13348: <td>REPLACE_PERL6</td>
1.328 ! jnemeth 13349: <td>REPLACE_PHP</td>
1.269 leot 13350: </tr>
13351: <tr>
1.327 wiz 13352: <td>REPLACE_PYTHON</td>
1.328 ! jnemeth 13353: <td>REPLACE_R</td>
1.269 leot 13354: </tr>
13355: <tr>
1.327 wiz 13356: <td>REPLACE_RUBY</td>
1.328 ! jnemeth 13357: <td>REPLACE_RUBY_DIRS</td>
1.269 leot 13358: </tr>
13359: <tr>
1.327 wiz 13360: <td>REPLACE_RUBY_PAT</td>
1.328 ! jnemeth 13361: <td>REPLACE_SH</td>
1.269 leot 13362: </tr>
13363: <tr>
1.327 wiz 13364: <td>REPLACE_TEXLUA</td>
1.328 ! jnemeth 13365: <td>REQD_DIRS</td>
1.269 leot 13366: </tr>
13367: <tr>
1.327 wiz 13368: <td>REQD_DIRS_PERMS</td>
1.328 ! jnemeth 13369: <td>REQD_FILES</td>
1.281 leot 13370: </tr>
13371: <tr>
1.327 wiz 13372: <td>REQD_FILES_MODE</td>
1.328 ! jnemeth 13373: <td>REQD_FILES_PERMS</td>
1.269 leot 13374: </tr>
13375: <tr>
1.327 wiz 13376: <td>RESOLV_AUTO_VARS</td>
1.328 ! jnemeth 13377: <td>RESOLV_LDFLAGS</td>
1.269 leot 13378: </tr>
13379: <tr>
1.327 wiz 13380: <td>RESOLV_LIBS</td>
1.320 wiz 13381: <td>RM</td>
13382: </tr>
13383: <tr>
1.324 nia 13384: <td>ROOT_CMD</td>
1.328 ! jnemeth 13385: <td>ROOT_GROUP</td>
1.327 wiz 13386: </tr>
13387: <tr>
13388: <td>ROOT_USER</td>
1.328 ! jnemeth 13389: <td>RPCGEN</td>
1.269 leot 13390: </tr>
13391: <tr>
1.327 wiz 13392: <td>RPM</td>
1.328 ! jnemeth 13393: <td>RPM2PKG_PLIST</td>
1.311 leot 13394: </tr>
13395: <tr>
1.327 wiz 13396: <td>RPM2PKG_PREFIX</td>
1.328 ! jnemeth 13397: <td>RPM2PKG_STAGE</td>
1.269 leot 13398: </tr>
13399: <tr>
1.327 wiz 13400: <td>RPM2PKG_STRIP</td>
1.328 ! jnemeth 13401: <td>RPM2PKG_SUBPREFIX</td>
1.269 leot 13402: </tr>
13403: <tr>
1.327 wiz 13404: <td>RPMFILES</td>
1.328 ! jnemeth 13405: <td>RPMIGNOREPATH</td>
1.269 leot 13406: </tr>
13407: <tr>
1.327 wiz 13408: <td>RPM_DB_PREFIX</td>
1.328 ! jnemeth 13409: <td>RSSH_CVS_PATH</td>
1.269 leot 13410: </tr>
13411: <tr>
1.327 wiz 13412: <td>RSSH_RDIST_PATH</td>
1.328 ! jnemeth 13413: <td>RSSH_RSYNC_PATH</td>
1.269 leot 13414: </tr>
13415: <tr>
1.327 wiz 13416: <td>RSSH_SCP_PATH</td>
1.328 ! jnemeth 13417: <td>RSSH_SFTP_SERVER_PATH</td>
1.269 leot 13418: </tr>
13419: <tr>
1.327 wiz 13420: <td>RUBY</td>
1.328 ! jnemeth 13421: <td>RUBYGEM</td>
1.269 leot 13422: </tr>
13423: <tr>
1.327 wiz 13424: <td>RUBYGEM_NAME</td>
1.328 ! jnemeth 13425: <td>RUBYGEM_OPTIONS</td>
1.269 leot 13426: </tr>
13427: <tr>
1.327 wiz 13428: <td>RUBYGEM_VERBOSE</td>
1.328 ! jnemeth 13429: <td>RUBY_ABI_VERSION</td>
1.269 leot 13430: </tr>
13431: <tr>
1.327 wiz 13432: <td>RUBY_ARCH</td>
1.328 ! jnemeth 13433: <td>RUBY_ARCHINC</td>
1.269 leot 13434: </tr>
13435: <tr>
1.327 wiz 13436: <td>RUBY_ARCHLIB</td>
1.328 ! jnemeth 13437: <td>RUBY_BASE</td>
1.269 leot 13438: </tr>
13439: <tr>
1.327 wiz 13440: <td>RUBY_BASERIDIR</td>
1.328 ! jnemeth 13441: <td>RUBY_BUILD_DOCUMENT</td>
1.269 leot 13442: </tr>
13443: <tr>
1.327 wiz 13444: <td>RUBY_DLEXT</td>
1.328 ! jnemeth 13445: <td>RUBY_DOC</td>
1.269 leot 13446: </tr>
13447: <tr>
1.327 wiz 13448: <td>RUBY_DYNAMIC_DIRS</td>
1.328 ! jnemeth 13449: <td>RUBY_EG</td>
1.269 leot 13450: </tr>
13451: <tr>
1.327 wiz 13452: <td>RUBY_ENCODING_ARG</td>
1.328 ! jnemeth 13453: <td>RUBY_EXTCONF</td>
1.269 leot 13454: </tr>
13455: <tr>
1.327 wiz 13456: <td>RUBY_EXTCONF_CHECK</td>
1.328 ! jnemeth 13457: <td>RUBY_EXTCONF_DEBUG</td>
1.269 leot 13458: </tr>
13459: <tr>
1.327 wiz 13460: <td>RUBY_EXTCONF_MAKEFILE</td>
1.328 ! jnemeth 13461: <td>RUBY_GEM_BASE</td>
1.269 leot 13462: </tr>
13463: <tr>
1.327 wiz 13464: <td>RUBY_INC</td>
1.328 ! jnemeth 13465: <td>RUBY_LIB</td>
1.269 leot 13466: </tr>
13467: <tr>
1.327 wiz 13468: <td>RUBY_LIB_BASE</td>
1.328 ! jnemeth 13469: <td>RUBY_NAME</td>
1.269 leot 13470: </tr>
13471: <tr>
1.327 wiz 13472: <td>RUBY_NOVERSION</td>
1.328 ! jnemeth 13473: <td>RUBY_PKGPREFIX</td>
1.269 leot 13474: </tr>
13475: <tr>
1.327 wiz 13476: <td>RUBY_RAILS</td>
1.328 ! jnemeth 13477: <td>RUBY_RAILS52_VERSION</td>
1.269 leot 13478: </tr>
13479: <tr>
1.327 wiz 13480: <td>RUBY_RAILS60_VERSION</td>
1.328 ! jnemeth 13481: <td>RUBY_RAILS61_VERSION</td>
1.269 leot 13482: </tr>
13483: <tr>
1.328 ! jnemeth 13484: <td>RUBY_RAILS70_VERSION</td>
1.327 wiz 13485: <td>RUBY_RAILS_ACCEPTED</td>
1.269 leot 13486: </tr>
13487: <tr>
1.325 gutterid 13488: <td>RUBY_RAILS_DEFAULT</td>
1.327 wiz 13489: <td>RUBY_RAILS_REQD</td>
1.312 gdt 13490: </tr>
13491: <tr>
1.325 gutterid 13492: <td>RUBY_RAILS_STRICT_DEP</td>
1.327 wiz 13493: <td>RUBY_RIDIR</td>
1.289 leot 13494: </tr>
13495: <tr>
1.325 gutterid 13496: <td>RUBY_SETUP</td>
1.327 wiz 13497: <td>RUBY_SHLIB</td>
1.269 leot 13498: </tr>
13499: <tr>
1.325 gutterid 13500: <td>RUBY_SHLIBALIAS</td>
1.327 wiz 13501: <td>RUBY_SHLIBVER</td>
1.269 leot 13502: </tr>
13503: <tr>
1.325 gutterid 13504: <td>RUBY_SIMPLE_INSTALL</td>
1.327 wiz 13505: <td>RUBY_SITEARCHLIB</td>
1.269 leot 13506: </tr>
13507: <tr>
1.325 gutterid 13508: <td>RUBY_SITELIB</td>
1.327 wiz 13509: <td>RUBY_SITELIB_BASE</td>
1.269 leot 13510: </tr>
13511: <tr>
1.325 gutterid 13512: <td>RUBY_SITERIDIR</td>
1.327 wiz 13513: <td>RUBY_SLEXT</td>
1.269 leot 13514: </tr>
13515: <tr>
1.325 gutterid 13516: <td>RUBY_SRCDIR</td>
1.327 wiz 13517: <td>RUBY_STATICLIB</td>
1.269 leot 13518: </tr>
13519: <tr>
1.325 gutterid 13520: <td>RUBY_SUFFIX</td>
1.327 wiz 13521: <td>RUBY_SYSRIDIR</td>
1.269 leot 13522: </tr>
13523: <tr>
1.325 gutterid 13524: <td>RUBY_USE_PTHREAD</td>
1.327 wiz 13525: <td>RUBY_VENDORARCHLIB</td>
1.269 leot 13526: </tr>
13527: <tr>
1.325 gutterid 13528: <td>RUBY_VENDORLIB</td>
1.327 wiz 13529: <td>RUBY_VENDORLIB_BASE</td>
1.269 leot 13530: </tr>
13531: <tr>
1.325 gutterid 13532: <td>RUBY_VER</td>
1.327 wiz 13533: <td>RUBY_VERSION</td>
1.269 leot 13534: </tr>
13535: <tr>
1.325 gutterid 13536: <td>RUBY_VERSIONS_ACCEPTED</td>
1.327 wiz 13537: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.269 leot 13538: </tr>
13539: <tr>
1.325 gutterid 13540: <td>RUBY_VERSION_DEFAULT</td>
1.327 wiz 13541: <td>RUBY_VERSION_REQD</td>
1.269 leot 13542: </tr>
13543: <tr>
1.325 gutterid 13544: <td>RUBY_VER_DIR</td>
1.327 wiz 13545: <td>RUN</td>
1.269 leot 13546: </tr>
13547: <tr>
1.325 gutterid 13548: <td>RUN_LDCONFIG</td>
1.327 wiz 13549: <td>SAWFISH_THEMES</td>
1.269 leot 13550: </tr>
13551: <tr>
1.325 gutterid 13552: <td>SCO</td>
1.327 wiz 13553: <td>SCREWS_GROUP</td>
1.269 leot 13554: </tr>
13555: <tr>
1.325 gutterid 13556: <td>SCREWS_USER</td>
1.327 wiz 13557: <td>SCRIPTS_ENV</td>
1.269 leot 13558: </tr>
13559: <tr>
1.325 gutterid 13560: <td>SCROLLKEEPER_DATADIR</td>
1.327 wiz 13561: <td>SCROLLKEEPER_REBUILDDB</td>
1.269 leot 13562: </tr>
13563: <tr>
1.325 gutterid 13564: <td>SCROLLKEEPER_UPDATEDB</td>
1.327 wiz 13565: <td>SDIST_PAWD</td>
1.269 leot 13566: </tr>
13567: <tr>
1.325 gutterid 13568: <td>SERIAL_DEVICES</td>
1.327 wiz 13569: <td>SETGIDGAME</td>
1.269 leot 13570: </tr>
13571: <tr>
1.325 gutterid 13572: <td>SETGID_GAMES_PERMS</td>
1.327 wiz 13573: <td>SETUID_ROOT_PERMS</td>
1.269 leot 13574: </tr>
13575: <tr>
1.325 gutterid 13576: <td>SH</td>
1.327 wiz 13577: <td>SHLIB</td>
1.269 leot 13578: </tr>
13579: <tr>
1.324 nia 13580: <td>SIGN_PACKAGES</td>
1.328 ! jnemeth 13581: <td>SILC_CLIENT_WITH_PERL</td>
1.292 leot 13582: </tr>
13583: <tr>
1.324 nia 13584: <td>SITE_SPECIFIC_PKGS</td>
1.328 ! jnemeth 13585: <td>SKIP_DEPENDS</td>
1.269 leot 13586: </tr>
13587: <tr>
1.324 nia 13588: <td>SMF_INSTANCES</td>
1.328 ! jnemeth 13589: <td>SMF_MANIFEST</td>
1.269 leot 13590: </tr>
13591: <tr>
1.324 nia 13592: <td>SMF_METHODS</td>
1.328 ! jnemeth 13593: <td>SMF_METHOD_SHELL</td>
1.274 rillig 13594: </tr>
13595: <tr>
1.324 nia 13596: <td>SMF_METHOD_SRC</td>
1.328 ! jnemeth 13597: <td>SMF_NAME</td>
1.269 leot 13598: </tr>
13599: <tr>
1.324 nia 13600: <td>SMF_PREFIX</td>
1.328 ! jnemeth 13601: <td>SMF_SRCDIR</td>
1.269 leot 13602: </tr>
13603: <tr>
1.324 nia 13604: <td>SNIPROXY_GROUP</td>
1.328 ! jnemeth 13605: <td>SNIPROXY_USER</td>
1.269 leot 13606: </tr>
13607: <tr>
1.324 nia 13608: <td>SOURCE_BUFFSIZE</td>
1.328 ! jnemeth 13609: <td>SPECIAL_PERMS</td>
1.269 leot 13610: </tr>
13611: <tr>
1.324 nia 13612: <td>SPECIFIC_PKGS</td>
1.328 ! jnemeth 13613: <td>SSH_SUID</td>
1.269 leot 13614: </tr>
13615: <tr>
1.324 nia 13616: <td>SSP_SUPPORTED</td>
1.328 ! jnemeth 13617: <td>SSYNC_PAWD</td>
1.269 leot 13618: </tr>
13619: <tr>
1.324 nia 13620: <td>STEP_MSG</td>
1.328 ! jnemeth 13621: <td>STRIP</td>
1.269 leot 13622: </tr>
13623: <tr>
1.324 nia 13624: <td>STRIP_DBG</td>
1.328 ! jnemeth 13625: <td>STRIP_DEBUG</td>
1.269 leot 13626: </tr>
13627: <tr>
1.324 nia 13628: <td>STRIP_DEBUG_SUPPORTED</td>
1.328 ! jnemeth 13629: <td>STRIP_FILES_SKIP</td>
1.269 leot 13630: </tr>
13631: <tr>
1.324 nia 13632: <td>SU</td>
1.328 ! jnemeth 13633: <td>SUBDIR</td>
1.269 leot 13634: </tr>
13635: <tr>
1.324 nia 13636: <td>SUBST</td>
1.328 ! jnemeth 13637: <td>SUBST_CLASSES</td>
1.269 leot 13638: </tr>
13639: <tr>
1.324 nia 13640: <td>SUBST_FILES</td>
1.328 ! jnemeth 13641: <td>SUBST_FILTER_CMD</td>
1.289 leot 13642: </tr>
13643: <tr>
1.324 nia 13644: <td>SUBST_MESSAGE</td>
1.328 ! jnemeth 13645: <td>SUBST_NOOP_OK</td>
1.269 leot 13646: </tr>
13647: <tr>
1.324 nia 13648: <td>SUBST_SED</td>
1.328 ! jnemeth 13649: <td>SUBST_SHOW_DIFF</td>
1.269 leot 13650: </tr>
13651: <tr>
1.324 nia 13652: <td>SUBST_SKIP_TEXT_CHECK</td>
1.328 ! jnemeth 13653: <td>SUBST_STAGE</td>
1.269 leot 13654: </tr>
13655: <tr>
1.324 nia 13656: <td>SUBST_VARS</td>
1.328 ! jnemeth 13657: <td>SUNWSPROBASE</td>
1.269 leot 13658: </tr>
13659: <tr>
1.324 nia 13660: <td>SUSE_PREFER</td>
1.308 leot 13661: <td>SU_CMD</td>
1.327 wiz 13662: </tr>
13663: <tr>
1.324 nia 13664: <td>SYSCONFBASE</td>
1.328 ! jnemeth 13665: <td>TBL</td>
1.320 wiz 13666: </tr>
13667: <tr>
1.324 nia 13668: <td>TERMCAP_TYPE</td>
1.328 ! jnemeth 13669: <td>TERMINFO_DEFAULT</td>
1.303 bacon 13670: </tr>
13671: <tr>
1.324 nia 13672: <td>TERMINFO_TYPE</td>
1.328 ! jnemeth 13673: <td>TEST</td>
1.274 rillig 13674: </tr>
13675: <tr>
1.324 nia 13676: <td>TEST_DEPENDS</td>
1.328 ! jnemeth 13677: <td>TEST_DIRS</td>
1.269 leot 13678: </tr>
13679: <tr>
1.324 nia 13680: <td>TEST_ENV</td>
1.328 ! jnemeth 13681: <td>TEST_ENV_SHELL</td>
1.269 leot 13682: </tr>
13683: <tr>
1.324 nia 13684: <td>TEST_MAKE_CMD</td>
1.328 ! jnemeth 13685: <td>TEST_MAKE_FLAGS</td>
1.269 leot 13686: </tr>
13687: <tr>
1.324 nia 13688: <td>TEST_TARGET</td>
1.328 ! jnemeth 13689: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.269 leot 13690: </tr>
13691: <tr>
1.324 nia 13692: <td>TEXLIVE_REV</td>
1.328 ! jnemeth 13693: <td>TEXLIVE_UNVERSIONED</td>
1.269 leot 13694: </tr>
13695: <tr>
1.324 nia 13696: <td>TEXMFSITE</td>
1.328 ! jnemeth 13697: <td>TEX_FORMATS</td>
1.269 leot 13698: </tr>
13699: <tr>
1.324 nia 13700: <td>TEX_HYPHEN_DAT</td>
1.328 ! jnemeth 13701: <td>TEX_HYPHEN_DEF</td>
1.269 leot 13702: </tr>
13703: <tr>
1.324 nia 13704: <td>TEX_TEXMF_DIRS</td>
1.328 ! jnemeth 13705: <td>THTTPD_LOG_FACILITY</td>
1.269 leot 13706: </tr>
13707: <tr>
1.324 nia 13708: <td>TINYDYN_USER</td>
1.328 ! jnemeth 13709: <td>TO</td>
1.269 leot 13710: </tr>
13711: <tr>
1.324 nia 13712: <td>TOOLS_ALIASES</td>
1.328 ! jnemeth 13713: <td>TOOLS_ALWAYS_WRAP</td>
1.269 leot 13714: </tr>
13715: <tr>
1.324 nia 13716: <td>TOOLS_ARGS</td>
1.328 ! jnemeth 13717: <td>TOOLS_BROKEN</td>
1.269 leot 13718: </tr>
13719: <tr>
1.324 nia 13720: <td>TOOLS_CMD</td>
1.328 ! jnemeth 13721: <td>TOOLS_CMDLINE_SED</td>
1.269 leot 13722: </tr>
13723: <tr>
1.324 nia 13724: <td>TOOLS_CREATE</td>
1.328 ! jnemeth 13725: <td>TOOLS_DIR</td>
1.269 leot 13726: </tr>
13727: <tr>
1.324 nia 13728: <td>TOOLS_FAIL</td>
1.328 ! jnemeth 13729: <td>TOOLS_GNU_MISSING</td>
1.269 leot 13730: </tr>
13731: <tr>
1.324 nia 13732: <td>TOOLS_LDCONFIG</td>
1.328 ! jnemeth 13733: <td>TOOLS_NOOP</td>
1.269 leot 13734: </tr>
13735: <tr>
1.324 nia 13736: <td>TOOLS_PATH</td>
1.328 ! jnemeth 13737: <td>TOOLS_SCRIPT</td>
1.269 leot 13738: </tr>
13739: <tr>
1.324 nia 13740: <td>TOOL_DEPENDS</td>
13741: <td>TTF_FONTS_DIR</td>
1.327 wiz 13742: </tr>
13743: <tr>
1.325 gutterid 13744: <td>TYPE</td>
1.327 wiz 13745: <td>UAC_REQD_EXECS</td>
1.311 leot 13746: </tr>
13747: <tr>
1.325 gutterid 13748: <td>UCSPI_SSL_GROUP</td>
1.327 wiz 13749: <td>UCSPI_SSL_USER</td>
1.269 leot 13750: </tr>
13751: <tr>
1.325 gutterid 13752: <td>UNLIMIT_RESOURCES</td>
1.327 wiz 13753: <td>UNPRIVILEGED</td>
1.269 leot 13754: </tr>
13755: <tr>
1.325 gutterid 13756: <td>UNPRIVILEGED_GROUP</td>
1.327 wiz 13757: <td>UNPRIVILEGED_GROUPS</td>
1.269 leot 13758: </tr>
13759: <tr>
1.325 gutterid 13760: <td>UNPRIVILEGED_USER</td>
1.327 wiz 13761: <td>UNWRAP_FILES</td>
1.269 leot 13762: </tr>
13763: <tr>
1.325 gutterid 13764: <td>UNWRAP_PATTERNS</td>
1.327 wiz 13765: <td>UPDATE_GEMSPEC</td>
1.269 leot 13766: </tr>
13767: <tr>
1.325 gutterid 13768: <td>UPDATE_TARGET</td>
1.327 wiz 13769: <td>URI</td>
1.269 leot 13770: </tr>
13771: <tr>
1.325 gutterid 13772: <td>USERGROUP_PHASE</td>
1.327 wiz 13773: <td>USERPPP_GROUP</td>
1.269 leot 13774: </tr>
13775: <tr>
1.325 gutterid 13776: <td>USER_SPECIFIC_PKGS</td>
1.327 wiz 13777: <td>USE_ABI_DEPENDS</td>
1.269 leot 13778: </tr>
13779: <tr>
1.325 gutterid 13780: <td>USE_APR</td>
1.327 wiz 13781: <td>USE_BSD_MAKEFILE</td>
1.269 leot 13782: </tr>
13783: <tr>
1.325 gutterid 13784: <td>USE_BUILTIN</td>
1.327 wiz 13785: <td>USE_CROSS_COMPILE</td>
1.320 wiz 13786: </tr>
13787: <tr>
1.325 gutterid 13788: <td>USE_CURSES</td>
1.327 wiz 13789: <td>USE_CWRAPPERS</td>
1.269 leot 13790: </tr>
13791: <tr>
1.325 gutterid 13792: <td>USE_DB185</td>
1.327 wiz 13793: <td>USE_FEATURES</td>
1.269 leot 13794: </tr>
13795: <tr>
1.325 gutterid 13796: <td>USE_GAMESGROUP</td>
1.327 wiz 13797: <td>USE_GCC_RUNTIME</td>
1.269 leot 13798: </tr>
13799: <tr>
1.325 gutterid 13800: <td>USE_IMAKE</td>
1.327 wiz 13801: <td>USE_JAVA</td>
1.269 leot 13802: </tr>
13803: <tr>
1.325 gutterid 13804: <td>USE_JAVA2</td>
1.327 wiz 13805: <td>USE_LANGUAGES</td>
1.269 leot 13806: </tr>
13807: <tr>
1.325 gutterid 13808: <td>USE_LIBTOOL</td>
1.327 wiz 13809: <td>USE_NATIVE_GCC</td>
1.269 leot 13810: </tr>
13811: <tr>
1.325 gutterid 13812: <td>USE_NETBSD_REPO</td>
1.327 wiz 13813: <td>USE_PKGSRC_GCC</td>
1.269 leot 13814: </tr>
13815: <tr>
1.325 gutterid 13816: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.327 wiz 13817: <td>USE_PKGTASKS</td>
1.269 leot 13818: </tr>
13819: <tr>
1.325 gutterid 13820: <td>USE_PKG_ADMIN_DIGEST</td>
1.327 wiz 13821: <td>USE_RUBY_EXTCONF</td>
1.269 leot 13822: </tr>
13823: <tr>
1.325 gutterid 13824: <td>USE_RUBY_INSTALL</td>
1.327 wiz 13825: <td>USE_RUBY_SETUP</td>
1.269 leot 13826: </tr>
13827: <tr>
1.325 gutterid 13828: <td>USE_RUBY_SETUP_PKG</td>
1.327 wiz 13829: <td>USE_TOOLS</td>
1.269 leot 13830: </tr>
13831: <tr>
1.325 gutterid 13832: <td>UUCP_GROUP</td>
1.327 wiz 13833: <td>UUCP_USER</td>
1.269 leot 13834: </tr>
13835: <tr>
1.325 gutterid 13836: <td>VARBASE</td>
1.327 wiz 13837: <td>VARNAME</td>
1.269 leot 13838: </tr>
13839: <tr>
1.325 gutterid 13840: <td>VIM_EXTRA_OPTS</td>
1.327 wiz 13841: <td>WARNING_MSG</td>
1.269 leot 13842: </tr>
13843: <tr>
1.325 gutterid 13844: <td>WCALC_CGIDIR</td>
1.327 wiz 13845: <td>WCALC_CGIPATH</td>
1.269 leot 13846: </tr>
13847: <tr>
1.325 gutterid 13848: <td>WCALC_HTMLDIR</td>
1.327 wiz 13849: <td>WCALC_HTMLPATH</td>
1.269 leot 13850: </tr>
13851: <tr>
1.325 gutterid 13852: <td>WDM_MANAGERS</td>
1.327 wiz 13853: <td>WRAPPER_CC</td>
1.269 leot 13854: </tr>
13855: <tr>
1.325 gutterid 13856: <td>WRAPPER_REORDER_CMDS</td>
1.327 wiz 13857: <td>WRKDIR</td>
1.269 leot 13858: </tr>
13859: <tr>
1.325 gutterid 13860: <td>WRKDIR_BASENAME</td>
1.327 wiz 13861: <td>WRKDIR_LOCKTYPE</td>
1.269 leot 13862: </tr>
13863: <tr>
1.325 gutterid 13864: <td>WRKLOG</td>
1.327 wiz 13865: <td>WRKOBJDIR</td>
1.303 bacon 13866: </tr>
13867: <tr>
1.325 gutterid 13868: <td>WRKSRC</td>
1.327 wiz 13869: <td>X10_PORT</td>
1.269 leot 13870: </tr>
13871: <tr>
1.325 gutterid 13872: <td>X11</td>
1.327 wiz 13873: <td>X11BASE</td>
1.269 leot 13874: </tr>
13875: <tr>
1.325 gutterid 13876: <td>X11_PKGSRCDIR</td>
1.327 wiz 13877: <td>X11_TYPE</td>
1.269 leot 13878: </tr>
13879: <tr>
1.325 gutterid 13880: <td>X509_CERTIFICATE</td>
1.327 wiz 13881: <td>X509_KEY</td>
1.269 leot 13882: </tr>
13883: <tr>
1.325 gutterid 13884: <td>XAW_TYPE</td>
1.327 wiz 13885: <td>XLOCK_DEFAULT_MODE</td>
1.269 leot 13886: </tr>
13887: <tr>
1.325 gutterid 13888: <td>XMKMF</td>
1.327 wiz 13889: <td>XMKMF_FLAGS</td>
1.269 leot 13890: </tr>
13891: <tr>
1.320 wiz 13892: <td>XXX</td>
1.328 ! jnemeth 13893: <td>YES</td>
1.274 rillig 13894: </tr>
13895: <tr>
1.324 nia 13896: <td>ZSH_STATIC</td>
1.328 ! jnemeth 13897: <td>__stdc__</td>
1.269 leot 13898: </tr>
13899: <tr>
1.324 nia 13900: <td>_vargroups</td>
1.328 ! jnemeth 13901: <td>accept</td>
1.316 cirnatda 13902: </tr>
13903: <tr>
1.324 nia 13904: <td>acquire-localbase-lock</td>
1.328 ! jnemeth 13905: <td>acquire-lock</td>
1.289 leot 13906: </tr>
13907: <tr>
1.324 nia 13908: <td>add</td>
1.328 ! jnemeth 13909: <td>administrator</td>
1.269 leot 13910: </tr>
13911: <tr>
1.324 nia 13912: <td>alloca</td>
1.328 ! jnemeth 13913: <td>alternatives</td>
1.269 leot 13914: </tr>
13915: <tr>
1.324 nia 13916: <td>aslr</td>
1.328 ! jnemeth 13917: <td>asprintf</td>
1.289 leot 13918: </tr>
13919: <tr>
1.324 nia 13920: <td>atlas</td>
1.328 ! jnemeth 13921: <td>autoconf</td>
1.269 leot 13922: </tr>
13923: <tr>
1.324 nia 13924: <td>automake</td>
1.328 ! jnemeth 13925: <td>autoreconf</td>
1.269 leot 13926: </tr>
13927: <tr>
1.324 nia 13928: <td>awk</td>
1.328 ! jnemeth 13929: <td>bash</td>
1.269 leot 13930: </tr>
13931: <tr>
1.324 nia 13932: <td>big-endian</td>
1.328 ! jnemeth 13933: <td>bin-install</td>
1.271 brook 13934: </tr>
13935: <tr>
1.324 nia 13936: <td>bind</td>
1.328 ! jnemeth 13937: <td>binpkg-list</td>
1.269 leot 13938: </tr>
13939: <tr>
1.324 nia 13940: <td>blas</td>
1.328 ! jnemeth 13941: <td>bootstrap-depends</td>
1.292 leot 13942: </tr>
13943: <tr>
1.324 nia 13944: <td>broken</td>
1.328 ! jnemeth 13945: <td>broken_on_platform</td>
1.274 rillig 13946: </tr>
13947: <tr>
1.324 nia 13948: <td>bsd</td>
1.328 ! jnemeth 13949: <td>bsd.prog.mk</td>
1.269 leot 13950: </tr>
13951: <tr>
1.324 nia 13952: <td>build</td>
1.328 ! jnemeth 13953: <td>build-env</td>
1.289 leot 13954: </tr>
13955: <tr>
1.324 nia 13956: <td>buildlink-directories</td>
1.328 ! jnemeth 13957: <td>buildlink-oss-soundcard-h</td>
1.269 leot 13958: </tr>
13959: <tr>
1.324 nia 13960: <td>c</td>
1.328 ! jnemeth 13961: <td>c++</td>
1.269 leot 13962: </tr>
13963: <tr>
1.324 nia 13964: <td>ccache</td>
1.328 ! jnemeth 13965: <td>cce</td>
1.269 leot 13966: </tr>
13967: <tr>
1.324 nia 13968: <td>cdefs</td>
1.328 ! jnemeth 13969: <td>ceil</td>
1.269 leot 13970: </tr>
13971: <tr>
1.324 nia 13972: <td>changes</td>
1.328 ! jnemeth 13973: <td>changes-entry</td>
1.289 leot 13974: </tr>
13975: <tr>
1.324 nia 13976: <td>changes-entry-noupdate</td>
1.328 ! jnemeth 13977: <td>check</td>
1.269 leot 13978: </tr>
13979: <tr>
1.324 nia 13980: <td>check-clean</td>
1.328 ! jnemeth 13981: <td>check-files</td>
1.269 leot 13982: </tr>
13983: <tr>
1.324 nia 13984: <td>check-files-clean</td>
1.328 ! jnemeth 13985: <td>check-vulnerable</td>
1.269 leot 13986: </tr>
13987: <tr>
1.324 nia 13988: <td>checksum</td>
1.328 ! jnemeth 13989: <td>checksum-phase</td>
1.269 leot 13990: </tr>
13991: <tr>
1.324 nia 13992: <td>clean</td>
1.328 ! jnemeth 13993: <td>clean-depends</td>
1.269 leot 13994: </tr>
13995: <tr>
1.324 nia 13996: <td>cleandir</td>
1.328 ! jnemeth 13997: <td>commit</td>
1.269 leot 13998: </tr>
13999: <tr>
1.324 nia 14000: <td>commit-changes-entry</td>
1.328 ! jnemeth 14001: <td>compact</td>
1.269 leot 14002: </tr>
14003: <tr>
1.324 nia 14004: <td>compiler</td>
1.328 ! jnemeth 14005: <td>conf</td>
1.269 leot 14006: </tr>
14007: <tr>
1.324 nia 14008: <td>config.guess</td>
1.328 ! jnemeth 14009: <td>config.sub</td>
1.269 leot 14010: </tr>
14011: <tr>
1.324 nia 14012: <td>configuration</td>
1.328 ! jnemeth 14013: <td>configure</td>
1.269 leot 14014: </tr>
14015: <tr>
1.324 nia 14016: <td>configure-env</td>
1.328 ! jnemeth 14017: <td>configure-help</td>
1.269 leot 14018: </tr>
14019: <tr>
1.324 nia 14020: <td>configure_args</td>
1.328 ! jnemeth 14021: <td>connect</td>
1.269 leot 14022: </tr>
14023: <tr>
1.324 nia 14024: <td>cos</td>
1.328 ! jnemeth 14025: <td>cputime</td>
1.269 leot 14026: </tr>
14027: <tr>
1.324 nia 14028: <td>create-usergroup</td>
1.328 ! jnemeth 14029: <td>csh</td>
1.289 leot 14030: </tr>
14031: <tr>
1.324 nia 14032: <td>ctf</td>
14033: <td>debug</td>
1.327 wiz 14034: </tr>
14035: <tr>
1.325 gutterid 14036: <td>declaration</td>
1.327 wiz 14037: <td>declare</td>
1.320 wiz 14038: </tr>
14039: <tr>
1.325 gutterid 14040: <td>defined</td>
1.327 wiz 14041: <td>depend</td>
1.269 leot 14042: </tr>
14043: <tr>
1.325 gutterid 14044: <td>dependencies</td>
1.327 wiz 14045: <td>depends</td>
1.311 leot 14046: </tr>
14047: <tr>
1.325 gutterid 14048: <td>depends-checksum</td>
1.327 wiz 14049: <td>depends-fetch</td>
1.269 leot 14050: </tr>
14051: <tr>
1.325 gutterid 14052: <td>deps</td>
1.327 wiz 14053: <td>describe</td>
1.269 leot 14054: </tr>
14055: <tr>
1.325 gutterid 14056: <td>destdir</td>
1.327 wiz 14057: <td>disable</td>
1.269 leot 14058: </tr>
14059: <tr>
1.325 gutterid 14060: <td>distclean</td>
1.327 wiz 14061: <td>distinfo</td>
1.269 leot 14062: </tr>
14063: <tr>
1.325 gutterid 14064: <td>dl</td>
1.327 wiz 14065: <td>dlopen</td>
1.269 leot 14066: </tr>
14067: <tr>
1.325 gutterid 14068: <td>do-build</td>
1.327 wiz 14069: <td>do-buildlink</td>
1.269 leot 14070: </tr>
14071: <tr>
1.325 gutterid 14072: <td>do-clean</td>
1.327 wiz 14073: <td>do-configure</td>
1.277 rillig 14074: </tr>
14075: <tr>
1.325 gutterid 14076: <td>do-configure-post-hook</td>
1.327 wiz 14077: <td>do-extract</td>
1.269 leot 14078: </tr>
14079: <tr>
1.320 wiz 14080: <td>do-fetch</td>
1.328 ! jnemeth 14081: <td>emul</td>
1.269 leot 14082: </tr>
14083: <tr>
1.324 nia 14084: <td>emul-distinfo</td>
1.328 ! jnemeth 14085: <td>emul-fetch</td>
1.289 leot 14086: </tr>
14087: <tr>
1.324 nia 14088: <td>emulation</td>
1.328 ! jnemeth 14089: <td>emulator</td>
1.269 leot 14090: </tr>
14091: <tr>
1.324 nia 14092: <td>enable</td>
1.316 cirnatda 14093: <td>endian</td>
1.327 wiz 14094: </tr>
14095: <tr>
1.325 gutterid 14096: <td>enomem</td>
1.327 wiz 14097: <td>err</td>
1.269 leot 14098: </tr>
14099: <tr>
1.325 gutterid 14100: <td>errx</td>
1.327 wiz 14101: <td>etc</td>
1.320 wiz 14102: </tr>
14103: <tr>
1.325 gutterid 14104: <td>exp</td>
1.327 wiz 14105: <td>extract-rpm</td>
1.311 leot 14106: </tr>
14107: <tr>
1.325 gutterid 14108: <td>fabs</td>
1.327 wiz 14109: <td>feature</td>
1.269 leot 14110: </tr>
14111: <tr>
1.325 gutterid 14112: <td>features</td>
1.327 wiz 14113: <td>fetch</td>
1.269 leot 14114: </tr>
14115: <tr>
1.325 gutterid 14116: <td>fetch-list</td>
1.327 wiz 14117: <td>follows</td>
1.289 leot 14118: </tr>
14119: <tr>
1.325 gutterid 14120: <td>forbids</td>
1.327 wiz 14121: <td>form</td>
1.269 leot 14122: </tr>
14123: <tr>
1.325 gutterid 14124: <td>format</td>
1.327 wiz 14125: <td>fortify</td>
1.269 leot 14126: </tr>
14127: <tr>
1.320 wiz 14128: <td>fortify_source</td>
1.328 ! jnemeth 14129: <td>friend</td>
1.269 leot 14130: </tr>
14131: <tr>
1.324 nia 14132: <td>fts</td>
1.328 ! jnemeth 14133: <td>fts_close</td>
1.269 leot 14134: </tr>
14135: <tr>
1.324 nia 14136: <td>fts_open</td>
1.328 ! jnemeth 14137: <td>fts_read</td>
1.269 leot 14138: </tr>
14139: <tr>
1.324 nia 14140: <td>fts_set</td>
1.328 ! jnemeth 14141: <td>gcc</td>
1.269 leot 14142: </tr>
14143: <tr>
1.324 nia 14144: <td>gethostbyaddr</td>
1.328 ! jnemeth 14145: <td>gethostbyname</td>
1.289 leot 14146: </tr>
14147: <tr>
1.324 nia 14148: <td>gethostbyname2</td>
1.328 ! jnemeth 14149: <td>getopt_long</td>
1.269 leot 14150: </tr>
14151: <tr>
1.324 nia 14152: <td>getprogname</td>
1.328 ! jnemeth 14153: <td>getservbyname</td>
1.269 leot 14154: </tr>
14155: <tr>
1.324 nia 14156: <td>getservbyport</td>
1.328 ! jnemeth 14157: <td>getservent</td>
1.289 leot 14158: </tr>
14159: <tr>
1.324 nia 14160: <td>gettext</td>
14161: <td>github</td>
1.327 wiz 14162: </tr>
14163: <tr>
1.324 nia 14164: <td>glob</td>
1.328 ! jnemeth 14165: <td>gnu</td>
1.269 leot 14166: </tr>
14167: <tr>
1.324 nia 14168: <td>gnu_configure_strict</td>
1.328 ! jnemeth 14169: <td>go</td>
1.274 rillig 14170: </tr>
14171: <tr>
1.324 nia 14172: <td>go-deps</td>
1.328 ! jnemeth 14173: <td>golang</td>
1.269 leot 14174: </tr>
14175: <tr>
1.324 nia 14176: <td>guess-license</td>
1.328 ! jnemeth 14177: <td>hashbang</td>
1.269 leot 14178: </tr>
14179: <tr>
1.324 nia 14180: <td>heimdal</td>
1.316 cirnatda 14181: <td>help</td>
1.327 wiz 14182: </tr>
14183: <tr>
1.325 gutterid 14184: <td>imake</td>
1.327 wiz 14185: <td>increment</td>
1.269 leot 14186: </tr>
14187: <tr>
1.325 gutterid 14188: <td>inet_aton</td>
1.327 wiz 14189: <td>interp</td>
1.320 wiz 14190: </tr>
14191: <tr>
1.325 gutterid 14192: <td>interpreter</td>
1.327 wiz 14193: <td>intl</td>
1.311 leot 14194: </tr>
14195: <tr>
1.325 gutterid 14196: <td>ip4</td>
1.327 wiz 14197: <td>ip6</td>
1.269 leot 14198: </tr>
14199: <tr>
1.325 gutterid 14200: <td>ipv4</td>
1.327 wiz 14201: <td>ipv6</td>
1.269 leot 14202: </tr>
14203: <tr>
1.325 gutterid 14204: <td>iso</td>
1.327 wiz 14205: <td>kerberos</td>
1.269 leot 14206: </tr>
14207: <tr>
1.325 gutterid 14208: <td>krb</td>
1.327 wiz 14209: <td>krb5</td>
1.269 leot 14210: </tr>
14211: <tr>
1.325 gutterid 14212: <td>ksh</td>
1.327 wiz 14213: <td>lapack</td>
1.303 bacon 14214: </tr>
14215: <tr>
1.325 gutterid 14216: <td>latex</td>
1.327 wiz 14217: <td>libintl_bindtextdomain</td>
1.303 bacon 14218: </tr>
14219: <tr>
1.325 gutterid 14220: <td>libintl_gettext</td>
1.327 wiz 14221: <td>libintl_textdomain</td>
1.269 leot 14222: </tr>
14223: <tr>
1.325 gutterid 14224: <td>libnbcompat</td>
1.327 wiz 14225: <td>libs</td>
1.292 leot 14226: </tr>
14227: <tr>
1.325 gutterid 14228: <td>libtool</td>
1.327 wiz 14229: <td>licence</td>
1.269 leot 14230: </tr>
14231: <tr>
1.325 gutterid 14232: <td>license</td>
1.327 wiz 14233: <td>lintl</td>
1.289 leot 14234: </tr>
14235: <tr>
1.325 gutterid 14236: <td>little-endian</td>
1.327 wiz 14237: <td>lock</td>
1.274 rillig 14238: </tr>
14239: <tr>
1.325 gutterid 14240: <td>locking</td>
1.327 wiz 14241: <td>lvalue</td>
1.271 brook 14242: </tr>
14243: <tr>
1.325 gutterid 14244: <td>make</td>
1.327 wiz 14245: <td>makesum</td>
1.269 leot 14246: </tr>
14247: <tr>
1.320 wiz 14248: <td>memory</td>
1.328 ! jnemeth 14249: <td>meta</td>
1.269 leot 14250: </tr>
14251: <tr>
1.324 nia 14252: <td>meta-package</td>
1.328 ! jnemeth 14253: <td>meta_package</td>
1.269 leot 14254: </tr>
14255: <tr>
1.324 nia 14256: <td>mit-krb5</td>
1.328 ! jnemeth 14257: <td>mk.conf</td>
1.269 leot 14258: </tr>
14259: <tr>
1.324 nia 14260: <td>mkl</td>
1.328 ! jnemeth 14261: <td>mount</td>
1.292 leot 14262: </tr>
14263: <tr>
1.324 nia 14264: <td>mprotect</td>
1.328 ! jnemeth 14265: <td>mremap</td>
1.274 rillig 14266: </tr>
14267: <tr>
1.324 nia 14268: <td>nb</td>
1.328 ! jnemeth 14269: <td>nbcompat</td>
1.269 leot 14270: </tr>
14271: <tr>
1.324 nia 14272: <td>netlib</td>
1.328 ! jnemeth 14273: <td>obstack</td>
1.269 leot 14274: </tr>
14275: <tr>
1.324 nia 14276: <td>obstack_ptr_grow</td>
1.328 ! jnemeth 14277: <td>occurs</td>
1.320 wiz 14278: </tr>
14279: <tr>
1.324 nia 14280: <td>only</td>
1.328 ! jnemeth 14281: <td>openblas</td>
1.269 leot 14282: </tr>
14283: <tr>
1.324 nia 14284: <td>options</td>
1.328 ! jnemeth 14285: <td>options.mk</td>
1.269 leot 14286: </tr>
14287: <tr>
1.324 nia 14288: <td>order</td>
1.328 ! jnemeth 14289: <td>override</td>
1.269 leot 14290: </tr>
14291: <tr>
1.324 nia 14292: <td>override-intltool</td>
1.328 ! jnemeth 14293: <td>override-message-intltool</td>
1.271 brook 14294: </tr>
14295: <tr>
1.324 nia 14296: <td>package</td>
1.328 ! jnemeth 14297: <td>parallel</td>
1.269 leot 14298: </tr>
14299: <tr>
1.324 nia 14300: <td>path</td>
1.328 ! jnemeth 14301: <td>pax</td>
1.269 leot 14302: </tr>
14303: <tr>
1.324 nia 14304: <td>paxctl</td>
1.328 ! jnemeth 14305: <td>pbulk-index</td>
1.269 leot 14306: </tr>
14307: <tr>
1.324 nia 14308: <td>pc</td>
1.328 ! jnemeth 14309: <td>perl</td>
1.269 leot 14310: </tr>
14311: <tr>
1.324 nia 14312: <td>perl5</td>
1.328 ! jnemeth 14313: <td>perms</td>
1.269 leot 14314: </tr>
14315: <tr>
1.324 nia 14316: <td>php</td>
1.328 ! jnemeth 14317: <td>pkg-build-options</td>
1.269 leot 14318: </tr>
14319: <tr>
1.324 nia 14320: <td>pkg-config</td>
1.328 ! jnemeth 14321: <td>pkg_build_options</td>
1.269 leot 14322: </tr>
14323: <tr>
1.324 nia 14324: <td>platform</td>
1.328 ! jnemeth 14325: <td>plist</td>
1.269 leot 14326: </tr>
14327: <tr>
1.324 nia 14328: <td>post-extract</td>
1.328 ! jnemeth 14329: <td>post-fetch</td>
1.269 leot 14330: </tr>
14331: <tr>
1.324 nia 14332: <td>post-wrapper</td>
1.328 ! jnemeth 14333: <td>pre-build-checks-hook</td>
1.269 leot 14334: </tr>
14335: <tr>
1.324 nia 14336: <td>pre-configure</td>
1.328 ! jnemeth 14337: <td>pre-configure-checks-hook</td>
1.269 leot 14338: </tr>
14339: <tr>
1.324 nia 14340: <td>pre-extract</td>
1.328 ! jnemeth 14341: <td>pre-fetch</td>
1.289 leot 14342: </tr>
14343: <tr>
1.324 nia 14344: <td>print-go-deps</td>
1.328 ! jnemeth 14345: <td>print-plist</td>
1.269 leot 14346: </tr>
14347: <tr>
1.324 nia 14348: <td>print-summary-data</td>
1.328 ! jnemeth 14349: <td>privileged-install-hook</td>
1.269 leot 14350: </tr>
14351: <tr>
1.324 nia 14352: <td>pypi</td>
1.328 ! jnemeth 14353: <td>python</td>
1.269 leot 14354: </tr>
14355: <tr>
1.326 gutterid 14356: <td>r</td>
1.328 ! jnemeth 14357: <td>readme-all</td>
1.269 leot 14358: </tr>
14359: <tr>
1.320 wiz 14360: <td>recv</td>
1.328 ! jnemeth 14361: <td>recvfrom</td>
1.269 leot 14362: </tr>
14363: <tr>
1.320 wiz 14364: <td>regcomp</td>
1.328 ! jnemeth 14365: <td>release-localbase-lock</td>
1.289 leot 14366: </tr>
14367: <tr>
1.320 wiz 14368: <td>release-lock</td>
1.328 ! jnemeth 14369: <td>relro</td>
1.289 leot 14370: </tr>
14371: <tr>
1.320 wiz 14372: <td>rename</td>
1.328 ! jnemeth 14373: <td>reorder</td>
1.269 leot 14374: </tr>
14375: <tr>
1.320 wiz 14376: <td>replace</td>
1.328 ! jnemeth 14377: <td>replace_interpreter</td>
1.269 leot 14378: </tr>
14379: <tr>
1.320 wiz 14380: <td>reproducible</td>
1.328 ! jnemeth 14381: <td>resolv</td>
1.269 leot 14382: </tr>
14383: <tr>
1.320 wiz 14384: <td>root</td>
1.328 ! jnemeth 14385: <td>ruby</td>
1.269 leot 14386: </tr>
14387: <tr>
1.320 wiz 14388: <td>send</td>
1.328 ! jnemeth 14389: <td>sendfile</td>
1.289 leot 14390: </tr>
14391: <tr>
1.320 wiz 14392: <td>sendto</td>
1.328 ! jnemeth 14393: <td>setenv</td>
1.269 leot 14394: </tr>
14395: <tr>
1.320 wiz 14396: <td>setgid</td>
1.328 ! jnemeth 14397: <td>setprogname</td>
1.269 leot 14398: </tr>
14399: <tr>
1.320 wiz 14400: <td>setuid</td>
1.328 ! jnemeth 14401: <td>sh</td>
1.269 leot 14402: </tr>
14403: <tr>
1.320 wiz 14404: <td>shebang</td>
1.328 ! jnemeth 14405: <td>show</td>
1.269 leot 14406: </tr>
14407: <tr>
1.320 wiz 14408: <td>show-all</td>
1.328 ! jnemeth 14409: <td>show-build-defs</td>
1.296 rillig 14410: </tr>
14411: <tr>
1.320 wiz 14412: <td>show-depends</td>
1.328 ! jnemeth 14413: <td>show-deps</td>
1.269 leot 14414: </tr>
14415: <tr>
1.320 wiz 14416: <td>show-distfiles</td>
1.328 ! jnemeth 14417: <td>show-downlevel</td>
1.269 leot 14418: </tr>
14419: <tr>
1.320 wiz 14420: <td>show-subdir-var</td>
1.328 ! jnemeth 14421: <td>show-tools</td>
1.269 leot 14422: </tr>
14423: <tr>
1.320 wiz 14424: <td>show-var</td>
1.328 ! jnemeth 14425: <td>show-vars</td>
1.269 leot 14426: </tr>
14427: <tr>
1.320 wiz 14428: <td>snprintf</td>
1.328 ! jnemeth 14429: <td>socket</td>
1.269 leot 14430: </tr>
14431: <tr>
1.320 wiz 14432: <td>ssp</td>
1.328 ! jnemeth 14433: <td>st_mode</td>
1.289 leot 14434: </tr>
14435: <tr>
1.320 wiz 14436: <td>stage-install</td>
1.328 ! jnemeth 14437: <td>strcasestr</td>
1.269 leot 14438: </tr>
14439: <tr>
1.320 wiz 14440: <td>strict</td>
1.328 ! jnemeth 14441: <td>strip</td>
1.269 leot 14442: </tr>
14443: <tr>
1.320 wiz 14444: <td>strndup</td>
1.328 ! jnemeth 14445: <td>strnlen</td>
1.277 rillig 14446: </tr>
14447: <tr>
1.320 wiz 14448: <td>strsep</td>
1.328 ! jnemeth 14449: <td>subst</td>
1.269 leot 14450: </tr>
14451: <tr>
1.320 wiz 14452: <td>substitutions</td>
1.326 gutterid 14453: <td>sun</td>
1.327 wiz 14454: </tr>
14455: <tr>
1.324 nia 14456: <td>sunpro</td>
1.327 wiz 14457: <td>sunwspro</td>
1.311 leot 14458: </tr>
14459: <tr>
1.276 leot 14460: <td>symlink</td>
1.328 ! jnemeth 14461: <td>test</td>
1.269 leot 14462: </tr>
14463: <tr>
1.289 leot 14464: <td>test-env</td>
1.328 ! jnemeth 14465: <td>tex</td>
1.269 leot 14466: </tr>
14467: <tr>
1.289 leot 14468: <td>texlive</td>
1.328 ! jnemeth 14469: <td>tmp</td>
1.269 leot 14470: </tr>
14471: <tr>
1.289 leot 14472: <td>tool</td>
1.328 ! jnemeth 14473: <td>tools</td>
1.269 leot 14474: </tr>
14475: <tr>
1.289 leot 14476: <td>tools-libtool-m4-override</td>
1.328 ! jnemeth 14477: <td>type</td>
1.269 leot 14478: </tr>
14479: <tr>
1.289 leot 14480: <td>ulimit</td>
1.328 ! jnemeth 14481: <td>undefined</td>
1.269 leot 14482: </tr>
14483: <tr>
1.289 leot 14484: <td>undo-replace</td>
1.328 ! jnemeth 14485: <td>unlimit</td>
1.269 leot 14486: </tr>
14487: <tr>
1.289 leot 14488: <td>unprivileged</td>
1.328 ! jnemeth 14489: <td>unprivileged-install-hook</td>
1.269 leot 14490: </tr>
14491: <tr>
1.289 leot 14492: <td>unstripped</td>
1.328 ! jnemeth 14493: <td>update</td>
1.269 leot 14494: </tr>
14495: <tr>
1.289 leot 14496: <td>upload</td>
1.328 ! jnemeth 14497: <td>upload-distfiles</td>
1.269 leot 14498: </tr>
14499: <tr>
1.270 leot 14500: <td>use_tools</td>
1.328 ! jnemeth 14501: <td>user</td>
1.269 leot 14502: </tr>
14503: <tr>
1.270 leot 14504: <td>utimes</td>
1.328 ! jnemeth 14505: <td>vasprintf</td>
1.269 leot 14506: </tr>
14507: <tr>
1.270 leot 14508: <td>verbose</td>
1.328 ! jnemeth 14509: <td>vsnprintf</td>
1.269 leot 14510: </tr>
14511: <tr>
1.270 leot 14512: <td>warn</td>
1.328 ! jnemeth 14513: <td>warning</td>
1.269 leot 14514: </tr>
14515: <tr>
1.270 leot 14516: <td>warnings</td>
1.328 ! jnemeth 14517: <td>warnx</td>
1.269 leot 14518: </tr>
14519: <tr>
1.289 leot 14520: <td>wattr_off</td>
1.328 ! jnemeth 14521: <td>wattr_on</td>
1.269 leot 14522: </tr>
14523: <tr>
1.289 leot 14524: <td>work</td>
1.328 ! jnemeth 14525: <td>wrapper</td>
1.269 leot 14526: </tr>
14527: <tr>
1.289 leot 14528: <td>wrkdir</td>
1.328 ! jnemeth 14529: <td> </td>
1.269 leot 14530: </tr>
14531: </table>
1.267 rillig 14532: </div>
14533: <div class="appendix">
14534: <div class="titlepage"><div><div><h1 class="title">
1.322 leot 14535: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 14536: <div class="toc">
14537: <p><b>Table of Contents</b></p>
1.210 leot 14538: <dl class="toc">
1.322 leot 14539: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
14540: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.75 rillig 14541: </dl>
14542: </div>
1.79 rillig 14543: <p>This section contains information on editing the pkgsrc
14544: guide itself.</p>
1.148 asau 14545: <div class="sect1">
1.75 rillig 14546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 14547: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.79 rillig 14548: <p>The pkgsrc guide's source code is stored in
14549: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
14550: are created from it:</p>
1.148 asau 14551: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 14552: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
14553: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289 leot 14554: <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>
14555: <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 14556: The PDF version of the pkgsrc guide.</p></li>
1.289 leot 14557: <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 14558: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 14559: </ul></div>
14560: </div>
1.148 asau 14561: <div class="sect1">
1.75 rillig 14562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.322 leot 14563: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.79 rillig 14564: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 14565: <div class="procedure"><ol class="procedure" type="1">
1.304 bacon 14566: <li class="step"><p>Make sure you have checked out the htdocs repository
14567: into a sibling directory of your pkgsrc directory. You will need
14568: the ability to commit from both pkgsrc and htdocs.</p></li>
1.148 asau 14569: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 14570: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 14571: documentation) installed. These are automatically installed when
1.322 leot 14572: you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/index.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148 asau 14573: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 14574: right directory. All further steps will take place
14575: here.</p></li>
1.148 asau 14576: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 14577: <code class="filename">files/</code>.</p></li>
1.148 asau 14578: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 14579: guide for valid XML and to build the final output files. If you
14580: get any errors at this stage, you can just edit the files, as
14581: there are only symbolic links in the working directory, pointing
14582: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 14583: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 14584: commit)</strong></span></p></li>
1.148 asau 14585: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 14586: regenerate the output files with the proper RCS
14587: Ids.</p></li>
1.148 asau 14588: <li class="step">
1.110 hubertf 14589: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 14590: commit the files in both <code class="filename">pkgsrc/doc</code> and
14591: <code class="filename">htdocs</code>.</p>
1.148 asau 14592: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 14593: <h3 class="title">Note</h3>
14594: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 14595: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
14596: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 14597: directory.</p>
14598: </div>
14599: </li>
1.79 rillig 14600: </ol></div>
1.75 rillig 14601: </div>
14602: </div>
14603: </div></body>
1.1 grant 14604: </html>
CVSweb <webmaster@jp.NetBSD.org>