Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.272
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
1.266 martin 4: <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
1.1 dsieger 5: <title>The pkgsrc guide</title>
1.25 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
9: </head>
1.41 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1 dsieger 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.10 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.10 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.269 wiz 33: <div><p class="copyright">Copyright © 1994-2026 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.46 2026/01/01 08:41:23 wiz Exp $</p></div>
1.41 asau 35: <div><div class="abstract">
1.1 dsieger 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.100 leot 48: <dl class="toc">
1.1 dsieger 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
1.154 rillig 63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1 dsieger 65: <dd><dl>
1.154 rillig 66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 67: <dd><dl>
1.154 rillig 68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 70: </dl></dd>
1.154 rillig 71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 72: <dd><dl>
1.154 rillig 73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 75: </dl></dd>
76: </dl></dd>
1.154 rillig 77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 78: <dd><dl>
1.154 rillig 79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 81: </dl></dd>
1.154 rillig 82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 83: <dd><dl>
1.154 rillig 84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 85: <dd><dl>
1.154 rillig 86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 88: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
89: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
90: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
91: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
92: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
93: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1 dsieger 94: </dl></dd>
1.154 rillig 95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 96: <dd><dl>
1.154 rillig 97: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
98: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
99: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 100: </dl></dd>
101: </dl></dd>
1.154 rillig 102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 103: <dd><dl>
1.154 rillig 104: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
105: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 106: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
107: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
108: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
109: <dd><dl>
110: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
111: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
112: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 113: </dl></dd>
1.241 rillig 114: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
115: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 116: </dl></dd>
1.154 rillig 117: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 118: <dd><dl>
1.154 rillig 119: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
120: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 121: </dl></dd>
1.154 rillig 122: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 123: builds)</a></span></dt>
1.1 dsieger 124: <dd><dl>
1.154 rillig 125: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 126: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 127: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
1.272 ! wiz 128: <dt><span class="sect1"><a href="#bulk.scan">8.3. Speeding up bulk build scans</a></span></dt>
! 129: <dt><span class="sect1"><a href="#bulk.req">8.4. Requirements of a full bulk build</a></span></dt>
! 130: <dt><span class="sect1"><a href="#bulk.var">8.5. Bulk build variants</a></span></dt>
! 131: <dd><dl>
! 132: <dt><span class="sect2"><a href="#bulk.var.confopt">8.5.1. Detect unknown configure options</a></span></dt>
! 133: <dt><span class="sect2"><a href="#bulk.var.comperr">8.5.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
! 134: <dt><span class="sect2"><a href="#bulk.var.builderr">8.5.3. Force compiler options only in the build phase</a></span></dt>
! 135: <dt><span class="sect2"><a href="#bulk.var.dirs">8.5.4. Use custom directories</a></span></dt>
! 136: <dt><span class="sect2"><a href="#bulk.var.warn">8.5.5. Turn warnings into errors</a></span></dt>
! 137: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.5.6. Reject packages for which pkglint reports errors</a></span></dt>
! 138: <dt><span class="sect2"><a href="#bulk.var.strings">8.5.7. Reject packages that contain forbidden strings</a></span></dt>
! 139: <dt><span class="sect2"><a href="#bulk.var.test">8.5.8. Reject packages whose self-test fails</a></span></dt>
! 140: <dt><span class="sect2"><a href="#bulk.var.shvar">8.5.9. Reject packages that use undefined shell variables</a></span></dt>
! 141: <dt><span class="sect2"><a href="#bulk.var.quiet">8.5.10. Turn off verbose logging</a></span></dt>
1.178 rillig 142: </dl></dd>
1.272 ! wiz 143: <dt><span class="sect1"><a href="#creating-cdroms">8.6. Creating a multiple CD-ROM packages collection</a></span></dt>
! 144: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.6.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 145: </dl></dd>
146: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
147: <dd><dl>
148: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
149: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
150: </dl></dd>
151: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
152: <dd><dl>
153: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
154: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
155: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
156: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
157: <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>
158: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
159: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
160: <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>
161: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
1.266 martin 162: <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
163: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
164: <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>
1.221 nia 165: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 166: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
167: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
168: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
169: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
1.266 martin 170: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 171: </dl></dd>
172: </dl></dd>
173: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
174: <dd><dl>
1.154 rillig 175: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 176: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 177: <dd><dl>
1.184 rillig 178: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
179: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
180: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 181: <dd><dl>
1.184 rillig 182: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
183: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
184: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
185: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
186: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 187: </dl></dd>
1.184 rillig 188: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
189: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
190: <dd><dl>
191: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
192: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
193: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
194: </dl></dd>
195: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
196: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 197: </dl></dd>
1.184 rillig 198: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 199: <dd><dl>
1.184 rillig 200: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
201: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
202: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
203: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
204: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 205: <dd><dl>
1.184 rillig 206: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
207: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 208: </dl></dd>
1.184 rillig 209: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
210: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
211: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
212: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
213: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
214: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
215: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
216: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
217: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
218: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
219: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
220: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
221: </dl></dd>
222: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
223: <dd><dl>
224: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 225: <dd><dl>
1.219 nia 226: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
227: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
228: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.6 rillig 229: </dl></dd>
1.184 rillig 230: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
231: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6 rillig 232: </dl></dd>
1.184 rillig 233: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 234: <dd><dl>
1.184 rillig 235: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
236: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
237: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
238: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 239: <dd><dl>
1.184 rillig 240: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
241: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
242: <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>
243: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 244: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.6 rillig 245: </dl></dd>
246: </dl></dd>
1.184 rillig 247: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 248: <dd><dl>
1.184 rillig 249: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
250: <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>
251: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
252: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 253: </dl></dd>
1.184 rillig 254: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 255: <dd><dl>
1.184 rillig 256: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
257: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
258: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
259: </dl></dd>
260: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
261: <dd><dl>
262: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
263: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 264: <dd><dl>
1.184 rillig 265: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
266: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 267: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
268: and
269: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
270: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 271: </dl></dd>
1.184 rillig 272: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.241 rillig 273: <dd><dl><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></dl></dd>
1.184 rillig 274: </dl></dd>
275: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 276: <dd><dl>
1.184 rillig 277: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
278: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
279: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
280: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
281: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
282: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
283: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
284: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
285: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 286: </dl></dd>
1.184 rillig 287: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
288: <dd><dl>
289: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
290: <dd><dl>
291: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
292: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 293: </dl></dd>
1.184 rillig 294: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 295: <dd><dl>
1.184 rillig 296: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
297: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.239 dholland 298: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
299: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
300: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 301: </dl></dd>
302: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
303: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
304: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
305: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
306: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
307: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
308: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.154 rillig 309: </dl></dd>
310: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
311: <dd><dl>
312: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
313: <dd><dl>
314: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
315: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
316: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
317: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
318: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
319: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
320: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
321: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
322: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
323: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
324: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
325: </dl></dd>
326: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
327: <dd><dl>
328: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
329: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
330: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
331: </dl></dd>
332: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
333: <dd><dl>
334: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
336: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 337: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.260 wiz 338: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.154 rillig 339: </dl></dd>
340: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
341: <dd><dl>
342: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
343: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 344: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 345: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
346: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
347: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
348: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 349: </dl></dd>
350: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
351: <dd><dl>
352: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
353: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 354: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
1.266 martin 355: <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>
1.172 rillig 356: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 357: </dl></dd>
358: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
359: <dd><dl>
360: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
361: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
362: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
363: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
364: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 365: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.254 wiz 366: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
367: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
368: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
369: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
370: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
371: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
372: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
373: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
374: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
375: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.1 dsieger 376: emulation</a></span></dt>
1.254 wiz 377: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
378: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.1 dsieger 379: </dl></dd>
1.154 rillig 380: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 381: </dl></dd>
1.184 rillig 382: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
383: <dd><dl>
384: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
385: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
386: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
387: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
388: </dl></dd>
1.154 rillig 389: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 390: <dd><dl>
1.154 rillig 391: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
392: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
393: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
394: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
395: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
396: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
397: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
398: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
399: </dl></dd>
1.263 wiz 400: <dt><span class="chapter"><a href="#policies">24. pkgsrc Policies</a></span></dt>
401: <dd><dl>
402: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
403: <dd><dl>
404: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
405: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
406: </dl></dd>
407: </dl></dd>
408: <dt><span class="chapter"><a href="#devfaq">25. Frequently Asked Questions</a></span></dt>
1.1 dsieger 409: </dl></dd>
410: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
411: <dd><dl>
1.263 wiz 412: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 413: <dd><dl>
1.263 wiz 414: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
415: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
416: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 417: <dd><dl>
1.263 wiz 418: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
419: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 420: </dl></dd>
1.263 wiz 421: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
422: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 423: <dd><dl>
1.263 wiz 424: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
425: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 426: </dl></dd>
1.263 wiz 427: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 428: <dd><dl>
1.263 wiz 429: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
430: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 431: </dl></dd>
432: </dl></dd>
1.263 wiz 433: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1 dsieger 434: <dd><dl>
1.263 wiz 435: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
436: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 437: <dd><dl>
1.263 wiz 438: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
439: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 440: </dl></dd>
441: </dl></dd>
1.263 wiz 442: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
443: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 444: </dl></dd>
445: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
446: <dd><dl>
447: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
448: <dd><dl>
449: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
450: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
451: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 452: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 453: </dl></dd>
454: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
455: </dl></dd>
1.207 leot 456: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.1 dsieger 457: <dd><dl>
1.207 leot 458: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
459: <dd><dl>
460: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
461: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
462: </dl></dd>
463: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
464: <dd><dl>
465: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
466: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
467: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
468: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
469: </dl></dd>
470: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
471: <dd><dl>
472: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
473: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
474: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
475: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
476: </dl></dd>
477: </dl></dd>
478: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
479: <dd><dl>
480: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
481: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.1 dsieger 482: </dl></dd>
1.207 leot 483: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.1 dsieger 484: <dd><dl>
1.207 leot 485: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
486: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
487: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
488: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
489: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.148 leot 490: <code class="filename">stable</code>,
1.23 wiz 491: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 492: source packages</a></span></dt>
493: </dl></dd>
1.207 leot 494: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
495: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1 dsieger 496: <dd><dl>
1.207 leot 497: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
498: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 499: </dl></dd>
500: </dl>
501: </div>
502: <div class="list-of-tables">
503: <p><b>List of Tables</b></p>
504: <dl>
505: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
506: </dt>
1.184 rillig 507: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 508: </dt>
1.184 rillig 509: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 510: </dt>
511: </dl>
512: </div>
1.41 asau 513: <div class="chapter">
514: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 515: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 516: <div class="toc">
517: <p><b>Table of Contents</b></p>
1.100 leot 518: <dl class="toc">
1.1 dsieger 519: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
520: <dd><dl>
521: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
522: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
523: </dl></dd>
524: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
525: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
526: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
527: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
528: </dl>
529: </div>
1.41 asau 530: <div class="sect1">
1.1 dsieger 531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 532: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.1 dsieger 533: <p>There is a lot of software freely available for Unix-based
534: systems, which is usually available in form of the source code. Before
535: such software can be used, it needs to be configured to the local
536: system, compiled and installed, and this is exactly what The NetBSD
537: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
538: to handle binary packages, so that not every user has to build the
539: packages for himself, which is a time-costly task.</p>
540: <p>pkgsrc currently contains several thousand packages,
541: including:</p>
1.41 asau 542: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 543: <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.1 dsieger 544: web server</p></li>
1.207 leot 545: <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.1 dsieger 546: web browser</p></li>
1.207 leot 547: <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.1 dsieger 548: Desktop Environment</p></li>
1.207 leot 549: <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.1 dsieger 550: Desktop Environment</p></li>
551: </ul></div>
1.266 martin 552: <p>… just to name a few.</p>
1.1 dsieger 553: <p>pkgsrc has built-in support for handling varying dependencies,
554: such as pthreads and X11, and extended features such as IPv6 support on
555: a range of platforms.</p>
1.41 asau 556: <div class="sect2">
1.1 dsieger 557: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 558: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
1.1 dsieger 559: <p>
560: pkgsrc provides the following key features:
561: </p>
1.41 asau 562: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 563: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 564: and installation of binary packages. The source and latest
565: patches are retrieved from a master or mirror download site, checksum
566: verified, then built on your system. Support for binary-only
567: distributions is available for both native platforms and NetBSD
568: emulated platforms.</p></li>
1.23 wiz 569: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 570: including binaries, libraries, man pages and other
571: documentation.</p></li>
1.104 sevan 572: <li class="listitem"><p>Tracking of package dependencies automatically, including when
573: performing updates, to ensure required packages are installed. The
574: configuration files of various packages are handled automatically during
575: updates, so local changes are preserved.</p></li>
1.23 wiz 576: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 577: consists of highly portable code. This allows the greatest speed of
1.25 spz 578: development when porting to a new platform. This portability also
1.1 dsieger 579: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
580: platforms</em></span>.</p></li>
1.23 wiz 581: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 582: international encryption requirements and build-time options for a
583: large number of packages are all set in a simple, central
584: configuration file.</p></li>
1.23 wiz 585: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 586: freely available under a BSD license, so you may extend and adapt
587: pkgsrc to your needs. Support for local packages and patches is
588: available right out of the box, so you can configure it specifically
589: for your environment.</p></li>
590: </ul></div>
591: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 592: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.266 martin 593: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 594: — That means, if a package contains bugs, it's better to find
1.1 dsieger 595: them and to complain about them rather than to just install the package
596: and hope that it works. There are numerous checks in pkgsrc that try to
1.207 leot 597: 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.1 dsieger 598: of shell scripts), and post-installation checks (installed files,
599: references to shared libraries, script interpreters).</p></li>
1.266 martin 600: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 601: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 602: pkgsrc has been ported to many operating systems. Care is taken that
603: packages behave the same on all platforms.</p></li>
604: </ul></div>
605: </div>
1.41 asau 606: <div class="sect2">
1.1 dsieger 607: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 608: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
1.1 dsieger 609: <p>pkgsrc consists of both a source distribution and a binary
610: distribution for these operating systems. After retrieving the required
611: source or binaries, you can be up and running with pkgsrc in just
612: minutes!</p>
613: <p>pkgsrc was derived from FreeBSD's ports system, and
614: initially developed for NetBSD only. Since then, pkgsrc has
615: grown a lot, and now supports the following platforms:</p>
616: <div class="table">
1.266 martin 617: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 618: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 619: <colgroup>
620: <col>
621: <col>
1.92 sevan 622: <col>
1.1 dsieger 623: </colgroup>
624: <thead><tr>
625: <th>Platform</th>
626: <th>Date Support Added</th>
1.92 sevan 627: <th>Notes</th>
1.1 dsieger 628: </tr></thead>
629: <tbody>
630: <tr>
1.174 leot 631: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 632: <td align="center">Aug 1997</td>
1.266 martin 633: <td class="auto-generated"> </td>
1.1 dsieger 634: </tr>
635: <tr>
1.10 hubertf 636: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 637: <td align="center">Mar 1999</td>
1.151 sevan 638: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1 dsieger 639: </tr>
640: <tr>
1.174 leot 641: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 642: <td align="center">Jun 1999</td>
1.151 sevan 643: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1 dsieger 644: </tr>
645: <tr>
646: <td>
1.118 sevan 647: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 648: </td>
649: <td align="center">Oct 2001</td>
1.191 bacon 650: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.1 dsieger 651: </tr>
652: <tr>
1.174 leot 653: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 654: <td align="center">Nov 2002</td>
1.151 sevan 655: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1 dsieger 656: </tr>
657: <tr>
1.174 leot 658: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 659: <td align="center">Nov 2002</td>
1.151 sevan 660: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1 dsieger 661: </tr>
662: <tr>
1.174 leot 663: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 664: <td align="center">Dec 2002</td>
1.92 sevan 665: <td>
1.151 sevan 666: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.92 sevan 667: </td>
1.1 dsieger 668: </tr>
669: <tr>
670: <td>BSD/OS</td>
671: <td align="center">Dec 2003</td>
1.262 dholland 672: <td align="center">Removed from pkgsrc Mar 2025</td>
1.1 dsieger 673: </tr>
674: <tr>
1.174 leot 675: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 676: <td align="center">Dec 2003</td>
1.151 sevan 677: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1 dsieger 678: </tr>
679: <tr>
680: <td>
1.174 leot 681: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 682: (Microsoft Windows Services for Unix)
683: </td>
684: <td align="center">Mar 2004</td>
1.264 wiz 685: <td align="center">Removed from pkgsrc Apr 2025</td>
1.1 dsieger 686: </tr>
687: <tr>
1.174 leot 688: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 689: <td align="center">Oct 2004</td>
1.266 martin 690: <td class="auto-generated"> </td>
1.1 dsieger 691: </tr>
692: <tr>
1.10 hubertf 693: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 694: <td align="center">Nov 2004</td>
1.151 sevan 695: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1 dsieger 696: </tr>
697: <tr>
1.174 leot 698: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 699: <td align="center">Apr 2007</td>
1.151 sevan 700: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1 dsieger 701: </tr>
1.23 wiz 702: <tr>
1.174 leot 703: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.23 wiz 704: <td align="center">Sep 2010</td>
1.151 sevan 705: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23 wiz 706: </tr>
1.45 obache 707: <tr>
1.174 leot 708: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 709: <td align="center">Jan 2011</td>
1.262 dholland 710: <td align="center">Removed from pkgsrc Mar 2025</td>
1.45 obache 711: </tr>
712: <tr>
1.174 leot 713: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.45 obache 714: <td align="center">Nov 2011</td>
1.151 sevan 715: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45 obache 716: </tr>
717: <tr>
1.174 leot 718: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.45 obache 719: <td align="center">Mar 2013</td>
1.151 sevan 720: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45 obache 721: </tr>
1.58 ryoon 722: <tr>
1.174 leot 723: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.58 ryoon 724: <td align="center">Jul 2013</td>
1.261 maya 725: <td>Removed from pkgsrc Mar 2025</td>
1.58 ryoon 726: </tr>
1.104 sevan 727: <tr>
1.174 leot 728: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.104 sevan 729: <td align="center">Jun 2014</td>
1.229 gutterid 730: <td>Removed from pkgsrc Sep 2022</td>
1.104 sevan 731: </tr>
1.1 dsieger 732: </tbody>
733: </table></div>
734: </div>
735: <br class="table-break">
736: </div>
737: </div>
1.41 asau 738: <div class="sect1">
1.1 dsieger 739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 740: <a name="overview"></a>1.2. Overview</h2></div></div></div>
1.1 dsieger 741: <p>This document is divided into three parts. The first,
1.266 martin 742: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 743: describes how one can use one of the packages in the Package
744: Collection, either by installing a precompiled binary package,
745: or by building one's own copy using the NetBSD package system.
1.266 martin 746: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1 dsieger 747: package so it can be easily built by other NetBSD users without
748: knowing about the package's building details. The third part,
1.266 martin 749: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 750: is intended for those who want to understand how pkgsrc is
751: implemented.</p>
752: <p>This document is available in various formats:
1.10 hubertf 753: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1 dsieger 754: </div>
1.41 asau 755: <div class="sect1">
1.1 dsieger 756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 757: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
758: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
759: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 760: terminology used within this document.</p>
1.41 asau 761: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 762: <dt><span class="term">Package</span></dt>
763: <dd><p>A set of files and building instructions
764: that describe what's necessary
765: to build a certain piece of software using
766: pkgsrc. Packages are traditionally stored under
1.123 wiz 767: <code class="filename">/usr/pkgsrc</code>,
768: but may be stored in any location,
769: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1 dsieger 770: <dt><span class="term">The NetBSD package system</span></dt>
1.266 martin 771: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 772: is part of the NetBSD operating system and can be bootstrapped
773: to run on non-NetBSD operating systems as well. It handles
774: building (compiling), installing, and removing of
775: packages.</p></dd>
776: <dt><span class="term">Distfile</span></dt>
777: <dd><p>This term describes the file or files that are
778: provided by the author of the piece of software to
779: distribute his work. All the changes necessary to build on
780: NetBSD are reflected in the corresponding package. Usually
781: the distfile is in the form of a compressed tar-archive,
782: but other types are possible, too. Distfiles are usually
783: stored below
784: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
785: <dt><span class="term">Port</span></dt>
786: <dd><p>This is the term used by FreeBSD and OpenBSD people
787: for what we call a package.
1.266 martin 788: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 789: architecture.</p></dd>
790: <dt><span class="term">Precompiled/binary package</span></dt>
791: <dd>
792: <p>A set of binaries built with pkgsrc from a distfile
793: and stuffed together in a single <code class="filename">.tgz</code>
794: file so it can be installed on machines of the same
795: machine architecture without the need to
796: recompile. Packages are usually generated in
797: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 798: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.266 martin 799: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 800: especially in the context of precompiled packages.</p>
801: </dd>
802: <dt><span class="term">Program</span></dt>
803: <dd><p>The piece of software to be installed which will be
804: constructed from all the files in the distfile by the
805: actions defined in the corresponding package.</p></dd>
806: </dl></div>
1.41 asau 807: <div class="sect2">
1.1 dsieger 808: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 809: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 810: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 811: <dt><span class="term">pkgsrc users</span></dt>
812: <dd>
813: <p>The
814: pkgsrc users are people who use the packages provided by pkgsrc.
815: Typically they are system administrators. The people using the
1.266 martin 816: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
817: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 818: <p>There are two kinds of pkgsrc users: Some only want to
819: install pre-built binary packages. Others build the pkgsrc
820: packages from source, either for installing them directly or for
1.266 martin 821: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.1 dsieger 822: documentation.</p>
823: </dd>
824: <dt><span class="term">package maintainers</span></dt>
825: <dd><p>A
1.266 martin 826: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.1 dsieger 827: <dt><span class="term">infrastructure developers</span></dt>
828: <dd><p>These people are involved in all those files
829: that live in the <code class="filename">mk/</code> directory and below.
1.266 martin 830: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.1 dsieger 831: too.</p></dd>
832: </dl></div>
833: </div>
834: </div>
1.41 asau 835: <div class="sect1">
1.1 dsieger 836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 837: <a name="typography"></a>1.4. Typography</h2></div></div></div>
1.1 dsieger 838: <p>When giving examples for commands, shell prompts are used to
839: show if the command should/can be issued as root, or if
1.266 martin 840: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 841: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
842: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.229 gutterid 843: Bourne shell and derivatives.</p>
1.1 dsieger 844: </div>
845: </div>
1.41 asau 846: <div class="part">
1.1 dsieger 847: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 848: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
1.1 dsieger 849: <div class="toc">
850: <p><b>Table of Contents</b></p>
1.100 leot 851: <dl class="toc">
1.154 rillig 852: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
853: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1 dsieger 854: <dd><dl>
1.154 rillig 855: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 856: <dd><dl>
1.154 rillig 857: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
858: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 859: </dl></dd>
1.154 rillig 860: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 861: <dd><dl>
1.154 rillig 862: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
863: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 864: </dl></dd>
865: </dl></dd>
1.154 rillig 866: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 867: <dd><dl>
1.154 rillig 868: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
869: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 870: </dl></dd>
1.154 rillig 871: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 872: <dd><dl>
1.154 rillig 873: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 874: <dd><dl>
1.154 rillig 875: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
876: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 877: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
878: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
879: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
880: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
881: <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>
882: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1 dsieger 883: </dl></dd>
1.154 rillig 884: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 885: <dd><dl>
1.154 rillig 886: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
887: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
888: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 889: </dl></dd>
890: </dl></dd>
1.154 rillig 891: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 892: <dd><dl>
1.154 rillig 893: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
894: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 895: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
896: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
897: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
898: <dd><dl>
899: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
900: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
901: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 902: </dl></dd>
1.241 rillig 903: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
904: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 905: </dl></dd>
1.154 rillig 906: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 907: <dd><dl>
1.154 rillig 908: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
909: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 910: </dl></dd>
1.154 rillig 911: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 912: builds)</a></span></dt>
1.1 dsieger 913: <dd><dl>
1.154 rillig 914: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 915: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 916: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
1.272 ! wiz 917: <dt><span class="sect1"><a href="#bulk.scan">8.3. Speeding up bulk build scans</a></span></dt>
! 918: <dt><span class="sect1"><a href="#bulk.req">8.4. Requirements of a full bulk build</a></span></dt>
! 919: <dt><span class="sect1"><a href="#bulk.var">8.5. Bulk build variants</a></span></dt>
! 920: <dd><dl>
! 921: <dt><span class="sect2"><a href="#bulk.var.confopt">8.5.1. Detect unknown configure options</a></span></dt>
! 922: <dt><span class="sect2"><a href="#bulk.var.comperr">8.5.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
! 923: <dt><span class="sect2"><a href="#bulk.var.builderr">8.5.3. Force compiler options only in the build phase</a></span></dt>
! 924: <dt><span class="sect2"><a href="#bulk.var.dirs">8.5.4. Use custom directories</a></span></dt>
! 925: <dt><span class="sect2"><a href="#bulk.var.warn">8.5.5. Turn warnings into errors</a></span></dt>
! 926: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.5.6. Reject packages for which pkglint reports errors</a></span></dt>
! 927: <dt><span class="sect2"><a href="#bulk.var.strings">8.5.7. Reject packages that contain forbidden strings</a></span></dt>
! 928: <dt><span class="sect2"><a href="#bulk.var.test">8.5.8. Reject packages whose self-test fails</a></span></dt>
! 929: <dt><span class="sect2"><a href="#bulk.var.shvar">8.5.9. Reject packages that use undefined shell variables</a></span></dt>
! 930: <dt><span class="sect2"><a href="#bulk.var.quiet">8.5.10. Turn off verbose logging</a></span></dt>
1.178 rillig 931: </dl></dd>
1.272 ! wiz 932: <dt><span class="sect1"><a href="#creating-cdroms">8.6. Creating a multiple CD-ROM packages collection</a></span></dt>
! 933: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.6.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 934: </dl></dd>
935: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
936: <dd><dl>
937: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
938: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
939: </dl></dd>
940: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
941: <dd><dl>
942: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
943: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
944: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
945: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
946: <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>
947: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
948: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
949: <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>
950: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
1.266 martin 951: <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
952: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
953: <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>
1.221 nia 954: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 955: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
956: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
957: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
958: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
1.266 martin 959: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 960: </dl></dd>
961: </dl>
962: </div>
1.41 asau 963: <div class="chapter">
1.1 dsieger 964: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 965: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
1.154 rillig 966: <p>
967: To get help when using pkgsrc, the definitive source is this
968: document, the pkgsrc guide. If you don't find anything here,
969: there are alternatives:
970: </p>
971: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
972: <li class="listitem">
973: <p>
974: The built-in pkgsrc help, which is available after bootstrapping
1.266 martin 975: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
1.154 rillig 976: help for any topic, such as a variable name like
977: <code class="varname">BUILD_DEFS</code>, a make target like
978: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
979: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.266 martin 980: <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.154 rillig 981: </li>
982: <li class="listitem"><p>
1.163 rillig 983: To see the value of a single variable, run <span class="command"><strong>bmake
984: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
985: </p></li>
986: <li class="listitem"><p>
987: To see the values of the most common variables, run
988: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
989: topic. To see the variables for a single topic, run
990: <span class="command"><strong>bmake
991: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
992: <span class="command"><strong>bmake show-all-fetch</strong></span>.
993: </p></li>
994: <li class="listitem"><p>
1.154 rillig 995: The pkgsrc-users mailing list, to which
996: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
997: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
998: questions</a>.</p></li>
999: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
1.262 dholland 1000: <a class="ulink" href="https://web.libera.chat/" target="_top">via a web browser</a>
1.154 rillig 1001: or by using a specialized chat program such as
1002: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
1003: Pick any user name and join the channel #pkgsrc.</p></li>
1004: </ul></div>
1005: </div>
1006: <div class="chapter">
1007: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 1008: <a name="getting"></a>Chapter 3. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
1.1 dsieger 1009: <div class="toc">
1010: <p><b>Table of Contents</b></p>
1.100 leot 1011: <dl class="toc">
1.154 rillig 1012: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 1013: <dd><dl>
1.154 rillig 1014: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
1015: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 1016: </dl></dd>
1.154 rillig 1017: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 1018: <dd><dl>
1.154 rillig 1019: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
1020: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 1021: </dl></dd>
1022: </dl>
1023: </div>
1024: <p>Before you download and extract the files, you need to decide
1025: where you want to extract them. When using pkgsrc as root user, pkgsrc
1026: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
1027: free to install the sources and binary packages wherever you want in
1028: your filesystem, provided that the pathname does not contain white-space
1029: or other characters that are interpreted specially by the shell and some
1030: other programs. A safe bet is to use only letters, digits, underscores
1031: and dashes.</p>
1.41 asau 1032: <div class="sect1">
1.1 dsieger 1033: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1034: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 1035: <p>Before you download any pkgsrc files, you should decide
1036: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1037: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1038: quarterly basis from the current branch and only gets modified
1039: for security updates. The names of the stable branches are built
1040: from the year and the quarter, for example
1.267 leot 1041: <code class="literal">2025Q4</code>.</p>
1.1 dsieger 1042: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 1043: want to download pkgsrc. You can get it as a tar file or via CVS.
1044: Both ways are described here.</p>
1.51 asau 1045: <p>Note that tar archive contains CVS working copy.
1046: Thus you can switch to using CVS at any later time.</p>
1.41 asau 1047: <div class="sect2">
1.1 dsieger 1048: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1049: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 1050: <p>The primary download location for all pkgsrc files is
1.151 sevan 1051: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 1052: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1053: (it points to the same location).
1054: There are a number of subdirectories for different purposes,
1.266 martin 1055: 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.51 asau 1056: <p>The tar archive for the current branch is in the directory
1.151 sevan 1057: <code class="filename">current</code> and is called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.118 sevan 1058: It is autogenerated weekly.</p>
1.51 asau 1059: <p>To save download time we provide bzip2- and
1060: xz-compressed archives which are published at
1.151 sevan 1061: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
1.51 asau 1062: and
1.151 sevan 1063: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
1.51 asau 1064: respectively.
1065: </p>
1066: <p>You can fetch the same files using FTP.</p>
1.267 leot 1067: <p>The tar file for the stable branch 2025Q4 is in the
1068: directory <code class="filename">pkgsrc-2025Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2025Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136 leot 1069: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 1070: <pre class="screen">
1.267 leot 1071: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2025Q4/pkgsrc.tar.gz</code></strong></pre>
1.78 snj 1072: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1073: or your web browser.</p>
1.12 weinem 1074: <p>Then, extract it with:</p>
1.78 snj 1075: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1076: <p>This will create the directory <code class="filename">pkgsrc/</code>
1077: in <code class="filename">/usr/</code> and all the package source will be
1078: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1079: <p>To download pkgsrc-current, run:</p>
1080: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1 dsieger 1081: </div>
1.41 asau 1082: <div class="sect2">
1.1 dsieger 1083: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1084: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1085: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.267 leot 1086: <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-2025Q4 -P pkgsrc</code></strong>
1.23 wiz 1087: </pre>
1088: <p>This will create the directory <code class="filename">pkgsrc/</code>
1089: in your <code class="filename">/usr/</code> directory and all the package source
1090: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1091: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1092: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1093: </pre>
1.174 leot 1094: <p>Refer to the <a class="ulink" href="https://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23 wiz 1095: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39 wiz 1096: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23 wiz 1097: </pre>
1098: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1099: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1100: or better globally in <code class="filename">/etc/profile</code>:</p>
1101: <pre class="programlisting">
1102: # set CVS remote shell command
1103: CVS_RSH=ssh
1104: export CVS_RSH
1105: </pre>
1106: <p>By default, CVS doesn't do things like most people would expect it to do.
1107: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1108: in your home directory and saving the following lines to it.
1109: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1110: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1111: <pre class="programlisting">
1112: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1113: cvs -q
1.2 rillig 1114: checkout -P
1.4 rillig 1115: update -dP
1116: diff -upN
1.2 rillig 1117: rdiff -u
1.23 wiz 1118: release -d
1.2 rillig 1119: </pre>
1.1 dsieger 1120: </div>
1121: </div>
1.41 asau 1122: <div class="sect1">
1.1 dsieger 1123: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1124: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1125: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1126: (which also works if you have first installed it via a tar
1127: file). It saves bandwidth and hard disk activity, compared to
1128: downloading the tar file again.</p>
1.41 asau 1129: <div class="sect2">
1.1 dsieger 1130: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1131: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1132: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1133: <h3 class="title">Warning</h3>
1134: <p>When updating from a tar file, you first need to
1135: completely remove the old pkgsrc directory. Otherwise those
1136: files that have been removed from pkgsrc in the mean time will
1137: not be removed on your local disk, resulting in inconsistencies.
1138: When removing the old files, any changes that you have done to
1139: the pkgsrc files will be lost after updating. Therefore updating
1140: via CVS is strongly recommended.</p>
1141: </div>
1142: <p>Note that by default the distfiles and the binary packages
1143: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1144: before updating. You can also configure pkgsrc to store distfiles
1145: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1146: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.266 martin 1147: variables. See <a class="xref" href="#configuring" title="Chapter 6. Configuring pkgsrc">Chapter 6, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1 dsieger 1148: <p>To update pkgsrc from a tar file, download the tar file as
1149: explained above. Then, make sure that you have not made any
1150: changes to the files in the pkgsrc directory. Remove the pkgsrc
1151: directory and extract the new tar file. Done.</p>
1152: </div>
1.41 asau 1153: <div class="sect2">
1.1 dsieger 1154: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1155: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1156: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1157: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1158: </pre>
1159: <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>
1160: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1161: </pre>
1.41 asau 1162: <div class="sect3">
1.1 dsieger 1163: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 1164: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1165: <p>When updating pkgsrc, the CVS program keeps track of the
1166: branch you selected. But if you, for whatever reason, want to
1167: switch from the stable branch to the current one, you can do it
1.266 martin 1168: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1169: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1170: back to the stable branch, add the
1.267 leot 1171: <span class="quote">“<span class="quote">-rpkgsrc-2025Q4</span>”</span> option.</p>
1.1 dsieger 1172: </div>
1.41 asau 1173: <div class="sect3">
1.1 dsieger 1174: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 1175: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1176: <p>When you update pkgsrc, the CVS program will only touch
1177: those files that are registered in the CVS repository. That
1178: means that any packages that you created on your own will stay
1179: unmodified. If you change files that are managed by CVS, later
1180: updates will try to merge your changes with those that have been
1181: done by others. See the CVS manual, chapter
1.266 martin 1182: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1183: </div>
1184: </div>
1185: </div>
1186: </div>
1.41 asau 1187: <div class="chapter">
1.1 dsieger 1188: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 1189: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1190: <div class="toc">
1191: <p><b>Table of Contents</b></p>
1.100 leot 1192: <dl class="toc">
1.154 rillig 1193: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1194: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1195: </dl>
1196: </div>
1.41 asau 1197: <div class="sect1">
1.1 dsieger 1198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1199: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1200: <p>See <a class="xref" href="#using-pkg" title="5.1. Using binary packages">Section 5.1, “Using binary packages”</a>.</p>
1.1 dsieger 1201: </div>
1.41 asau 1202: <div class="sect1">
1.1 dsieger 1203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1204: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1205: <p>pkgsrc can be bootstrapped for use in two different modes:
1206: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1207: to privileged one all programs are installed under one particular user
1.43 asau 1208: and cannot utilise privileged operations (packages don't create
1209: special users and all special file permissions like setuid are ignored).
1210: </p>
1.1 dsieger 1211: <p>Installing the bootstrap kit from source should be as simple as:</p>
1212: <pre class="screen">
1.60 asau 1213: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1214: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1215: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1216: </pre>
1.266 martin 1217: <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>
1.43 asau 1218: <p>By default, in privileged mode pkgsrc uses
1219: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1220: where programs will be installed in,
1.118 sevan 1221: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1222: directory where pkgsrc will do its internal bookkeeping,
1223: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1224: where packages install their persistent data.
1225: In unprivileged mode pkgsrc uses
1226: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1227: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1228: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1229: </p>
1230: <p>You can change default layout using command-line arguments.
1.266 martin 1231: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1.43 asau 1232: </p>
1.41 asau 1233: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1234: <h3 class="title">Note</h3>
1.10 hubertf 1235: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1236: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1237: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.266 martin 1238: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1239: </div>
1.43 asau 1240: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1241: <h3 class="title">Note</h3>
1242: <p>It is possible to bootstrap multiple instances of pkgsrc
1243: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1244: corresponding to the installation you're working with to build
1245: and install packages.
1246: </p>
1247: </div>
1.1 dsieger 1248: </div>
1249: </div>
1.41 asau 1250: <div class="chapter">
1.1 dsieger 1251: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 1252: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1253: <div class="toc">
1254: <p><b>Table of Contents</b></p>
1.100 leot 1255: <dl class="toc">
1.154 rillig 1256: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1257: <dd><dl>
1.154 rillig 1258: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1259: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 1260: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1261: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1262: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1263: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1264: <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>
1265: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.154 rillig 1266: </dl></dd>
1267: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1268: <dd><dl>
1269: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1270: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1271: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 1272: </dl></dd>
1273: </dl>
1274: </div>
1275: <p>Basically, there are two ways of using pkgsrc. The first
1276: is to only install the package tools and to use binary packages
1.266 martin 1277: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1278: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1279: of pkgsrc, too. Then you are able to build your own packages,
1280: and you can still use binary packages from someone else.</p>
1.41 asau 1281: <div class="sect1">
1.1 dsieger 1282: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1283: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.202 nia 1284: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.151 sevan 1285: site and mirrors, there are collections of binary packages,
1.9 rillig 1286: ready to be installed. These binary packages have been built using the
1287: default settings for the directories, that is:</p>
1.41 asau 1288: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1289: <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>
1290: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1291: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.9 rillig 1292: </ul></div>
1293: <p>If you cannot use these directories for whatever reasons (maybe
1294: because you're not root), you cannot use these binary packages, but
1.266 martin 1295: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="4.2. Bootstrapping pkgsrc">Section 4.2, “Bootstrapping pkgsrc”</a>.</p>
1.41 asau 1296: <div class="sect2">
1.1 dsieger 1297: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1298: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1299: <p>To install binary packages, you first need to know from where
1300: to get them. The first place where you should look is on the main
1.202 nia 1301: pkgsrc CDN in the directory <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5 weinem 1302: <p>This directory contains binary packages for multiple
1.226 gutterid 1303: platforms. First, select your operating system. Then, select your
1304: hardware architecture, and in the third step, the OS version and
1.266 martin 1305: the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.226 gutterid 1306: <p>In this directory, you may find a file called
1.9 rillig 1307: <code class="filename">bootstrap.tar.gz</code> which contains the package
1308: management tools. If the file is missing, it is likely that your
1309: operating system already provides those tools. Download the file and
1310: extract it in the <code class="filename">/</code> directory. It will create
1311: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1312: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1313: </div>
1.41 asau 1314: <div class="sect2">
1.1 dsieger 1315: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1316: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1317: <p>In the directory from the last section, there is a
1.85 wiz 1318: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1319: binary packages that are available for the platform, excluding those
1.202 nia 1320: that may not be distributed via HTTP or FTP.</p>
1.9 rillig 1321: <p>To install packages directly from an FTP or HTTP server, run
1322: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1323: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1324: <pre class="screen">
1.202 nia 1325: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1326: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.169 rillig 1327: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="$PKG_PATH/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.9 rillig 1328: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.202 nia 1329: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.9 rillig 1330: </pre>
1331: <p>Instead of URLs, you can also use local paths, for example if
1332: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1333: repository. If you want to install packages from multiple sources,
1334: you can separate them by a semicolon in
1335: <code class="varname">PKG_PATH</code>.</p>
1336: <p>After these preparations, installing a package is very
1337: easy:</p>
1338: <pre class="screen">
1.202 nia 1339: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1340: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1341: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1342: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1343: </pre>
1344: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1345: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1346: <p>Any prerequisite packages needed to run the
1.1 dsieger 1347: package in question will be installed, too, assuming they are
1.202 nia 1348: present in the repository.</p>
1.1 dsieger 1349: <p>After you've installed packages, be sure to have
1350: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1351: <code class="varname">PATH</code> so you can actually start the just
1352: installed program.</p>
1353: </div>
1.41 asau 1354: <div class="sect2">
1.1 dsieger 1355: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1356: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1.202 nia 1357: <p>To update binary packages, it is recommended that you use
1358: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1359: package repository to your locally installed packages and safely
1360: replace any older packages.</p>
1361: <p>Note that pkgsrc is released as quarterly branches.
1362: If you are updating to a newer quarterly branch of pkgsrc, you may
1363: need to adjust the repository in
1364: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1365: </div>
1366: <div class="sect2">
1367: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1368: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1369: <p>To deinstall a package, it does not matter whether it was
1.202 nia 1370: installed from source code or from a binary package. Neither the
1371: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1372: command need to know.</p>
1373: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.1 dsieger 1374: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.202 nia 1375: name can be given with or without version number.</p>
1.1 dsieger 1376: </div>
1.41 asau 1377: <div class="sect2">
1.1 dsieger 1378: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1379: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1380: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.202 nia 1381: installed packages or binary package files.
1382: As with other management tools, it works with packages installed
1383: from source or binaries.</p>
1.1 dsieger 1384: </div>
1.41 asau 1385: <div class="sect2">
1.1 dsieger 1386: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1387: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1388: <p>
1.164 leot 1389: The pkgsrc Security Team and Packages Groups maintain a list of
1.202 nia 1390: known vulnerabilities to packages which are (or have been)
1.1 dsieger 1391: included in pkgsrc. The list is available from the NetBSD
1.202 nia 1392: 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>.
1393: </p>
1394: <p>
1395: Please note that not every "vulnerability" with a CVE assignment is
1396: exploitable in every configuration.
1397: Some bugs are marked as active simply because an fix was not
1398: marked as such.
1399: Operating system specific hardening and mitigation features may also
1400: reduce the impact of bugs.
1.1 dsieger 1401: </p>
1402: <p>
1.22 jakllsch 1403: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1404: this list can be downloaded
1405: automatically, and a security audit of all packages installed on a system
1406: can take place.
1407: </p>
1408: <p>
1.22 jakllsch 1409: There are two components to auditing. The first
1410: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1411: is for downloading
1.1 dsieger 1412: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1413: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1414: installed packages are vulnerable. If a package is vulnerable, you
1415: will see output similar to the following:
1416: </p>
1417: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1418: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.1 dsieger 1419: <p>
1.22 jakllsch 1420: You may wish to have the
1.202 nia 1421: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1422: file downloaded daily so that
1423: it remains current. This may be done by adding an appropriate entry
1.259 leot 1424: to the root users <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1425: </p>
1426: <pre class="screen">
1.121 sevan 1427: # Download vulnerabilities file
1.118 sevan 1428: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1429: # Audit the installed packages and email results to root
1430: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1431: root >/dev/null 2>&1
1.22 jakllsch 1432: </pre>
1433: <p>
1.118 sevan 1434: will update the vulnerability list every day at 3AM, followed by an audit
1435: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1436:
1.118 sevan 1437: On NetBSD this may be accomplished instead by adding the following
1438: line to <code class="filename">/etc/daily.conf</code>:
1439: </p>
1440: <pre class="screen">
1441: fetch_pkg_vulnerabilities=YES
1442: </pre>
1443: <p>
1444: to fetch the vulnerability list from the daily security script. The system
1445: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1446: desired (not required), by adding the following line to
1.118 sevan 1447: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1448: </p>
1449: <pre class="screen">
1.118 sevan 1450: check_pkg_vulnerabilities=YES
1.22 jakllsch 1451: </pre>
1452: <p>
1.259 leot 1453: see <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.1 dsieger 1454: </p>
1455: </div>
1.41 asau 1456: <div class="sect2">
1.1 dsieger 1457: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1458: <a name="pkg_versions"></a>5.1.7. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.1 dsieger 1459: <p>
1.207 leot 1460: 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.266 martin 1461: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.202 nia 1462: argument to check if any packages are stale, e.g.
1.1 dsieger 1463: </p>
1464: <pre class="screen">
1465: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1466: ...
1467: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1468: </pre>
1469: </div>
1.41 asau 1470: <div class="sect2">
1.1 dsieger 1471: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1472: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.10 hubertf 1473: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1474: administrative functions on the package system.</p>
1475: </div>
1476: </div>
1.41 asau 1477: <div class="sect1">
1.1 dsieger 1478: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1479: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1 dsieger 1480: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1481: directory now contains a set of packages, organized into
1482: categories. You can browse the online index of packages, or run
1.10 hubertf 1483: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1484: directory to build local <code class="filename">README.html</code> files for
1.207 leot 1485: 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.1 dsieger 1486: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1487: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1488: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1489: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1490: different <code class="varname">LOCALBASE</code> definitions on the same
1491: system (inside a chroot is an exception). </p>
1492: <p>The rest of this chapter assumes that the package is already
1.266 martin 1493: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.1 dsieger 1494: instructions how to create your own packages.</p>
1.41 asau 1495: <div class="sect2">
1.1 dsieger 1496: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1497: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1 dsieger 1498: <p>To build packages from source, you need a working C
1499: compiler. On NetBSD, you need to install the
1.266 martin 1500: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1501: sets. If you want to build X11-related packages, the
1.266 martin 1502: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1503: sets are required, too.</p>
1504: </div>
1.41 asau 1505: <div class="sect2">
1.1 dsieger 1506: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1507: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1 dsieger 1508: <p>The first step for building a package is downloading the
1509: distfiles (i.e. the unmodified source). If they have not yet been
1510: downloaded, pkgsrc will fetch them automatically.</p>
1511: <p>If you have all files that you need in the
1512: <code class="filename">distfiles</code> directory,
1513: you don't need to connect. If the distfiles are on CD-ROM, you can
1514: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1515: </p>
1516: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1517: <p>
1.10 hubertf 1518: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1519: <p>By default a list of distribution sites will be randomly
1520: intermixed to prevent huge load on servers which holding popular
1521: packages (for example, SourceForge.net mirrors). Thus, every
1522: time when you need to fetch yet another distfile all the mirrors
1523: will be tried in new (random) order. You can turn this feature
1524: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1525: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1526: <p>You can overwrite some of the major distribution sites to
1527: fit to sites that are close to your own. By setting one or two
1528: variables you can modify the order in which the master sites are
1529: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1530: delimited list of domain suffixes.
1531: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1532: contains a whitespace delimited list of regular expressions. It
1533: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1534: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1535: some examples. This may save some of your bandwidth and
1536: time.</p>
1537: <p>You can change these settings either in your shell's environment, or,
1538: if you want to keep the settings, by editing the
1.10 hubertf 1539: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1540: and adding the definitions there.</p>
1541: <p>
1542: If a package depends on many other packages (such as
1.207 leot 1543: <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.1 dsieger 1544: alternate between periods of
1545: downloading source, and compiling. To ensure you have all the source
1546: downloaded initially you can run the command:
1547: </p>
1548: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1549: <p>
1550: which will output and run a set of shell commands to fetch the
1551: necessary files into the <code class="filename">distfiles</code> directory. You can
1552: also choose to download the files manually.
1553: </p>
1554: </div>
1.41 asau 1555: <div class="sect2">
1.1 dsieger 1556: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1557: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1 dsieger 1558: <p>
1559: Once the software has downloaded, any patches will be applied, then it
1560: will be compiled for you. This may take some time depending on your
1561: computer, and how many other packages the software depends on and their
1562: compile time.
1563: </p>
1.41 asau 1564: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1565: <h3 class="title">Note</h3>
1566: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1567: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.266 martin 1568: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1569: </div>
1570: <p>For example, type</p>
1571: <pre class="screen">
1572: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1573: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1574: </pre>
1575: <p>at the shell prompt to build the various components of the
1576: package.</p>
1577: <p>The next stage is to actually install the newly compiled
1578: program onto your system. Do this by entering:
1579:
1580: </p>
1581: <pre class="screen">
1582: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1583: </pre>
1584: <p>
1585:
1586: while you are still in the directory for whatever package you
1587: are installing.</p>
1588: <p>Installing the package on your system may require you to
1589: be root. However, pkgsrc has a
1590: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1591: to only become root for the actual installation step.</p>
1592: <p>That's it, the software should now be installed and setup for use.
1593: You can now enter:
1594:
1595: </p>
1596: <pre class="screen">
1597: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1598: </pre>
1599: <p>
1600:
1601: to remove the compiled files in the work directory, as you shouldn't need
1602: them any more. If other packages were also added to your system
1603: (dependencies) to allow your program to compile, you can tidy these up
1604: also with the command:</p>
1605: <pre class="screen">
1606: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1607: </pre>
1608: <p>Taking the figlet utility as an example, we can install it on our
1.266 martin 1609: 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.1 dsieger 1610: <p>The program is installed under the default root of the
1611: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1612: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1613: variable in your environment, and it will use that value as the
1614: root of your packages tree. So, to use
1615: <code class="filename">/usr/local</code>, set
1616: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1617: Please note that you should use a directory which is dedicated to
1618: packages and not shared with other programs (i.e., do not try and
1619: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1620: to add any of your own files or directories (such as
1621: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1622: <code class="filename">pkgsrc/</code>) below the
1623: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1624: conflicts between programs and other files installed by the
1625: package system and whatever else may have been installed
1626: there.</p>
1.10 hubertf 1627: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1628: alter some configuration options at build time. Have a look at
1629: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1630: of what will be set there by default. Environment variables such
1631: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1632: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1633: set them each time you want to use pkgsrc.</p>
1.266 martin 1634: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1635: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1636: or being installed. This may be for debugging purposes, or out of
1637: simple curiosity. A number of utility values have been added to
1638: help with this.</p>
1.23 wiz 1639: <div class="orderedlist"><ol class="orderedlist" type="1">
1640: <li class="listitem">
1.259 leot 1641: <p>If you invoke the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 1642: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1643: information will be displayed. For example,</p>
1644: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1645: <p>will show all the commands that are invoked, up to and
1.266 martin 1646: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1647: </li>
1.23 wiz 1648: <li class="listitem">
1.259 leot 1649: <p>If you want to know the value of a certain <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1650: definition, then the <code class="varname">VARNAME</code> definition
1651: should be used, in conjunction with the show-var
1.259 leot 1652: target. e.g. to show the expansion of the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1653: variable <code class="varname">LOCALBASE</code>:</p>
1654: <pre class="screen">
1655: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1656: /usr/pkg
1657: <code class="prompt">%</code>
1658: </pre>
1659: </li>
1660: </ol></div>
1661: <p>If you want to install a binary package that you've either
1662: created yourself (see next section), that you put into
1663: pkgsrc/packages manually or that is located on a remote FTP
1664: server, you can use the "bin-install" target. This target will
1.259 leot 1665: install a binary package - if available - via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 1666: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1667: sites searched is kept in the variable
1668: <code class="varname">BINPKG_SITES</code>, which defaults to
1.259 leot 1669: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 1670: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1671: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1672: details.</p>
1673: <p>A final word of warning: If you set up a system that has a
1674: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1675: set that before any packages are installed, as you cannot use
1676: several directories for the same purpose. Doing so will result in
1677: pkgsrc not being able to properly detect your installed packages,
1678: and fail miserably. Note also that precompiled binary packages are
1679: usually built with the default <code class="varname">LOCALBASE</code> of
1680: <code class="filename">/usr/pkg</code>, and that you should
1681: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1682: <code class="varname">LOCALBASE</code>.</p>
1683: </div>
1684: </div>
1685: </div>
1.41 asau 1686: <div class="chapter">
1.1 dsieger 1687: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 1688: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1 dsieger 1689: <div class="toc">
1690: <p><b>Table of Contents</b></p>
1.100 leot 1691: <dl class="toc">
1.154 rillig 1692: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1693: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 1694: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
1695: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
1696: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
1697: <dd><dl>
1698: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
1699: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1700: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 1701: </dl></dd>
1.241 rillig 1702: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
1703: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 1704: </dl>
1705: </div>
1.4 rillig 1706: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1707: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1708: that file depends on the installation. On NetBSD, when you use
1.259 leot 1709: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 1710: <code class="filename">/etc/</code>. In all other cases the default location is
1711: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1712: bootstrap program to install the binary packages.</p>
1713: <p>The format of the configuration file is that of the usual
1714: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1715: is done by setting variables in this file. Note that you can define all
1716: kinds of variables, and no special error checking (for example for
1.112 rillig 1717: spelling mistakes) takes place.</p>
1.41 asau 1718: <div class="sect1">
1.1 dsieger 1719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1720: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112 rillig 1721: <p>The following variables apply to all
1.1 dsieger 1722: pkgsrc packages. A complete list of the variables that can be
1723: configured by the user is available in
1724: <code class="filename">mk/defaults/mk.conf</code>, together with some
1725: comments that describe each variable's intent.</p>
1.41 asau 1726: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1727: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1728: packages will be installed. The default is
1729: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1730: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1731: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1.266 martin 1732: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1733: installed. The default is
1734: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1735: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1736: X11 is installed on the system. The default is
1.84 wiz 1737: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1738: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1739: downloaded copies of the original source distributions used
1740: for building pkgsrc packages. The default is
1741: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1742: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1743: database about installed packages is stored. The default is
1.118 sevan 1744: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1745: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1746: If set, override the packages'
1747: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1748: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1749: Backup location(s) for distribution files and patch files
1750: if not found locally or in
1751: <code class="filename">${MASTER_SITES}</code> or
1752: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1753: The defaults is
1754: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1755: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1756: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1757: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.266 martin 1758: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1759: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1.23 wiz 1760: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1761: List of acceptable licenses. License names are case-sensitive.
1762: Whenever you try to build a package whose license is not in this
1763: list, you will get an error message. If the license condition is
1764: simple enough, the error message will include specific
1765: instructions on how to change this variable.</p></li>
1.1 dsieger 1766: </ul></div>
1767: </div>
1.41 asau 1768: <div class="sect1">
1.1 dsieger 1769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1770: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1771: <p>
1.1 dsieger 1772: </p>
1.41 asau 1773: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1774: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1775: directory for the binary packages. The default is
1776: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1777: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1778: The top level directory where, if defined, the separate
1779: working directories will get created, and symbolically
1780: linked to from <code class="filename">${WRKDIR}</code> (see below).
1781: This is useful for building packages on several
1782: architectures, then <code class="filename">${PKGSRCDIR}</code>
1783: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1784: is local to every architecture. (It should be noted that
1785: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1786: — it is an internal definition which refers to the
1.1 dsieger 1787: root of the pkgsrc tree. It is possible to have many
1788: pkgsrc tree instances.)</p></li>
1.23 wiz 1789: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1790: Directory for local patches that aren't part of pkgsrc.
1.266 martin 1791: See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> for more
1.1 dsieger 1792: information.</p></li>
1.23 wiz 1793: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1794: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1795: BSD-style Makefile. If this is not set,
1796: <code class="varname">MAKECONF</code> is set to
1797: <code class="filename">/dev/null</code> to avoid picking up
1798: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1799: </ul></div>
1800: </div>
1.41 asau 1801: <div class="sect1">
1.1 dsieger 1802: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1803: <a name="native-or-pkgsrc-preference"></a>6.3. Preferences for native or pkgsrc software</h2></div></div></div>
1.241 rillig 1804: <p>Whenever a package depends on a package that has a
1805: <code class="filename">builtin.mk</code> file, the dependent package can
1806: either use the built-in (native) version from the base system or the
1807: pkgsrc-provided version. This only affects dependencies, so it is
1808: still possible to build the pkgsrc package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pcre++/index.html" target="_top"><code class="filename">devel/pcre++</code></a> even when other packages depend
1809: on the native pcre++ version instead.</p>
1810: <p>To force using the pkgsrc-provided version for a particular
1.266 martin 1811: package, define <span class="quote">“<span class="quote"><code class="varname">PREFER_PKGSRC</code> =
1812: <em class="replaceable"><code>package-ID</code></em></span>”</span> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. To force
1.241 rillig 1813: using the native package, define
1.266 martin 1814: <span class="quote">“<span class="quote"><code class="varname">PREFER_NATIVE</code> =
1815: <em class="replaceable"><code>package-ID</code></em></span>”</span>. In both cases, the
1.241 rillig 1816: <em class="replaceable"><code>package-ID</code></em> is the one from the
1817: <code class="filename">buildlink3.mk</code> of the package. In most cases,
1818: this ID is the same as the directory name of the package, but for
1819: example, <code class="filename">devel/pcre++</code> has the
1.266 martin 1820: package ID <span class="quote">“<span class="quote">pcrexx</span>”</span>.</p>
1.241 rillig 1821: <p>For the packages that are not listed by their package ID,
1822: pkgsrc uses the pkgsrc-provided version if
1823: <code class="varname">PREFER_PKGSRC</code> contains the word
1.266 martin 1824: <span class="quote">“<span class="quote">yes</span>”</span>. Otherwise, if <code class="varname">PREFER_NATIVE</code>
1825: contains the word <span class="quote">“<span class="quote">yes</span>”</span>, pkgsrc uses the native
1.241 rillig 1826: version. For example, to require using the pkgsrc-provided versions
1827: for all but the most basic bits on a NetBSD system, you can
1828: set:</p>
1829: <pre class="programlisting">
1830: PREFER_PKGSRC= yes
1831: PREFER_NATIVE= getopt skey tcp_wrappers
1832: </pre>
1833: <p>A package <span class="emphasis"><em>must</em></span> have a
1834: <code class="filename">builtin.mk</code> file to be listed in
1835: <code class="varname">PREFER_NATIVE</code>, otherwise it is simply ignored in
1836: that list.</p>
1837: <p><code class="varname">PREFER_PKGSRC</code> and
1838: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap to
1839: ensure that the bootstrap process does not use inapropriate native
1840: tools as dependencies for core packages.</p>
1841: <pre class="screen">
1842: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
1843: </pre>
1844: <p>Switching between settings globally at a later date can
1845: introduce complications with dependency resolution. This is caused
1846: by packages built with the opposite preference being installed
1847: alongside each other. Hence, when changing any of these variables
1848: after bootstrap, you need to rebuild all packages depending on those
1849: whose preference has been changed. This is not trivial and should
1850: be avoided.</p>
1851: <p>When using pkgsrc on Linux systems, there is high risk of
1.266 martin 1852: <span class="quote">“<span class="quote">leakage</span>”</span>, where programs installed by pkgsrc may
1.241 rillig 1853: inadvertently use a command or library not installed by pkgsrc, e.g.
1854: those installed by yum or apt. Such foreign dependencies may be
1855: installed, removed, or upgraded to a version incompatible with the
1856: pkgsrc package at any time, causing pkgsrc packages to subsequently
1857: malfunction. Pkgsrc cannot prevent this, as it has no control over
1858: other package managers. Another potential problem is that under
1859: Redhat Enterprise and related Linux systems, yum packages are only
1860: patched and never upgraded, so eventually they may become too
1861: outdated for use by pkgsrc. Even intentionally using foreign
1862: dependencies, not considered leakage, can lead to these problems, so
1863: it is generally discouraged. In order to minimize such problems,
1.266 martin 1864: PREFER_PKGSRC defaults to <span class="quote">“<span class="quote">yes</span>”</span> on Linux systems. This ensures that
1.241 rillig 1865: pkgsrc is aware of any changes to dependency packages and can
1866: rebuild or upgrade the entire dependency tree as needed. This
1867: default can be overridden by setting --prefer-pkgsrc to a
1.266 martin 1868: list of packages and --prefer-native to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.241 rillig 1869: </div>
1870: <div class="sect1">
1871: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1872: <a name="variables-affecting-installation"></a>6.4. Variables affecting the installation process</h2></div></div></div>
1.198 leot 1873: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
1.143 maya 1874: By default, binary packages of built packages are
1.150 leot 1875: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143 maya 1876: this variable to "no" prevents this.</p></li></ul></div>
1.107 jnemeth 1877: <p>Packages have to support installation into a
1.4 rillig 1878: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1879: to be built, before the actual filesystem is touched. DESTDIR
1880: support exists in two variations:</p>
1.41 asau 1881: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1882: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1883: installation and packaging is still run as root.</p></li>
1884: <li class="listitem"><p>Full DESTDIR support can run the complete
1885: build, installation and packaging as normal user. Root
1886: privileges are only needed to add packages.</p></li>
1887: </ul></div>
1.4 rillig 1888: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1889: clean</code></strong> needs to be run as root.</p>
1.17 imil 1890: <p>Considering the <code class="filename">foo/bar</code> package,
1891: DESTDIR full support can be tested using the following commands
1892:
1893: </p>
1894: <pre class="programlisting">
1895: <code class="prompt">$</code> id
1896: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1897: <code class="prompt">$</code> mkdir $HOME/packages
1898: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1899: </pre>
1900: <p>
1901:
1902: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1903: should be needed
1904:
1905: </p>
1906: <pre class="programlisting">
1.66 asau 1907: <code class="prompt">$</code> make stage-install
1.17 imil 1908: </pre>
1909: <p>
1910:
1911: Create a package without root privileges
1912:
1913: </p>
1914: <pre class="programlisting">
1.66 asau 1915: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1916: </pre>
1917: <p>
1918:
1919: For the following command, you must be able to gain root
1.259 leot 1920: privileges using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 1921:
1922: </p>
1923: <pre class="programlisting">
1.66 asau 1924: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1925: </pre>
1926: <p>
1927:
1928: Then, as a simple user
1929:
1930: </p>
1931: <pre class="programlisting">
1932: <code class="prompt">$</code> make clean
1933: </pre>
1934: <p>
1935:
1936: </p>
1.4 rillig 1937: </div>
1.41 asau 1938: <div class="sect1">
1.4 rillig 1939: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 1940: <a name="conf.compiler"></a>6.5. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1941: <div class="sect2">
1.1 dsieger 1942: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 1943: <a name="selecting-the-compiler"></a>6.5.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1944: <p>By default, pkgsrc will use GCC to build packages. This may be
1945: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1946: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1947: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1948: <dd>
1949: <p>This is a list of values specifying the chain of
1950: compilers to invoke when building packages. Valid values
1951: are:</p>
1.41 asau 1952: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1953: <li class="listitem"><p><code class="varname">ccc</code>:
1954: Compaq C Compilers (Tru64)</p></li>
1955: <li class="listitem"><p><code class="varname">ccache</code>:
1956: compiler cache (chainable)</p></li>
1957: <li class="listitem"><p><code class="varname">clang</code>:
1958: Clang C and Objective-C compiler</p></li>
1.23 wiz 1959: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1960: distributed C/C++ (chainable)</p></li>
1.66 asau 1961: <li class="listitem"><p><code class="varname">f2c</code>:
1962: Fortran 77 to C compiler (chainable)</p></li>
1963: <li class="listitem"><p><code class="varname">icc</code>:
1964: Intel C++ Compiler (Linux)</p></li>
1965: <li class="listitem"><p><code class="varname">ido</code>:
1966: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1967: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1968: GNU C/C++ Compiler</p></li>
1.66 asau 1969: <li class="listitem"><p><code class="varname">hp</code>:
1970: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1971: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1972: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1973: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1974: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1975: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1976: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1977: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1978: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1979: </ul></div>
1980: <p>The default is
1.266 martin 1981: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1982: <code class="varname">ccache</code> and/or
1983: <code class="varname">distcc</code> with an appropriate
1984: <code class="varname">PKGSRC_COMPILER</code> setting,
1.266 martin 1985: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1986: variable should always be terminated with a value for
1987: a real compiler. Note that only one real compiler
1.266 martin 1988: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1989: is not allowed).</p>
1990: </dd>
1991: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1992: <dd><p>This specifies the minimum version of GCC to use
1993: when building packages. If the system GCC doesn't
1994: satisfy this requirement, then pkgsrc will build and
1995: install one of the GCC packages to use instead.</p></dd>
1.153 leot 1996: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114 maya 1997: <dd><p>Specifies which version of python to use when several
1998: options are available.</p></dd>
1999: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.176 gutterid 2000: <dd><p>Specifies the Fortran compiler to use.
2001: The default is <code class="varname">gfortran</code>.</p></dd>
1.114 maya 2002: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
2003: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
2004: <code class="varname">gfortran</code> is used, this option specifies which
2005: version to use.</p></dd>
1.1 dsieger 2006: </dl></div>
2007: </div>
1.41 asau 2008: <div class="sect2">
1.1 dsieger 2009: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 2010: <a name="conf.cflags"></a>6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2011: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2012: please make sure to use the <code class="literal">+=</code> operator
2013: instead of the <code class="literal">=</code> operator:</p>
2014: <pre class="programlisting">
2015: CFLAGS+= -your -flags
2016: </pre>
2017: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.266 martin 2018: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 2019: need to add their own flags. You may want to take a look
1.207 leot 2020: 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.23 wiz 2021: package if you're interested in optimization specifically
2022: for the current CPU. </p>
1.1 dsieger 2023: </div>
1.41 asau 2024: <div class="sect2">
1.1 dsieger 2025: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 2026: <a name="conf.ldflags"></a>6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2027: <p>If you want to pass flags to the linker, both in the configure
2028: step and the build step, you can do this in two ways. Either set
2029: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2030: between the two is that <code class="varname">LIBS</code> will be appended to
2031: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2032: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2033: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2034: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2035: <code class="varname">CFLAGS</code>, if you do not wish to override these
2036: settings, use the <code class="literal">+=</code> operator:</p>
2037: <pre class="programlisting">
2038: LDFLAGS+= -your -linkerflags
2039: </pre>
2040: </div>
2041: </div>
1.41 asau 2042: <div class="sect1">
1.1 dsieger 2043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2044: <a name="developer-advanced-settings"></a>6.6. Developer/advanced settings</h2></div></div></div>
1.84 wiz 2045: <p>
1.1 dsieger 2046: </p>
1.41 asau 2047: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2048: <li class="listitem">
1.1 dsieger 2049: <p><code class="varname">PKG_DEVELOPER</code>:
1.232 gutterid 2050: Run some sanity checks that package developers want:
2051: </p>
1.41 asau 2052: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2053: <li class="listitem"><p>make sure patches apply with zero
1.232 gutterid 2054: fuzz</p></li>
1.23 wiz 2055: <li class="listitem"><p>run check-shlibs to see that all
1.232 gutterid 2056: binaries will find their shared libs.</p></li>
1.1 dsieger 2057: </ul></div>
2058: </li>
1.232 gutterid 2059: <li class="listitem"><p><code class="varname">CHECK_FILES_STRICT</code>:
2060: Also check <code class="varname">VARBASE</code> and <code class="varname">PKG_SYSCONFDIR
2061: </code> values in PLIST entries.
2062: </p></li>
1.23 wiz 2063: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.232 gutterid 2064: of debugging output which is displayed whilst making and
2065: installing the package. The default value for this is 0,
2066: which will not display the commands as they are executed
2067: (normal, default, quiet operation); the value 1 will display
2068: all shell commands before their invocation, and the value 2
2069: will display both the shell commands before their invocation,
2070: as well as their actual execution progress with <span class="command"><strong>set
2071: -x</strong></span>.</p></li>
1.1 dsieger 2072: </ul></div>
2073: <p>
2074: </p>
2075: </div>
1.41 asau 2076: <div class="sect1">
1.1 dsieger 2077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2078: <a name="selecting-build-options"></a>6.7. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2079: <p>Some packages have build time options, usually to select
2080: between different dependencies, enable optional support for big
2081: dependencies or enable experimental features.</p>
2082: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2083: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2084: show-options</strong></span>, for example:</p>
2085: <pre class="programlisting">
2086: The following options are supported by this package:
2087: ssl Enable SSL support.
2088: Exactly one of the following gecko options is required:
2089: firefox Use firefox as gecko rendering engine.
2090: mozilla Use mozilla as gecko rendering engine.
2091: At most one of the following database options may be selected:
2092: mysql Enable support for MySQL database.
2093: pgsql Enable support for PostgreSQL database.
2094:
2095: These options are enabled by default: firefox
2096: These options are currently enabled: mozilla ssl
2097: </pre>
2098: <p>The following variables can be defined in
1.10 hubertf 2099: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2100: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2101: which can be used to select or disable options for all packages
2102: that support them, and
2103: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2104: which can be used to select or disable options specifically for
2105: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.266 martin 2106: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2107: are disabled. A few examples:</p>
2108: <pre class="screen">
1.10 hubertf 2109: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1 dsieger 2110: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2111: PKG_OPTIONS.kdebase= debug -sasl
2112: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2113: <p>It is important to note that options that were specifically
1.18 snj 2114: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2115: you do not wish to include the option. If you are unsure you can view
2116: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2117: <p>The following settings are consulted in the order given, and
2118: the last setting that selects or disables an option is
2119: used:</p>
1.23 wiz 2120: <div class="orderedlist"><ol class="orderedlist" type="1">
2121: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2122: maintainer</p></li>
1.23 wiz 2123: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2124: variables (see below)</p></li>
1.23 wiz 2125: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2126: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2127: </ol></div>
2128: <p>For groups of mutually exclusive options, the last option
2129: selected is used, all others are automatically disabled. If an
2130: option of the group is explicitly disabled, the previously
2131: selected option, if any, is used. It is an error if no option
2132: from a required group of options is selected, and building the
2133: package will fail.</p>
2134: <p>Before the options framework was introduced, build options
2135: were selected by setting a variable (often named
2136: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2137: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2138: transition to the options framework for the user, these legacy
2139: variables are converted to the appropriate options setting
2140: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2141: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2142: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2143: directly. Support for the legacy variables will be removed
2144: eventually.</p>
2145: </div>
2146: </div>
1.41 asau 2147: <div class="chapter">
1.1 dsieger 2148: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 2149: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1 dsieger 2150: <div class="toc">
2151: <p><b>Table of Contents</b></p>
1.100 leot 2152: <dl class="toc">
1.154 rillig 2153: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2154: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.1 dsieger 2155: </dl>
2156: </div>
1.41 asau 2157: <div class="sect1">
1.1 dsieger 2158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2159: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1 dsieger 2160: <p>Once you have built and installed a package, you can create
2161: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.259 leot 2162: another system with <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 2163: the same package on a group of hosts and wasting CPU time. It also
2164: provides a simple means for others to install your package, should
2165: you distribute it.</p>
2166: <p>To create a binary package, change into the appropriate
1.10 hubertf 2167: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2168: package</strong></span>:</p>
2169: <pre class="screen">
1.112 rillig 2170: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2171: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2172: </pre>
1.242 gutterid 2173: <p>This will build your package (if not already done) and package
2174: it into a binary package. You can then use the
2175: <span class="command"><strong>pkg_*</strong></span> tools to manipulate it. Binary packages are
2176: created in <code class="varname">PACKAGES</code>, which defaults to
2177: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a compressed
1.266 martin 2178: tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a continuation of
1.242 gutterid 2179: 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>
2180: example.</p>
1.266 martin 2181: <p>See <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a> for information on how to submit
1.1 dsieger 2182: such a binary package.</p>
2183: </div>
1.41 asau 2184: <div class="sect1">
1.1 dsieger 2185: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2186: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
2187: <p>See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a>.</p>
1.6 rillig 2188: </div>
2189: </div>
1.41 asau 2190: <div class="chapter">
1.6 rillig 2191: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 2192: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 2193: builds)</h2></div></div></div>
2194: <div class="toc">
2195: <p><b>Table of Contents</b></p>
1.100 leot 2196: <dl class="toc">
1.154 rillig 2197: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 2198: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 2199: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
1.272 ! wiz 2200: <dt><span class="sect1"><a href="#bulk.scan">8.3. Speeding up bulk build scans</a></span></dt>
! 2201: <dt><span class="sect1"><a href="#bulk.req">8.4. Requirements of a full bulk build</a></span></dt>
! 2202: <dt><span class="sect1"><a href="#bulk.var">8.5. Bulk build variants</a></span></dt>
! 2203: <dd><dl>
! 2204: <dt><span class="sect2"><a href="#bulk.var.confopt">8.5.1. Detect unknown configure options</a></span></dt>
! 2205: <dt><span class="sect2"><a href="#bulk.var.comperr">8.5.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
! 2206: <dt><span class="sect2"><a href="#bulk.var.builderr">8.5.3. Force compiler options only in the build phase</a></span></dt>
! 2207: <dt><span class="sect2"><a href="#bulk.var.dirs">8.5.4. Use custom directories</a></span></dt>
! 2208: <dt><span class="sect2"><a href="#bulk.var.warn">8.5.5. Turn warnings into errors</a></span></dt>
! 2209: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.5.6. Reject packages for which pkglint reports errors</a></span></dt>
! 2210: <dt><span class="sect2"><a href="#bulk.var.strings">8.5.7. Reject packages that contain forbidden strings</a></span></dt>
! 2211: <dt><span class="sect2"><a href="#bulk.var.test">8.5.8. Reject packages whose self-test fails</a></span></dt>
! 2212: <dt><span class="sect2"><a href="#bulk.var.shvar">8.5.9. Reject packages that use undefined shell variables</a></span></dt>
! 2213: <dt><span class="sect2"><a href="#bulk.var.quiet">8.5.10. Turn off verbose logging</a></span></dt>
1.178 rillig 2214: </dl></dd>
1.272 ! wiz 2215: <dt><span class="sect1"><a href="#creating-cdroms">8.6. Creating a multiple CD-ROM packages collection</a></span></dt>
! 2216: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.6.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2217: </dl>
2218: </div>
1.175 gutterid 2219: <p>For a number of reasons, you may want to build binary packages
2220: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.71 wiz 2221: For instance, when you have multiple machines that should run the same software,
2222: it is wasted time if they all build their packages themselves from source.
2223: Or you may want to build a list of packages you want and check them before
1.175 gutterid 2224: deploying onto production systems.
1.71 wiz 2225: There is a way of getting a set of binary packages:
1.175 gutterid 2226: the bulk build system, or pbulk ("p" stands for "parallel").
1.112 rillig 2227: This chapter describes how to set it up.</p>
1.41 asau 2228: <div class="sect1">
1.6 rillig 2229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2230: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71 wiz 2231: <p>First of all, you have to decide whether you build all packages
2232: or a limited set of them. Full bulk builds usually consume a lot more resources,
2233: both space and time, than builds for some practical sets of packages.
1.175 gutterid 2234: A number of particularly heavy packages exist that are not actually
2235: interesting to a wide audience. (The approximate resource consumption for a
1.272 ! wiz 2236: full bulk build is given in section <a class="xref" href="#bulk.req" title="8.4. Requirements of a full bulk build">Section 8.4, “Requirements of a full bulk build”</a>.)
1.175 gutterid 2237: For limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2238: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2239: </p>
2240: <p>During bulk builds various packages are installed and deinstalled
2241: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2242: so make sure that you don't need any package during the builds.
1.112 rillig 2243: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2244: or something even more restrictive, depending on what the operating system provides,
2245: or dedicate the whole physical machine.
2246: As a useful side effect this makes sure that bulk builds cannot
2247: break anything in your system. There have been numerous cases where
1.6 rillig 2248: certain packages tried to install files outside the
2249: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2250: <code class="filename">/etc</code>.
2251: </p>
1.6 rillig 2252: </div>
1.41 asau 2253: <div class="sect1">
1.6 rillig 2254: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2255: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
1.180 rillig 2256: <p>Running a bulk build works roughly as follows:</p>
1.41 asau 2257: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2258: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2259: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2260: </ul></div>
1.41 asau 2261: <div class="sect2">
1.15 rillig 2262: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 2263: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112 rillig 2264: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2265: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2266: Configure network access to fetch distribution files.
1.112 rillig 2267: Create a user with name "pbulk".</p>
1.68 asau 2268: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2269: <pre class="screen">
1.151 sevan 2270: <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>
2271: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
1.72 wiz 2272: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.68 asau 2273: </pre>
2274: <p>Or any other way that fits (e.g., curl, wget).</p>
2275: <p>Deploy and configure pbulk tools, e.g.:</p>
2276: <pre class="screen">
1.118 sevan 2277: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.68 asau 2278: <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>
2279: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2280: </pre>
2281: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2282: <h3 class="title">Note</h3>
2283: <p><code class="filename">mk.conf.frag</code> is a fragment of
2284: <code class="filename">mk.conf</code> that contains settings you want to
2285: apply to packages you build. For instance,</p>
2286: <pre class="programlisting">
1.112 rillig 2287: PKG_DEVELOPER= yes # perform more checks
2288: X11_TYPE= modular # use pkgsrc X11
2289: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2290: # when building all packages)
1.68 asau 2291: </pre>
2292: </div>
2293: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2294: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2295: <pre class="programlisting">
2296: www/firefox
2297: mail/thunderbird
2298: misc/libreoffice4
2299: </pre>
1.69 asau 2300: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2301: and make final amendments, if wanted.</p>
1.68 asau 2302: <p>Start it:</p>
2303: <pre class="screen">
2304: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2305: </pre>
2306: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2307: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2308: </p>
2309: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2310: <h3 class="title">Note</h3>
2311: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2312: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2313: The script is kept small enough for better understanding.</p>
2314: </div>
2315: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2316: <h3 class="title">Note</h3>
2317: <p>The <code class="filename">pbulk.sh</code> script supports running
1.205 wiz 2318: unprivileged bulk build and helps configuring distributed bulk builds.
2319: Distributed bulk builds support either building in worker chroots
2320: (each node is a path to a different chroot)
2321: that replicate the target system, including the pbulk prefix,
2322: or remote machines (each node is
2323: an IP address that must be accessible over SSH without a password).</p>
1.68 asau 2324: </div>
1.6 rillig 2325: </div>
2326: </div>
1.41 asau 2327: <div class="sect1">
1.6 rillig 2328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.272 ! wiz 2329: <a name="bulk.scan"></a>8.3. Speeding up bulk build scans</h2></div></div></div>
! 2330: <p>At the start of a bulk build. pkgsrc is scanned for details
! 2331: about the packages to build. This is needed e.g. to build a
! 2332: dependency graph for building the packages in the correct
! 2333: order.</p>
! 2334: <p>Basically, this calls <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> once for each package. To
! 2335: speed this up, some variables can be pre-computed and others can be
! 2336: cached. This will greatly reduce the time needed for the scan part
! 2337: of a bulk build.</p>
! 2338: <p>The fake <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/varcache/index.html" target="_top"><code class="filename">pkgtools/varcache</code></a>
! 2339: package provides a Makefile target to precompute some often-used
! 2340: variables for the build system that shouldn't change during one
! 2341: build. Redirect its output to a file and include it from
! 2342: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>; for example:</p>
! 2343: <pre class="screen">
! 2344: <code class="prompt">$</code> <strong class="userinput"><code>cd pkgtools/varcache</code></strong>
! 2345: <code class="prompt">$</code> <strong class="userinput"><code>make show-varcache > /etc/varcache.mk</code></strong>
! 2346: <code class="prompt">$</code> <strong class="userinput"><code>echo .include "varcache.mk" >> /etc/mk.conf</code></strong>
! 2347: </pre>
! 2348: <p>Some system information is needed quite early in the build
! 2349: and can not be cached this way. It must be set in the environment
! 2350: for the next speed-up:</p>
! 2351: <pre class="screen">
! 2352: <code class="prompt">$</code> <strong class="userinput"><code>export HOST_MACHINE_ARCH=`uname -m`</code></strong>
! 2353: <code class="prompt">$</code> <strong class="userinput"><code>export NATIVE_OPSYS=`uname -s`</code></strong>
! 2354: <code class="prompt">$</code> <strong class="userinput"><code>export NATIVE_OPSYS_VERSION=`uname -r | awk -F. '{major=int($1); minor=int($2); if (minor>=100) minor=99; patch=int($3); if (patch>=100) patch=99; printf "%02d%02d%02d", major, minor, patch}'`</code></strong>
! 2355: <code class="prompt">$</code> <strong class="userinput"><code>export NATIVE_OS_VERSION=`uname -r`</code></strong>
! 2356: </pre>
! 2357: <p>Some settings that also affect the scan time strongly can be set in
! 2358: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
! 2359: <pre class="programlisting">
! 2360: NATIVE_PKG_TOOLS_BIN=/usr/sbin # location on NetBSD
! 2361: NO_PKGTOOLS_REQD_CHECK=yes # assume pkg tools are up-to-date
! 2362: SKIP_LICENSE_CHECK=yes # do not check license validity
! 2363: _SRC_TOP_= # bulk build is not running from inside /usr/src
! 2364: UNPRIVILEGED_USER=pbulk # use the appropriate user for your system
! 2365: UNPRIVILEGED_GROUP=builder # use the appropriate group for your system
! 2366: UNPRIVILEGED_GROUPS=builder # use the appropriate groups for your system
! 2367: </pre>
! 2368: <p>Finally, some packages require information about build options
! 2369: of other packages. This information can be cached by setting
! 2370: <code class="varname">PBULK_CACHE_DIRECTORY</code>.</p>
! 2371: <pre class="programlisting">
! 2372: PBULK_CACHE_DIRECTORY=/tmp/pbulk_cache
! 2373: </pre>
! 2374: <p>For all of these: please make sure they are kept up-to-date for
! 2375: changes in your environment. The safest method is to re-create the
! 2376: varcache before each build, make sure the environment variables are
! 2377: still up-to-date, and to delete the
! 2378: <code class="varname">PBULK_CACHE_DIRECTORY</code> before builds.</p>
! 2379: </div>
! 2380: <div class="sect1">
! 2381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
! 2382: <a name="bulk.req"></a>8.4. Requirements of a full bulk build</h2></div></div></div>
1.71 wiz 2383: <p>A complete bulk build requires lots of disk space. Some of the
2384: disk space can be read-only, some other must be writable. Some can be on
2385: remote filesystems (such as NFS) and some should be local. Some can be
2386: temporary filesystems, others must survive a sudden reboot.</p>
2387: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.205 wiz 2388: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2389: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.71 wiz 2390: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2391: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2392: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2393: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2394: </ul></div>
2395: </div>
2396: <div class="sect1">
2397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.272 ! wiz 2398: <a name="bulk.var"></a>8.5. Bulk build variants</h2></div></div></div>
1.178 rillig 2399: <p>To ensure that pkgsrc packages work in different configurations, it
2400: makes sense to run non-default bulk builds from time to time. This
2401: section lists some ideas for bulk builds that intentionally let packages
2402: fail if they don't follow the pkgsrc style.</p>
2403: <div class="sect2">
2404: <div class="titlepage"><div><div><h3 class="title">
1.272 ! wiz 2405: <a name="bulk.var.confopt"></a>8.5.1. Detect unknown configure options</h3></div></div></div>
1.178 rillig 2406: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2407: <pre class="programlisting">
2408: GNU_CONFIGURE_STRICT= yes
2409: </pre>
2410: <p>When a package fails this additional check, the most common cause
2411: is that the configure option was valid for an older version of the
2412: package but does not apply anymore. In that case, just remove it.</p>
2413: </div>
2414: <div class="sect2">
2415: <div class="titlepage"><div><div><h3 class="title">
1.272 ! wiz 2416: <a name="bulk.var.comperr"></a>8.5.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.178 rillig 2417: <p>The job of a compiler is not restricted to producing executable
1.179 rillig 2418: code, most compilers also detect typical programming mistakes. The pkgsrc
2419: compiler wrappers make it easy to force compiler options when the package
2420: is built. This can be used to find typical bugs across all packages that
2421: are in pkgsrc. By reporting these bugs upstream, the packages will be
2422: more reliable with the next updates.</p>
2423: <p>Add some of the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.178 rillig 2424: <pre class="programlisting">
2425: CFLAGS+= -Werror=char-subscripts
1.179 rillig 2426: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 2427: </pre>
1.179 rillig 2428: <p>When a package fails to build using these stricter compiler
2429: options, document the circumstances in which the compiler produced the
2430: error message. This includes:</p>
1.178 rillig 2431: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2432: <li class="listitem"><p>The platform
2433: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2434: <li class="listitem"><p>The source file</p></li>
2435: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2436: part of the diagnostic.</p></li>
1.179 rillig 2437: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.178 rillig 2438: </ul></div>
2439: <p>If a package produces these error messages, but the package is
1.179 rillig 2440: 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
2441: in the next builds:</p>
1.178 rillig 2442: <pre class="programlisting">
1.179 rillig 2443: .if ${PKGPATH} == category/package
1.178 rillig 2444: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2445: # error message
2446: # code
1.179 rillig 2447: # Reason why the code does not need to be fixed.
1.178 rillig 2448: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 2449: .endif
1.178 rillig 2450: </pre>
2451: <p>If the error messages from the compiler are valid and the code
1.179 rillig 2452: needs to be fixed, prepare a local patch (see
2453: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2454: authors of the package, providing them with the information you collected
2455: above.</p>
2456: <p>Patches that are not essential for the package to work should only
2457: be reported upstream but not committed to pkgsrc, to make future updates
2458: easier.</p>
1.178 rillig 2459: </div>
2460: <div class="sect2">
2461: <div class="titlepage"><div><div><h3 class="title">
1.272 ! wiz 2462: <a name="bulk.var.builderr"></a>8.5.3. Force compiler options only in the build phase</h3></div></div></div>
1.181 rillig 2463: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2464: these apply to all phases of the package build process. Especially in the
2465: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2466: decisions. The GNU configure scripts feed many small test programs to the
2467: C compiler to see whether certain headers are available, functions are
2468: defined in a library and programs can be run. In many cases these
2469: programs would not survive a strict compiler run with <code class="literal">-Wall
2470: -Wextra -Werror</code>.</p>
2471: <p>The pkgsrc infrastructure is flexible enough to support compiler
2472: options being added between the <code class="literal">configure</code> and
2473: <code class="literal">build</code> phases. It's a little more complicated than the
2474: other examples in this section but still easy enough.</p>
2475: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2476: desired compiler options. The compiler wrapper's original task is to hide
2477: unwanted directories of include files and to normalize compiler options.
2478: It does this by wrapping the compiler command and rewriting the command
2479: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2480: package directory and examine the
2481: <code class="filename">work/.cwrappers/config</code> directory. It contains
2482: individual configurations for the C compiler and the related tools. The
2483: plan is to find a hook between the configure and build phases, and to
2484: modify these configuration files at that point.</p>
2485: <p>To find this hook, have a look at
2486: <code class="filename">mk/build/build.mk</code>, which contains among others the
2487: <code class="literal">pre-build-checks-hook</code>. The word
2488: <code class="literal">checks</code> doesn't quite fit, but the
2489: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2490: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2491: <pre class="programlisting">
2492: # Just a few example options.
2493: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2494:
2495: .if ${BUILD_ONLY_CFLAGS:U:M*}
2496: pre-build-checks-hook: add-build-only-cflags
2497:
2498: add-build-only-cflags: .PHONY
2499: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2500: ${TEST} ! -f ${.TARGET} || exit 0; \
2501: for flag in ${BUILD_ONLY_CFLAGS}; do \
2502: ${ECHO} "append=$$flag" >> cc; \
2503: done; \
2504: > ${.TARGET}
2505: .endif
2506: </pre>
2507: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2508: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2509: not with spaces.)</p>
2510: <p>The condition in the <code class="literal">.if</code> statement contains the
2511: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2512: should be undefined, possibly because it is only defined for a subset of
2513: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2514: at least one compiler option, to prevent a syntax error in the shell
2515: parser.</p>
2516: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2517: that the additional compiler options are only appended once, even if
2518: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2519: creates a marker file.</p>
2520: <p>To verify that this setup works, run <span class="command"><strong>bmake
2521: configure</strong></span> in a package directory. Up to now, everything works
2522: as usual. Examine the directory
2523: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2524: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2525: the file <code class="filename">cc</code>. Examine the tail of the
2526: <code class="filename">work/.work.log</code> file to see that the normal compiler
2527: options are used.</p>
2528: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2529: options to the file <code class="filename">cc</code> and will create the marker
2530: file in the same directory. After that, the build starts as usual, but
2531: with the added compiler options. Examine the tail of the file
2532: <code class="filename">work/.work.log</code> to see that the lines starting with
2533: <code class="literal">[*]</code> don't contain the compiler options, but the
2534: corresponding lines starting with <code class="literal"><.></code> do end
2535: with these options.</p>
2536: <p>Building packages using this setup variant and fixing the resulting
1.272 ! wiz 2537: bugs is the same as in <a class="xref" href="#bulk.var.comperr" title="8.5.2. Detect classes of bugs by forcing compiler warnings">Section 8.5.2, “Detect classes of bugs by forcing compiler warnings”</a>.</p>
1.181 rillig 2538: </div>
2539: <div class="sect2">
2540: <div class="titlepage"><div><div><h3 class="title">
1.272 ! wiz 2541: <a name="bulk.var.dirs"></a>8.5.4. Use custom directories</h3></div></div></div>
1.178 rillig 2542: <p>Some directories like <code class="varname">PREFIX</code>,
2543: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2544: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2545: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2546: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2547: <pre class="programlisting">
2548: PREFIX= /a-random-uuid
2549: PKG_SYSCONFDIR= /a-random-uuid
2550: VARBASE= /a-random-uuid
2551: PKGMANDIR= a-random-uuid
2552: PKG_INFODIR= a-random-uuid
2553: </pre>
2554: </div>
2555: <div class="sect2">
2556: <div class="titlepage"><div><div><h3 class="title">
1.272 ! wiz 2557: <a name="bulk.var.warn"></a>8.5.5. Turn warnings into errors</h3></div></div></div>
1.178 rillig 2558: <p>When building a package, warnings are typically ignored since they
2559: just flow by and do not cause the build to fail immediately. To find
2560: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2561: <pre class="programlisting">
2562: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2563: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2564: </pre>
2565: <p>(There are many more classes of warnings in pkgsrc, and most of
2566: them can be redefined with a simple definition like above.</p>
1.179 rillig 2567: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.178 rillig 2568: the package Makefile, research whether the package actually needs Perl.
2569: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2570: Makefile, and if it doesn't, add
2571: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2572: </div>
2573: <div class="sect2">
2574: <div class="titlepage"><div><div><h3 class="title">
1.272 ! wiz 2575: <a name="bulk.var.pkglint"></a>8.5.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.178 rillig 2576: <p>Using pkglint as part of the regular build process is mostly a
2577: waste of time. If you want to fix some of the warnings, just run pkglint
2578: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2579: 10), which is much faster than a complete bulk build.</p>
2580: </div>
2581: <div class="sect2">
2582: <div class="titlepage"><div><div><h3 class="title">
1.272 ! wiz 2583: <a name="bulk.var.strings"></a>8.5.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.178 rillig 2584: <p>To ensure that the binary packages don't contain references to the
2585: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2586: that variable includes the item <code class="literal">extra</code>, it is
2587: possible to define additional patterns that must not appear in any
2588: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2589: <pre class="programlisting">
2590: CHECK_WRKREF= extra
2591: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2592: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2593: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2594: </pre>
2595: <p>The above patterns will probably generate many false positives,
2596: therefore the results need to be taken with a grain of salt.</p>
2597: </div>
2598: <div class="sect2">
2599: <div class="titlepage"><div><div><h3 class="title">
1.272 ! wiz 2600: <a name="bulk.var.test"></a>8.5.8. Reject packages whose self-test fails</h3></div></div></div>
1.178 rillig 2601: <p>To run the test suites that come with each package, add this line
2602: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2603: <pre class="programlisting">
2604: PKGSRC_RUN_TEST= yes
2605: </pre>
2606: <p>Be prepared that even the most basic packages fail this test. When
2607: doing a bulk build with this, it will often abort in the early phase
2608: where the packages are scanned for their dependencies since there are
2609: cyclic dependencies. There is still a lot to do in this area.</p>
2610: </div>
2611: <div class="sect2">
2612: <div class="titlepage"><div><div><h3 class="title">
1.272 ! wiz 2613: <a name="bulk.var.shvar"></a>8.5.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.178 rillig 2614: <p>To catch typos in the shell snippets from the Makefile fragments,
2615: add the <code class="literal">-u</code> flag to most of the commands by adding this
2616: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2617: <pre class="programlisting">
2618: RUN= @set -eu;
2619: </pre>
1.181 rillig 2620: <p>After that, ensure that none of the bulk build log files (even
2621: those for successfully built packages) contains the string
2622: <code class="literal">parameter not set</code> or whatever error message the
2623: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.178 rillig 2624: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2625: definition.</p>
2626: </div>
2627: <div class="sect2">
2628: <div class="titlepage"><div><div><h3 class="title">
1.272 ! wiz 2629: <a name="bulk.var.quiet"></a>8.5.10. Turn off verbose logging</h3></div></div></div>
1.178 rillig 2630: <p>The build logs of a package are often quite long. This allows error
2631: messages or other interesting details to hide between the noise. To make
2632: the actual error message stand out more, add these lines to
2633: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2634: <pre class="programlisting">
2635: GNU_CONFIGURE_QUIET= yes
2636: MAKE_FLAGS+= -s
2637: </pre>
2638: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2639: Make. On exotic platforms with their own make, it may be a little
2640: different.</p>
2641: </div>
2642: </div>
2643: <div class="sect1">
2644: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.272 ! wiz 2645: <a name="creating-cdroms"></a>8.6. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2646: <p>After your pkgsrc bulk-build has completed, you may wish to
2647: create a CD-ROM set of the resulting binary packages to assist
2648: in installing packages on other machines. The
1.207 leot 2649: <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.1 dsieger 2650: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2651: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2652: way that keeps all the dependencies for a given package on the same
2653: CD as that package.</p>
1.41 asau 2654: <div class="sect2">
1.1 dsieger 2655: <div class="titlepage"><div><div><h3 class="title">
1.272 ! wiz 2656: <a name="cdpack-example"></a>8.6.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2657: <p>Complete documentation for cdpack is found in the cdpack(1)
2658: man page. The following short example assumes that the binary
2659: packages are left in
2660: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2661: sufficient disk space exists in <code class="filename">/u2</code> to
2662: hold the ISO 9660 images.</p>
2663: <pre class="screen">
2664: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2665: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2666: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2667: </pre>
2668: <p>If you wish to include a common set of files
2669: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2670: etc.) on each CD in the collection, then you need to create a
1.175 gutterid 2671: directory which contains these files, e.g.:</p>
1.1 dsieger 2672: <pre class="screen">
2673: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2674: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2675: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2676: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2677: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2678: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2679: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2680: </pre>
2681: <p>Now create the images:</p>
2682: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2683: <p>Each image will contain <code class="filename">README</code>,
2684: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2685: in their root directories.</p>
2686: </div>
2687: </div>
2688: </div>
1.41 asau 2689: <div class="chapter">
1.1 dsieger 2690: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 2691: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2692: <div class="toc">
2693: <p><b>Table of Contents</b></p>
1.100 leot 2694: <dl class="toc">
1.154 rillig 2695: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2696: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1 dsieger 2697: </dl>
2698: </div>
2699: <p>The files that are installed by pkgsrc are organized in a way that
2700: is similar to what you find in the <code class="filename">/usr</code> directory
2701: of the base system. But some details are different. This is because
2702: pkgsrc initially came from FreeBSD and had adopted its file system
2703: hierarchy. Later it was largely influenced by NetBSD. But no matter
2704: which operating system you are using pkgsrc with, you can expect the
2705: same layout for pkgsrc.</p>
2706: <p>There are mainly four root directories for pkgsrc, which are all
2707: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2708: When pkgsrc has been installed as root, the default locations
2709: are:</p>
2710: <pre class="programlisting">
2711: LOCALBASE= /usr/pkg
2712: PKG_SYSCONFBASE= /usr/pkg/etc
2713: VARBASE= /var
1.119 sevan 2714: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2715: </pre>
2716: <p>In unprivileged mode (when pkgsrc has been installed as any other
2717: user), the default locations are:</p>
2718: <pre class="programlisting">
2719: LOCALBASE= ${HOME}/pkg
2720: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2721: VARBASE= ${HOME}/pkg/var
1.119 sevan 2722: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2723: </pre>
2724: <p>What these four directories are for, and what they look like is
2725: explained below.</p>
1.41 asau 2726: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2727: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2728: <code class="filename">/usr</code> directory in the base system. It is the
1.266 martin 2729: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2730: the well-known subdirectories like <code class="filename">bin</code>,
2731: <code class="filename">include</code>, <code class="filename">lib</code>,
2732: <code class="filename">share</code> and
2733: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2734: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2735: <code class="filename">/var</code> in the base system. Some programs (especially
2736: games, network daemons) need write access to it during normal
2737: operation.</p></li>
1.23 wiz 2738: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2739: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2740: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 2741: itself.</p></li>
2742: </ul></div>
1.41 asau 2743: <div class="sect1">
1.1 dsieger 2744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2745: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2746: </h2></div></div></div>
2747: <p>The following directories exist in a typical pkgsrc installation
2748: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2749: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2750: <dt><span class="term"><code class="filename">bin</code></span></dt>
2751: <dd><p>Contains executable programs that are intended to be
2752: directly used by the end user.</p></dd>
2753: <dt><span class="term"><code class="filename">emul</code></span></dt>
2754: <dd><p>Contains files for the emulation layers of various other
2755: operating systems, especially for
2756: NetBSD.</p></dd>
2757: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2758: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2759: <dd><p>Contains
2760: the configuration files.</p></dd>
2761: <dt><span class="term"><code class="filename">include</code></span></dt>
2762: <dd><p>Contains headers for the C and C++ programming
2763: languages.</p></dd>
2764: <dt><span class="term"><code class="filename">info</code></span></dt>
2765: <dd><p>Contains GNU info files of various
2766: packages.</p></dd>
2767: <dt><span class="term"><code class="filename">lib</code></span></dt>
2768: <dd><p>Contains shared and static
2769: libraries.</p></dd>
2770: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2771: <dd><p>Contains data files that don't change after
2772: installation. Other data files belong into
2773: <code class="filename">${VARBASE}</code>.</p></dd>
2774: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2775: <dd><p>Contains programs that are not intended to be used by
2776: end users, such as helper programs or network
2777: daemons.</p></dd>
2778: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2779: <dd><p>Contains programs that are intended to be executed as
2780: CGI scripts by a web server.</p></dd>
2781: <dt><span class="term"><code class="filename">man</code> (the usual value of
2782: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2783: <dd><p>Contains brief
2784: documentation in form of manual pages.</p></dd>
2785: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2786: <dd><p>Contains programs that are intended to be used only by
2787: the super-user.</p></dd>
2788: <dt><span class="term"><code class="filename">share</code></span></dt>
2789: <dd><p>Contains platform-independent data files that don't
2790: change after installation.</p></dd>
2791: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2792: <dd><p>Contains documentation files provided by the
2793: packages.</p></dd>
2794: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2795: <dd><p>Contains example files provided by the packages. Among
2796: others, the original configuration files are saved here and copied to
2797: <code class="filename">${PKG_SYSCONFDIR}</code> during
2798: installation.</p></dd>
2799: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2800: <dd><p>Contains the original files for rc.d
2801: scripts.</p></dd>
2802: <dt><span class="term"><code class="filename">var</code> (the usual location of
2803: <code class="filename">${VARBASE}</code>)</span></dt>
2804: <dd><p>Contains files
2805: that may be modified after
2806: installation.</p></dd>
2807: </dl></div>
2808: </div>
1.41 asau 2809: <div class="sect1">
1.1 dsieger 2810: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2811: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2812: </h2></div></div></div>
1.41 asau 2813: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2814: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2815: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2816: <dd><p>Contains
2817: information about the currently installed
2818: packages.</p></dd>
2819: <dt><span class="term"><code class="filename">games</code></span></dt>
2820: <dd><p>Contains highscore
2821: files.</p></dd>
2822: <dt><span class="term"><code class="filename">log</code></span></dt>
2823: <dd><p>Contains log files.</p></dd>
2824: <dt><span class="term"><code class="filename">run</code></span></dt>
2825: <dd><p>Contains informational files about daemons that are
2826: currently running.</p></dd>
2827: </dl></div>
2828: </div>
2829: </div>
1.41 asau 2830: <div class="chapter">
1.1 dsieger 2831: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 2832: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2833: <div class="toc">
2834: <p><b>Table of Contents</b></p>
1.100 leot 2835: <dl class="toc">
1.154 rillig 2836: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2837: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2838: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2839: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2840: <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>
2841: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2842: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2843: <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>
2844: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
1.266 martin 2845: <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
2846: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
2847: <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>
1.221 nia 2848: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 2849: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2850: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2851: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2852: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
1.266 martin 2853: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 2854: </dl>
2855: </div>
2856: <p>This section contains hints, tips & tricks on special things in
2857: pkgsrc that we didn't find a better place for in the previous chapters, and
2858: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2859: <div class="sect1">
1.1 dsieger 2860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2861: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2862: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2863: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2864: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 2865: This is a general purpose list for most issues regarding
2866: pkgsrc, regardless of platform, e.g. soliciting user help
2867: for pkgsrc configuration, unexpected build failures, using
2868: particular packages, upgrading pkgsrc installations,
2869: questions regarding the pkgsrc release branches, etc. General announcements or
2870: proposals for changes that impact the pkgsrc user community,
2871: e.g. major infrastructure changes, new features, package
2872: removals, etc., may also be posted.</p></li>
1.174 leot 2873: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 2874: A list where the results of pkgsrc bulk builds are sent and
2875: discussed.</p></li>
1.174 leot 2876: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 2877: This list is for those who are interested in getting a
2878: commit message for every change committed to pkgsrc. It is
2879: also available in digest form, meaning one daily message
2880: containing all commit messages for changes to the package
2881: source tree in that 24 hour period.</p></li>
2882: </ul></div>
2883: <p>To subscribe, do:</p>
2884: <pre class="programlisting">
2885: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2886: </pre>
2887: <p>Archives for all these mailing lists are available from
1.174 leot 2888: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2889: </div>
1.41 asau 2890: <div class="sect1">
1.1 dsieger 2891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2892: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2893: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2894: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2895: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2896: they might be useful, and not to duplicate the documentation that comes
2897: with each package.</p>
2898: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.207 leot 2899: <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.1 dsieger 2900: Symlinks for use by buildlink.</p></li></ul></div>
2901: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2902: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2903: <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.121 sevan 2904: Calculates various kinds of checksums (including SHA3).</p></li>
1.207 leot 2905: <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.1 dsieger 2906: Compatibility library for pkgsrc tools.</p></li>
1.207 leot 2907: <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.1 dsieger 2908: non-BSD systems due to lack of native mtree.</p></li>
1.207 leot 2909: <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.1 dsieger 2910: Up-to-date replacement for
2911: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2912: systems where pkg_install is not present.</p></li>
2913: </ul></div>
2914: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2915: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2916: <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.1 dsieger 2917: Create a binary package from an
1.10 hubertf 2918: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2919: save the old package.</p></li>
1.207 leot 2920: <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.1 dsieger 2921: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2922: from multiple locations. It currently supports the following
2923: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.207 leot 2924: <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.16 jnemeth 2925: the best compiler flags to optimise code for your current
1.23 wiz 2926: CPU and compiler. </p></li>
1.1 dsieger 2927: </ul></div>
2928: <p>Utilities for keeping track of installed packages, being up to date,
2929: etc:</p>
1.41 asau 2930: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2931: <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.65 wiz 2932: update tool similar to apt(1). Download, install, and upgrade
2933: binary packages easily.</p></li>
1.207 leot 2934: <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.1 dsieger 2935: packages whose installed versions do not match the latest pkgsrc
2936: entries.</p></li>
1.207 leot 2937: <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.1 dsieger 2938: dependency graphs of packages, to aid in choosing a strategy for
2939: updating.</p></li>
1.207 leot 2940: <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
2941: 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>
2942: <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.12 weinem 2943: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.207 leot 2944: <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.1 dsieger 2945: does various checks on the complete pkgsrc system.</p></li>
1.207 leot 2946: <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.1 dsieger 2947: packages you have installed.</p></li>
2948: </ul></div>
2949: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2950: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2951: <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.1 dsieger 2952: making and maintaining patches for a package (includes pkgdiff,
2953: pkgvi, mkpatches, etc.).</p></li>
1.207 leot 2954: <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.1 dsieger 2955: converting to pkgsrc.</p></li>
2956: </ul></div>
2957: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2958: utilities)</p>
1.41 asau 2959: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2960: <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.1 dsieger 2961: packages in a chrooted area.</p></li>
1.207 leot 2962: <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.1 dsieger 2963: kernel version for chrooted cross builds.</p></li>
2964: </ul></div>
2965: </div>
1.41 asau 2966: <div class="sect1">
1.1 dsieger 2967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2968: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2969: <p>To install packages from source as a non-root user, download
1.266 martin 2970: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 3. Where to get pkgsrc and how to keep it up-to-date">Chapter 3, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
1.108 rillig 2971: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2972: --unprivileged</strong></span>.</p>
2973: <p>This will install the binary part of pkgsrc to
2974: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2975: into <code class="filename">~/pkg/etc</code>.</p>
2976: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2977: </div>
1.41 asau 2978: <div class="sect1">
1.1 dsieger 2979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 2980: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2981: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2982: enable this feature by adding the option
2983: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2984: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2985: distfile is found, pkgsrc will try to resume it.</p>
2986: <p>You can also
1.61 wiz 2987: use a different program than the platform default program by changing the
1.16 jnemeth 2988: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2989: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2990: by using the value manual. A value of custom disables the system defaults
2991: and dependency tracking for the fetch program. In that case you have to
2992: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2993: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2994: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2995: <p>For example, if you want to use
1.16 jnemeth 2996: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2997: like:</p>
2998: <pre class="programlisting">
1.112 rillig 2999: FETCH_USING= wget
1.1 dsieger 3000: </pre>
3001: </div>
1.41 asau 3002: <div class="sect1">
1.1 dsieger 3003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3004: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4 rillig 3005: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3006: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3007: you will have to add the following line into
1.10 hubertf 3008: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3009: <pre class="programlisting">
1.4 rillig 3010: X11_TYPE=modular
1.1 dsieger 3011: </pre>
3012: </div>
1.41 asau 3013: <div class="sect1">
1.1 dsieger 3014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3015: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3016: <p>If you are sitting behind a firewall which does not allow direct
3017: connections to Internet hosts (i.e. non-NAT), you may specify the
3018: relevant proxy hosts. This is done using an environment variable in the
3019: form of a URL, e.g. in Amdahl, the machine
1.266 martin 3020: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 3021: port 80 as the proxy port number. So the proxy environment variables
3022: are:</p>
3023: <pre class="programlisting">
3024: ftp_proxy=ftp://orpheus.amdahl.com:80/
3025: http_proxy=http://orpheus.amdahl.com:80/
3026: </pre>
3027: </div>
1.41 asau 3028: <div class="sect1">
1.1 dsieger 3029: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3030: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 3031: <p>Some fetch tools are not prepared to support HTTPS by default
3032: (for example, the one in NetBSD 6.0), or the one installed by the
3033: pkgsrc bootstrap (to avoid an openssl dependency that low in the
3034: dependency graph).</p>
3035: <p>Usually you won't notice, because distribution files are
1.266 martin 3036: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
1.65 wiz 3037: be often enough if you are following pkgsrc-current. In that case, set
3038: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
1.266 martin 3039: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
1.65 wiz 3040: with HTTPS support by default. Of course, these tools need to be
3041: installed before you can use them this way.</p>
3042: </div>
3043: <div class="sect1">
3044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3045: <a name="passive-ftp"></a>10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1 dsieger 3046: <p>This depends on which utility is used to retrieve distfiles. From
3047: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3048: the first available command from the following list:</p>
1.41 asau 3049: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3050: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3051: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 3052: </ul></div>
3053: <p>On a default NetBSD installation, this will be
3054: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3055: connections first, and falls back to active connections if the server
3056: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 3057: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3058: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3059: <p>Having that option present will prevent
3060: <code class="filename">/usr/bin/ftp</code> from falling back to active
3061: transfers.</p>
3062: </div>
1.41 asau 3063: <div class="sect1">
1.1 dsieger 3064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3065: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3066: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3067: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 3068: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.1 dsieger 3069: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3070: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3071: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3072: resulting list to your machine at work/school and use it there. If you
1.259 leot 3073: don't have a NetBSD-compatible <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1 dsieger 3074: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3075: URL:</p>
3076: <p>At home:</p>
3077: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3078: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3079: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3080: <p>At work:</p>
3081: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3082: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3083: home.</p>
3084: <p>If you have a machine running NetBSD, and you want to get
3085: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3086: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3087: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3088: directly by running:</p>
3089: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3090: <p>If you even decide to ignore
3091: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3092: by running:</p>
3093: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3094: </div>
1.41 asau 3095: <div class="sect1">
1.1 dsieger 3096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3097: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">“<span class="quote">Don't know how to make
3098: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.207 leot 3099: <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.1 dsieger 3100: package, you get the error from make that it doesn't know how to make
3101: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.266 martin 3102: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 3103: the NetBSD base distribution on your machine. It is recommended to do
3104: that to format man pages.</p>
1.207 leot 3105: <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.1 dsieger 3106: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3107: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3108: </div>
1.41 asau 3109: <div class="sect1">
1.1 dsieger 3110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3111: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3112: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3113: when you installed your NetBSD machine. Please get and install it, by
3114: extracting it in <code class="filename">/</code>:</p>
3115: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3116: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3117: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3118: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3119: -r</strong></span>).</p>
3120: </div>
1.41 asau 3121: <div class="sect1">
1.1 dsieger 3122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3123: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.1 dsieger 3124: <p>When installing packages as non-root user and using the just-in-time
1.259 leot 3125: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.1 dsieger 3126: password for each required package installed. To avoid this, the sudo
3127: package can be used, which does password caching over a limited time. To
1.221 nia 3128: use it, install <span class="command"><strong>sudo</strong></span> or
3129: <span class="command"><strong>priv</strong></span> (either as binary package, from
3130: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/priv/index.html" target="_top"><code class="filename">security/priv</code></a>, or
1.207 leot 3131: <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.10 hubertf 3132: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3133: <span class="emphasis"><em>after</em></span> the definition of the
3134: <code class="varname">LOCALBASE</code> variable:</p>
3135: <pre class="programlisting">
3136: .if exists(${LOCALBASE}/bin/sudo)
1.260 wiz 3137: SU_CMD= ${LOCALBASE}/bin/sudo -E /bin/sh -c
1.1 dsieger 3138: .endif
3139: </pre>
1.260 wiz 3140: <p>Note the <span class="command"><strong>-E</strong></span> flag; that tells
3141: <span class="command"><strong>sudo</strong></span> to preserve the environment.
3142: Without this, the bin-install target will fail when building a
3143: package with a non-default python version.
3144: </p>
1.1 dsieger 3145: </div>
1.41 asau 3146: <div class="sect1">
1.1 dsieger 3147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3148: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3149: <p>As the system administrator, you can choose where configuration files
3150: are installed. The default settings make all these files go into
3151: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3152: be suboptimal depending on your expectations (e.g., a read-only,
3153: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3154: configuration of the provided packages).</p>
3155: <p>In order to change the defaults, you can modify the
3156: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3157: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3158: directory; some common examples include <code class="filename">/etc</code> or
3159: <code class="filename">/etc/pkg</code>.</p>
3160: <p>Furthermore, you can change this value on a per-package basis by
3161: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3162: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3163: package you would like to modify, that is, the contents of
3164: <code class="varname">PKGBASE</code>.</p>
3165: <p>Note that after changing these settings, you must rebuild and
3166: reinstall any affected packages.</p>
3167: </div>
1.41 asau 3168: <div class="sect1">
1.1 dsieger 3169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3170: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3171: <p>Please be aware that there can often be bugs in third-party software,
3172: and some of these bugs can leave a machine vulnerable to exploitation by
3173: attackers. In an effort to lessen the exposure, the NetBSD packages team
3174: maintains a database of known-exploits to packages which have at one time
3175: been included in pkgsrc. The database can be downloaded automatically, and
3176: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3177: do this, refer to the following two tools (installed as part of the
1.207 leot 3178: <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.23 wiz 3179: <div class="orderedlist"><ol class="orderedlist" type="1">
3180: <li class="listitem">
1.20 snj 3181: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3182: download a list of the security vulnerabilities information. This list
1.25 spz 3183: is kept up to date by the pkgsrc security team, and is distributed
3184: from the NetBSD ftp server:</p>
1.177 leot 3185: <p><a class="ulink" href="https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a></p>
1.1 dsieger 3186: </li>
1.23 wiz 3187: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3188: current machine, checking each known vulnerability. If a
1.1 dsieger 3189: vulnerable package is installed, it will be shown by output to stdout,
3190: including a description of the type of vulnerability, and a URL
3191: containing more information.</p></li>
3192: </ol></div>
1.121 sevan 3193: <p>Use of these tools is strongly recommended!
1.266 martin 3194: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, “Checking for security vulnerabilities in installed packages”</a> for instructions on how to automate checking and
1.121 sevan 3195: reporting.</p>
3196: <p>If this database is installed, pkgsrc builds will use it to
3197: perform a security check before building any package.</p>
1.1 dsieger 3198: </div>
1.41 asau 3199: <div class="sect1">
1.1 dsieger 3200: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3201: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1 dsieger 3202: <p>When you add your own preferences to the
3203: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3204: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3205: environment variables to the <code class="filename">./configure</code>
1.259 leot 3206: scripts and to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1 dsieger 3207: <code class="varname">CFLAGS</code> from the environment variable by
3208: overriding them in the <code class="filename">Makefile</code>s of their
3209: package.</p>
3210: <p>Currently there is no solution to this problem. If you
3211: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3212: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3213: directory and then inspect any <code class="filename">Makefile</code> and
3214: <code class="filename">Makefile.in</code> for whether they define
3215: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.266 martin 3216: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3217: programmers write so bad code that it only works for the
3218: specific combination of <code class="varname">CFLAGS</code> they have
3219: chosen.</p>
1.172 rillig 3220: <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>
3221: <pre class="programlisting">
3222: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3223: CFLAGS+= -Dpkgsrc___CFLAGS
3224: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3225: </pre>
3226: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3227: to see whether the above flags are passed to the actual build
3228: commands in general.</p>
3229: <p>To find out whether the flags are passed to individual compiler
3230: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3231: most cases, the flags from the original command lines (the lines starting
3232: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3233: (the lines starting with <code class="literal"><.></code>). If the flag is
3234: missing from the actual compiler command, it must have been removed by
1.266 martin 3235: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.1 dsieger 3236: </div>
1.41 asau 3237: <div class="sect1">
1.1 dsieger 3238: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3239: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3240: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3241: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3242: case that occurs often is that people only update pkgsrc in
3243: parts, because of performance reasons. Since pkgsrc is one large
3244: system, not a collection of many small systems, there are
3245: sometimes changes that only work when the whole pkgsrc tree is
3246: updated.</p></li>
1.41 asau 3247: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.266 martin 3248: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3249: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3250: files.</p></li>
1.41 asau 3251: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3252: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3253: verify this.</p></li>
1.108 rillig 3254: <li class="step"><p>If you are a package developer who wants to invest
1.266 martin 3255: some work, have a look at <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.41 asau 3256: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3257: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3258: </ol></div>
3259: </div>
1.41 asau 3260: <div class="sect1">
1.1 dsieger 3261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3262: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3263: <p>You have modified a file from pkgsrc, and someone else has
3264: modified that same file afterwards in the CVS repository. Both changes
3265: are in the same region of the file, so when you updated pkgsrc, the
3266: <code class="literal">cvs</code> command marked the conflicting changes in the
3267: file. Because of these markers, the file is no longer a valid
3268: <code class="filename">Makefile</code>.</p>
3269: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3270: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3271: -dP</strong></span> in that directory to download the current version.</p>
3272: </div>
3273: </div>
3274: </div>
1.41 asau 3275: <div class="part">
1.1 dsieger 3276: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 3277: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3278: <div class="partintro">
1.1 dsieger 3279: <div></div>
3280: <p>This part of the book deals with creating and
1.266 martin 3281: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3282: guide on creating a new package. The remaining chapters are more
3283: like a reference manual for pkgsrc.</p>
3284: <div class="toc">
3285: <p><b>Table of Contents</b></p>
1.100 leot 3286: <dl class="toc">
1.154 rillig 3287: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 3288: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 3289: <dd><dl>
1.184 rillig 3290: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3291: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3292: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 3293: <dd><dl>
1.184 rillig 3294: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3295: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3296: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3297: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3298: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 3299: </dl></dd>
1.184 rillig 3300: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3301: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3302: <dd><dl>
3303: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3304: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3305: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3306: </dl></dd>
3307: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3308: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3309: </dl></dd>
1.184 rillig 3310: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 3311: <dd><dl>
1.184 rillig 3312: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3313: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3314: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3315: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3316: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 3317: <dd><dl>
1.184 rillig 3318: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3319: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 3320: </dl></dd>
1.184 rillig 3321: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3322: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3323: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3324: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3325: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3326: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3327: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3328: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3329: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3330: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3331: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3332: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3333: </dl></dd>
3334: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3335: <dd><dl>
3336: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 3337: <dd><dl>
1.219 nia 3338: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
3339: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
3340: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.6 rillig 3341: </dl></dd>
1.184 rillig 3342: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3343: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6 rillig 3344: </dl></dd>
1.184 rillig 3345: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3346: <dd><dl>
1.184 rillig 3347: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3348: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3349: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3350: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 3351: <dd><dl>
1.184 rillig 3352: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3353: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3354: <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>
3355: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 3356: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.6 rillig 3357: </dl></dd>
3358: </dl></dd>
1.184 rillig 3359: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 3360: <dd><dl>
1.184 rillig 3361: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3362: <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>
3363: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3364: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3365: </dl></dd>
1.184 rillig 3366: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 3367: <dd><dl>
1.184 rillig 3368: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3369: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3370: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3371: </dl></dd>
3372: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3373: <dd><dl>
3374: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3375: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3376: <dd><dl>
1.184 rillig 3377: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3378: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 3379: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3380: and
3381: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3382: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3383: </dl></dd>
1.184 rillig 3384: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.241 rillig 3385: <dd><dl><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></dl></dd>
1.184 rillig 3386: </dl></dd>
3387: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 3388: <dd><dl>
1.184 rillig 3389: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3390: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3391: <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>
3392: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3393: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3394: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3395: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3396: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3397: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 3398: </dl></dd>
1.184 rillig 3399: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3400: <dd><dl>
3401: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3402: <dd><dl>
3403: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3404: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 3405: </dl></dd>
1.184 rillig 3406: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 3407: <dd><dl>
1.184 rillig 3408: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3409: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.239 dholland 3410: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
3411: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
3412: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 3413: </dl></dd>
3414: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3415: <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>
3416: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3417: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3418: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3419: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3420: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.154 rillig 3421: </dl></dd>
3422: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3423: <dd><dl>
3424: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3425: <dd><dl>
3426: <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>
3427: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3428: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3429: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3430: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3431: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3432: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3433: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3434: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3435: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3436: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3437: </dl></dd>
3438: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3439: <dd><dl>
3440: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3441: <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>
3442: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3443: </dl></dd>
3444: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3445: <dd><dl>
3446: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3447: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3448: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 3449: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.260 wiz 3450: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.154 rillig 3451: </dl></dd>
3452: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3453: <dd><dl>
3454: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3455: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 3456: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 3457: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
3458: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
3459: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
3460: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 3461: </dl></dd>
3462: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3463: <dd><dl>
3464: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3465: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 3466: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
1.266 martin 3467: <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>
1.172 rillig 3468: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 3469: </dl></dd>
3470: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3471: <dd><dl>
3472: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3473: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3474: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3475: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3476: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 3477: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.254 wiz 3478: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
3479: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
3480: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
3481: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
3482: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
3483: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
3484: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
3485: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
3486: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
3487: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.1 dsieger 3488: emulation</a></span></dt>
1.254 wiz 3489: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
3490: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.1 dsieger 3491: </dl></dd>
1.154 rillig 3492: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3493: </dl></dd>
1.184 rillig 3494: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3495: <dd><dl>
3496: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3497: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3498: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3499: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3500: </dl></dd>
1.154 rillig 3501: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3502: <dd><dl>
1.154 rillig 3503: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3504: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3505: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3506: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3507: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3508: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3509: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3510: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3511: </dl></dd>
1.263 wiz 3512: <dt><span class="chapter"><a href="#policies">24. pkgsrc Policies</a></span></dt>
3513: <dd><dl>
3514: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
3515: <dd><dl>
3516: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
3517: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
3518: </dl></dd>
3519: </dl></dd>
3520: <dt><span class="chapter"><a href="#devfaq">25. Frequently Asked Questions</a></span></dt>
1.1 dsieger 3521: </dl>
3522: </div>
3523: </div>
1.41 asau 3524: <div class="chapter">
1.1 dsieger 3525: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 3526: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
1.154 rillig 3527: <p>
3528: To get help when developing pkgsrc, the definitive source is this
3529: document, the pkgsrc guide. If you don't find anything here,
3530: there are alternatives:
3531: </p>
3532: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3533: <li class="listitem">
3534: <p>
3535: The built-in pkgsrc help, which is available after bootstrapping
1.266 martin 3536: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
1.154 rillig 3537: help for any topic, such as a variable name like
3538: <code class="varname">BUILD_DEFS</code>, a make target like
3539: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3540: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.266 martin 3541: <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.154 rillig 3542: </li>
3543: <li class="listitem"><p>
1.163 rillig 3544: To see the value of a single variable, run <span class="command"><strong>bmake
3545: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3546: </p></li>
3547: <li class="listitem"><p>
3548: To see the values of the most common variables, run
3549: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3550: topic. To see the variables for a single topic, run
3551: <span class="command"><strong>bmake
3552: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3553: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3554: </p></li>
3555: <li class="listitem"><p>
1.154 rillig 3556: The tech-pkg mailing list, to which
3557: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3558: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3559: questions</a>.</p></li>
3560: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
1.262 dholland 3561: <a class="ulink" href="https://web.libera.chat/" target="_top">via a web browser</a>
1.154 rillig 3562: or by using a specialized chat program such as
3563: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3564: Pick any user name and join the channel #pkgsrc.</p></li>
3565: </ul></div>
3566: </div>
3567: <div class="chapter">
3568: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 3569: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3570: <div class="toc">
3571: <p><b>Table of Contents</b></p>
1.100 leot 3572: <dl class="toc">
1.184 rillig 3573: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3574: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3575: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3576: <dd><dl>
3577: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3578: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3579: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3580: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3581: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3582: </dl></dd>
3583: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3584: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3585: <dd><dl>
3586: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3587: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3588: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3589: </dl></dd>
1.184 rillig 3590: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3591: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3592: </dl>
3593: </div>
1.184 rillig 3594: <p>Whenever you're preparing a package, there are a number of
3595: files involved which are described in the following
3596: sections.</p>
3597: <div class="sect1">
3598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3599: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
1.184 rillig 3600: </h2></div></div></div>
3601: <p>Building, installation and creation of a binary package are all
3602: controlled by the package's <code class="filename">Makefile</code>.
3603: The <code class="filename">Makefile</code> describes various things about
3604: a package, for example from where to get it, how to configure,
3605: build, and install it.</p>
3606: <p>A package <code class="filename">Makefile</code> contains several
3607: sections that describe the package.</p>
3608: <p>In the first section there are the following variables, which
3609: should appear exactly in the order given here. The order and
3610: grouping of the variables is mostly historical and has no further
3611: meaning.</p>
3612: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3613: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3614: distribution file to be downloaded from the package's
3615: website.</p></li>
3616: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3617: package, as used by pkgsrc. You need to provide it if
3618: <code class="varname">DISTNAME</code> (which is the default) is not a good
3619: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3620: provided (no distribution file is required). Usually it is the pkgsrc
3621: directory name together with the version number. It must match the
3622: regular expression
3623: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3624: starts with a letter or digit, and contains only letters, digits,
1.204 nia 3625: dashes, underscores, dots and plus signs.
3626: New packages should have entirely lower-case names, with the exception
3627: of some that must follow pre-existing conventions
3628: (e.g. R packages begin with <code class="varname">R-</code>).
3629: You can use the <code class="code">:tl</code> variable modifier to lower-case
3630: the package name.</p></li>
1.184 rillig 3631: <li class="listitem">
3632: <p><code class="varname">CATEGORIES</code> is a list of categories
3633: which the package fits in. You can choose any of the top-level
3634: directories of pkgsrc for it.</p>
3635: <p>Currently the following values are available for
3636: <code class="varname">CATEGORIES</code>. If more than
3637: one is used, they need to be separated by spaces:</p>
1.1 dsieger 3638: <pre class="programlisting">
1.184 rillig 3639: archivers cross geography meta-pkgs security
3640: audio databases graphics misc shells
3641: benchmarks devel ham multimedia sysutils
3642: biology editors inputmethod net textproc
3643: cad emulators lang news time
3644: chat finance mail parallel wm
3645: comms fonts math pkgtools www
3646: converters games mbone print x11
1.1 dsieger 3647: </pre>
3648: </li>
1.184 rillig 3649: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3650: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3651: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3652: and <code class="varname">DISTFILES</code> are discussed in detail in
1.266 martin 3653: <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>
1.184 rillig 3654: </ul></div>
3655: <p>The second section contains information about separately
3656: downloaded patches, if any.
3657: </p>
3658: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3659: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3660: Name(s) of additional files that contain distribution patches.
3661: There is no default. pkgsrc will look for them at
3662: <code class="varname">PATCH_SITES</code>.
3663: They will automatically be uncompressed before patching if
3664: the names end with <code class="filename">.gz</code> or
3665: <code class="filename">.Z</code>.</p></li>
3666: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3667: Primary location(s) for distribution patch files (see
3668: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3669: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.259 leot 3670: an argument to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.184 rillig 3671: help find the correct files to patch. It defaults to
3672: <span class="command"><strong>-p0</strong></span>.</p></li>
3673: </ul></div>
3674: <p>The third section contains the following variables.
3675: </p>
3676: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.253 gutterid 3677: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email address
3678: of the person who is currently responsible for this package. In
3679: theory, the maintainer will be aware of upstream release, keep it
3680: updated, and generally resolve problems. Others contemplating
3681: significant changes should ask the maintainer for advice or review
3682: of a proposed change. This is not necessary for micro updates,
3683: bug fixes, pkgsrc-wide changes affecting many packages, and other
3684: things expected to be uncontroversial. It goes with this "should
3685: ask" that the maintainer should respond to inquiries reasonably
3686: promptly (most of the time), and either approve changes or provide
3687: reasons why not. Typically, when packaging a new program, set
3688: <code class="varname">MAINTAINER</code> to yourself. If you don't intend to
3689: maintain the package (especially if you feel you have no special
3690: insight), set it to <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>. This
3691: special value is a code point indicating that there is no
3692: maintainer, but the variable is mandatory, absent
3693: <code class="varname">OWNER</code>.</p></li>
3694: <li class="listitem">
3695: <p><code class="varname">OWNER</code> can be used instead of
3696: <code class="varname">MAINTAINER</code> in relatively rare circumstances
3697: when the package is such that modifying it is riskier than normal.
3698: This is a stronger form of being the maintainer, with an
3699: expectation that others will ask for almost all changes, except
3700: revbumps and accommodating structural changes. Someone who becomes
3701: <code class="varname">OWNER</code> has a strong obligation to keep the
3702: package very well maintained, to answer queries promptly and to be
3703: a steward of the package on behalf of users. In this case,
3704: <code class="varname">MAINTAINER</code> should be omitted.</p>
3705: <p>Because of the friction that <code class="varname">OWNER</code> adds,
3706: PMC may downgrade it to <code class="varname">MAINTAINER</code> at any
3707: time.</p>
3708: </li>
1.184 rillig 3709: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3710: find more information about the package.</p></li>
3711: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3712: description of the package (should not include the package
3713: name).</p></li>
3714: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.266 martin 3715: 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>
1.184 rillig 3716: </ul></div>
3717: <p>Other variables that affect the build:
3718: </p>
3719: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3720: <p><code class="varname">WRKSRC</code>: The directory where the
3721: interesting distribution files of the package are found. The
3722: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3723: works for most packages.</p>
3724: <p>If a package doesn't create a subdirectory for itself
3725: (most GNU software does, for instance), but extracts itself in
3726: the current directory, you should set
3727: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3728: <p>If a package doesn't create a subdirectory with the
3729: name of <code class="varname">DISTNAME</code> but some different name,
3730: set <code class="varname">WRKSRC</code> to point to the proper name in
3731: <code class="filename">${WRKDIR}</code>, for example
3732: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.207 leot 3733: <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.184 rillig 3734: <p>The name of the working directory created by pkgsrc is
3735: taken from the <code class="varname">WRKDIR_BASENAME</code>
3736: variable. By default, its value is
3737: <code class="filename">work</code>. If you want to use the same
3738: pkgsrc tree for building different kinds of binary packages,
3739: you can change the variable according to your needs. Two
3740: other variables handle common cases of setting
3741: <code class="varname">WRKDIR_BASENAME</code> individually. If
3742: <code class="varname">OBJHOSTNAME</code> is defined in
3743: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3744: the host's name is attached to the directory name. If
3745: <code class="varname">OBJMACHINE</code> is defined, the platform name
3746: is attached, which might look like
3747: <code class="filename">work.i386</code> or
3748: <code class="filename">work.sparc</code>.</p>
3749: </li></ul></div>
3750: <p>Please pay attention to the following gotchas:</p>
3751: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3752: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3753: installed in compressed form by the package. For packages using
3754: BSD-style makefiles which honor MANZ, there is
3755: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3756: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
1.266 martin 3757: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.184 rillig 3758: below).</p></li>
1.266 martin 3759: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.8. Packages installing info files">Section 21.6.8, “Packages installing info files”</a>.</p></li>
1.184 rillig 3760: </ul></div>
3761: </div>
1.41 asau 3762: <div class="sect1">
1.1 dsieger 3763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3764: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
1.184 rillig 3765: </h2></div></div></div>
3766: <p>The <code class="filename">distinfo</code> file contains the message
3767: digest, or checksum, of each distfile needed for the package. This
3768: ensures that the distfiles retrieved from the Internet have not been
3769: corrupted during transfer or altered by a malign force to introduce
3770: a security hole. To provide maximum security, all distfiles are
1.243 gutterid 3771: protected using two different message digest algorithms (BLAKE2s
3772: and SHA512), as well as the file size.</p>
1.184 rillig 3773: <p>The <code class="filename">distinfo</code> file also contains the
3774: checksums for all the patches found in the
1.266 martin 3775: <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
1.184 rillig 3776: are only applied intentionally and that they don't accidentally change,
3777: e.g. when merging different changes together. They also make sure that
3778: new patches are actually added to CVS and old ones are removed.
3779: Too see whether the patches and the <code class="filename">distinfo</code> file
3780: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3781: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3782: <span class="command"><strong>make distinfo</strong></span> command.</p>
3783: <p>Some packages have different sets of distfiles depending on
1.207 leot 3784: 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.184 rillig 3785: <code class="filename">distinfo</code> file and care should be taken when
3786: upgrading such a package to ensure distfile information is not
3787: lost.</p>
3788: </div>
3789: <div class="sect1">
3790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 3791: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
1.184 rillig 3792: </h2></div></div></div>
3793: <p>Some packages don't work out-of-the box on the various
3794: platforms that are supported by pkgsrc. These packages need
3795: to be patched to make them work. The patch files can be
3796: found in the <code class="filename">patches/</code> directory.</p>
3797: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3798: applied to the files in <code class="varname">WRKSRC</code> directory after
3799: extracting them, in alphabetic order.</p>
1.41 asau 3800: <div class="sect2">
1.1 dsieger 3801: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 3802: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
1.184 rillig 3803: <p>The <code class="filename">patch-*</code> files should be in
3804: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3805: problems. (To force patches to apply with fuzz you can set
3806: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3807: should contain only changes for a single file, and no file should be
3808: patched by more than one patch file. This helps to keep future
3809: modifications simple.</p>
3810: <p>Each patch file is structured as follows: In the first line,
3811: there is the RCS Id of the patch itself. The second line should be
3812: empty for aesthetic reasons. After that, there should be a comment for
3813: each change that the patch does. There are a number of standard
3814: cases:</p>
3815: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3816: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3817: mention the vulnerability ID (CAN, CVE).</p></li>
3818: <li class="listitem"><p>Patches that change source code should mention the
3819: platform and other environment (for example, the compiler) that the
3820: patch is needed for.</p></li>
3821: </ul></div>
3822: <p>The patch should be commented so that any
3823: developer who knows the code of the application can make some use of
3824: the patch. Special care should be taken for the upstream developers,
3825: since we generally want that they accept our patches, so we have less
3826: work in the future.</p>
1.1 dsieger 3827: </div>
1.41 asau 3828: <div class="sect2">
1.1 dsieger 3829: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 3830: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
1.184 rillig 3831: <p>One important thing to mention is to pay attention that no RCS
3832: IDs get stored in the patch files, as these will cause problems when
3833: later checked into the NetBSD CVS tree. Use the
1.207 leot 3834: <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.184 rillig 3835: problems.</p>
3836: <p>For even more automation, we recommend using
3837: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.222 gutterid 3838: whole set of patches. You just have to back up files before you
3839: edit them to <code class="filename">filename.orig</code>, e.g., with
1.184 rillig 3840: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3841: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3842: you upgrade a package this way, you can easily compare the new
3843: set of patches with the previously existing one with
3844: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3845: are replaced by new files, so carefully check if you want to take all
3846: the changes.</p>
3847: <p>When you have finished a package, remember to generate
3848: the checksums for the patch files by using the <span class="command"><strong>make
1.266 martin 3849: 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>
1.184 rillig 3850: <p>When adding a patch that corrects a problem in the
3851: distfile (rather than e.g. enforcing pkgsrc's view of where
3852: man pages should go), send the patch as a bug report to the
3853: maintainer. This benefits non-pkgsrc users of the package,
3854: and usually makes it possible to remove the patch in future
3855: version.</p>
3856: <p>The file names of the patch files are usually of the form
3857: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3858: Many packages still use the previous convention
3859: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3860: but new patches should be of the form containing the filename.
1.207 leot 3861: <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.184 rillig 3862: automatically.</p>
1.222 gutterid 3863: <p>When updating pre-existing patch files, if a file uses the old
3864: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
3865: convention, it's best not to change it to the new form, as that will
3866: just cause churn that makes it harder to track changes to patching
3867: over time. Similarly, if a patch now applies at different line offsets,
3868: but still applies cleanly as-is, there's no need to update it, as that
3869: also unnecessarily complicates the patch history.</p>
1.17 imil 3870: </div>
1.160 brook 3871: <div class="sect2">
3872: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 3873: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
1.184 rillig 3874: <p>If you want to share patches between multiple packages
3875: in pkgsrc, e.g. because they use the same distfiles, set
3876: <code class="varname">PATCHDIR</code> to the path where the patch files
3877: can be found, e.g.:</p>
3878: <pre class="programlisting">
3879: PATCHDIR= ../../editors/xemacs/patches
3880: </pre>
3881: <p>Patch files that are distributed by the author or other
3882: maintainers can be listed in
3883: <code class="varname">PATCHFILES</code>.</p>
3884: <p>If it is desired to store any patches that should not be
3885: committed into pkgsrc, they can be kept outside the pkgsrc
3886: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3887: directory tree there is expected to have the same
1.266 martin 3888: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.184 rillig 3889: patches are expected to be stored inside these dirs (also
3890: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3891: example, if you want to keep a private patch for
3892: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3893: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3894: files in the named directory are expected to be patch files,
3895: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3896: applied</em></span>.</p>
1.160 brook 3897: </div>
3898: <div class="sect2">
3899: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 3900: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
1.184 rillig 3901: <p>When fixing a portability issue in the code do not use
3902: preprocessor magic to check for the current operating system nor
3903: platform. Doing so hurts portability to other platforms because
3904: the OS-specific details are not abstracted appropriately.</p>
3905: <p>The general rule to follow is: instead of checking for the
3906: operating system the application is being built on, check for the
3907: specific <span class="emphasis"><em>features</em></span> you need. For example,
3908: instead of assuming that kqueue is available under NetBSD and
3909: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3910: kqueue support, add a check that detects kqueue itself —
3911: yes, this generally involves patching the
3912: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3913: that prevents some OSes from adopting interfaces from other OSes
3914: (e.g. Linux implementing kqueue), something that the above checks
3915: cannot take into account.</p>
3916: <p>Of course, checking for features generally involves more
3917: work on the developer's side, but the resulting changes are
3918: cleaner and there are chances they will work on many other
3919: platforms. Not to mention that there are higher chances of being
3920: later integrated into the mainstream sources. Remember:
3921: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3922: <p>Some typical examples:</p>
3923: <div class="table">
1.266 martin 3924: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
1.184 rillig 3925: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3926: <colgroup>
3927: <col>
3928: <col>
3929: <col>
3930: </colgroup>
3931: <thead><tr>
3932: <th>Where</th>
3933: <th>Incorrect</th>
3934: <th>Correct</th>
3935: </tr></thead>
3936: <tbody>
3937: <tr>
3938: <td>configure script</td>
3939: <td>
1.160 brook 3940: <pre class="programlisting">
1.184 rillig 3941: case ${target_os} in
3942: netbsd*) have_kvm=yes ;;
3943: *) have_kvm=no ;;
3944: esac
1.160 brook 3945: </pre>
1.184 rillig 3946: </td>
3947: <td>
1.160 brook 3948: <pre class="programlisting">
1.184 rillig 3949: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.160 brook 3950: </pre>
1.184 rillig 3951: </td>
3952: </tr>
3953: <tr>
3954: <td>C source file</td>
3955: <td>
1.1 dsieger 3956: <pre class="programlisting">
1.184 rillig 3957: #if defined(__NetBSD__)
3958: # include <sys/event.h>
3959: #endif
1.1 dsieger 3960: </pre>
1.184 rillig 3961: </td>
3962: <td>
1.1 dsieger 3963: <pre class="programlisting">
1.184 rillig 3964: #if defined(HAVE_SYS_EVENT_H)
3965: # include <sys/event.h>
3966: #endif
1.1 dsieger 3967: </pre>
1.184 rillig 3968: </td>
3969: </tr>
3970: <tr>
3971: <td>C source file</td>
3972: <td>
1.1 dsieger 3973: <pre class="programlisting">
1.184 rillig 3974: int
3975: monitor_file(...)
3976: {
3977: #if defined(__NetBSD__)
3978: int fd = kqueue();
3979: ...
3980: #else
3981: ...
3982: #endif
3983: }
1.1 dsieger 3984: </pre>
1.184 rillig 3985: </td>
3986: <td>
1.1 dsieger 3987: <pre class="programlisting">
1.184 rillig 3988: int
3989: monitor_file(...)
3990: {
3991: #if defined(HAVE_KQUEUE)
3992: int fd = kqueue();
3993: ...
3994: #else
3995: ...
3996: #endif
3997: }
1.1 dsieger 3998: </pre>
1.184 rillig 3999: </td>
4000: </tr>
4001: </tbody>
4002: </table></div>
4003: </div>
4004: <br class="table-break">
4005: </div>
4006: <div class="sect2">
4007: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 4008: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
1.184 rillig 4009: <p>Always, always, <span class="strong"><strong>always</strong></span>
4010: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4011: improvements you do to a package to the mainstream developers.
4012: This is the only way to get their attention on portability issues
4013: and to ensure that future versions can be built out-of-the box on
4014: NetBSD. Furthermore, any user that gets newer distfiles will get
4015: the fixes straight from the packaged code.</p>
4016: <p>This generally involves cleaning up the patches
4017: (because sometimes the patches that are
4018: added to pkgsrc are quick hacks), filing bug reports in the
4019: appropriate trackers for the projects and working with the
4020: mainstream authors to accept your changes. It is
4021: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4022: the packages in pkgsrc are kept simple and thus further changes
4023: can be done without much hassle.</p>
4024: <p>When you have done this, please add a URL to the upstream
4025: bug report to the patch comment.</p>
4026: <p>Support the idea of free software!</p>
4027: </div>
1.1 dsieger 4028: </div>
1.184 rillig 4029: <div class="sect1">
4030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4031: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
1.184 rillig 4032: <div class="variablelist"><dl class="variablelist">
4033: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4034: <dd><p>A multi-line description of the piece of software. This should include
4035: any credits where they are due. Please bear in mind that others do not
4036: share your sense of humour (or spelling idiosyncrasies), and that others
4037: will read everything that you write here.</p></dd>
4038: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4039: <dd><p>This file governs the files that are installed on your
4040: system: all the binaries, manual pages, etc. There are other
4041: directives which may be entered in this file, to control the
4042: creation and deletion of directories, and the location of
1.266 martin 4043: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
1.184 rillig 4044: information.</p></dd>
4045: </dl></div>
4046: </div>
4047: <div class="sect1">
4048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4049: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
1.184 rillig 4050: <div class="sect2">
4051: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 4052: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
1.184 rillig 4053: <div class="variablelist"><dl class="variablelist">
4054: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
4055: <dd>
1.259 leot 4056: <p>This shell script is invoked twice by <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.184 rillig 4057: First time after package extraction and before files are
4058: moved in place, the second time after the files to install
4059: are moved in place. This can be used to do any custom
4060: procedures not possible with @exec commands in
1.259 leot 4061: <code class="filename">PLIST</code>. See <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
1.266 martin 4062: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information. See also <a class="xref" href="#files-and-dirs-outside-prefix" title="20.1. Files and directories outside the installation prefix">Section 20.1, “Files and directories outside the installation prefix”</a>.
1.184 rillig 4063: Please note that you can modify variables in it easily by using
4064: <code class="varname">FILES_SUBST</code> in the package's
4065: <code class="filename">Makefile</code>:</p>
1.1 dsieger 4066: <pre class="programlisting">
1.184 rillig 4067: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 4068: </pre>
1.266 martin 4069: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
1.184 rillig 4070: <code class="filename">INSTALL</code>. By default, substitution is
4071: performed for <code class="varname">PREFIX</code>,
4072: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4073: <code class="varname">VARBASE</code>, and a few others, type
4074: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4075: complete list.</p>
4076: </dd>
4077: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4078: <dd><p>This script is executed before and after any files are removed. It is
4079: this script's responsibility to clean up any additional messy details
4080: around the package's installation, since all pkg_delete knows is how to
4081: delete the files created in the original distribution.
1.259 leot 4082: See <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4083: and <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.184 rillig 4084: The same methods to replace variables can be used as for
4085: the <code class="filename">INSTALL</code> file.</p></dd>
4086: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4087: <dd>
4088: <p>This file is displayed after installation of the package.
1.198 leot 4089: While this was used often in the past, it has two
4090: problems: the display will be missed if many packages are
1.257 jkoshy 4091: installed at once, and the person installing the package
1.198 leot 4092: and the one using or configuring it may be different. It
4093: should therefore be used only in exceptional circumstances
4094: where lasting negative consequences would result from
4095: someone not reading it.</p>
4096: <p>MESSAGE should not be used for:</p>
4097: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4098: <li class="listitem"><p>exhortations to read the documentation</p></li>
4099: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
4100: <li class="listitem"><p>anything that should be explained in the
4101: installation/configuration documentation that should
4102: come with the package</p></li>
4103: </ul></div>
4104: <p>If the documentation provided by upstream needs
4105: enhancing, create e.g. files/README.pkgsrc and install it
4106: in the package's documentation directory.
4107: </p>
4108: <p>Note that MESSAGE is shown for all operating
4109: systems and all init systems. If a MESSAGE is necessary,
4110: it should be narrowed to only those operating systems and
4111: init systems to which it applies.</p>
4112: <p>Note that you can modify variables in it easily by using
1.184 rillig 4113: <code class="varname">MESSAGE_SUBST</code> in the package's
4114: <code class="filename">Makefile</code>:</p>
1.1 dsieger 4115: <pre class="programlisting">
1.184 rillig 4116: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 4117: </pre>
1.266 martin 4118: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.184 rillig 4119: <code class="filename">MESSAGE</code>. By default, substitution is
4120: performed for <code class="varname">PKGNAME</code>,
4121: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4122: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4123: <code class="varname">PKG_SYSCONFDIR</code>,
4124: <code class="varname">ROOT_GROUP</code>, and
4125: <code class="varname">ROOT_USER</code>.</p>
4126: <p>You can display a different or additional files by
4127: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4128: default is <code class="filename">MESSAGE</code>, if the file
4129: exists.</p>
4130: </dd>
4131: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4132: <dd>
4133: <p>This file is used by the alternatives framework.
4134: It creates, configures, and destroys generic wrappers used to
4135: run programs with similar interfaces.
4136: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4137: for more information.</p>
4138: <p>Each line of the file contains two filenames, first
4139: the wrapper and then the alternative provided by the package.
4140: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4141: </dd>
4142: </dl></div>
4143: </div>
4144: <div class="sect2">
4145: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 4146: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
1.184 rillig 4147: <div class="variablelist"><dl class="variablelist">
4148: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4149: <dd><p>This file contains arbitrary things that could
4150: also go into a <code class="filename">Makefile</code>, but its purpose is
4151: to be used by more than one package. This file should only be
4152: used when the packages that will use the file are known in
4153: advance. For other purposes it is often better to write a
4154: <code class="filename">*.mk</code> file and give it a good name that
4155: describes what it does.</p></dd>
4156: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4157: <dd><p>This file contains the dependency information
1.266 martin 4158: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
1.184 rillig 4159: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4160: <dd><p>This file contains workarounds for compiler bugs
4161: and similar things. It is included automatically by the pkgsrc
4162: infrastructure, so you don't need an extra
4163: <code class="literal">.include</code> line for
4164: it.</p></dd>
4165: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4166: <dd><p>This file contains the code for the
1.266 martin 4167: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.184 rillig 4168: selected by the user. If a package has only one or two options,
4169: it is equally acceptable to put the code directly into the
4170: <code class="filename">Makefile</code>.</p></dd>
4171: </dl></div>
4172: </div>
4173: <div class="sect2">
4174: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 4175: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
1.184 rillig 4176: <div class="variablelist"><dl class="variablelist">
4177: <dt><span class="term"><code class="filename">README*</code></span></dt>
4178: <dd><p>These files do not take place in the creation of
4179: a package and thus are purely informative to the package
4180: developer.</p></dd>
4181: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4182: <dd><p>This file contains things that need to be done
4183: to make the package even
4184: better.</p></dd>
4185: </dl></div>
4186: </div>
4187: </div>
4188: <div class="sect1">
4189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4190: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
1.184 rillig 4191: </h2></div></div></div>
4192: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4193: unpacked into the directory denoted by
4194: <code class="varname">WRKDIR</code>. It can be removed by running
4195: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4196: directory is also used to keep various timestamp files.
4197: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4198: The default is <code class="filename">${.CURDIR}/work</code>
4199: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4200: if <code class="varname">OBJMACHINE</code> is set.</p>
1.1 dsieger 4201: </div>
1.184 rillig 4202: <div class="sect1">
4203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4204: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
1.184 rillig 4205: </h2></div></div></div>
4206: <p>If you have any files that you wish to be placed in the package
4207: prior to configuration or building, you can place these files here
4208: and use a <span class="command"><strong>${CP}</strong></span> command in the
1.266 martin 4209: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
1.184 rillig 4210: <p>If you want to share files in this way with other
4211: packages, set the <code class="varname">FILESDIR</code> variable to point
4212: to the other package's <code class="filename">files</code> directory,
4213: e.g.:</p>
1.1 dsieger 4214: <pre class="programlisting">
1.184 rillig 4215: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 4216: </pre>
4217: </div>
4218: </div>
1.41 asau 4219: <div class="chapter">
1.1 dsieger 4220: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 4221: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.1 dsieger 4222: <div class="toc">
4223: <p><b>Table of Contents</b></p>
1.100 leot 4224: <dl class="toc">
1.184 rillig 4225: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4226: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4227: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4228: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4229: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4230: <dd><dl>
4231: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4232: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4233: </dl></dd>
4234: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4235: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4236: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4237: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4238: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4239: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4240: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4241: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4242: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4243: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4244: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4245: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.1 dsieger 4246: </dl>
4247: </div>
1.41 asau 4248: <div class="sect1">
1.1 dsieger 4249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4250: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
1.184 rillig 4251: <p>This chapter gives a detailed description on how a package is
4252: built. Building a package is separated into different
4253: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4254: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4255: described in the following sections. Each phase is split into
4256: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4257: containing phase, prefixed by one of <code class="varname">pre-</code>,
4258: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4259: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4260: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4261: <p>Never override the regular targets (like
4262: <code class="varname">fetch</code>), if you have to, override the
4263: <code class="varname">do-*</code> ones instead.</p>
4264: <p>The basic steps for building a program are always the same. First
4265: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4266: the local system and then extracted. After any pkgsrc-specific patches
4267: to compile properly are applied, the software can be configured, then
4268: built (usually by compiling), and finally the generated binaries, etc.
4269: can be put into place on the system.</p>
4270: <p>To get more details about what is happening at each step,
4271: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4272: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4273: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4274: </div>
4275: <div class="sect1">
4276: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4277: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
1.184 rillig 4278: <p>Before outlining the process performed by the NetBSD package system in
4279: the next section, here's a brief discussion on where programs are
4280: installed, and which variables influence this.</p>
4281: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4282: where all files of the final program shall be installed. It is
4283: usually set to <code class="varname">LOCALBASE</code>
4284: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4285: for pkgs in the <code class="filename">cross</code> category. The value of
4286: <code class="varname">PREFIX</code> needs to be put
4287: into the various places in the program's source where paths to
1.266 martin 4288: 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>
1.184 rillig 4289: <p>When choosing which of these variables to use,
4290: follow the following rules:</p>
1.41 asau 4291: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 4292: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4293: where the current pkg will be installed. When referring to a
4294: pkg's own installation path, use
1.266 martin 4295: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
1.223 nia 4296: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.184 rillig 4297: are installed. If you need to construct a -I or -L argument
4298: to the compiler to find includes and libraries installed by
1.266 martin 4299: another pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.184 rillig 4300: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4301: installed all packages in <code class="filename">/usr/local</code>. As
4302: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4303: administrator, this variable is a misnomer.</p></li>
4304: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4305: distribution (from xsrc, etc.) is installed. When looking for
4306: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.266 martin 4307: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.184 rillig 4308: <li class="listitem"><p>X11-based packages using imake must set
4309: <code class="varname">USE_IMAKE</code> to be installed correctly under
4310: <code class="varname">LOCALBASE</code>.</p></li>
4311: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.259 leot 4312: install files according to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.184 rillig 4313: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4314: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4315: </ul></div>
4316: </div>
4317: <div class="sect1">
4318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4319: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
1.184 rillig 4320: <p>When building a package, various directories are used to store
4321: source files, temporary files, pkgsrc-internal files, and so on. These
4322: directories are explained here.</p>
4323: <p>Some of the directory variables contain relative pathnames. There
4324: are two common base directories for these relative directories:
4325: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4326: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4327: inside the package itself.</p>
4328: <div class="variablelist"><dl class="variablelist">
4329: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4330: <dd><p>This is an absolute pathname that points to the pkgsrc
4331: root directory. Generally, you don't need
4332: it.</p></dd>
4333: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4334: <dd><p>This is an absolute pathname that points to the
4335: current package.</p></dd>
4336: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.228 gutterid 4337: <dd>
4338: <p>This is a pathname relative to
4339: <code class="varname">PKGSRCDIR</code> that points to the current package.
4340: It is defined after including <code class="filename">bsd.prefs.mk</code>
4341: and can be used in makefile fragments that are used by several
4342: packages to distinguish between these packages. Other variables
4343: that would serve the same purpose are <code class="varname">PKGBASE</code>
4344: and <code class="varname">PKGNAME</code>, but these are only defined after
4345: including <code class="filename">bsd.pkg.mk</code>, which is too
4346: late.</p>
4347: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
4348: <code class="varname">PKGPATH</code> to tweak variables like
4349: <code class="varname">MAKE_JOBS</code> and
4350: <code class="varname">CFLAGS</code>.</p>
4351: </dd>
1.184 rillig 4352: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4353: <dd><p>This is an absolute pathname pointing to the directory
4354: where all work takes place. The distfiles are extracted to this
4355: directory. It also contains temporary directories and log files used by
4356: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4357: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4358: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4359: <dd><p>This is an absolute pathname pointing to the directory
4360: where the distfiles are extracted. It is usually a direct subdirectory
4361: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4362: that isn't hidden. This variable may be changed by a package
4363: <code class="filename">Makefile</code>.</p></dd>
4364: </dl></div>
4365: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4366: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4367: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4368: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4369: If users would like to have their pkgsrc trees behave in a
4370: read-only manner, then the value of
4371: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4372: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 4373: </div>
1.41 asau 4374: <div class="sect1">
1.1 dsieger 4375: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4376: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
1.184 rillig 4377: <p>You can run a particular phase by typing <span class="command"><strong>make
1.228 gutterid 4378: <em class="replaceable"><code>phase</code></em></strong></span>, where
4379: <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
4380: automatically run all phases that are required for this phase. The
4381: default phase is <code class="varname">build</code>, that is, when you run
4382: <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.184 rillig 4383: the package will be built, but not installed.</p>
1.1 dsieger 4384: </div>
1.41 asau 4385: <div class="sect1">
1.1 dsieger 4386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4387: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.184 rillig 4388: <p>The first step in building a package is to fetch the
4389: distribution files (distfiles) from the sites that are providing
4390: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4391: phase.</p>
1.41 asau 4392: <div class="sect2">
1.1 dsieger 4393: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 4394: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
1.184 rillig 4395: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4396: defines all URLs from where the distfile, whose name is
4397: derived from the <code class="varname">DISTNAME</code> variable, is
4398: fetched. The more complicated cases are described
4399: below.</p>
4400: <p>The variable <code class="varname">DISTFILES</code> specifies
4401: the list of distfiles that have to be fetched. Its value
4402: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4403: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4404: so that most packages don't need to define it at all.
4405: <code class="varname">EXTRACT_SUFX</code> is
4406: <code class="literal">.tar.gz</code> by default, but can be changed
4407: freely. Note that if your package requires additional
4408: distfiles to the default one, you cannot just append the
4409: additional filenames using the <code class="literal">+=</code>
4410: operator, but you have write for example:</p>
4411: <pre class="programlisting">
4412: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4413: </pre>
4414: <p>Each distfile is fetched from a list of sites, usually
4415: <code class="varname">MASTER_SITES</code>. If the package has multiple
4416: <code class="varname">DISTFILES</code> or multiple
4417: <code class="varname">PATCHFILES</code> from different sites, you can
4418: set
4419: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4420: to the list of URLs where the file
4421: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4422: (including the suffix) can be found.</p>
4423: <pre class="programlisting">
4424: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4425: DISTFILES+= foo-file.tar.gz
4426: SITES.foo-file.tar.gz= \
4427: https://www.somewhere.com/somehow/ \
4428: https://www.somewhereelse.com/mirror/somehow/
4429: </pre>
4430: <p>When actually fetching the distfiles, each item from
4431: <code class="varname">MASTER_SITES</code> or
4432: <code class="varname">SITES.*</code> gets the name of each distfile
4433: appended to it, without an intermediate slash. Therefore,
4434: all site values have to end with a slash or other separator
4435: character. This allows for example to set
4436: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4437: that gets the name of the distfile as a parameter. In this
4438: case, the definition would look like:</p>
4439: <pre class="programlisting">
4440: MASTER_SITES= https://www.example.com/download.cgi?file=
4441: </pre>
4442: <p> The exception to this rule are URLs starting with a dash.
4443: In that case the URL is taken as is, fetched and the result
4444: stored under the name of the distfile. You can use this style
4445: for the case when the download URL style does not match the
4446: above common case. For example, if permanent download URL is a
4447: redirector to the real download URL, or the download file name
4448: is offered by an HTTP Content-Disposition header. In the
4449: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4450: created instead of the default
4451: <code class="filename">v1.0.0.tar.gz</code>.</p>
4452: <pre class="programlisting">
4453: DISTNAME= foo-1.0.0
4454: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4455: </pre>
4456: <p>There are some predefined values for
4457: <code class="varname">MASTER_SITES</code>, which can be used in
4458: packages. The names of the variables should speak for
4459: themselves.</p>
4460: <table border="0" summary="Simple list" class="simplelist">
4461: <tr>
4462: <td>MASTER_SITE_APACHE</td>
4463: <td>MASTER_SITE_BACKUP</td>
4464: </tr>
4465: <tr>
4466: <td>MASTER_SITE_CRATESIO</td>
4467: <td>MASTER_SITE_CYGWIN</td>
4468: </tr>
4469: <tr>
4470: <td>MASTER_SITE_DEBIAN</td>
4471: <td>MASTER_SITE_FREEBSD</td>
4472: </tr>
4473: <tr>
4474: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4475: <td>MASTER_SITE_GENTOO</td>
4476: </tr>
4477: <tr>
4478: <td>MASTER_SITE_GITHUB</td>
1.225 gutterid 4479: <td>MASTER_SITE_GITLAB</td>
4480: </tr>
4481: <tr>
1.184 rillig 4482: <td>MASTER_SITE_GNOME</td>
1.225 gutterid 4483: <td>MASTER_SITE_GNU</td>
1.184 rillig 4484: </tr>
4485: <tr>
1.260 wiz 4486: <td>MASTER_SITE_GNUPG</td>
1.184 rillig 4487: <td>MASTER_SITE_GNUSTEP</td>
4488: </tr>
4489: <tr>
1.260 wiz 4490: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.184 rillig 4491: <td>MASTER_SITE_IFARCHIVE</td>
4492: </tr>
4493: <tr>
1.260 wiz 4494: <td>MASTER_SITE_KDE</td>
1.184 rillig 4495: <td>MASTER_SITE_MOZILLA</td>
4496: </tr>
4497: <tr>
1.260 wiz 4498: <td>MASTER_SITE_MOZILLA_ALL</td>
1.184 rillig 4499: <td>MASTER_SITE_MYSQL</td>
4500: </tr>
4501: <tr>
1.260 wiz 4502: <td>MASTER_SITE_NETLIB</td>
1.184 rillig 4503: <td>MASTER_SITE_OPENBSD</td>
4504: </tr>
4505: <tr>
1.260 wiz 4506: <td>MASTER_SITE_OPENOFFICE</td>
1.184 rillig 4507: <td>MASTER_SITE_OSDN</td>
4508: </tr>
4509: <tr>
1.260 wiz 4510: <td>MASTER_SITE_PERL_CPAN</td>
1.184 rillig 4511: <td>MASTER_SITE_PGSQL</td>
4512: </tr>
4513: <tr>
1.260 wiz 4514: <td>MASTER_SITE_PYPI</td>
1.184 rillig 4515: <td>MASTER_SITE_RUBYGEMS</td>
4516: </tr>
4517: <tr>
1.260 wiz 4518: <td>MASTER_SITE_R_CRAN</td>
1.184 rillig 4519: <td>MASTER_SITE_SOURCEFORGE</td>
4520: </tr>
1.1 dsieger 4521: <tr>
1.260 wiz 4522: <td>MASTER_SITE_SUNSITE</td>
1.184 rillig 4523: <td>MASTER_SITE_SUSE</td>
1.1 dsieger 4524: </tr>
4525: <tr>
1.260 wiz 4526: <td>MASTER_SITE_TEX_CTAN</td>
1.184 rillig 4527: <td>MASTER_SITE_XCONTRIB</td>
1.1 dsieger 4528: </tr>
4529: <tr>
1.260 wiz 4530: <td>MASTER_SITE_XEMACS</td>
1.184 rillig 4531: <td>MASTER_SITE_XORG</td>
4532: </tr>
4533: </table>
4534: <p>Some explanations for the less self-explaining ones:
4535: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.254 wiz 4536: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.184 rillig 4537: 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>
4538: <p>If you choose one of these predefined sites, you may
4539: want to specify a subdirectory of that site. Since these
4540: macros may expand to more than one actual site, you
4541: <span class="emphasis"><em>must</em></span> use the following construct to
4542: specify a subdirectory:</p>
1.1 dsieger 4543: <pre class="programlisting">
1.184 rillig 4544: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4545: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 4546: </pre>
1.184 rillig 4547: <p>Note the trailing slash after the subdirectory
4548: name.</p>
4549: </div>
4550: <div class="sect2">
4551: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 4552: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
1.184 rillig 4553: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4554: all the distfiles exist in a local directory
4555: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4556: user). If the files do not exist, they are fetched using
4557: commands of the form</p>
1.1 dsieger 4558: <pre class="programlisting">
1.184 rillig 4559: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4560: </pre>
4561: <p>where <code class="literal">${site}</code> varies through
4562: several possibilities in turn: first,
4563: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4564: sites specified in either <code class="varname">SITES.file</code> if
4565: defined, else <code class="varname">MASTER_SITES</code> or
4566: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4567: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4568: all except the first and the last can be optionally sorted
4569: by the user, via setting either
4570: <code class="varname">MASTER_SORT_RANDOM</code>, and
4571: <code class="varname">MASTER_SORT_AWK</code> or
4572: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4573: <p> The specific command and arguments used depend on the
4574: <code class="varname">FETCH_USING</code> parameter. The example above is
4575: for <code class="literal">FETCH_USING=custom</code>.</p>
4576: <p>The distfiles mirror run by the NetBSD Foundation uses the
4577: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4578: distfiles, if they are freely distributable. Packages setting
4579: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.266 martin 4580: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.184 rillig 4581: mirrored.</p>
1.1 dsieger 4582: </div>
4583: </div>
1.184 rillig 4584: <div class="sect1">
4585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4586: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.184 rillig 4587: <p>After the distfile(s) are fetched, their checksum is
4588: generated and compared with the checksums stored in the
4589: distinfo file. If the checksums don't match, the build is
4590: aborted. This is to ensure the same distfile is used for
4591: building, and that the distfile wasn't changed, e.g. by some
4592: malign force, deliberately changed distfiles on the master
4593: distribution site or network lossage.</p>
1.1 dsieger 4594: </div>
1.41 asau 4595: <div class="sect1">
1.1 dsieger 4596: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4597: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.184 rillig 4598: <p>When the distfiles are present on the local system, they
4599: need to be extracted, as they usually come in the form of some
4600: compressed archive format.</p>
4601: <p>By default, all <code class="varname">DISTFILES</code> are
4602: extracted. If you only need some of them, you can set the
4603: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4604: files.</p>
4605: <p>Extracting the files is usually done by a little
4606: program, <code class="filename">mk/extract/extract</code>, which
4607: already knows how to extract various archive formats, so most
4608: likely you will not need to change anything here. But if you
4609: need, the following variables may help you:</p>
1.41 asau 4610: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4611: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4612: <dd><p>Use these variables to override the default
4613: options for an extract command, which are defined in
4614: <code class="filename">mk/extract/extract</code>.</p></dd>
4615: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4616: <dd><p>This variable can be set to
4617: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4618: (which is the default value), <code class="literal">pax</code>, or an
4619: absolute pathname pointing to the command with which tar
4620: archives should be extracted. It is preferred to choose bsdtar over gtar
4621: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 4622: </dl></div>
1.184 rillig 4623: <p>If the <code class="filename">extract</code> program doesn't
4624: serve your needs, you can also override the
4625: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4626: command used for extracting the files. This command is
4627: executed in the <code class="filename">${WRKSRC}</code>
4628: directory. During execution of this command, the shell
4629: variable <code class="varname">extract_file</code> holds the absolute
4630: pathname of the file that is going to be extracted.</p>
4631: <p>And if that still does not suffice, you can override the
4632: <code class="varname">do-extract</code> target in the package
4633: Makefile.</p>
1.1 dsieger 4634: </div>
1.41 asau 4635: <div class="sect1">
1.1 dsieger 4636: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4637: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.184 rillig 4638: <p>After extraction, all the patches named by the
4639: <code class="varname">PATCHFILES</code>, those present in the patches
4640: subdirectory of the package as well as in
4641: $LOCALPATCHES/$PKGPATH (e.g.
4642: <code class="filename">/usr/local/patches/graphics/png</code>) are
4643: applied. Patchfiles ending in <code class="filename">.Z</code> or
4644: <code class="filename">.gz</code> are uncompressed before they are
4645: applied, files ending in <code class="filename">.orig</code> or
4646: <code class="filename">.rej</code> are ignored. Any special options to
1.259 leot 4647: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.266 martin 4648: <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.259 leot 4649: <p>By default <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.184 rillig 4650: fail if the expected text from the patch context is not found in the
4651: patched file. If that happens, fix the patch file by comparing it
4652: with the actual text in the file to be patched.</p>
1.1 dsieger 4653: </div>
1.41 asau 4654: <div class="sect1">
1.1 dsieger 4655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4656: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4657: <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>.
1.184 rillig 4658: </p>
1.1 dsieger 4659: </div>
1.41 asau 4660: <div class="sect1">
1.1 dsieger 4661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4662: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.184 rillig 4663: <p>This phase creates wrapper programs for the compilers and
4664: linkers. The following variables can be used to tweak the
4665: wrappers.</p>
4666: <div class="variablelist"><dl class="variablelist">
4667: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4668: <dd><p>The command used to print progress
4669: messages. Does nothing by default. Set to
4670: <code class="literal">${ECHO}</code> to see the progress
4671: messages.</p></dd>
4672: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4673: <dd><p>This variable can be set to
4674: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4675: depending on whether you want additional information in the
4676: wrapper log file.</p></dd>
4677: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4678: <dd><p>This variable can be set to
4679: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4680: on whether the wrapper should use its cache, which will
4681: improve the speed. The default value is
4682: <code class="literal">yes</code>, but is forced to
4683: <code class="literal">no</code> if the platform does not support
4684: it.</p></dd>
4685: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4686: <dd><p>A list of reordering commands. A reordering
4687: command has the form
4688: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4689: It ensures that that
4690: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4691: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4692: </p></dd>
4693: </dl></div>
4694: </div>
4695: <div class="sect1">
4696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4697: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.184 rillig 4698: <p>Most pieces of software need information on the header
4699: files, system calls, and library routines which are available
4700: on the platform they run on. The process of determining this
4701: information is known as configuration, and is usually
4702: automated. In most cases, a script is supplied with the
4703: distfiles, and its invocation results in generation of header
4704: files, Makefiles, etc.</p>
4705: <p>If the package contains a configure script, this can be
4706: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.266 martin 4707: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.184 rillig 4708: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.266 martin 4709: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
1.187 rillig 4710: <p>In the <code class="literal">do-configure</code> stage, a rough
4711: equivalent of the following command is run. See
4712: <code class="filename">mk/configure/configure.mk</code>, target
4713: <code class="literal">do-configure-script</code> for the exact
4714: definition.</p>
4715: <pre class="programlisting">
4716: .for dir in ${CONFIGURE_DIRS}
4717: cd ${WRKSRC} && cd ${dir} \
4718: && env ${CONFIGURE_ENV} \
4719: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 4720: .endfor
1.1 dsieger 4721: </pre>
1.184 rillig 4722: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.266 martin 4723: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.184 rillig 4724: <code class="varname">WRKSRC</code>. In each of these directories, the
4725: configure script is run with the environment
4726: <code class="varname">CONFIGURE_ENV</code> and arguments
4727: <code class="varname">CONFIGURE_ARGS</code>. The variables
4728: <code class="varname">CONFIGURE_ENV</code>,
4729: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.266 martin 4730: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.184 rillig 4731: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4732: package.</p>
4733: <p>If the program uses the Perl way of configuration (mainly Perl
4734: modules, but not only), i.e. a file called
4735: <code class="filename">Makefile.PL</code>, it should include
4736: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4737: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4738: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4739: <p>If the program uses an <code class="filename">Imakefile</code>
4740: for configuration, the appropriate steps can be invoked by
4741: setting <code class="varname">USE_IMAKE</code> to
1.266 martin 4742: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
1.184 rillig 4743: You can add variables to xmkmf's environment by adding them to the
4744: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4745: <p>If the program uses <code class="filename">cmake</code>
4746: for configuration, the appropriate steps can be invoked by
1.233 wiz 4747: including <code class="filename">../../devel/cmake/build.mk</code>.
1.184 rillig 4748: You can add variables to cmake's environment by adding them to the
4749: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
1.256 wiz 4750: by adding them to the <code class="varname">CMAKE_CONFIGURE_ARGS</code> variable.
1.233 wiz 4751: If you want to add arguments only for particular stages, you can use the
4752: <code class="varname">CMAKE_CONFIGURE_ARGS</code>,
4753: <code class="varname">CMAKE_BUILD_ARGS</code>, and
4754: <code class="varname">CMAKE_INSTALL_ARGS</code> variables.
4755: You can set the <code class="varname">CONFIGURE_DIRS</code> variable to the
4756: directories in which CMake should be run, relative to
1.266 martin 4757: <code class="varname">WRKSRC</code>. This defaults to to <span class="quote">“<span class="quote">.</span>”</span>.
1.233 wiz 4758: </p>
1.256 wiz 4759: <p>Any package using the now-deprecated
4760: <code class="varname">USE_CMAKE=yes</code> should be converted.
4761: Essentially, replace with an include of
4762: <code class="filename">../../devel/cmake/build.mk</code>, prune creation of a build
4763: directory and settings to use it, and check/fix settings that
4764: intend to perform the build in a subdirectory.
4765: </p>
1.184 rillig 4766: <p>If there is no configure step at all, set
1.266 martin 4767: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4768: </div>
1.41 asau 4769: <div class="sect1">
1.1 dsieger 4770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4771: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.187 rillig 4772: <p>For building a package, a rough equivalent of the following
4773: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4774: <code class="literal">do-build</code> for the exact definition.</p>
1.1 dsieger 4775: <pre class="programlisting">
1.187 rillig 4776: .for dir in ${BUILD_DIRS}
4777: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 4778: && env ${MAKE_ENV} \
1.187 rillig 4779: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 4780: -f ${MAKE_FILE} \
4781: ${BUILD_TARGET}
4782: .endfor
1.1 dsieger 4783: </pre>
1.184 rillig 4784: <p><code class="varname">BUILD_DIRS</code> (default:
1.266 martin 4785: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.184 rillig 4786: <code class="varname">WRKSRC</code>. In each of these directories,
4787: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4788: <code class="varname">MAKE_ENV</code> and arguments
4789: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4790: <code class="varname">MAKE_ENV</code>,
4791: <code class="varname">BUILD_MAKE_FLAGS</code>,
4792: <code class="varname">MAKE_FILE</code> and
4793: <code class="varname">BUILD_TARGET</code> may all be changed by the
4794: package.</p>
4795: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.266 martin 4796: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4797: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.184 rillig 4798: default value of <code class="varname">MAKE_FILE</code> is
1.266 martin 4799: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4800: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.184 rillig 4801: <p>If there is no build step at all, set
1.266 martin 4802: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4803: </div>
1.41 asau 4804: <div class="sect1">
1.1 dsieger 4805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4806: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.184 rillig 4807: <p>[TODO]</p>
1.1 dsieger 4808: </div>
1.41 asau 4809: <div class="sect1">
1.1 dsieger 4810: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4811: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.184 rillig 4812: <p>Once the build stage has completed, the final step is to
4813: install the software in public directories, so users can
4814: access the programs and files.</p>
1.187 rillig 4815: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4816: of the following code is executed; see
4817: <code class="filename">mk/install/install.mk</code>, target
4818: <code class="literal">do-install</code> for the exact definition. Additionally,
4819: before and after this code, several consistency checks are run
4820: against the files-to-be-installed, see
4821: <code class="filename">mk/check/*.mk</code> for details.</p>
4822: <pre class="programlisting">
4823: .for dir in ${INSTALL_DIRS}
4824: cd ${WRKSRC} && cd ${dir} \
4825: && env ${INSTALL_ENV} ${MAKE_ENV} \
4826: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4827: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 4828: .endfor
1.1 dsieger 4829: </pre>
1.184 rillig 4830: <p>The variable's meanings are analogous to the ones in the
4831: <span class="emphasis"><em>build</em></span> phase.
4832: <code class="varname">INSTALL_DIRS</code> defaults to
4833: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.266 martin 4834: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4835: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.184 rillig 4836: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4837: defined.</p>
4838: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4839: variables are useful. They are all variations of the
1.259 leot 4840: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.184 rillig 4841: permissions preset. <code class="varname">INSTALL</code> is the plain
4842: install command. The specialized variants, together with their
4843: intended use, are:</p>
4844: <div class="variablelist"><dl class="variablelist">
4845: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4846: <dd><p>directories that contain
4847: binaries</p></dd>
4848: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4849: <dd><p>directories that contain
4850: scripts</p></dd>
4851: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4852: <dd><p>directories that contain shared and static
4853: libraries</p></dd>
4854: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4855: <dd><p>directories that contain data
4856: files</p></dd>
4857: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4858: <dd><p>directories that contain man
4859: pages</p></dd>
4860: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4861: <dd><p>directories that contain data files for games
4862: </p></dd>
4863: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4864: <dd><p>binaries that can be stripped from debugging
4865: symbols</p></dd>
4866: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4867: <dd><p>binaries that cannot be
4868: stripped</p></dd>
4869: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4870: <dd><p>game
4871: binaries</p></dd>
4872: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4873: <dd><p>shared and static
4874: libraries</p></dd>
4875: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4876: <dd><p>data files</p></dd>
4877: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4878: <dd><p>data files for
4879: games</p></dd>
4880: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4881: <dd><p>man pages</p></dd>
4882: </dl></div>
4883: <p>Some other variables are:</p>
4884: <div class="variablelist"><dl class="variablelist">
4885: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.259 leot 4886: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.184 rillig 4887: when installing binaries. Any debugging sections and symbols present in
4888: binaries will be preserved.
4889: </p></dd>
4890: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4891: <dd><p>A list of directories relative to
4892: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4893: beginning of the <span class="emphasis"><em>install</em></span> phase.
4894: The package is supposed to create all needed directories itself
4895: before installing files to it and list all other directories here.
4896: </p></dd>
4897: </dl></div>
4898: <p>In the rare cases that a package shouldn't install anything,
1.266 martin 4899: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.184 rillig 4900: mostly relevant for packages in the <code class="filename">regress</code>
4901: category.</p>
1.1 dsieger 4902: </div>
1.41 asau 4903: <div class="sect1">
1.1 dsieger 4904: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4905: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.184 rillig 4906: <p>Once the install stage has completed, a binary package of
4907: the installed files can be built. These binary packages can be
4908: used for quick installation without previous compilation, e.g. by
4909: the <span class="command"><strong>make bin-install</strong></span> or by using
4910: <span class="command"><strong>pkg_add</strong></span>.</p>
4911: <p>By default, the binary packages are created in
4912: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4913: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4914: one for each category in the <code class="varname">CATEGORIES</code>
4915: variable. <code class="varname">PACKAGES</code> defaults to
4916: <code class="filename">pkgsrc/packages</code>.</p>
1.1 dsieger 4917: </div>
1.41 asau 4918: <div class="sect1">
1.1 dsieger 4919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4920: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
1.184 rillig 4921: <p>Once you're finished with a package, you can clean the work
4922: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4923: to clean the work directories of all dependencies too, use
4924: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 4925: </div>
1.41 asau 4926: <div class="sect1">
1.1 dsieger 4927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 4928: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.41 asau 4929: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4930: <dt><span class="term">pre/post-*</span></dt>
4931: <dd>
4932: <p>For any of the main targets described in the previous
4933: section (configure, build, install, etc.), two auxiliary
4934: targets exist with
1.266 martin 4935: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.184 rillig 4936: prefix for the main target's name. These targets are
4937: invoked before and after the main target is called,
4938: allowing extra configuration or installation steps be
4939: performed from a package's Makefile, for example, which
4940: a program's configure script or install target
4941: omitted.</p>
4942: <p>About 5% of the pkgsrc packages define their custom
4943: post-extract target, another 5% define pre-configure, and 10%
4944: define post-install. The other pre/post-* targets are defined
4945: even less often.</p>
4946: </dd>
4947: <dt><span class="term">do-*</span></dt>
1.1 dsieger 4948: <dd>
1.184 rillig 4949: <p>Should one of the main targets do the wrong thing,
4950: and should there be no variable to fix this, you can
4951: redefine it with the do-* target. (Note that redefining
4952: the target itself instead of the do-* target is a bad
4953: idea, as the pre-* and post-* targets won't be called
4954: anymore, etc.)</p>
4955: <p>About 15% of the pkgsrc packages override the default
4956: do-install, the other do-* targets are overridden even less
4957: often.</p>
1.1 dsieger 4958: </dd>
1.184 rillig 4959: <dt><span class="term">reinstall</span></dt>
1.1 dsieger 4960: <dd>
1.184 rillig 4961: <p>If you did a <span class="command"><strong>make install</strong></span> and
4962: you noticed some file was not installed properly, you
4963: can repeat the installation with this target, which will
1.266 martin 4964: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.184 rillig 4965: <p>This is the default value of
4966: <code class="varname">DEPENDS_TARGET</code> except in the case of
4967: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4968: package</strong></span>, where the defaults are
1.266 martin 4969: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.184 rillig 4970: respectively.</p>
1.1 dsieger 4971: </dd>
1.184 rillig 4972: <dt><span class="term">deinstall</span></dt>
4973: <dd>
1.259 leot 4974: <p>This target does a <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.184 rillig 4975: current directory, effectively de-installing the
4976: package. The following variables can be used to tune the
4977: behaviour:</p>
4978: <div class="variablelist"><dl class="variablelist">
4979: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.259 leot 4980: <dd><p>Add a "-v" to the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.184 rillig 4981: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4982: <dd><p>Remove all packages that require (depend on)
4983: the given package. This can be used to remove any
4984: packages that may have been pulled in by a given
4985: package, e.g. if <span class="command"><strong>make deinstall
4986: DEINSTALLDEPENDS=1</strong></span> is done in
4987: <code class="filename">pkgsrc/x11/kde</code>, this is
4988: likely to remove whole KDE. Works by adding
1.266 martin 4989: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.184 rillig 4990: command line.</p></dd>
4991: </dl></div>
4992: </dd>
4993: <dt><span class="term">bin-install</span></dt>
4994: <dd><p>Install a binary package from local disk and via FTP
4995: from a list of sites (see the
4996: <code class="varname">BINPKG_SITES</code> variable), and do a
4997: <span class="command"><strong>make package</strong></span> if no binary package is
4998: available anywhere. The arguments given to
4999: <span class="command"><strong>pkg_add</strong></span> can be set via
5000: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
5001: operation, etc.</p></dd>
5002: <dt><span class="term">install-clean</span></dt>
5003: <dd><p>This target removes the state files for the "install" and later
5004: phases so that the "install" target may be re-invoked. This can be
5005: used after editing the PLIST to install the package without
5006: rebuilding it.</p></dd>
5007: <dt><span class="term">build-clean</span></dt>
5008: <dd><p>This target removes the state files for the "build" and later
5009: phases so that the "build" target may be re-invoked.</p></dd>
5010: <dt><span class="term">update</span></dt>
5011: <dd>
5012: <p>This target causes the current package to be
5013: updated to the latest version. The package and all
5014: depending packages first get de-installed, then current
5015: versions of the corresponding packages get compiled and
5016: installed. This is similar to manually noting which
5017: packages are currently installed, then performing a
5018: series of <span class="command"><strong>make deinstall</strong></span> and
5019: <span class="command"><strong>make install</strong></span> (or whatever
5020: <code class="varname">UPDATE_TARGET</code> is set to) for these
5021: packages.</p>
1.266 martin 5022: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.184 rillig 5023: resume package updating in case a previous <span class="command"><strong>make
5024: update</strong></span> was interrupted for some reason.
5025: However, in this case, make sure you don't call
5026: <span class="command"><strong>make clean</strong></span> or otherwise remove the
5027: list of dependent packages in <code class="varname">WRKDIR</code>.
5028: Otherwise, you lose the ability to automatically update
5029: the current package along with the dependent packages
5030: you have installed.</p>
5031: <p>Resuming an interrupted <span class="command"><strong>make
5032: update</strong></span> will only work as long as the package
5033: tree remains unchanged. If the source code for one of
5034: the packages to be updated has been changed, resuming
5035: <span class="command"><strong>make update</strong></span> will most certainly
5036: fail!</p>
5037: <p>The following variables can be used either on the
5038: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
5039: alter the behaviour of <span class="command"><strong>make
5040: update</strong></span>:</p>
5041: <div class="variablelist"><dl class="variablelist">
5042: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
5043: <dd><p>Install target to recursively use for the
5044: updated package and the dependent packages.
5045: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.266 martin 5046: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.184 rillig 5047: <span class="command"><strong>make update</strong></span>. Other good
1.266 martin 5048: targets are <span class="quote">“<span class="quote">package</span>”</span> or
5049: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
5050: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.184 rillig 5051: endless loop!</p></dd>
5052: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
5053: <dd><p>Don't clean up after updating. Useful if
5054: you want to leave the work sources of the updated
5055: packages around for inspection or other purposes.
5056: Be sure you eventually clean up the source tree
1.266 martin 5057: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.184 rillig 5058: or you may run into troubles with old source code
5059: still lying around on your next
5060: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
5061: update</strong></span>.</p></dd>
5062: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
5063: <dd><p>Deinstall each package before installing
5064: (making <code class="varname">DEPENDS_TARGET</code>). This
5065: may be necessary if the
1.266 martin 5066: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.184 rillig 5067: called after interrupting a running <span class="command"><strong>make
5068: update</strong></span>.</p></dd>
5069: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
5070: <dd><p>Allows you to disable recursion and hardcode
5071: the target for packages. The default is
1.266 martin 5072: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.184 rillig 5073: facilitating a recursive update of prerequisite
5074: packages. Only set
5075: <code class="varname">DEPENDS_TARGET</code> if you want to
5076: disable recursive updates. Use
5077: <code class="varname">UPDATE_TARGET</code> instead to just
5078: set a specific target for each package to be
5079: installed during <span class="command"><strong>make update</strong></span>
5080: (see above).</p></dd>
5081: </dl></div>
5082: </dd>
5083: <dt><span class="term">clean-update</span></dt>
5084: <dd>
5085: <p>Clean the source tree for all packages that would
5086: get updated if <span class="command"><strong>make update</strong></span> was called
5087: from the current directory. This target should not be
5088: used if the current package (or any of its depending
5089: packages) have already been de-installed (e.g., after
5090: calling <span class="command"><strong>make update</strong></span>) or you may lose
5091: some packages you intended to update. As a rule of
5092: thumb: only use this target <span class="emphasis"><em>before</em></span>
5093: the first time you run <span class="command"><strong>make update</strong></span>
5094: and only if you have a dirty package tree (e.g., if you
5095: used <code class="varname">NOCLEAN</code>).</p>
5096: <p>If you are unsure about whether your tree is
5097: clean, you can either perform a <span class="command"><strong>make
5098: clean</strong></span> at the top of the tree, or use the
5099: following sequence of commands from the directory of the
5100: package you want to update (<span class="emphasis"><em>before</em></span>
5101: running <span class="command"><strong>make update</strong></span> for the first
5102: time, otherwise you lose all the packages you wanted to
5103: update!):</p>
5104: <pre class="screen">
5105: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
5106: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
5107: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
5108: </pre>
5109: <p>The following variables can be used either on the
5110: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
5111: <span class="command"><strong>make clean-update</strong></span>:</p>
5112: <div class="variablelist"><dl class="variablelist">
5113: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
5114: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
5115: reconstruct the list of directories to update for
5116: this package. Only use this if <span class="command"><strong>make
5117: update</strong></span> successfully installed all
5118: packages you wanted to update. Normally, this is
5119: done automatically on <span class="command"><strong>make
5120: update</strong></span>, but may have been suppressed by
5121: the <code class="varname">NOCLEAN</code> variable (see
5122: above).</p></dd>
5123: </dl></div>
5124: </dd>
5125: <dt><span class="term">replace</span></dt>
5126: <dd>
5127: <p>Update the installation of the current package. This
5128: differs from update in that it does not replace dependent
1.207 leot 5129: 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.184 rillig 5130: target to work.</p>
5131: <p><span class="emphasis"><em>Be careful when using this
5132: target!</em></span> There are no guarantees that dependent
5133: packages will still work, in particular they will most
5134: certainly break if you <span class="command"><strong>make replace</strong></span> a
5135: library package whose shared library major version changed
5136: between your installed version and the new one. For this
5137: reason, this target is not officially supported and only
5138: recommended for advanced users.</p>
5139: </dd>
5140: <dt><span class="term">info</span></dt>
1.259 leot 5141: <dd><p>This target invokes <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.184 rillig 5142: package. You can use this to check which version of a
5143: package is installed.</p></dd>
5144: <dt><span class="term">index</span></dt>
5145: <dd>
5146: <p>This is a top-level command, i.e. it should be used in
5147: the <code class="filename">pkgsrc</code> directory. It creates a
5148: database of all packages in the local pkgsrc tree, including
5149: dependencies, comment, maintainer, and some other useful
5150: information. Individual entries are created by running
5151: <span class="command"><strong>make describe</strong></span> in the packages'
5152: directories. This index file is saved as
5153: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
5154: verbose format by running <span class="command"><strong>make
5155: print-index</strong></span>. You can search in it with
5156: <span class="command"><strong>make search
5157: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
5158: extract a list of all packages that depend on a particular
5159: one by running <span class="command"><strong>make show-deps
5160: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
5161: <p>Running this command takes a very long time, some
5162: hours even on fast machines!</p>
5163: </dd>
5164: <dt><span class="term">readme</span></dt>
5165: <dd>
5166: <p>This target generates a
1.199 nia 5167: <code class="filename">index.html</code> file, which can be
1.207 leot 5168: 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.184 rillig 5169: contain references to any packages which are in the
5170: <code class="varname">PACKAGES</code> directory on the local
5171: host. The generated files can be made to refer to URLs
5172: based on <code class="varname">FTP_PKG_URL_HOST</code> and
5173: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.199 nia 5174: wanted to generate <code class="filename">index.html</code>
1.184 rillig 5175: files which pointed to binary packages on the local
5176: machine, in the directory
5177: <code class="filename">/usr/packages</code>, set
5178: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
5179: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
5180: <code class="varname">${PACKAGES}</code> directory and its
5181: subdirectories will be searched for all the binary
5182: packages.</p>
5183: <p>The target can be run at the toplevel or in category
5184: directories, in which case it descends recursively.</p>
5185: </dd>
5186: <dt><span class="term">readme-all</span></dt>
5187: <dd><p>This is a top-level command, run it in
5188: <code class="filename">pkgsrc</code>. Use this target to create a
5189: file <code class="filename">README-all.html</code> which contains a
5190: list of all packages currently available in the NetBSD
5191: Packages Collection, together with the category they belong
5192: to and a short description. This file is compiled from the
1.199 nia 5193: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.184 rillig 5194: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
5195: readme</strong></span>.</p></dd>
5196: <dt><span class="term">cdrom-readme</span></dt>
5197: <dd><p>This is very much the same as the
1.266 martin 5198: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.184 rillig 5199: used when generating a pkgsrc tree to be written to a
5200: CD-ROM. This target also produces
1.199 nia 5201: <code class="filename">index.html</code> files, and can be made
1.184 rillig 5202: to refer to URLs based on
5203: <code class="varname">CDROM_PKG_URL_HOST</code> and
5204: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
5205: <dt><span class="term">show-distfiles</span></dt>
5206: <dd><p>This target shows which distfiles and patchfiles
5207: are needed to build the package
5208: (<code class="varname">ALLFILES</code>, which contains all
5209: <code class="varname">DISTFILES</code> and
5210: <code class="varname">PATCHFILES</code>, but not
5211: <code class="filename">patches/*</code>).</p></dd>
5212: <dt><span class="term">show-downlevel</span></dt>
5213: <dd><p>This target shows nothing if the package is not
5214: installed. If a version of this package is installed,
5215: but is not the version provided in this version of
5216: pkgsrc, then a warning message is displayed. This target
5217: can be used to show which of your installed packages are
5218: downlevel, and so the old versions can be deleted, and
5219: the current ones added.</p></dd>
5220: <dt><span class="term">show-pkgsrc-dir</span></dt>
5221: <dd><p>This target shows the directory in the pkgsrc
5222: hierarchy from which the package can be built and
5223: installed. This may not be the same directory as the one
5224: from which the package was installed. This target is
5225: intended to be used by people who may wish to upgrade
5226: many packages on a single host, and can be invoked from
5227: the top-level pkgsrc Makefile by using the
1.266 martin 5228: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.184 rillig 5229: <dt><span class="term">show-installed-depends</span></dt>
5230: <dd><p>This target shows which installed packages match
5231: the current package's <code class="varname">DEPENDS</code>. Useful
5232: if out of date dependencies are causing build
5233: problems.</p></dd>
5234: <dt><span class="term">print-build-depends-list</span></dt>
5235: <dd><p>This target shows the list of packages that the current package
5236: depends on for building.</p></dd>
5237: <dt><span class="term">print-run-depends-list</span></dt>
5238: <dd><p>This target shows the list of packages that the current package
5239: depends on for running.</p></dd>
5240: <dt><span class="term">check-shlibs</span></dt>
5241: <dd><p>After a package is installed, check all its
5242: binaries and (on ELF platforms) shared libraries to see
5243: if they find the shared libs they need. Run by default
5244: 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>
5245: <dt><span class="term">print-PLIST</span></dt>
5246: <dd>
1.266 martin 5247: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.184 rillig 5248: upgraded pkg, this prints out an attempt to generate a
5249: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5250: -newer work/.extract_done</strong></span>. An attempt is made
5251: to care for shared libs etc., but it is
5252: <span class="emphasis"><em>strongly</em></span> recommended to review the
5253: result before putting it into
5254: <code class="filename">PLIST</code>. On upgrades, it's useful to
5255: diff the output of this command against an already
5256: existing <code class="filename">PLIST</code> file.</p>
1.259 leot 5257: <p>If the package installs files via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.184 rillig 5258: other methods that don't update file access times, be
5259: sure to add these files manually to your
1.266 martin 5260: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5261: -newer</span>”</span> command used by this target won't catch
1.184 rillig 5262: them!</p>
1.266 martin 5263: <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
1.184 rillig 5264: information on this target.</p>
5265: </dd>
1.255 wiz 5266: <dt><span class="term">rebuild</span></dt>
5267: <dd><p>If you did a <span class="command"><strong>make build</strong></span> and you
5268: noticed some further modifications of sources are needed,
5269: you can repeat the build with this target, which will ignore
1.266 martin 5270: the <span class="quote">“<span class="quote">already built</span>”</span> flag. This target is
1.255 wiz 5271: helpful while working with patches.</p></dd>
5272: <dt><span class="term">repackage</span></dt>
5273: <dd><p>If you did a <span class="command"><strong>make package</strong></span> and you
5274: noticed some further modifications of sources are needed,
5275: you can repeat the package with this target, which will ignore
1.266 martin 5276: the <span class="quote">“<span class="quote">already packaged</span>”</span> flag. This target is
1.255 wiz 5277: helpful while working with patches, PLIST* files etc.</p></dd>
5278: <dt><span class="term">retest</span></dt>
5279: <dd><p>If you did a <span class="command"><strong>make test</strong></span> and you
5280: noticed some further modifications of sources are needed,
5281: you can repeat the test with this target, which will ignore
1.266 martin 5282: the <span class="quote">“<span class="quote">already tested</span>”</span> flag. This target is
1.255 wiz 5283: helpful while working with patches.</p></dd>
1.184 rillig 5284: </dl></div>
5285: </div>
5286: </div>
5287: <div class="chapter">
5288: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 5289: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.184 rillig 5290: <div class="toc">
5291: <p><b>Table of Contents</b></p>
5292: <dl class="toc">
5293: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5294: <dd><dl>
1.219 nia 5295: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
5296: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
5297: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.184 rillig 5298: </dl></dd>
5299: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5300: <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>
5301: </dl>
5302: </div>
5303: <p>When you find a package that is not yet in pkgsrc, you
5304: most likely have a URL from where you can download the source
5305: code. Starting with this URL, creating a package involves only a
5306: few steps.</p>
5307: <div class="procedure"><ol class="procedure" type="1">
5308: <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
5309: enable the basic quality checks.</p></li>
5310: <li class="step">
1.207 leot 5311: <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.184 rillig 5312: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5313: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5314: <span class="command"><strong>mkpatches</strong></span>:</p>
5315: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5316: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5317: </li>
5318: <li class="step">
5319: <p>Choose one of the top-level directories as the category in
5320: which you want to place your package. You can also create a directory of
1.219 nia 5321: your own (maybe called <code class="filename">local</code>). Change into that
5322: category directory:</p>
5323: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em></code></strong></pre>
1.184 rillig 5324: </li>
5325: <li class="step">
1.219 nia 5326: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
5327: argument the URL of the distribution file (in most cases a
5328: <code class="filename">.tar.gz</code> file). This will download the distribution
5329: file and create the necessary files of the package, based on what's in
5330: the distribution file:</p>
1.184 rillig 5331: <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>
5332: </li>
5333: <li class="step">
5334: <p>Examine the extracted files to determine the dependencies of
5335: your package. Ideally, this is mentioned in some
5336: <code class="filename">README</code> file, but things may differ. For each of
5337: these dependencies, look where it exists in pkgsrc, and if there is a
5338: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5339: line to your package <code class="filename">Makefile</code> which includes that
5340: file just before the last line. If the
5341: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5342: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5343: that the package's include files and libraries are provided.</p>
1.219 nia 5344: <p>If you just need binaries from a dependent package, add a
1.184 rillig 5345: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5346: version of the dependency and where it can be found in pkgsrc. This line
5347: should be placed in the third paragraph. If the dependency is only
5348: needed for building the package, but not when using it, use
5349: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5350: instead of <code class="varname">DEPENDS</code>.
5351: The difference between <code class="varname">TOOL_DEPENDS</code> and
5352: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5353: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.219 nia 5354: packages, i.e. packages for the platform where the package is built;
1.184 rillig 5355: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.219 nia 5356: packages, i.e. packages for the platform for which the package
5357: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
5358: specifies a dependency used only for testing the resulting package
5359: built, using the upstream project's included test suite, on the native
5360: platform.
1.184 rillig 5361: Your package may then look like this:</p>
5362: <pre class="programlisting">
5363: [...]
5364:
5365: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5366: DEPENDS+= screen-[0-9]*:../../misc/screen
5367: DEPENDS+= screen>=4.0:../../misc/screen
5368:
5369: [...]
5370:
5371: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5372: .include "../../devel/glib2/buildlink3.mk"
5373: .include "../../mk/bsd.pkg.mk"
5374: </pre>
5375: </li>
5376: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.266 martin 5377: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.184 rillig 5378: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5379: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5380: additional explanations.</p></li>
5381: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.266 martin 5382: 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
1.184 rillig 5383: over there, you can hopefully continue here.</p></li>
5384: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5385: directory from the extracted files. Besides these files, a lot of cache
1.219 nia 5386: files and other system information have been saved in the working
5387: directory, which may have become outdated after you edited the
1.184 rillig 5388: <code class="filename">Makefile</code>.</p></li>
5389: <li class="step">
5390: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.266 martin 5391: 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>
1.219 nia 5392: <p>If the extracted files from the package need to be fixed, run
5393: multiple rounds of these commands:</p>
5394: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.184 rillig 5395: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5396: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.219 nia 5397: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
5398: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.184 rillig 5399: </li>
5400: <li class="step"><p>When the package builds fine, the next step is to install
5401: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5402: everything works.</p></li>
5403: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5404: contains a list of the files that are installed by the package, is
5405: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5406: >PLIST</strong></span> to generate a probably correct list. Check
5407: the file using your preferred text editor to see if the list of
5408: files looks plausible.</p></li>
5409: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5410: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5411: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5412: had been registered in the database of installed files, but with an
5413: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5414: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5415: registered with the list of files from
5416: <code class="filename">PLIST</code>.</p></li>
5417: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5418: from above again in a single step, making sure that the PLIST is correct
5419: and the whole package is created as intended.</p></li>
1.219 nia 5420: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
5421: left to do.</p></li>
1.266 martin 5422: <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>
1.184 rillig 5423: </ol></div>
5424: <div class="sect1">
5425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 5426: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
1.184 rillig 5427: <div class="sect2">
5428: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5429: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.184 rillig 5430: <p>Python modules and programs packages are easily created using a
5431: set of predefined variables.</p>
5432: <p>
5433: If some Python versions are not supported by the software, set the
5434: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5435: that are not supported, e.g.
5436: </p>
5437: <pre class="programlisting">
5438: PYTHON_VERSIONS_INCOMPATIBLE= 27
5439: </pre>
5440: <p>
1.249 gutterid 5441: If the packaged software is a Python module, include
1.255 wiz 5442: <code class="filename">../../lang/python/wheel.mk</code>. Note per PEP-518,
1.258 wiz 5443: the minimum and default requirement to create .whl files is <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/py-setuptools/index.html" target="_top"><code class="filename">devel/py-setuptools</code></a>; however, there are various
5444: other possible tools that projects can use. Thus inclusion of
1.255 wiz 5445: <code class="filename">wheel.mk</code> does not imply these defaults are
5446: defined as <code class="varname">TOOL_DEPENDS</code>. Whatever the project
5447: specifically requires as packaging tools must be defined in the
5448: package Makefile.
1.215 wiz 5449: </p>
1.248 wiz 5450: <p>The package directory should be called
1.266 martin 5451: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5452: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.184 rillig 5453: </p>
5454: <pre class="programlisting">
5455: DISTNAME= foopymodule-1.2.10
5456: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5457: </pre>
1.226 gutterid 5458: <p>
5459: For software in PyPi, the name should match what PyPi specifies for
5460: "pip install software".
5461: </p>
1.184 rillig 5462: <p>If it is an application, include
1.266 martin 5463: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
1.184 rillig 5464: In order to correctly set the path to the Python interpreter, use the
5465: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5466: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5467: For example:
5468: </p>
5469: <pre class="programlisting">
5470: REPLACE_PYTHON= *.py
5471: </pre>
5472: </div>
5473: <div class="sect2">
5474: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5475: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.184 rillig 5476: <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>
5477: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.207 leot 5478: 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.184 rillig 5479: Individual packages (and optionally their dependencies) may be created
5480: and updated. R packages generally follow the same form, and most of
5481: the relevant information needed is contained in a
5482: <code class="filename">DESCRIPTION</code> file as part of each R package on
5483: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5484: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5485: creates or updates a package in the canonical form. The resulting
5486: package should be reviewed for correctness.</p>
5487: </div>
5488: <div class="sect2">
5489: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5490: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.184 rillig 5491: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.207 leot 5492: <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.184 rillig 5493: <p>If the TeXlive package name is not known, it may be useful to
5494: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
1.266 martin 5495: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
1.184 rillig 5496: 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
5497: archive</a>.</p>
5498: <p>If the TeXlive package name is known, download the files from
5499: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5500: archive</a>. For package <code class="filename">foo</code>, you will need
5501: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5502: also have associated documentation packages, so download
5503: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5504: should be placed in the appropriate category directory, which is often
5505: but not always <code class="filename">print</code>. Then run the following
5506: command in the category directory.</p>
5507: <pre class="programlisting">
5508: texlive2pkg foo.tar.xz foo.doc.tar.xz
5509: </pre>
5510: <p>This will create two packages, <code class="filename">tex-foo</code> and
5511: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5512: are correct.</p>
5513: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5514: currently does not include version information in package filenames
5515: and changes their contents periodically when updates occur.
5516: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5517: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5518: main one and the corresponding documentation, upload the distfiles
5519: with the following command in each package directory.</p>
5520: <pre class="programlisting">
5521: make upload-distfiles
5522: </pre>
5523: </div>
5524: </div>
5525: <div class="sect1">
5526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 5527: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
1.184 rillig 5528: <div class="sect2">
5529: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5530: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.184 rillig 5531: <div class="sect3">
5532: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 5533: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
1.184 rillig 5534: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.266 martin 5535: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.184 rillig 5536: pkgsrc. As the description says it has to do with the web, the obvious
1.266 martin 5537: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.184 rillig 5538: <pre class="programlisting">
5539: <code class="prompt">$</code> mkdir www/nvu
5540: <code class="prompt">$</code> cd www/nvu
5541: </pre>
5542: <p>The web site says that the sources are available as a tar file, so
5543: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5544: <pre class="programlisting">
5545: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5546: </pre>
5547: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5548: below the <code class="varname">DISTNAME</code> line, as the package name should
1.266 martin 5549: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.184 rillig 5550: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5551: <code class="varname">COMMENT</code> fields. Then the package
5552: <code class="filename">Makefile</code> looked like that:</p>
5553: <pre class="programlisting">
5554: # $NetBSD $
5555: #
5556:
5557: DISTNAME= nvu-1.0-sources
5558: PKGNAME= nvu-1.0
5559: CATEGORIES= www
5560: MASTER_SITES= http://cvs.nvu.com/download/
5561: EXTRACT_SUFX= .tar.bz2
5562:
5563: MAINTAINER= rillig@NetBSD.org
5564: HOMEPAGE= http://cvs.nvu.com/
5565: COMMENT= Web Authoring System
5566:
5567: # url2pkg-marker (please do not remove this line.)
5568: .include "../../mk/bsd.pkg.mk"
5569: </pre>
5570: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5571: this is a workaround to prevent CVS expanding to the filename of the
5572: guide.</p>
5573: <p>Then, I quit the editor and watched pkgsrc downloading a large
5574: source archive:</p>
5575: <pre class="programlisting">
5576: url2pkg> Running "make makesum" ...
5577: => Required installed package digest>=20010302: digest-20060826 found
5578: => Fetching nvu-1.0-sources.tar.bz2
5579: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5580: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5581: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5582: url2pkg> Running "make extract" ...
5583: => Required installed package digest>=20010302: digest-20060826 found
5584: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5585: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5586: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5587: ===> Installing dependencies for nvu-1.0
5588: ===> Overriding tools for nvu-1.0
5589: ===> Extracting for nvu-1.0
5590: url2pkg> Adjusting the Makefile.
5591:
5592: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5593:
5594: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5595: </pre>
5596: </div>
5597: <div class="sect3">
5598: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 5599: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.184 rillig 5600: <p>Now that the package has been extracted, let's see what's inside
5601: it. The package has a <code class="filename">README.txt</code>, but that only
5602: says something about mozilla, so it's probably useless for seeing what
5603: dependencies this package has. But since there is a GNU configure script
5604: in the package, let's hope that it will complain about everything it
5605: needs.</p>
5606: <pre class="programlisting">
5607: <code class="prompt">$</code> bmake
5608: => Required installed package digest>=20010302: digest-20060826 found
5609: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5610: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5611: ===> Patching for nvu-1.0
5612: ===> Creating toolchain wrappers for nvu-1.0
5613: ===> Configuring for nvu-1.0
5614: [...]
5615: configure: error: Perl 5.004 or higher is required.
5616: [...]
5617: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5618: [...]
5619: </pre>
5620: <p>That worked quite well. So I opened the package Makefile in my
5621: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.266 martin 5622: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.184 rillig 5623: package have changed now, and since a perl wrapper is automatically
1.266 martin 5624: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.184 rillig 5625: from scratch.</p>
5626: <pre class="programlisting">
5627: <code class="prompt">$</code> bmake clean
5628: ===> Cleaning for nvu-1.0
5629: <code class="prompt">$</code> bmake
5630: [...]
5631: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5632: GNU Make. You will not be able to build Mozilla without GNU Make.
5633: [...]
5634: </pre>
1.266 martin 5635: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.184 rillig 5636: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5637: <pre class="programlisting">
5638: [...]
5639: checking for GTK - version >= 1.2.0... no
5640: *** Could not run GTK test program, checking why...
5641: [...]
5642: </pre>
5643: <p>Now to the other dependencies. The first question is: Where is the
5644: GTK package hidden in pkgsrc?</p>
5645: <pre class="programlisting">
5646: <code class="prompt">$</code> echo ../../*/gtk*
5647: [many packages ...]
5648: <code class="prompt">$</code> echo ../../*/gtk
5649: ../../x11/gtk
5650: <code class="prompt">$</code> echo ../../*/gtk2
5651: ../../x11/gtk2
5652: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5653: ../../x11/gtk2/buildlink3.mk
5654: </pre>
5655: <p>The first try was definitely too broad. The second one had exactly
5656: one result, which is very good. But there is one pitfall with GNOME
5657: packages. Before GNOME 2 had been released, there were already many
5658: GNOME 1 packages in pkgsrc. To be able to continue to use these
5659: packages, the GNOME 2 packages were imported as separate packages, and
1.266 martin 5660: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.184 rillig 5661: whether this was the case here, and indeed it was.</p>
5662: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5663: file, adding the dependency is very easy. I just inserted an
5664: <code class="literal">.include</code> line before the last line of the package
5665: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5666: <pre class="programlisting">
5667: [...]
5668: .include "../../x11/gtk2/buildlink3.mk"
5669: .include "../../mk/bsd.pkg.mk
5670: </pre>
5671: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5672: was:</p>
1.1 dsieger 5673: <pre class="programlisting">
1.184 rillig 5674: [...]
5675: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5676: checking for GTK - version >= 1.2.0... no
5677: *** Could not run GTK test program, checking why...
5678: *** The test program failed to compile or link. See the file config.log for the
5679: *** exact error that occured. This usually means GTK was incorrectly installed
5680: *** or that you have moved GTK since it was installed. In the latter case, you
5681: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5682: configure: error: Test for GTK failed.
5683: [...]
1.111 sevan 5684: </pre>
1.266 martin 5685: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5686: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.184 rillig 5687: told me that this package really wanted to have the GNOME 1 version of
5688: GTK. If the package had looked for GTK2, it would have looked for
5689: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5690: So I changed the <code class="literal">x11/gtk2</code> to
5691: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5692: and tried again.</p>
1.18 snj 5693: <pre class="programlisting">
1.184 rillig 5694: [...]
5695: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5696: In file included from xpidl.c:42:
5697: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5698: In file included from xpidl.c:42:
5699: xpidl.h:132: error: parse error before "IDL_ns"
5700: [...]
1.111 sevan 5701: </pre>
1.184 rillig 5702: <p>The package still does not find all of its dependencies. Now the
5703: question is: Which package provides the
5704: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.18 snj 5705: <pre class="programlisting">
1.184 rillig 5706: <code class="prompt">$</code> echo ../../*/*idl*
5707: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5708: <code class="prompt">$</code> echo ../../*/*IDL*
5709: ../../net/libIDL
1.111 sevan 5710: </pre>
1.184 rillig 5711: <p>Let's take the one from the second try. So I included the
5712: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5713: again. But the error didn't change. After digging through some of the
5714: code, I concluded that the build process of the package was broken and
5715: couldn't have ever worked, but since the Mozilla source tree is quite
5716: large, I didn't want to fix it. So I added the following to the package
5717: <code class="filename">Makefile</code> and tried again:</p>
1.86 wiz 5718: <pre class="programlisting">
1.184 rillig 5719: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5720: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.111 sevan 5721: </pre>
1.184 rillig 5722: <p>The latter line is needed because the package expects the library
5723: <code class="filename">libIDL.so</code>, but only
5724: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5725: wrapper to rewrite that on the fly.</p>
5726: <p>The next problem was related to a recent change of the FreeType
1.207 leot 5727: 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.184 rillig 5728: which patch files were relevant for this issue and copied them to the
5729: <code class="filename">patches</code> directory. Then I retried, fixed the
5730: patches so that they applied cleanly and retried again. This time,
5731: everything worked.</p>
1.86 wiz 5732: </div>
1.184 rillig 5733: <div class="sect3">
5734: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 5735: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 5736: <pre class="programlisting">
1.184 rillig 5737: <code class="prompt">$</code> bmake CHECK_FILES=no install
5738: [...]
5739: <code class="prompt">$</code> bmake print-PLIST >PLIST
5740: <code class="prompt">$</code> bmake deinstall
5741: <code class="prompt">$</code> bmake install
1.111 sevan 5742: </pre>
1.184 rillig 5743: </div>
5744: </div>
1.1 dsieger 5745: </div>
5746: </div>
1.41 asau 5747: <div class="chapter">
1.1 dsieger 5748: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 5749: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 5750: <div class="toc">
5751: <p><b>Table of Contents</b></p>
1.100 leot 5752: <dl class="toc">
1.184 rillig 5753: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5754: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5755: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5756: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5757: <dd><dl>
5758: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5759: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5760: <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>
5761: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 5762: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.1 dsieger 5763: </dl></dd>
5764: </dl>
5765: </div>
1.184 rillig 5766: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5767: each of which forms a well-defined part of the pkgsrc system. Using
1.259 leot 5768: the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.184 rillig 5769: like pkgsrc requires some discipline to keep the code correct and
5770: understandable.</p>
5771: <p>The basic ingredients for <code class="filename">Makefile</code>
5772: programming are variables and shell
5773: commands. Among these shell commands may even be more complex ones
1.259 leot 5774: like <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/awk.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.184 rillig 5775: as intended it is necessary to quote all variables correctly when they
5776: are used.</p>
5777: <p>This chapter describes some patterns that appear quite often in
5778: <code class="filename">Makefile</code>s, including the pitfalls that come along
5779: with them.</p>
1.41 asau 5780: <div class="sect1">
1.1 dsieger 5781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 5782: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
1.184 rillig 5783: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5784: <p>When you are creating a file as a
5785: target of a rule, always write the data to a temporary file first
5786: and finally rename that file. Otherwise there might occur an error
5787: in the middle of generating the file, and when the user runs
1.259 leot 5788: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.184 rillig 5789: regenerated properly. Example:</p>
1.1 dsieger 5790: <pre class="programlisting">
1.184 rillig 5791: wrong:
5792: @echo "line 1" > ${.TARGET}
5793: @echo "line 2" >> ${.TARGET}
5794: @false
5795:
5796: correct:
5797: @echo "line 1" > ${.TARGET}.tmp
5798: @echo "line 2" >> ${.TARGET}.tmp
5799: @false
5800: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 5801: </pre>
1.184 rillig 5802: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5803: <code class="filename">wrong</code> will exist, although there was an error
5804: message in the first run. On the other hand, running <span class="command"><strong>make
5805: correct</strong></span> gives an error message twice, as expected.</p>
1.259 leot 5806: <p>You might remember that <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.184 rillig 5807: <code class="literal">${.TARGET}</code> in case of error, but this only
5808: happens when it is interrupted, for example by pressing
5809: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.259 leot 5810: when one of the commands fails (like <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.184 rillig 5811: </li></ul></div>
5812: </div>
5813: <div class="sect1">
5814: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 5815: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.184 rillig 5816: <p><code class="filename">Makefile</code> variables contain strings that
5817: can be processed using the five operators <code class="code">=</code>,
5818: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.259 leot 5819: <code class="code">!=</code>, which are described in the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.184 rillig 5820: page.</p>
5821: <p>When a variable's value is parsed from a
5822: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5823: the backslash character <code class="code">\</code> are handled specially. If a
5824: backslash is the last character in a line, that backslash is removed
5825: from the line and the line continues with the next line of the file.</p>
5826: <p>The <code class="code">#</code> character starts a comment that reaches
5827: until the end of the line. To get an actual <code class="code">#</code> character,
5828: such as in a URL, write <code class="code">\#</code> instead.</p>
5829: <p>The evaluation of variables either happens immediately or lazy.
5830: It happens immediately when the variable occurs on the right-hand
5831: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5832: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5833: In the other cases, it is evaluated lazily.</p>
5834: <p>Some of the modifiers split the string into words and then
5835: operate on the words, others operate on the string as a whole. When a
5836: string is split into words, double quotes and single quotes are
1.259 leot 5837: interpreted as delimiters, just like in <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.184 rillig 5838: <div class="sect2">
5839: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5840: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
1.184 rillig 5841: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5842: <li class="listitem"><p>All variable names starting with an underscore
5843: are reserved for use by the pkgsrc infrastructure. They shall
5844: not be used by packages.</p></li>
5845: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5846: lowercase variable names for the iteration
5847: variables.</p></li>
5848: <li class="listitem"><p>All list variables should have a plural name,
5849: such as <code class="varname">PKG_OPTIONS</code> or
5850: <code class="varname">DISTFILES</code>.</p></li>
5851: </ul></div>
5852: </div>
5853: </div>
5854: <div class="sect1">
5855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 5856: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
1.184 rillig 5857: <div class="sect2">
5858: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5859: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
1.184 rillig 5860: <p>When adding a string that possibly contains whitespace or quotes to
5861: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5862: modifier.</p>
5863: <p>When adding another list to a list (example 2), it must not be
5864: quoted, since its elements are already quoted.</p>
1.1 dsieger 5865: <pre class="programlisting">
1.184 rillig 5866: STRING= foo * bar `date`
5867: LIST= # empty
5868: ANOTHER_LIST= a=b c=d
5869:
5870: LIST+= ${STRING:Q} # 1
5871: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 5872: </pre>
1.184 rillig 5873: </div>
5874: <div class="sect2">
5875: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5876: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.184 rillig 5877: <p>Echoing a string containing special characters needs special
5878: work.</p>
1.1 dsieger 5879: <pre class="programlisting">
1.184 rillig 5880: STRING= foo bar < > * `date` $$HOME ' "
5881: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5882:
5883: all:
5884: echo ${STRING} # 1
5885: echo ${STRING:Q} # 2
5886: printf '%s\n' ${STRING:Q}'' # 3
5887: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 5888: </pre>
1.184 rillig 5889: <p>Example 1 leads to a syntax error in the shell, as the characters
5890: are just copied.</p>
5891: <p>Example 2 quotes the string so that the shell interprets it
5892: correctly. But the echo command may additionally interpret strings with a
5893: leading dash or those containing backslashes.</p>
1.259 leot 5894: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.184 rillig 5895: interprets the format string, but not the next argument. The trailing
5896: single quotes handle the case when the string is empty. In that case, the
5897: :Q modifier would result in an empty string too, which would then be
1.259 leot 5898: skipped by the shell. For <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.184 rillig 5899: but other programs may care.</p>
5900: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5901: need to be quoted because the quoting has already been done
5902: when adding elements to the list.</p>
1.1 dsieger 5903: </div>
1.41 asau 5904: <div class="sect2">
1.1 dsieger 5905: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5906: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
1.184 rillig 5907: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5908: GNU-style configure script (especially those that call other configure
5909: scripts), it must not have leading or trailing whitespace, since
5910: otherwise the configure script gets confused. To trim leading and
5911: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5912: following example:</p>
1.1 dsieger 5913: <pre class="programlisting">
1.184 rillig 5914: CPPFLAGS= # empty
5915: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5916: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 5917:
1.184 rillig 5918: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 5919:
1.184 rillig 5920: all:
5921: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5922: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5923: </pre>
5924: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5925: trailing whitespace because the <code class="code">+=</code> operator always adds a
5926: space.</p>
5927: </div>
5928: <div class="sect2">
5929: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5930: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
1.184 rillig 5931: <p>When a possibly empty variable is used in a shell program, it may
5932: lead to a syntax error.</p>
5933: <pre class="programlisting">
5934: EGFILES= # empty
1.1 dsieger 5935:
1.184 rillig 5936: install-examples: # produces a syntax error in the shell
5937: for egfile in ${EGFILES}; do \
5938: echo "Installing $$egfile"; \
5939: done
5940: </pre>
5941: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.259 leot 5942: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.184 rillig 5943: To fix this syntax error, use one of the snippets below.</p>
5944: <pre class="programlisting">
1.229 gutterid 5945: EGFILES= # empty
1.1 dsieger 5946:
1.184 rillig 5947: install-examples:
5948: for egfile in ${EGFILES} ""; do \
5949: [ -n "$$egfile" ] || continue; \
5950: echo "Installing $$egfile"; \
5951: done
5952: </pre>
5953: <p>In this case, an empty string is appended to the iteration list (to
5954: prevent the syntax error) and filtered out later.</p>
5955: <pre class="programlisting">
5956: EGFILES= # empty
1.1 dsieger 5957:
1.184 rillig 5958: install-examples:
5959: .for egfile in ${EGFILES}
5960: echo "Installing ${egfile}"
5961: .endfor
1.1 dsieger 5962: </pre>
1.184 rillig 5963: <p>If one of the filenames contains special characters, it should be
5964: enclosed in single or double quotes.</p>
5965: <p>To have a shell command test whether a make variable is empty, use
5966: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5967: </div>
1.229 gutterid 5968: <div class="sect2">
5969: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 5970: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
1.229 gutterid 5971: <p>When a variable can have the values <code class="literal">yes</code> or
5972: <code class="literal">no</code>, use the following pattern to test the variable:</p>
5973: <pre class="programlisting">
5974: .if ${VAR:U:tl} == "yes"
5975: # do something
5976: .endif
5977: </pre>
5978: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
5979: can be undefined. If the variable is guaranteed to be defined, the
5980: <code class="literal">:U</code> can be omitted.</p>
5981: <p>The <code class="literal">:tl</code> modifier converts the variable value to
5982: lowercase, allowing for the values <code class="literal">yes</code>,
5983: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
5984: </div>
1.184 rillig 5985: </div>
5986: </div>
5987: <div class="chapter">
5988: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 5989: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.184 rillig 5990: <div class="toc">
5991: <p><b>Table of Contents</b></p>
5992: <dl class="toc">
5993: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5994: <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>
5995: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5996: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5997: </dl>
1.1 dsieger 5998: </div>
1.184 rillig 5999: <p>Many packages have the ability to be built to support different
6000: sets of features. <code class="filename">bsd.options.mk</code> is a framework
6001: in pkgsrc that provides generic handling of those options that
6002: determine different ways in which the packages can be built. It's
6003: possible for the user to specify exactly which sets of options will be
6004: built into a package or to allow a set of global default options
6005: apply.</p>
6006: <p>There are two broad classes of behaviors that one might want to
6007: control via options. One is whether some particular feature is
6008: enabled in a program that will be built anyway, often by including or
6009: not including a dependency on some other package. The other is
6010: whether or not an additional program will be built as part of the
6011: package. Generally, it is better to make a split package for such
6012: additional programs instead of using options, because it enables
6013: binary packages to be built which can then be added separately. For
6014: example, the foo package might have minimal dependencies (those
6015: packages without which foo doesn't make sense), and then the foo-gfoo
6016: package might include the GTK frontend program gfoo. This is better
6017: than including a gtk option to foo that adds gfoo, because either that
6018: option is default, in which case binary users can't get foo without
6019: gfoo, or not default, in which case they can't get gfoo. With split
6020: packages, they can install foo without having GTK, and later decide to
6021: install gfoo (pulling in GTK at that time). This is an advantage to
6022: source users too, avoiding the need for rebuilds.</p>
6023: <p>Plugins with widely varying dependencies should usually be split
6024: instead of options.</p>
6025: <p>It is often more work to maintain split packages, especially if
6026: the upstream package does not support this. The decision of split
6027: vs. option should be made based on the likelihood that users will want
6028: or object to the various pieces, the size of the dependencies that are
6029: included, and the amount of work.</p>
6030: <p>A further consideration is licensing. Non-free parts, or parts
6031: that depend on non-free dependencies (especially plugins) should
6032: almost always be split if feasible.</p>
6033: <div class="sect1">
6034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6035: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.184 rillig 6036: <p>Global default options are listed in
6037: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6038: that should be built into every package if that option is supported.
6039: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 6040: </div>
1.41 asau 6041: <div class="sect1">
1.1 dsieger 6042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6043: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.184 rillig 6044: </h2></div></div></div>
6045: <p>The following example shows how
6046: <code class="filename">bsd.options.mk</code> should be used
6047: by the hypothetical ``wibble'' package, either in the package
6048: <code class="filename">Makefile</code>, or in a file,
6049: e.g. <code class="filename">options.mk</code>, that is included by the
6050: main package <code class="filename">Makefile</code>.</p>
1.1 dsieger 6051: <pre class="programlisting">
1.184 rillig 6052: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6053: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6054: PKG_OPTIONS_OPTIONAL_GROUPS= database
6055: PKG_OPTIONS_GROUP.database= mysql pgsql
6056: PKG_SUGGESTED_OPTIONS= wibble-foo
6057: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6058: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6059:
6060: .include "../../mk/bsd.prefs.mk"
6061:
6062: # this package was previously named wibble2
6063: .if defined(PKG_OPTIONS.wibble2)
6064: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6065: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6066: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6067: .endif
6068:
6069: .include "../../mk/bsd.options.mk"
6070:
6071: # Package-specific option-handling
1.1 dsieger 6072:
1.184 rillig 6073: ###
6074: ### FOO support
6075: ###
6076: .if !empty(PKG_OPTIONS:Mwibble-foo)
6077: CONFIGURE_ARGS+= --enable-foo
6078: .endif
1.1 dsieger 6079:
1.184 rillig 6080: ###
6081: ### LDAP support
6082: ###
6083: .if !empty(PKG_OPTIONS:Mldap)
6084: . include "../../databases/openldap-client/buildlink3.mk"
6085: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6086: .endif
1.1 dsieger 6087:
1.184 rillig 6088: ###
6089: ### database support
6090: ###
6091: .if !empty(PKG_OPTIONS:Mmysql)
6092: . include "../../mk/mysql.buildlink3.mk"
6093: .endif
6094: .if !empty(PKG_OPTIONS:Mpgsql)
6095: . include "../../mk/pgsql.buildlink3.mk"
6096: .endif
6097: </pre>
6098: <p>The first section contains the information about which build
6099: options are supported by the package, and any default options settings
6100: if needed.</p>
6101: <div class="orderedlist"><ol class="orderedlist" type="1">
6102: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.259 leot 6103: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.184 rillig 6104: options. It should be set to
6105: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6106: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6107: at the point where the options are processed.</p></li>
6108: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6109: build options supported by the package.</p></li>
6110: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6111: list of names of groups of mutually exclusive options. The options in
6112: each group are listed in
6113: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6114: The most specific setting of any option from the group takes
6115: precedence over all other options in the group. Options from the
6116: groups will be automatically added to
6117: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6118: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6119: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6120: packages will fail if no option from the group is
6121: selected.</p></li>
6122: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6123: of names of sets of options. At least one option from each set must
6124: be selected. The options in each set are listed in
6125: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6126: Options from the sets will be automatically added to
6127: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6128: fail if no option from the set is selected.</p></li>
6129: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6130: build options which are enabled by default.</p></li>
6131: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6132: of
1.266 martin 6133: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.184 rillig 6134: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
6135: their option counterparts. Pairs should be added with
1.266 martin 6136: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.184 rillig 6137: warning will be issued if the user uses a legacy
6138: variable.</p></li>
6139: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6140: of
1.266 martin 6141: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
1.184 rillig 6142: pairs that map options that have been renamed to their new
1.266 martin 6143: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.184 rillig 6144: the listing of global legacy options. A warning will be issued if
6145: the user uses a legacy option.</p></li>
6146: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6147: options implied by deprecated variables used. This can be used for
6148: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6149: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6150: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6151: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6152: a list of warnings about deprecated variables or options used, and
6153: what to use instead.</p></li>
6154: </ol></div>
6155: <p>A package should never modify
6156: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6157: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6158: To suggest a default set of options, use
6159: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6160: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6161: including <code class="filename">bsd.options.mk</code>. If none of
6162: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6163: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6164: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6165: happen with platform-specific options if none of them is supported on
6166: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6167: empty list and the package is otherwise treated as not using the
6168: options framework.</p>
6169: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6170: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6171: build options, properly filtered to remove unsupported and duplicate
6172: options.</p>
6173: <p>The remaining sections contain the logic that is specific to
6174: each option. The correct way to check for an option is to check
6175: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6176: <pre class="programlisting">
6177: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.1 dsieger 6178: </pre>
6179: </div>
1.184 rillig 6180: <div class="sect1">
6181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6182: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.184 rillig 6183: <p>Options that enable similar features in different packages (like
6184: optional support for a library) should use a common name in all
6185: packages that support it (like the name of the library). If another
6186: package already has an option with the same meaning, use the same
6187: name.</p>
6188: <p>Options that enable features specific to one package, where it's
6189: unlikely that another (unrelated) package has the same (or a similar)
6190: optional feature, should use a name prefixed with
6191: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6192: <p>If a group of related packages share an optional feature
6193: specific to that group, prefix it with the name of the
1.266 martin 6194: <span class="quote">“<span class="quote">main</span>”</span> package
1.184 rillig 6195: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6196: <p>For new options, add a line to
6197: <code class="filename">mk/defaults/options.description</code>. Lines have two
6198: fields, separated by tab. The first field is the option name, the
6199: second its description. The description should be a whole sentence
6200: (starting with an uppercase letter and ending with a period) that
1.266 martin 6201: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6202: support.</span>”</span> The file is sorted by option names.</p>
1.184 rillig 6203: </div>
6204: <div class="sect1">
6205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6206: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.184 rillig 6207: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6208: different dependencies based on the options with which the package was
6209: built. For querying these options, the file
6210: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6211: typical example looks like this:</p>
1.1 dsieger 6212: <pre class="programlisting">
1.184 rillig 6213: pkgbase := libpurple
6214: .include "../../mk/pkg-build-options.mk"
6215:
6216: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6217: ...
6218: .endif
1.117 sevan 6219: </pre>
1.184 rillig 6220: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6221: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6222: options of the libpurple package, which can then be queried like
6223: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6224: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6225: details.</p>
1.1 dsieger 6226: </div>
6227: </div>
1.41 asau 6228: <div class="chapter">
1.1 dsieger 6229: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 6230: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6231: <div class="toc">
6232: <p><b>Table of Contents</b></p>
1.100 leot 6233: <dl class="toc">
1.184 rillig 6234: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
6235: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
6236: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6237: </dl>
6238: </div>
1.184 rillig 6239: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6240: by pkgsrc and also for individual packages to define what commands
6241: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6242: or for later run-time of an installed packaged (such as
6243: <code class="varname">DEPENDS</code>).
6244: If the native system provides an adequate tool, then in many cases, a pkgsrc
6245: package will not be used.</p>
6246: <p>When building a package, the replacement tools are
6247: made available in a directory (as symlinks or wrapper scripts)
6248: that is early in the executable search path. Just like the buildlink
6249: system, this helps with consistent builds.</p>
6250: <p>A tool may be needed to help build a specific package. For example,
6251: perl, GNU make (gmake) or yacc may be needed.</p>
6252: <p>Also a tool may be needed, for example, because the native system's supplied
6253: tool may be inefficient for building a package with pkgsrc.
6254: For example, a package may need GNU awk, bison (instead of
6255: yacc) or a better sed.</p>
6256: <p>The tools used by a package can be listed by running
6257: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6258: <div class="sect1">
1.1 dsieger 6259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6260: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.184 rillig 6261: <p>The default set of tools used by pkgsrc is defined in
6262: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6263: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6264: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6265: These can be seen by running:
6266: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6267: <p>If a package needs a specific program to build
6268: then the <code class="varname">USE_TOOLS</code> variable can be used
6269: to define the tools needed.</p>
1.1 dsieger 6270: </div>
1.184 rillig 6271: <div class="sect1">
6272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6273: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.184 rillig 6274: <p>In the following examples, the :run means that it is needed at
6275: run-time (and becomes a DEPENDS).
6276: The default is a build dependency which can be set with
6277: :build. (So in this example, it is the same as gmake:build
6278: and pkg-config:build.)</p>
1.1 dsieger 6279: <pre class="programlisting">
1.184 rillig 6280: USE_TOOLS+= gmake perl:run pkg-config
1.1 dsieger 6281: </pre>
1.184 rillig 6282: <p>When using the tools framework, a
6283: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6284: which contains the full path to the appropriate tool. For example,
1.266 martin 6285: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.184 rillig 6286: on Linux systems.</p>
6287: <p>If you always need a pkgsrc version of the
6288: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6289: </p>
1.1 dsieger 6290: </div>
1.184 rillig 6291: <div class="sect1">
6292: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6293: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.184 rillig 6294: <p>When improving or porting pkgsrc to a new platform, have a look
6295: at (or create) the corresponding platform specific make file fragment under
6296: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6297: the name of the common tools. For example:</p>
1.1 dsieger 6298: <pre class="programlisting">
1.184 rillig 6299: .if exists(/usr/bin/bzcat)
6300: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6301: .elif exists(/usr/bin/bzip2)
6302: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6303: .endif
6304:
6305: TOOLS_PLATFORM.true?= true # shell builtin
1.1 dsieger 6306: </pre>
6307: </div>
6308: </div>
1.184 rillig 6309: <div class="chapter">
6310: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 6311: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
1.184 rillig 6312: <div class="toc">
6313: <p><b>Table of Contents</b></p>
6314: <dl class="toc">
6315: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6316: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6317: <dd><dl>
6318: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6319: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6320: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6321: and
6322: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6323: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6324: </dl></dd>
6325: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.241 rillig 6326: <dd><dl><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></dl></dd>
1.184 rillig 6327: </dl>
1.1 dsieger 6328: </div>
1.184 rillig 6329: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6330: are seen by a package's configure and build processes. This is implemented
6331: in a two step process:</p>
6332: <div class="orderedlist"><ol class="orderedlist" type="1">
6333: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6334: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6335: of <code class="varname">WRKDIR</code>.</p></li>
6336: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6337: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6338: <code class="option">-L${LOCALBASE}/lib</code> into references to
6339: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6340: native compiler on some operating systems look like GCC, so that
6341: packages that expect GCC won't require modifications to build with
6342: those native compilers.</p></li>
6343: </ol></div>
6344: <p>This normalizes the environment in which a package is built so that the
6345: package may be built consistently despite what other software may be
6346: installed. Please note that the normal system header and library paths,
6347: e.g. <code class="filename">/usr/include</code>,
6348: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6349: designed to insulate the package build from non-system-supplied
6350: software.</p>
1.41 asau 6351: <div class="sect1">
1.1 dsieger 6352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6353: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
1.184 rillig 6354: <p>The process of converting packages to use the buildlink3
1.266 martin 6355: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.184 rillig 6356: The things to keep in mind are:</p>
1.23 wiz 6357: <div class="orderedlist"><ol class="orderedlist" type="1">
1.184 rillig 6358: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6359: instead of the actual toolchain. Some packages are tricky,
6360: and the only way to know for sure is the check
6361: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6362: wrappers are being invoked.</p></li>
6363: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6364: the package Makefile, e.g. Java VMs, standalone shells,
6365: etc., because the code to symlink files into
6366: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.266 martin 6367: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.184 rillig 6368: </p></li>
6369: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6370: <code class="filename">buildlink3.mk</code> files that you list in a
6371: package's Makefile are added as dependencies for that package.
6372: </p></li>
6373: </ol></div>
6374: <p>If a dependency on a particular package is required for its libraries and
6375: headers, then we replace:</p>
6376: <pre class="programlisting">
6377: DEPENDS+= foo>=1.1.0:../../category/foo
6378: </pre>
6379: <p>with</p>
6380: <pre class="programlisting">
6381: .include "../../category/foo/buildlink3.mk"
6382: </pre>
6383: <p>The buildlink3.mk files usually define the required dependencies.
6384: If you need a newer version of the dependency when using buildlink3.mk
6385: files, then you can define it in your Makefile; for example:</p>
1.1 dsieger 6386: <pre class="programlisting">
1.184 rillig 6387: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6388: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 6389: </pre>
1.184 rillig 6390: <p>There are several <code class="filename">buildlink3.mk</code>
6391: files in <code class="filename">pkgsrc/mk</code>
6392: that handle special package issues:</p>
6393: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6394: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6395: the native or a pkgsrc Berkeley DB implementation based on
6396: the values of <code class="varname">BDB_ACCEPTED</code> and
6397: <code class="varname">BDB_DEFAULT</code>.</p></li>
6398: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6399: comes with neither Curses nor NCurses, this will take care
1.207 leot 6400: 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.184 rillig 6401: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6402: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6403: adding a dependency on Heimdal or MIT-krb5 for packages that
6404: require a Kerberos 5 implementation.</p></li>
6405: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6406: system-provided Motif installation or adds a dependency on
1.270 wiz 6407: <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
6408: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span> or
6409: <span class="quote">“<span class="quote">motif</span>”</span> to choose which Motif version will be
6410: used.</p></li>
1.184 rillig 6411: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6412: system-provided GNU readline or editline (libedit) installation,
1.207 leot 6413: 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>,
6414: <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.184 rillig 6415: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6416: If your package really needs GNU readline library, its Makefile
6417: should include <code class="filename">devel/readline/buildlink3.mk</code>
6418: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6419: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6420: variables that may be used by packages that use the
6421: Open Sound System (OSS) API.</p></li>
6422: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6423: any of the Postgres versions in the variable
6424: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6425: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6426: the file for more information.</p></li>
6427: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6428: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.207 leot 6429: 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.184 rillig 6430: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6431: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6432: library.</p></li>
6433: </ul></div>
6434: <p>The comments in those <code class="filename">buildlink3.mk</code>
6435: files provide a more complete
6436: description of how to use them properly.</p>
1.1 dsieger 6437: </div>
1.41 asau 6438: <div class="sect1">
1.1 dsieger 6439: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6440: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.184 rillig 6441: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6442: included by Makefiles to indicate the need to compile and link
6443: against header files and libraries provided by the package. A
6444: <code class="filename">buildlink3.mk</code> file should always provide
6445: enough information to add the correct type of dependency
6446: relationship and include any other
6447: <code class="filename">buildlink3.mk</code> files that it needs to find
6448: headers and libraries that it needs in turn.</p>
6449: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.207 leot 6450: 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.184 rillig 6451: package is highly recommended. For most packages, the following
6452: command will generate a good starting point for
6453: <code class="filename">buildlink3.mk</code> files:</p>
6454: <pre class="screen">
6455: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6456: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6457: </pre>
1.41 asau 6458: <div class="sect2">
1.1 dsieger 6459: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 6460: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.184 rillig 6461: <p>The following real-life example
6462: <code class="filename">buildlink3.mk</code> is taken
6463: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.1 dsieger 6464: <pre class="programlisting">
1.184 rillig 6465: BUILDLINK_TREE+= tiff
6466:
6467: .if !defined(TIFF_BUILDLINK3_MK)
6468: TIFF_BUILDLINK3_MK:=
6469:
6470: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6471: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6472: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6473:
6474: .include "../../devel/zlib/buildlink3.mk"
6475: .include "../../graphics/jpeg/buildlink3.mk"
6476: .endif # TIFF_BUILDLINK3_MK
6477:
6478: BUILDLINK_TREE+= -tiff
1.1 dsieger 6479: </pre>
1.184 rillig 6480: <p>The header and footer manipulate
6481: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6482: <code class="filename">buildlink3.mk</code> files and is used to track
6483: the dependency tree.</p>
6484: <p>The main section is protected from multiple inclusion
6485: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6486: added. Several important variables are set in the section:</p>
6487: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6488: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6489: is the dependency version recorded in the installed
1.184 rillig 6490: package; this should always be set using
6491: <span class="command"><strong>+=</strong></span> to ensure that
6492: we're appending to any pre-existing list of values. This
1.185 wiz 6493: variable should be set to the last version of the
1.184 rillig 6494: package that had an backwards-incompatible API change.
6495: </p></li>
6496: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6497: is the location of the <em class="replaceable"><code>pkg</code></em>
6498: pkgsrc directory.</p></li>
6499: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6500: (not shown above) controls whether we use
1.236 gutterid 6501: <code class="varname">BUILD_DEPENDS</code> or
1.184 rillig 6502: <code class="varname">DEPENDS</code> to add the dependency on
6503: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6504: selected by setting
6505: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.266 martin 6506: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.184 rillig 6507: used.</p></li>
6508: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6509: and
6510: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6511: (not shown above) are lists of subdirectories of
6512: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6513: to add to the header and library search paths. These
1.266 martin 6514: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.184 rillig 6515: respectively.</p></li>
6516: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6517: (not shown above) is the list of preprocessor flags to add
6518: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.266 martin 6519: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.184 rillig 6520: should be avoided and instead be handled using
6521: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6522: above.</p></li>
6523: </ul></div>
6524: <p>The following variables are all optionally defined within
6525: this second section (protected against multiple inclusion) and
6526: control which package files are symlinked into
6527: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6528: transformed during the symlinking:</p>
6529: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6530: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6531: (not shown above) is a shell glob pattern relative to
6532: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6533: to be symlinked into
6534: <code class="filename">${BUILDLINK_DIR}</code>,
6535: e.g. <code class="filename">include/*.h</code>.</p></li>
6536: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6537: (not shown above) is a shell pipeline that
6538: outputs to stdout a list of files relative to
6539: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6540: The resulting files are to be symlinked
6541: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6542: this takes the <code class="filename">+CONTENTS</code> of a
6543: <em class="replaceable"><code>pkg</code></em> and filters it through
6544: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6545: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6546: (not shown above) is a filter command that filters
6547: <code class="filename">+CONTENTS</code> input into a list of files
6548: relative to
6549: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6550: on stdout. By default,
6551: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6552: outputs the contents of the <code class="filename">include</code>
6553: and <code class="filename">lib</code> directories in the package
6554: <code class="filename">+CONTENTS</code>.</p></li>
6555: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6556: (not shown above) is a list of sed arguments used to
6557: transform the name of the source filename into a
6558: destination filename, e.g. <span class="command"><strong>-e
6559: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6560: </ul></div>
6561: <p>This section can additionally include any
6562: <code class="filename">buildlink3.mk</code> needed for
6563: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6564: Including these <code class="filename">buildlink3.mk</code> files
6565: means that the headers and libraries for these
6566: dependencies are also symlinked into
6567: <code class="filename">${BUILDLINK_DIR}</code>
6568: whenever the <em class="replaceable"><code>pkg</code></em>
6569: <code class="filename">buildlink3.mk</code>
6570: file is included. Dependencies are only added for directly
6571: include <code class="filename">buildlink3.mk</code> files.</p>
6572: <p>When providing a <code class="filename">buildlink3.mk</code> and
6573: including other <code class="filename">buildlink3.mk</code> files in it,
6574: please only add necessary ones, i.e., those whose libraries or
6575: header files are automatically exposed when the package is
6576: use.</p>
6577: <p>In particular, if only an executable
6578: (<code class="filename">bin/foo</code>) is linked against a library, that
6579: library does not need to be propagated in the
6580: <code class="filename">buildlink3.mk</code> file.</p>
6581: <p>The following steps should help you decide if a
6582: <code class="filename">buildlink3.mk</code> file needs to be included:
6583: </p>
6584: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6585: <li class="listitem"><p>Look at the installed header files: What
6586: headers do they include? The packages providing these files
6587: must be buildlinked.</p></li>
6588: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6589: libraries and look against what other libraries they link.
6590: Some of the packages providing these probably need to be
6591: buildlinked; however, it's not automatic, since e.g. GTK on
6592: some systems pulls in the X libraries, so they will show up in
6593: the <code class="filename">ldd</code> output, while on others (like OS
6594: X) it won't. <code class="filename">ldd</code> output can thus only be
6595: used as a hint.</p></li>
6596: </ul></div>
6597: <p>
6598: </p>
6599: </div>
1.41 asau 6600: <div class="sect2">
1.1 dsieger 6601: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 6602: <a name="updating-buildlink-depends"></a>18.2.2. Updating
1.184 rillig 6603: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6604: and
6605: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6606: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.185 wiz 6607: <p>Both variables set lower bounds for a version of this package.
6608: The two variables differ in that one describes source
1.184 rillig 6609: compatibility (API) and the other binary compatibility (ABI).
6610: The difference is that a change in the API breaks compilation of
6611: programs while changes in the ABI stop compiled programs from
6612: running.</p>
1.185 wiz 6613: <p>The
6614: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6615: variable in a <code class="filename">buildlink3.mk</code> should be
6616: changed very rarely. (One possible scenario: If all packages
6617: using this package need a higher version than defined in the
6618: <code class="filename">buildlink3.mk</code>,
1.184 rillig 6619: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6620: could be updated to that higher version.)</p>
6621: <p>On the other hand, changes to
1.184 rillig 6622: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6623: are more common. The variable will need to be updated every
6624: time the major version of one of its shared libraries is changed,
6625: or any other change where a binary built against the previous
6626: version of the package will not run against the new version any
6627: longer.</p>
6628: <p>In such a case, the package's
1.184 rillig 6629: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6630: must be increased to require the new package version. Then the
6631: <code class="varname">PKGREVISION</code> of all packages
6632: <em class="replaceable"><code>foo</code></em> that depend on this package need
6633: to be increased, and if they have
6634: <code class="filename">buildlink3.mk</code> files,
6635: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6636: in their <code class="filename">buildlink3.mk</code> files must be
6637: increased to the new version as well. This is required so that a
6638: package will pull in the versions of the packages that use the
6639: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6640: uniquely identify the packages built against the new ABI. The
1.207 leot 6641: <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.185 wiz 6642: help with these updates.</p>
1.266 martin 6643: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
1.185 wiz 6644: about dependencies on other packages, including the
6645: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.184 rillig 6646: <p>Please take careful consideration before adjusting
6647: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6648: or
6649: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6650: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6651: cause unneeded package deletions and rebuilds. In many cases,
6652: new versions of packages work just fine with older
6653: dependencies.</p>
1.211 gutterid 6654: <p>Also, it is not needed to set
1.184 rillig 6655: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6656: when it is identical to
1.211 gutterid 6657: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
6658: <p>Note there is also the distinction that users are able to disable
6659: enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
6660: variable, but there is no equivalent option for API dependencies.</p>
1.1 dsieger 6661: </div>
6662: </div>
1.41 asau 6663: <div class="sect1">
1.1 dsieger 6664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6665: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.184 rillig 6666: <p>Some packages in pkgsrc install headers and libraries that
6667: coincide with headers and libraries present in the base system.
6668: Aside from a <code class="filename">buildlink3.mk</code> file, these
6669: packages should also include a <code class="filename">builtin.mk</code>
6670: file that includes the necessary checks to decide whether using
6671: the built-in software or the pkgsrc software is
6672: appropriate.</p>
6673: <p>The only requirements of a builtin.mk file for
6674: <em class="replaceable"><code>pkg</code></em> are:</p>
6675: <div class="orderedlist"><ol class="orderedlist" type="1">
6676: <li class="listitem"><p>It should set
6677: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.266 martin 6678: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.184 rillig 6679: after it is included.</p></li>
6680: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6681: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6682: which is already set before the
6683: <code class="filename">builtin.mk</code> file is included.</p></li>
6684: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6685: is <span class="emphasis"><em>very</em></span> important and takes careful
6686: attention to <code class="filename">Makefile</code> coding.</p></li>
6687: </ol></div>
6688: <div class="sect2">
6689: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 6690: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.184 rillig 6691: <p>The following is the recommended template for builtin.mk
6692: files:</p>
1.1 dsieger 6693: <pre class="programlisting">
1.184 rillig 6694: .if !defined(IS_BUILTIN.foo)
6695: #
6696: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6697: # genuinely exists in the system or not.
6698: #
6699: IS_BUILTIN.foo?= no
1.1 dsieger 6700:
1.184 rillig 6701: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6702: # version can be determined.
6703: #
6704: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6705: BUILTIN_PKG.foo?= foo-1.0
6706: . endif
6707: .endif # IS_BUILTIN.foo
1.1 dsieger 6708:
1.184 rillig 6709: .if !defined(USE_BUILTIN.foo)
6710: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6711: . if defined(BUILTIN_PKG.foo)
6712: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6713: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6714: USE_BUILTIN.foo!= \
6715: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6716: && ${ECHO} "yes" || ${ECHO} "no"
6717: . endif
6718: . endfor
6719: . endif
6720: .endif # USE_BUILTIN.foo
1.1 dsieger 6721:
1.184 rillig 6722: CHECK_BUILTIN.foo?= no
6723: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6724: #
6725: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6726: # "yes" or "no".
6727: #
6728: .endif # CHECK_BUILTIN.foo
1.1 dsieger 6729: </pre>
1.184 rillig 6730: <p>The first section sets
6731: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6732: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6733: in the base system. This should not be a base system software
6734: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.266 martin 6735: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.184 rillig 6736: included as part of the base system. This variable is only
6737: used internally within the <code class="filename">builtin.mk</code>
6738: file.</p>
6739: <p>The second section sets
6740: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6741: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6742: system if it exists (if
6743: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.266 martin 6744: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.184 rillig 6745: within the <code class="filename">builtin.mk</code> file.</p>
6746: <p>The third section sets
6747: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6748: and is <span class="emphasis"><em>required</em></span> in all
6749: <code class="filename">builtin.mk</code> files. The code in this
6750: section must make the determination whether the built-in
6751: software is adequate to satisfy the dependencies listed in
6752: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6753: This is typically done by comparing
6754: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6755: against each of the dependencies in
6756: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6757: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6758: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6759: end of the <code class="filename">builtin.mk</code> file. Note that
6760: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.266 martin 6761: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.184 rillig 6762: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.266 martin 6763: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.184 rillig 6764: that the built-in version of the software is similar enough to
6765: be used as a replacement.</p>
6766: <p>The last section is guarded by
6767: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6768: and includes code that uses the value of
6769: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6770: set in the previous section. This typically includes, e.g.,
6771: adding additional dependency restrictions and listing additional
6772: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6773: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6774: </div>
1.7 rillig 6775: </div>
1.1 dsieger 6776: </div>
1.41 asau 6777: <div class="chapter">
1.1 dsieger 6778: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 6779: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.1 dsieger 6780: <div class="toc">
6781: <p><b>Table of Contents</b></p>
1.100 leot 6782: <dl class="toc">
1.184 rillig 6783: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6784: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6785: <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>
6786: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6787: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6788: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6789: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6790: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6791: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 6792: </dl>
6793: </div>
1.184 rillig 6794: <p>The <code class="filename">PLIST</code> file contains a package's
1.266 martin 6795: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.184 rillig 6796: the package (relative to the <code class="filename">${PREFIX}</code>
6797: directory it's been installed in) plus some additional statements
1.259 leot 6798: - see the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.184 rillig 6799: This chapter addresses some issues that need attention when
6800: dealing with the <code class="filename">PLIST</code> file (or files, see
6801: below!).</p>
1.41 asau 6802: <div class="sect1">
1.1 dsieger 6803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6804: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
1.184 rillig 6805: <p>Be sure to add a RCS ID line as the first thing in any
6806: <code class="filename">PLIST</code> file you write:</p>
6807: <pre class="programlisting">
6808: @comment $NetBSD $
6809: </pre>
6810: <p>An artificial space has been added between NetBSD and $, this is a
6811: workaround here to prevent CVS expanding to the filename of the guide. When
6812: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6813: </div>
1.41 asau 6814: <div class="sect1">
1.1 dsieger 6815: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6816: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.184 rillig 6817: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6818: to output a PLIST that matches any new files since the package
1.266 martin 6819: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
1.184 rillig 6820: more information on this target.</p>
1.1 dsieger 6821: </div>
1.41 asau 6822: <div class="sect1">
1.1 dsieger 6823: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6824: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.184 rillig 6825: </h2></div></div></div>
6826: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6827: of AWK patterns and actions that are used to filter the output of
6828: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6829: scripting you like to it, but be careful with quoting.</p>
6830: <p>For example, to get all files inside the
6831: <code class="filename">libdata/foo</code> directory removed from the
6832: resulting PLIST:</p>
1.1 dsieger 6833: <pre class="programlisting">
1.184 rillig 6834: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 6835: </pre>
1.185 wiz 6836: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6837: evaluated after the file list and directory list are sorted.
6838: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6839: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6840: list and directory list are sorted.</p>
1.184 rillig 6841: </div>
6842: <div class="sect1">
6843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6844: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
1.184 rillig 6845: <p>A number of variables are substituted automatically in
6846: PLISTs when a package is installed on a system. This includes the
6847: following variables:</p>
6848: <div class="variablelist"><dl class="variablelist">
6849: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6850: <dd>
6851: <p>Some packages like emacs and perl embed information
6852: about which architecture they were built on into the
6853: pathnames where they install their files. To handle this
6854: case, PLIST will be preprocessed before actually used, and
6855: the symbol
1.266 martin 6856: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.184 rillig 6857: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6858: same is done if the string
6859: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6860: PLIST somewhere - use this on packages that have GNU
6861: autoconf-created configure scripts.</p>
6862: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6863: <h3 class="title">Legacy note</h3>
6864: <p>There used to be a symbol
1.266 martin 6865: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.184 rillig 6866: was replaced by the output of <span class="command"><strong>uname
6867: -m</strong></span>, but that's no longer supported and has
6868: been removed.</p>
6869: </div>
6870: </dd>
6871: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6872: <dd>
6873: <p>Some packages want to embed the OS name and version
6874: into some paths. To do this, use these variables in the
6875: <code class="filename">PLIST</code>:
6876: </p>
6877: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.266 martin 6878: <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>
6879: <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>
6880: <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>
1.184 rillig 6881: </ul></div>
6882: </dd>
6883: </dl></div>
6884: <p>For a list of values which are replaced by
6885: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6886: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6887: <code class="varname">PLIST_SUBST</code> should help.</p>
6888: <p>If you want to change other variables not listed above, you
6889: can add variables and their expansions to this variable in the
1.266 martin 6890: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="12.5. Optional files">Section 12.5, “Optional files”</a>):</p>
1.1 dsieger 6891: <pre class="programlisting">
1.184 rillig 6892: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 6893: </pre>
1.266 martin 6894: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.184 rillig 6895: in the <code class="filename">PLIST</code> with
1.266 martin 6896: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.184 rillig 6897: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6898: the common case of conditionally including some
6899: <code class="filename">PLIST</code> entries. It can be done by adding
6900: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6901: setting the corresponding <code class="varname">PLIST.foo</code> variable
6902: to <code class="literal">yes</code> if the entry should be included.
1.266 martin 6903: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.184 rillig 6904: in the <code class="filename">PLIST</code> with either
1.266 martin 6905: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6906: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.184 rillig 6907: For example, in <code class="filename">Makefile</code>:</p>
1.66 asau 6908: <pre class="programlisting">
1.184 rillig 6909: PLIST_VARS+= foo
6910: .if <em class="replaceable"><code>condition</code></em>
6911: PLIST.foo= yes
6912: .else
1.66 asau 6913: </pre>
1.184 rillig 6914: <p>And then in <code class="filename">PLIST</code>:</p>
1.1 dsieger 6915: <pre class="programlisting">
1.184 rillig 6916: @comment $NetBSD $
6917: bin/bar
6918: man/man1/bar.1
6919: ${PLIST.foo}bin/foo
6920: ${PLIST.foo}man/man1/foo.1
6921: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 6922: </pre>
1.184 rillig 6923: <p>An artificial space has been added between NetBSD and $, this is a
6924: workaround here to prevent CVS expanding to the filename of the guide. When
1.195 gutterid 6925: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6926: </div>
1.184 rillig 6927: <div class="sect1">
6928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6929: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
1.184 rillig 6930: <p>Man pages should be installed in compressed form if
6931: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6932: and uncompressed otherwise. To handle this in the
1.266 martin 6933: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.184 rillig 6934: appended/removed automatically for man pages according to
6935: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6936: or not, see above for details. This modification of the
6937: <code class="filename">PLIST</code> file is done on a copy of it, not
6938: <code class="filename">PLIST</code> itself.</p>
1.1 dsieger 6939: </div>
1.41 asau 6940: <div class="sect1">
1.1 dsieger 6941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6942: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.184 rillig 6943: </h2></div></div></div>
6944: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6945: in generating the binary package, set the variable
6946: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.259 leot 6947: The files are later concatenated using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.184 rillig 6948: important. The default for <code class="varname">PLIST_SRC</code> is
6949: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.1 dsieger 6950: </div>
1.41 asau 6951: <div class="sect1">
1.1 dsieger 6952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6953: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.184 rillig 6954: <p>Some packages decide to install a different set of files based on
6955: the operating system being used. These differences can be
6956: automatically handled by using the following files:</p>
6957: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6958: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6959: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6960: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6961: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6962: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6963: </ul></div>
1.1 dsieger 6964: </div>
1.41 asau 6965: <div class="sect1">
1.1 dsieger 6966: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6967: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
1.184 rillig 6968: <p>Some packages decide to generate hard-to-guess file names
6969: during installation that are hard to wire down.</p>
6970: <p>In such cases, you can set the
6971: <code class="varname">GENERATE_PLIST</code> variable to shell code
6972: terminated (with a semicolon) that will output PLIST entries which
6973: will be appended to the PLIST</p>
6974: <p>You can find one example in editors/xemacs:</p>
6975: <pre class="programlisting">
6976: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6977: </pre>
6978: <p>which will append something like
6979: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6980: <code class="filename">PLIST</code>.
6981: </p>
1.1 dsieger 6982: </div>
1.41 asau 6983: <div class="sect1">
1.1 dsieger 6984: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 6985: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6986: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.184 rillig 6987: multiple (and unrelated) packages install files. These
6988: directories were problematic because you had to add special
6989: tricks in the PLIST to conditionally remove them, or have some
6990: centralized package handle them.</p>
6991: <p>In pkgsrc, it is now easy: Each package should create
6992: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6993: will remove any directories left empty after uninstalling a
6994: package.</p>
6995: <p>If a package needs an empty directory to work, create
6996: the directory during installation as usual, and also add an
6997: entry to the PLIST:
6998:
6999: </p>
7000: <pre class="programlisting">
7001: @pkgdir path/to/empty/directory
7002: </pre>
7003: <p>
7004:
7005: or take a look at <code class="varname">MAKE_DIRS</code> and
7006: <code class="varname">OWN_DIRS</code>.
1.1 dsieger 7007: </p>
7008: </div>
1.184 rillig 7009: </div>
7010: <div class="chapter">
7011: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 7012: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
1.184 rillig 7013: <div class="toc">
7014: <p><b>Table of Contents</b></p>
7015: <dl class="toc">
7016: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
7017: <dd><dl>
7018: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
7019: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
7020: </dl></dd>
7021: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
7022: <dd><dl>
7023: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
7024: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.239 dholland 7025: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
7026: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
7027: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 7028: </dl></dd>
7029: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
7030: <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>
7031: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
7032: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
7033: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
7034: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
7035: <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>
7036: </dl>
7037: </div>
7038: <p>This chapter describes the framework known as
7039: <code class="literal">pkginstall</code>, whose key features are:</p>
7040: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7041: <li class="listitem"><p>Generic installation and manipulation of directories and files
7042: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
7043: <li class="listitem"><p>Automatic handling of configuration files during installation,
7044: provided that packages are correctly designed.</p></li>
7045: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
7046: <li class="listitem"><p>Registration of system users and groups.</p></li>
7047: <li class="listitem"><p>Registration of system shells.</p></li>
7048: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
7049: </ul></div>
7050: <p>The following sections inspect each of the above points in detail.</p>
7051: <p>You may be thinking that many of the things described here could be
7052: easily done with simple code in the package's post-installation target
7053: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
7054: as the code in them is only executed when building from source. Machines
7055: using binary packages could not benefit from it at all (as the code itself
7056: could be unavailable). Therefore, the only way to achieve any of the items
7057: described above is by means of the installation scripts, which are
7058: automatically generated by pkginstall.</p>
1.41 asau 7059: <div class="sect1">
1.1 dsieger 7060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7061: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
1.184 rillig 7062: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
7063: of files and directories that belong to a package. The names used in it
7064: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
7065: which means that it cannot register files outside this directory (absolute
7066: path names are not allowed). Despite this restriction, some packages need
7067: to install files outside this location; e.g., under
7068: <code class="filename">${VARBASE}</code> or
7069: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
7070: is to create such files during installation time by using
7071: installation scripts.</p>
7072: <p>The generic installation scripts are shell scripts that can
7073: contain arbitrary code. The list of scripts to execute is taken from
7074: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
7075: <code class="filename">INSTALL</code>. A similar variable exists for package
7076: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
7077: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
7078: commands, so they have the potential to create and manage files
7079: anywhere in the file system.</p>
7080: <p>Using these general installation files is not recommended, but
7081: may be needed in some special cases. One reason for avoiding them is
7082: that the user has to trust the packager that there is no unwanted or
7083: simply erroneous code included in the installation script. Also,
7084: previously there were many similar scripts for the same functionality,
7085: and fixing a common error involved finding and changing all of
7086: them.</p>
7087: <p>The pkginstall framework offers another, standardized way. It
7088: provides generic scripts to abstract the manipulation of such files
7089: and directories based on variables set in the package's
7090: <code class="filename">Makefile</code>. The rest of this section describes
7091: these variables.</p>
7092: <div class="sect2">
7093: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7094: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
1.184 rillig 7095: <p>The following variables can be set to request the creation of
7096: directories anywhere in the file system:</p>
7097: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7098: <li class="listitem">
7099: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
7100: contain a list of directories that should be created and should attempt
7101: to be destroyed by the installation scripts. The difference between
7102: the two is that the latter prompts the administrator to remove any
7103: directories that may be left after deinstallation (because they were
7104: not empty), while the former does not. Example:</p>
7105: <pre class="programlisting">
7106: MAKE_DIRS+= ${VARBASE}/foo/private
7107: </pre>
7108: </li>
7109: <li class="listitem">
7110: <p><code class="varname">MAKE_DIRS_PERMS</code> and
7111: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
7112: which directories should be created and should attempt to be destroyed
7113: by the installation scripts. Each tuple holds the following values,
7114: separated by spaces: the directory name, its owner, its group and its
7115: numerical mode. For example:</p>
7116: <pre class="programlisting">
7117: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
7118: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
7119: </pre>
7120: <p>The difference between the two is exactly the same as their
7121: non-<code class="varname">PERMS</code> counterparts.</p>
7122: </li>
7123: </ul></div>
1.1 dsieger 7124: </div>
1.184 rillig 7125: <div class="sect2">
7126: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7127: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
1.184 rillig 7128: <p>Creating non-empty files outside the installation prefix is tricky
7129: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.239 dholland 7130: To overcome this problem, the only solution is to extract the file in a
1.184 rillig 7131: known place (i.e., inside the installation prefix) and copy it to the
7132: appropriate location during installation (done by the installation scripts
1.239 dholland 7133: generated by pkginstall). We will call the former the <span class="emphasis"><em>reference
1.184 rillig 7134: file</em></span> in the following paragraphs, which describe the variables
7135: that can be used to automatically and consistently handle files outside the
7136: installation prefix:</p>
7137: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.239 dholland 7138: <li class="listitem"><p><code class="varname">REQD_FILES</code> is a list of pairs of reference
7139: and target files. At installation time, the reference file is copied
7140: to the target if and only if the latter does not exist. Upon
7141: deinstallation, the reference file is removed provided that it was
7142: not modified by the installation.</p></li>
1.184 rillig 7143: <li class="listitem">
1.239 dholland 7144: <p><code class="varname">REQD_FILES_PERMS</code> contains tuples describing
7145: reference files and targets, including owner, group, and numeric
7146: permissions that should be set. For example:</p>
1.1 dsieger 7147: <pre class="programlisting">
1.184 rillig 7148: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
7149: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 7150: </pre>
1.184 rillig 7151: </li>
1.239 dholland 7152: <li class="listitem"><p><code class="varname">CONF_FILES</code> and
7153: <code class="varname">CONF_FILES_PERMS</code> have the same syntax as
7154: <code class="varname">REQD_FILES</code> and
7155: <code class="varname">REQD_FILES_PERMS</code> respectively. The difference
7156: is that these variables are specifically intended for handling
7157: configuration files, for which additional conventions and
1.266 martin 7158: constraints apply. See <a class="xref" href="#conf-files" title="20.2. Configuration files">Section 20.2, “Configuration files”</a> for further
1.239 dholland 7159: discussion. Note in particular that while handling of
1.266 martin 7160: configuration files can be disabled by the user (see <a class="xref" href="#conf-files-disable" title="20.2.5. Disabling handling of configuration files">Section 20.2.5, “Disabling handling of configuration files”</a>), this setting does not affect
1.239 dholland 7161: <code class="varname">REQD_FILES</code> and
7162: <code class="varname">REQD_FILES_PERMS</code>.</p></li>
1.184 rillig 7163: </ul></div>
1.239 dholland 7164: <p>To install an empty file, one can use these macros and
7165: <code class="filename">/dev/null</code> as the reference file.</p>
1.184 rillig 7166: </div>
1.1 dsieger 7167: </div>
1.41 asau 7168: <div class="sect1">
1.1 dsieger 7169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7170: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
1.239 dholland 7171: <p>There are two principles that govern the handling of
7172: configuration files in pkgsrc: first, the user's configuration must
7173: not be lost or overwritten by upgrades or reinstallations; and second,
7174: the default configuration should always be available for reference.
7175: To that end, pkgsrc has a framework specifically for handling
7176: configuration files. In general, configuration files are installed
7177: into <code class="filename">${PREFIX}/share/examples</code>, and copied from
7178: there to the pertinent <code class="filename">etc</code> directory as a
7179: separate step and only as needed.</p>
7180: <p>To make this work, there are three things that need to happen,
7181: any of which may require patching. First, the package must be told to
7182: read its configuration from the correct place at runtime; this place
7183: is <code class="filename">${PKG_SYSCONFDIR}</code> (or possibly a subdirectory
7184: of it) which is often but not always
7185: <code class="filename">${PREFIX}/etc</code>. Second, the package must be
7186: taught to install its default configuration files in
7187: <code class="filename">${PREFIX}/share/examples/${PKGBASE}</code>; this is the
7188: point at which patching often becomes required because it is not the
7189: same place as the runtime location. Third, the configuration files
7190: need to be declared in the package makefile; this is the easy part.
7191: </p>
7192: <p>With those elements in place, the right things will happen: the
7193: package install phase and resulting binary package will not touch
7194: <code class="filename">${PKG_SYSCONFDIR}</code>, and the default configuration
7195: will be copied into place by the pkgsrc framework only if not already
7196: present. Similarly, upon deinstall the configuration will not be
7197: removed if it has been modified. (This means that in the case of
7198: reinstallation and upgrades, unmodified configuration files are
7199: updated but modifications are never discarded.)</p>
7200: <p>The following sections describe how to make these things happen
7201: and document other relevant knobs available in the pkgsrc
7202: infrastructure.</p>
1.184 rillig 7203: <div class="sect2">
7204: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7205: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.184 rillig 7206: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7207: specifies where configuration files shall be installed. Its contents are
7208: set based upon the following variables:</p>
7209: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7210: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7211: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.239 dholland 7212: be overridden by the user to point to their preferred location (e.g.,
1.184 rillig 7213: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7214: Packages must not use it directly.</p></li>
7215: <li class="listitem">
7216: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7217: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7218: for the package being built shall be installed. The definition of this
7219: variable only makes sense in the package's
7220: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7221: <p>As an example, consider the Apache package,
1.207 leot 7222: <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.184 rillig 7223: configuration files under the
7224: <code class="filename">httpd/</code> subdirectory of
7225: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7226: Makefile.</p>
7227: </li>
7228: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7229: variable that holds this package's configuration directory (if
7230: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7231: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7232: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7233: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7234: directory where the configuration files for the package identified by
7235: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7236: </ul></div>
7237: <p>Based on the above variables, pkginstall determines the value of
7238: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
1.239 dholland 7239: variable that may be used within a package to refer to its configuration
1.184 rillig 7240: directory. The algorithm used to set its value is basically the
7241: following:</p>
7242: <div class="orderedlist"><ol class="orderedlist" type="1">
7243: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7244: its value is used.</p></li>
7245: <li class="listitem"><p>If the previous variable is not defined but
7246: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7247: <code class="filename">Makefile</code>, the resulting value is
7248: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7249: <li class="listitem"><p>Otherwise, it is set to
7250: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7251: </ol></div>
7252: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.239 dholland 7253: automatically added to <code class="filename">OWN_DIRS</code>. This causes it
1.266 martin 7254: to be automatically created if needed. See <a class="xref" href="#dirs-outside-prefix" title="20.1.1. Directory manipulation">Section 20.1.1, “Directory manipulation”</a> for further details. This does not apply to
1.239 dholland 7255: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>; they must be manually
7256: created with <code class="varname">OWN_DIRS</code> or
7257: <code class="varname">MAKE_DIRS</code>.</p>
1.184 rillig 7258: </div>
7259: <div class="sect2">
7260: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7261: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
1.184 rillig 7262: <p>Given that pkgsrc (and users!) expect configuration files to be in a
1.239 dholland 7263: known place, you need to teach each package where to install its files. In
7264: some cases you will have to patch the package Makefiles to achieve it. If
7265: you are lucky, though, it may be as easy as passing an extra flag to the
7266: configuration script. This is the case for packages using GNU
7267: autoconf:</p>
1.1 dsieger 7268: <pre class="programlisting">
1.184 rillig 7269: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 7270: </pre>
1.184 rillig 7271: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
1.239 dholland 7272: for</em></span> its configuration files, not where they will be installed.
7273: Fortunately, there is a different way to specify the latter, as seen
1.240 gutterid 7274: in the next section, although the combination is rather confusing at
1.239 dholland 7275: first glance.</p>
1.1 dsieger 7276: </div>
1.184 rillig 7277: <div class="sect2">
7278: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7279: <a name="conf-files-patching"></a>20.2.3. Patching installation</h3></div></div></div>
1.239 dholland 7280: <p>As discussed above, <span class="strong"><strong>packages themselves must not
1.184 rillig 7281: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7282: directly</strong></span>. Bad news is that many software installation scripts
7283: will, out of the box, mess with the contents of that directory. So what is
7284: the correct procedure to fix this issue?</p>
7285: <p>You must teach the package (usually by manually patching it) to
7286: install any configuration files under the examples hierarchy,
7287: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7288: <code class="filename">PLIST</code> registers them and the administrator always
7289: has the original copies available.</p>
1.239 dholland 7290: <p>It turns out that for packages using GNU autoconf it is possible
7291: to create the desired effect by setting <code class="varname">sysconfdir</code>
7292: on the make command line at install time. Consider this example taken
7293: from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/index.html" target="_top"><code class="filename">mail/mutt</code></a>:</p>
7294: <pre class="programlisting">
7295: EGDIR= ${PREFIX}/share/examples/mutt
7296: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
7297: </pre>
7298: <p>Note that the <code class="varname">EGDIR</code> variable, though commonly
7299: used for this purpose, is local to that package and has no meaning
7300: outside it.</p>
7301: </div>
7302: <div class="sect2">
7303: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7304: <a name="conf-files-declare"></a>20.2.4. Declaring configuration files</h3></div></div></div>
1.184 rillig 7305: <p>Once the required configuration files are in place (i.e., under the
1.239 dholland 7306: examples hierarchy), the pkginstall framework can use them as reference copies
1.184 rillig 7307: during the package installation to update what is in
7308: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7309: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.266 martin 7310: used. Check out <a class="xref" href="#files-outside-prefix" title="20.1.2. File manipulation">Section 20.1.2, “File manipulation”</a> for further
1.239 dholland 7311: information about their syntax and their purpose. Here is an example,
7312: taken from the <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>
7313: <pre class="programlisting">
7314: EGDIR= ${PREFIX}/share/examples/mutt
7315: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7316: </pre>
7317: <p>Note that (as in the previous section's example) the
7318: <code class="varname">EGDIR</code> variable is specific to the package and has
7319: no meaning outside it.</p>
7320: <p>For reference, the complete example from Mutt is as follows:</p>
1.1 dsieger 7321: <pre class="programlisting">
1.239 dholland 7322: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
7323: EGDIR= ${PREFIX}/share/examples/mutt
7324: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7325: INSTALLATION_DIRS+= ${EGDIR}
7326: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.1 dsieger 7327: </pre>
7328: </div>
1.184 rillig 7329: <div class="sect2">
7330: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7331: <a name="conf-files-disable"></a>20.2.5. Disabling handling of configuration files</h3></div></div></div>
1.184 rillig 7332: <p>The automatic copying of config files can be toggled by setting the
7333: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7334: installation.</p>
1.1 dsieger 7335: </div>
7336: </div>
1.41 asau 7337: <div class="sect1">
1.1 dsieger 7338: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7339: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
1.184 rillig 7340: <p>System startup scripts are special files because they must be
7341: installed in a place known by the underlying OS, usually outside the
1.266 martin 7342: 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
1.184 rillig 7343: can be used. However, pkginstall provides a special mechanism to handle
7344: these files.</p>
7345: <p>In order to provide system startup scripts, the package has
7346: to:</p>
7347: <div class="orderedlist"><ol class="orderedlist" type="1">
7348: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7349: the <code class="literal">.sh</code> suffix appended. Considering the
1.223 nia 7350: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups-base/index.html" target="_top"><code class="filename">print/cups-base</code></a> package as an example, it
7351: has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.184 rillig 7352: <li class="listitem">
7353: <p>Tell pkginstall to handle it, appending the name of the script,
7354: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7355: Continuing the previous example:</p>
7356: <pre class="programlisting">
7357: RCD_SCRIPTS+= cupsd
7358: </pre>
7359: </li>
7360: </ol></div>
7361: <p>Once this is done, pkginstall will do the following steps for each
7362: script in an automated fashion:</p>
7363: <div class="orderedlist"><ol class="orderedlist" type="1">
7364: <li class="listitem"><p>Process the file found in the files directory applying all the
7365: substitutions described in the <code class="filename">FILES_SUBST</code>
7366: variable.</p></li>
7367: <li class="listitem"><p>Copy the script from the files directory to the examples
7368: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.239 dholland 7369: that this reference file must be explicitly registered in the
1.184 rillig 7370: <code class="filename">PLIST</code>.</p></li>
7371: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7372: from the examples hierarchy into the system-wide startup scripts
7373: directory.</p></li>
7374: </ol></div>
7375: <div class="sect2">
7376: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7377: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.184 rillig 7378: <p>The automatic copying of config files can be toggled by setting the
7379: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7380: installation. Note that the scripts will be always copied inside the
7381: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7382: matter what the value of this variable is.</p>
1.1 dsieger 7383: </div>
7384: </div>
1.184 rillig 7385: <div class="sect1">
7386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7387: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
1.184 rillig 7388: <p>If a package needs to create special users and/or groups during
7389: installation, it can do so by using the pkginstall framework.</p>
7390: <p>Users can be created by adding entries to the
7391: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7392: syntax:</p>
7393: <pre class="programlisting">
7394: user:group
7395: </pre>
7396: <p>Further specification of user details may be done by setting
7397: per-user variables.
7398: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7399: numeric UID for the user.
7400: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7401: user's description or comment.
7402: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7403: user's home directory, and defaults to
7404: <code class="filename">/nonexistent</code> if not specified.
7405: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7406: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7407: not specified.</p>
7408: <p>Similarly, groups can be created by adding entries to the
7409: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7410: <pre class="programlisting">
7411: group
7412: </pre>
7413: <p>The numeric GID of the group may be set by defining
7414: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7415: <p>If a package needs to create the users and groups at an earlier
7416: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7417: <code class="literal">configure</code>,<code class="literal">build</code>, or
7418: <code class="literal">pre-install</code> to indicate the phase before which the
7419: users and groups are created. In this case, the numeric UIDs and GIDs
7420: of the created users and groups are automatically hardcoded into the
7421: final installation scripts.</p>
1.1 dsieger 7422: </div>
1.41 asau 7423: <div class="sect1">
1.1 dsieger 7424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7425: <a name="shells"></a>20.5. System shells</h2></div></div></div>
1.184 rillig 7426: <p>Packages that install system shells should register them in the shell
7427: database, <code class="filename">/etc/shells</code>, to make things easier to the
7428: administrator. This must be done from the installation scripts to keep
7429: binary packages working on any system. pkginstall provides an easy way to
7430: accomplish this task.</p>
7431: <p>When a package provides a shell interpreter, it has to set the
7432: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7433: add some hooks to the installation scripts to handle it. Consider the
1.207 leot 7434: 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.184 rillig 7435: <pre class="programlisting">
7436: PKG_SHELL= ${PREFIX}/bin/zsh
7437: </pre>
7438: <div class="sect2">
7439: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7440: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
1.184 rillig 7441: <p>The automatic registration of shell interpreters can be disabled by
7442: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7443: environment variable to <code class="literal">NO</code>.</p>
7444: </div>
1.1 dsieger 7445: </div>
1.41 asau 7446: <div class="sect1">
1.1 dsieger 7447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7448: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
1.184 rillig 7449: <p>Packages that install X11 fonts should update the database files
7450: that index the fonts within each fonts directory. This can easily be
7451: accomplished within the pkginstall framework.</p>
7452: <p>When a package installs X11 fonts, it must list the directories in
7453: which fonts are installed in the
7454: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.266 martin 7455: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7456: <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
1.184 rillig 7457: installation scripts to run the appropriate commands to update the fonts
7458: database files within each of those directories. For convenience, if the
7459: directory path is relative, it is taken to be relative to the package's
1.207 leot 7460: 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.1 dsieger 7461: <pre class="programlisting">
1.184 rillig 7462: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 7463: </pre>
1.184 rillig 7464: <div class="sect2">
7465: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7466: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.184 rillig 7467: <p>The automatic update of fonts databases can be disabled by
7468: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7469: environment variable to <code class="literal">NO</code>.</p>
1.1 dsieger 7470: </div>
7471: </div>
7472: </div>
1.41 asau 7473: <div class="chapter">
1.1 dsieger 7474: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 7475: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 7476: <div class="toc">
7477: <p><b>Table of Contents</b></p>
1.100 leot 7478: <dl class="toc">
1.154 rillig 7479: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 7480: <dd><dl>
1.154 rillig 7481: <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>
7482: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7483: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7484: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7485: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7486: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7487: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7488: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7489: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7490: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7491: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7492: </dl></dd>
7493: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7494: <dd><dl>
7495: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7496: <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>
7497: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7498: </dl></dd>
7499: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7500: <dd><dl>
7501: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7502: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7503: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 7504: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.260 wiz 7505: <dt><span class="sect2"><a href="#endian">21.3.5. Determining the endianness</a></span></dt>
1.154 rillig 7506: </dl></dd>
7507: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7508: <dd><dl>
7509: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7510: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 7511: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 7512: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
7513: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
7514: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
7515: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 7516: </dl></dd>
7517: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7518: <dd><dl>
7519: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7520: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 7521: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
1.266 martin 7522: <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>
1.172 rillig 7523: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 7524: </dl></dd>
7525: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7526: <dd><dl>
7527: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7528: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7529: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7530: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7531: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 7532: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.254 wiz 7533: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
7534: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
7535: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
7536: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
7537: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
7538: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
7539: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
7540: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
7541: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
7542: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.1 dsieger 7543: emulation</a></span></dt>
1.254 wiz 7544: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
7545: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.1 dsieger 7546: </dl></dd>
1.154 rillig 7547: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7548: </dl>
7549: </div>
1.41 asau 7550: <div class="sect1">
1.1 dsieger 7551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 7552: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 7553: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 7554: different platforms. As a result, it is important to ensure,
7555: where possible, that packages in pkgsrc are portable. This
7556: chapter mentions some particular details you should pay
7557: attention to while working on pkgsrc.</p>
1.41 asau 7558: <div class="sect2">
1.1 dsieger 7559: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7560: <a name="pulling-vars-from-etc-mk.conf"></a>21.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 7561: </h3></div></div></div>
7562: <p>The pkgsrc user can configure pkgsrc by overriding several
7563: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7564: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7565: want to use those variables in the preprocessor directives of
1.259 leot 7566: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1 dsieger 7567: <code class="literal">.for</code>), you need to include the file
7568: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7569: loads the user preferences.</p>
7570: <p>But note that some variables may not be completely defined
7571: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7572: included, as they may contain references to variables that are
1.108 rillig 7573: not yet defined. In shell commands (the lines in
7574: <code class="filename">Makefile</code> that are indented with a tab) this
7575: is no problem, since variables are only expanded when they are
7576: used. But in the preprocessor directives mentioned above and in
7577: dependency lines (of the form <code class="literal">target:
1.1 dsieger 7578: dependencies</code>) the variables are expanded at load
7579: time.</p>
1.41 asau 7580: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7581: <h3 class="title">Note</h3>
1.108 rillig 7582: <p>To check whether a variable can be used at load time,
7583: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 7584: </div>
7585: </div>
1.41 asau 7586: <div class="sect2">
1.1 dsieger 7587: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7588: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 7589: <p>Occasionally, packages require interaction from the user,
7590: and this can be in a number of ways:</p>
1.41 asau 7591: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7592: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7593: interaction such as entering username/password or accepting a
7594: license on a web page.</p></li>
1.23 wiz 7595: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7596: passwords.</p></li>
1.23 wiz 7597: <li class="listitem"><p>help to configure the package before it is built</p></li>
7598: <li class="listitem"><p>help during the build process</p></li>
7599: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7600: </ul></div>
1.108 rillig 7601: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7602: variable to define which stages need interaction. This should be
7603: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 7604: <pre class="programlisting">
7605: INTERACTIVE_STAGE= configure install
1.111 sevan 7606: </pre>
1.1 dsieger 7607: <p>The user can then decide to skip this package by setting the
1.108 rillig 7608: <code class="varname">BATCH</code> variable. Packages that require interaction
7609: are also excluded from bulk builds.</p>
1.1 dsieger 7610: </div>
1.41 asau 7611: <div class="sect2">
1.1 dsieger 7612: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7613: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 7614: <p>Authors of software can choose the licence under which software
7615: can be copied. The Free Software Foundation has declared some
7616: licenses "Free", and the Open Source Initiative has a definition of
7617: "Open Source".</p>
7618: <p>By default, pkgsrc allows packages with Free or Open Source
7619: licenses to be built. To allow packages with other licenses to be
7620: built as well, the pkgsrc user needs to add these licenses to the
7621: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7622: that this variable only affects which packages may be
7623: <span class="emphasis"><em>built</em></span>, while the license terms often also
7624: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 7625: <p>One might want to only install packages with a BSD license,
1.108 rillig 7626: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 7627: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 7628: user can override the default by setting the
7629: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 7630: of "+=". The licenses accepted by default are defined in the
7631: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7632: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7633: <p>The license tag mechanism is intended to address
7634: copyright-related issues surrounding building, installing and
7635: using a package, and not to address redistribution issues (see
7636: <code class="varname">RESTRICTED</code> and
1.111 sevan 7637: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7638: Packages with redistribution restrictions should set these
7639: tags.</p>
1.1 dsieger 7640: <p>Denoting that a package may be copied according to a
7641: particular license is done by placing the license in
7642: <code class="filename">pkgsrc/licenses</code> and setting the
7643: <code class="varname">LICENSE</code> variable to a string identifying the
1.207 leot 7644: 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.1 dsieger 7645: <pre class="programlisting">
7646: LICENSE= xv-license
1.111 sevan 7647: </pre>
1.1 dsieger 7648: <p>When trying to build, the user will get a notice that the
7649: package is covered by a license which has not been placed in the
7650: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7651: <pre class="programlisting">
7652: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7653: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7654: ===> To view the license, enter "/usr/bin/make show-license".
7655: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7656: ===> ACCEPTABLE_LICENSES+=xv-license
7657: *** Error code 1
1.111 sevan 7658: </pre>
1.260 wiz 7659: <p>In case a package requires multiple licenses, you can add all of
7660: them to the LICENSE variable, connected with the upper-case keyword
7661: <code class="varname">AND</code>. If the user has a choice between multiple
7662: licenses, you can add them connected with the upper-case keyword
7663: <code class="varname">OR</code>, for example:</p>
7664: <pre class="programlisting">
7665: LICENSE= isc AND apache-2.0
7666: LICENSE= 2-clause-bsd OR ruby-license
7667: </pre>
1.10 hubertf 7668: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7669: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7670: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7671: convey to pkgsrc that it should not in the future fail because of
7672: that license:</p>
7673: <pre class="programlisting">
7674: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7675: </pre>
7676: <p>The use of <code class="varname">LICENSE=shareware</code>,
7677: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7678: is deprecated because it does not crisply refer to a particular
7679: license text. Another problem with such usage is that it does not
7680: enable a user to tell pkgsrc to proceed for a single package
7681: without also telling pkgsrc to proceed for all packages with that
7682: tag.</p>
7683: <div class="sect3">
7684: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 7685: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7686: <p>When adding a package with a new license, the following steps
7687: are required:</p>
7688: <div class="orderedlist"><ol class="orderedlist" type="1">
7689: <li class="listitem">
1.169 rillig 7690: <p>Check whether the license qualifies as Free or Open Source by
7691: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7692: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111 sevan 7693: Open Source Initiative</a>. If this is the case, the filename in
7694: <code class="filename">pkgsrc/licenses/</code> does not need the
7695: <code class="filename">-license</code> suffix, and the license name should be
7696: added to:</p>
1.48 rodent 7697: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7698: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7699: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7700: <li class="listitem"><p>default_acceptable_licenses in
7701: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48 rodent 7702: </ul></div>
7703: </li>
1.169 rillig 7704: <li class="listitem"><p>The license text should be added to
7705: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7706: licenses can be seen in this directory.</p></li>
1.48 rodent 7707: </ol></div>
1.111 sevan 7708: </div>
7709: <div class="sect3">
7710: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 7711: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7712: <p>When the license changes (in a way other than formatting),
1.111 sevan 7713: make sure that the new license has a different name (e.g.,
1.1 dsieger 7714: append the version number if it exists, or the date). Just
7715: because a user told pkgsrc to build programs under a previous
7716: version of a license does not mean that pkgsrc should build
7717: programs under the new licenses. The higher-level point is that
7718: pkgsrc does not evaluate licenses for reasonableness; the only
7719: test is a mechanistic test of whether a particular text has been
1.111 sevan 7720: approved by either of two bodies (FSF or OSI).</p>
7721: </div>
1.1 dsieger 7722: </div>
1.41 asau 7723: <div class="sect2">
1.1 dsieger 7724: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7725: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7726: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7727: By declaring the restrictions, package tools can
1.1 dsieger 7728: automatically refrain from e.g. placing binary packages on FTP
7729: sites.</p>
1.111 sevan 7730: <p>There are four possible restrictions, which are
1.1 dsieger 7731: the cross product of sources (distfiles) and binaries not being
7732: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7733: language in any license, and because non-Free licenses tend to be
7734: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7735: CD-ROM.
7736:
7737: "FTP" means making the source or binary file available over the
7738: Internet at no charge.
7739:
7740: "CD-ROM" means making the source or binary available on some kind of
7741: media, together with other source and binary packages, which is sold
7742: for a distribution charge.
1.1 dsieger 7743: </p>
7744: <p>In order to encode these restrictions, the package system
7745: defines five make variables that can be set to note these
7746: restrictions:</p>
1.41 asau 7747: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7748: <li class="listitem">
1.1 dsieger 7749: <p><code class="varname">RESTRICTED</code></p>
7750: <p>This variable should be set whenever a restriction
7751: exists (regardless of its kind). Set this variable to a
7752: string containing the reason for the restriction. It should
7753: be understood that those wanting to understand the restriction
7754: will have to read the license, and perhaps seek advice of
7755: counsel.</p>
7756: </li>
1.23 wiz 7757: <li class="listitem">
1.1 dsieger 7758: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7759: <p>Binaries may not be placed on CD-ROM containing other
7760: binary packages, for which a distribution charge may be made.
7761: In this case, set this variable to
7762: <code class="varname">${RESTRICTED}</code>.</p>
7763: </li>
1.23 wiz 7764: <li class="listitem">
1.1 dsieger 7765: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7766: <p>Binaries may not made available on the Internet without
7767: charge. In this case, set this variable to
7768: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7769: binary packages will not be included on ftp.NetBSD.org.</p>
7770: </li>
1.23 wiz 7771: <li class="listitem">
1.1 dsieger 7772: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7773: <p>Distfiles may not be placed on CD-ROM, together with
7774: other distfiles, for which a fee may be charged. In this
7775: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7776: </p>
7777: </li>
1.23 wiz 7778: <li class="listitem">
1.1 dsieger 7779: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7780: <p>Distfiles may not made available via FTP at no charge.
7781: In this case, set this variable to
7782: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7783: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7784: </li>
7785: </ul></div>
1.111 sevan 7786: <p>Please note that packages will be removed from pkgsrc when the
7787: distfiles are not distributable and cannot be obtained for a period
7788: of one full quarter branch. Packages with manual/interactive fetch
7789: must have a maintainer and it is his/her responsibility to ensure
7790: this.</p>
1.1 dsieger 7791: </div>
1.41 asau 7792: <div class="sect2">
1.1 dsieger 7793: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7794: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.175 gutterid 7795: <p>Your package may depend on some other package being present,
7796: and there are various ways of expressing this dependency.
7797: pkgsrc supports the <code class="varname">DEPENDS</code>,
7798: <code class="varname">BUILD_DEPENDS</code>,
7799: <code class="varname">TOOL_DEPENDS</code>, and
7800: <code class="varname">TEST_DEPENDS</code> definitions, the
1.1 dsieger 7801: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7802: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7803: to handle dependencies, and which uses the variables named above.
1.266 martin 7804: See <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a> for more information.</p>
1.175 gutterid 7805: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7806: definition registers that pre-requisite in the binary package so it
7807: will be pulled in when the binary package is later installed, whilst
7808: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7809: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7810: dependency that is only needed for building or testing the resulting
1.266 martin 7811: package. See also <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> for more information.</p>
1.1 dsieger 7812: <p>This means that if you only need a package present whilst
1.175 gutterid 7813: you are building or testing, it should be noted as a
7814: <code class="varname">TOOL_DEPENDS</code>,
7815: <code class="varname">BUILD_DEPENDS</code>, or
7816: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.156 leot 7817: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7818: packages, i.e. packages for the architecture where the package
7819: is built;
7820: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.175 gutterid 7821: packages, i.e., packages for the architecture for which the package
1.156 leot 7822: is built.</p>
1.175 gutterid 7823: <p>The format for a <code class="varname">DEPENDS</code>,
7824: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7825: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.1 dsieger 7826: <pre class="programlisting">
7827: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7828: </pre>
1.266 martin 7829: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7830: may include any of the wildcard version numbers recognized by
1.259 leot 7831: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23 wiz 7832: <div class="orderedlist"><ol class="orderedlist" type="1">
7833: <li class="listitem">
1.1 dsieger 7834: <p>If your package needs another package's binaries or
1.54 wiz 7835: libraries to build and run, and if that package has a
1.1 dsieger 7836: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7837: <pre class="programlisting">
7838: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7839: </pre>
1.1 dsieger 7840: </li>
1.23 wiz 7841: <li class="listitem">
1.54 wiz 7842: <p>If your package needs another package's binaries or
7843: libraries only for building, and if that package has a
7844: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7845: <pre class="programlisting">
7846: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7847: </pre>
1.54 wiz 7848: <p>but set
7849: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7850: to make it a build dependency only. This case is rather
7851: rare.</p>
7852: </li>
7853: <li class="listitem">
1.25 spz 7854: <p>If your package needs binaries from another package to build,
1.156 leot 7855: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7856: <pre class="programlisting">
1.156 leot 7857: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7858: </pre>
1.1 dsieger 7859: </li>
1.156 leot 7860: <li class="listitem"><p>If your package needs static libraries to link against, header
7861: files to include, etc. from another package to build,
7862: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7863: <li class="listitem"><p>If your package needs a library with which to link and
7864: there is no <code class="filename">buildlink3.mk</code> file
7865: available, create one. Using
7866: <code class="varname">DEPENDS</code> won't be sufficient because the
7867: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7868: <li class="listitem">
1.25 spz 7869: <p>If your package needs some executable to be able to run
7870: correctly and if there's no
7871: <code class="filename">buildlink3.mk</code> file, this is specified
7872: using the <code class="varname">DEPENDS</code> variable. The
1.207 leot 7873: <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.129 wiz 7874: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7875: when it runs, and that is specified:</p>
1.1 dsieger 7876: <pre class="programlisting">
1.129 wiz 7877: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7878: </pre>
1.25 spz 7879: </li>
1.175 gutterid 7880: <li class="listitem"><p>If your package includes a test suite that has extra
7881: dependencies only required for this purpose (frequently this
1.266 martin 7882: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
1.175 gutterid 7883: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.25 spz 7884: <li class="listitem">
7885: <p>You can use wildcards in package dependencies. Note that
7886: such wildcard dependencies are retained when creating binary
7887: packages. The dependency is checked when installing the binary
7888: package and any package which matches the pattern will be
7889: used. Wildcard dependencies should be used with care.</p>
1.266 martin 7890: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7891: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7892: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7893: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7894: <p>Wildcards can also be used to specify that a package
7895: will only build against a certain minimum version of a
7896: pre-requisite:</p>
7897: <pre class="programlisting">
1.25 spz 7898: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7899: </pre>
1.25 spz 7900: <p>This means that the package will build using version 6.0
7901: of ImageMagick or newer. Such a dependency may be warranted
7902: if, for example, the command line options of an executable
7903: have changed.</p>
7904: <p>If you need to depend on minimum versions of libraries,
1.183 wiz 7905: set
7906: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7907: to the appropriate pattern before including its
7908: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7909: <pre class="programlisting">
7910: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7911: .include "../../graphics/jpeg/buildlink3.mk"
7912: </pre>
1.1 dsieger 7913: <p>For security fixes, please update the package
1.266 martin 7914: vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, “Handling packages with security problems”</a> for more
1.1 dsieger 7915: information.</p>
7916: </li>
7917: </ol></div>
7918: <p>If your package needs files from another package to build,
7919: add the relevant distribution files to
7920: <code class="varname">DISTFILES</code>, so they will be extracted
1.207 leot 7921: 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.1 dsieger 7922: (It relies on the jpeg sources being present in source form
7923: during the build.)</p>
7924: </div>
1.41 asau 7925: <div class="sect2">
1.1 dsieger 7926: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7927: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.226 gutterid 7928: <p>Your package may conflict with other packages users might
7929: already have installed on their system, e.g., if your package
1.1 dsieger 7930: installs the same set of files as another package in the pkgsrc
1.227 wiz 7931: tree.</p>
1.207 leot 7932: <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>
7933: 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.142 leot 7934: install the same shared library, thus you set in
7935: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7936: <pre class="programlisting">
7937: CONFLICTS= Xaw-Xpm-[0-9]*
1.238 wiz 7938: </pre>
1.142 leot 7939: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7940: <pre class="programlisting">
7941: CONFLICTS= libXaw3d-[0-9]*
1.238 wiz 7942: </pre>
1.259 leot 7943: <p><a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.142 leot 7944: that conflict with existing packages and abort. However, in many
7945: situations this is too late in the process. Binary package managers
7946: will not know about the conflict until they attempt to install the
7947: package after already downloading it and all its dependencies.
7948: Users may also waste time building a package and its dependencies
7949: only to find out at the end that it conflicts with another package
7950: they have installed.</p>
7951: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7952: should be added in all cases where it is known that packages conflict
7953: with each other. These <code class="varname">CONFLICTS</code> entries are
1.259 leot 7954: exported in <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.142 leot 7955: managers to inform users that packages cannot be installed onto
7956: the target system.</p>
1.1 dsieger 7957: </div>
1.41 asau 7958: <div class="sect2">
1.1 dsieger 7959: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7960: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7961: <p>There are several reasons why a package might be
7962: instructed to not build under certain circumstances. If the
7963: package builds and runs on most platforms, the exceptions
1.83 dholland 7964: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7965: the package builds and runs on a small handful of platforms,
7966: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7967: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7968: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7969: (OS-version-platform) that can use glob-style
7970: wildcards.</p>
7971: <p>If a package is not appropriate for some platforms (as
1.114 maya 7972: opposed to merely broken), a different set of variables should be
1.83 dholland 7973: used as this affects failure reporting and statistics.
7974: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7975: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7976: the package is appropriate for only a small handful of platforms
7977: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7978: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7979: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7980: (OS-version-platform) that can use glob-style
7981: wildcards.</p>
7982: <p>Some packages are tightly bound to a specific version of an
1.207 leot 7983: 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.1 dsieger 7984: backwards compatible with other versions of the OS, and should be
7985: uploaded to a version specific directory on the FTP server. Mark
7986: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.266 martin 7987: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7988: the package system internals, but may be used in the
7989: future.</p>
7990: <p>If the package should be skipped (for example, because it
7991: provides functionality already provided by the system), set
7992: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7993: the package should fail because some preconditions are not met,
7994: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7995: message.</p>
7996: </div>
1.41 asau 7997: <div class="sect2">
1.1 dsieger 7998: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 7999: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 8000: <p>To ensure that a package may not be deleted, once it has been
8001: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8002: be set in the package Makefile. This will be carried into any
8003: binary package that is made from this pkgsrc entry. A
1.266 martin 8004: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.259 leot 8005: not be deleted using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.266 martin 8006: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 8007: </div>
1.41 asau 8008: <div class="sect2">
1.1 dsieger 8009: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8010: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 8011: <p>When a vulnerability is found, this should be noted in
1.247 wiz 8012: <code class="filename">pkgsrc/doc/pkg-vulnerabilities</code>.
1.205 wiz 8013: Entries in that file consist of three parts:</p>
8014: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8015: <li class="listitem"><p>package version pattern</p></li>
8016: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
8017: <li class="listitem"><p>URL providing additional information about the issue</p></li>
8018: </ul></div>
8019: <p>For the package version pattern please always use `<' to
8020: mark an upper bound (not `<='!). This will avoid possible
8021: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
8022: related to security fixes. Lower bounds can be added too, using
8023: '>' or '>='. For example,
1.266 martin 8024: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.205 wiz 8025: versions 1.0 (included) to 1.2 (excluded) of
1.266 martin 8026: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
1.205 wiz 8027: issue.</p>
8028: <p>Entries should always be added at the bottom of the file.</p>
8029: <p>When fixing packages, please modify the upper bound of the
8030: corresponding entry. To continue the previous example, if a fix
8031: was backported to version 1.1nb2, change the previous pattern to
1.266 martin 8032: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.205 wiz 8033: <p>To locally test a package version pattern against a
8034: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
8035: pmatch</strong></span> command.</p>
8036: <p>The URL should be as permanent as possible and provide as
8037: much information about the issue as possible. CVE entries are
8038: preferred.</p>
8039: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.31 wiz 8040: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 8041: <p>After fixing the vulnerability by a patch, its
1.31 wiz 8042: <code class="varname">PKGREVISION</code> should be increased (this is of
8043: course not necessary if the problem is fixed by using a newer
8044: release of the software), and the pattern in the
8045: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 8046: <p>Also, if the fix should be applied to the stable pkgsrc
8047: branch, be sure to submit a pullup request!</p>
8048: <p>Binary packages already on ftp.NetBSD.org will be handled
8049: semi-automatically by a weekly cron job.</p>
1.205 wiz 8050: <p>In case a security issue is disputed, please contact
8051: pkgsrc-security@NetBSD.org.</p>
1.1 dsieger 8052: </div>
1.41 asau 8053: <div class="sect2">
1.1 dsieger 8054: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8055: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1 dsieger 8056: <p>When making fixes to an existing package it can be useful
8057: to change the version number in <code class="varname">PKGNAME</code>. To
8058: avoid conflicting with future versions by the original author, a
1.266 martin 8059: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.1 dsieger 8060: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.266 martin 8061: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
8062: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 8063: <pre class="programlisting">
8064: DISTNAME= foo-17.42
8065: PKGREVISION= 9
1.111 sevan 8066: </pre>
1.1 dsieger 8067: <p>will result in a <code class="varname">PKGNAME</code> of
1.266 martin 8068: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
8069: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 8070: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8071: <code class="varname">PKGNAME_NOREV</code>.</p>
8072: <p>When a new release of the package is released, the
8073: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8074: minor release of the above package, things should be like:</p>
8075: <pre class="programlisting">
8076: DISTNAME= foo-17.43
1.111 sevan 8077: </pre>
1.1 dsieger 8078: <p><code class="varname">PKGREVISION</code> should be incremented for any
8079: non-trivial change in the resulting binary package. Without a
8080: <code class="varname">PKGREVISION</code> bump, someone with the previous
8081: version installed has no way of knowing that their package is out
8082: of date. Thus, changes without increasing
8083: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8084: trivial that no reasonable person would want to upgrade", and this
8085: is the rough test for when increasing
8086: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8087: changes that do not merit increasing
8088: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 8089: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8090: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169 rillig 8091: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
8092: comments in Makefile.</p></li>
8093: <li class="listitem"><p>Changing build variables if the resulting binary
8094: package is the same.</p></li>
8095: <li class="listitem"><p>Changing
8096: <code class="filename">DESCR</code>.</p></li>
8097: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
8098: default options don't change.</p></li>
1.1 dsieger 8099: </ul></div>
8100: <p>Examples of changes that do merit an increase to
8101: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 8102: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 8103: <li class="listitem"><p>Security fixes</p></li>
8104: <li class="listitem"><p>Changes or additions to a patch
8105: file</p></li>
8106: <li class="listitem"><p>Changes to the
8107: <code class="filename">PLIST</code></p></li>
8108: <li class="listitem"><p>A dependency is changed or
8109: renamed.</p></li>
1.1 dsieger 8110: </ul></div>
8111: <p>PKGREVISION must also be incremented when dependencies have ABI
8112: changes.</p>
8113: </div>
1.41 asau 8114: <div class="sect2">
1.1 dsieger 8115: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8116: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.180 rillig 8117: <p>When you want to replace the same text in multiple files, or
8118: multiple times in the same file, it is cumbersome to maintain a patch
8119: file for this. This is where the SUBST framework steps in. It provides an
8120: easy-to-use interface for replacing text in files. It just needs the
8121: following information:</p>
8122: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8123: <li class="listitem"><p>In which phase of the package build cycle should the
8124: replacement happen?</p></li>
8125: <li class="listitem"><p>In which files should the replacement
1.172 rillig 8126: happen?</p></li>
1.180 rillig 8127: <li class="listitem"><p>Which text should be replaced with
8128: what?</p></li>
1.172 rillig 8129: </ul></div>
8130: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.180 rillig 8131: variables. A minimal example is:</p>
8132: <pre class="programlisting">
8133: SUBST_CLASSES+= paths
8134: SUBST_STAGE.paths= pre-configure
8135: SUBST_FILES.paths= src/*.c
8136: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
8137: </pre>
8138: <p>Translated into English, it means: In the pre-configure stage (that
8139: is, after applying the patches from the patches/ directory and before
8140: running the configure script and the portability check), replace the text
8141: <code class="literal">/usr/local</code> with the content of the variable
8142: <code class="varname">PREFIX</code>.</p>
8143: <p>Each SUBST block starts by appending an identifier to
8144: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
8145: identifier can be chosen freely by the package. If there should ever be
8146: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
8147: early, so don't worry about name collisions.</p>
8148: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
8149: SUBST block are parameterized using this identifier. In the remainder of
8150: this section, these parameterized variables are written as
8151: <code class="varname">SUBST_STAGE.*</code>.</p>
8152: <pre class="programlisting">
8153: SUBST_CLASSES+= paths
8154: SUBST_STAGE.paths= pre-configure
8155: SUBST_MESSAGE.paths= Fixing absolute paths.
8156: SUBST_FILES.paths= src/*.c
8157: SUBST_FILES.paths+= scripts/*.sh
8158: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
8159: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8160: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
8161: </pre>
8162: <p>To get a complete picture about the SUBST substitutions, run
8163: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
8164: expected, run pkglint on the package, which detects several typical
8165: mistakes surrounding the SUBST blocks. For any questions that might
8166: remain after this, have a look at
8167: <code class="filename">mk/subst.mk</code>.</p>
8168: <div class="sect3">
8169: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8170: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
1.180 rillig 8171: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
8172: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
8173: <code class="literal">pre-configure</code> is used most often, by far. The most
8174: popular stages are, in chronological order:</p>
8175: <div class="variablelist"><dl class="variablelist">
8176: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
8177: <dd>
8178: <p>The substitutions are applied immediately after the
8179: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
8180: package will leave no traces of the original files.</p>
8181: <p>When the substitution applies to files for which there is also a
8182: patch in the <code class="filename">patches/</code> directory, this means that the
8183: patches will be computed based on the result of the substitution. When
8184: these patches are sent to the upstream maintainer later, to be fixed in
8185: the upstream package, these patches may no longer match what the upstream
8186: author is used to. Because of this, <code class="literal">pre-configure</code> is
8187: often a better choice.</p>
8188: </dd>
8189: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
8190: <dd>
8191: <p>The substitutions are applied after the patches from the
8192: <code class="filename">patches/</code> directory. This makes it possible to run
8193: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.207 leot 8194: 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.180 rillig 8195: <p>When updating the patches, it is helpful to explicitly separate the
8196: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
8197: configure</strong></span>, and to only edit the patches between these commands.
8198: Otherwise the substitutions from the SUBST block will end up in the patch
8199: file. When this happens in really obvious ways, pkglint will complain
8200: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
8201: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
8202: can only detect these really obvious
8203: cases.</p>
8204: </dd>
8205: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
8206: <dd><p>This stage should only be used if the package defines a
8207: <code class="literal">pre-configure</code> action itself, and the substitution must
8208: happen after that. Typical examples are packages that use the
8209: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
8210: script from
8211: <code class="filename">configure.ac</code>.</p></dd>
8212: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
8213: <dd><p>This stage is used to fix up any mistakes by the
8214: configure stage.</p></dd>
8215: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
8216: <dd><p>This stage should only be used for substitutions that are
8217: clearly related to building the package, not for fixing the
8218: configuration. Substitutions for pathnames (such as replacing
8219: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
8220: user names (such as replacing <code class="literal">@MY_USER@</code> with the
8221: actual username) belong in pre-configure or post-configure
8222: instead.</p></dd>
8223: <dt><span class="term"><code class="literal">post-build</code></span></dt>
8224: <dd>
8225: <p>Just as with pre-build, this stage should only be used
8226: for substitutions that are clearly related to building the package, not
8227: for fixing the configuration. Substitutions for pathnames (such as
8228: replacing <code class="filename">/usr/local</code> with
8229: <code class="literal">${PREFIX}</code>) or user names (such as replacing
8230: <code class="literal">@MY_USER@</code> with the actual username) belong in
8231: pre-configure or post-configure instead.</p>
8232: <p>A typical use is to update pkg-config files to include the rpath
8233: compiler options.</p>
8234: </dd>
8235: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8236: <dd><p>In general, the install phase should be as simple as
8237: possible. As with the pre-build and post-build stages, it should not be
8238: used to fix pathnames or user names, these belong in pre-configure
8239: instead. There are only few legitimate use cases for applying
8240: substitutions in this stage.</p></dd>
8241: </dl></div>
8242: </div>
8243: <div class="sect3">
8244: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8245: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.180 rillig 8246: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8247: filename patterns. These patterns are relative to
8248: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8249: A typical example is:</p>
8250: <pre class="programlisting">
8251: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8252: </pre>
8253: <p>The above patterns, especially the last, are quite broad. The SUBST
8254: implementation checks that each filename pattern that is mentioned here
8255: has an effect. For example, if none of the
8256: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8257: and substituted, that filename pattern is redundant and should be left
1.181 rillig 8258: out. By default, the SUBST framework will complain with an error message.
8259: If the text to be substituted occurs in some of the files from a single
8260: pattern, but not in all of them, that is totally ok, and the SUBST
1.180 rillig 8261: framework will only print an INFO message for those files.</p>
8262: <p>If there is a good reason for having redundant filename patterns,
1.181 rillig 8263: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.180 rillig 8264: <p>Another popular way of choosing the files for the substitutions is
8265: via a shell command, like this:</p>
8266: <pre class="programlisting">
1.181 rillig 8267: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 8268: SUBST_FILES.path= ${C_FILES_CMD:sh}
8269: </pre>
8270: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8271: freely chosen and independent of the SUBST framework.</p>
8272: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8273: lists each file individually. Thereby chances are higher that there are
8274: filename patterns in which no substitution happens. Since the SUBST
8275: framework cannot know whether the filename patterns in
8276: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8277: Makefile (where any redundant filename pattern would be suspicious) or
8278: been generated by a shell command (in which redundant filename patterns
8279: are more likely and to be expected), it will complain about these
8280: redundant filename patterns. Therefore, SUBST blocks that use a shell
8281: command to generate the list of filename patterns often need to set
8282: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8283: </div>
8284: <div class="sect3">
8285: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8286: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
1.180 rillig 8287: <p>In most cases, the substitutions are given using one or more
1.259 leot 8288: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.180 rillig 8289: <pre class="programlisting">
8290: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8291: </pre>
8292: <p>Each of the sed commands needs to be preceded by the
8293: <code class="literal">-e</code> option and should be specified on a line of its
8294: own, to avoid hiding short sed commands at the end of a line.</p>
8295: <p>Since the sed commands often contain shell metacharacters as the
8296: separator (the <code class="literal">|</code> in the above example), it is common
8297: to enclose them in single quotes.</p>
8298: <p>A common substitution is to replace placeholders of the form
8299: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8300: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8301: <pre class="programlisting">
8302: SUBST_VARS.path= PREFIX
8303: </pre>
8304: <p>This type of substitutions is typically done by the GNU configure
1.181 rillig 8305: scripts during the do-configure stage, but in some cases these need to be
8306: overridden. The same pattern is also used when a package defines patches
8307: that replace previously hard-coded paths like
8308: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8309: placeholder first, which then gets substituted by the actual
8310: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8311: cases, it works equally well to just use the SUBST framework to directly
8312: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8313: thereby omitting the intermediate patch file.</p>
1.180 rillig 8314: <p>If the above is not flexible enough, it is possible to not use sed
8315: at all for the substitution but to specify an entirely different command,
8316: like this:</p>
1.1 dsieger 8317: <pre class="programlisting">
1.180 rillig 8318: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8319: </pre>
8320: <p>This is used for the few remaining packages in which the
8321: distributed files use Windows-style line endings that need to be
8322: converted to UNIX-style line endings.</p>
8323: </div>
8324: <div class="sect3">
8325: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8326: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
1.180 rillig 8327: <p>When a SUBST block is applied during a package build, a message is
8328: logged. The default message is fine for most purposes but can be
8329: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8330: message.</p>
8331: </div>
1.1 dsieger 8332: </div>
8333: </div>
1.41 asau 8334: <div class="sect1">
1.1 dsieger 8335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 8336: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 8337: <div class="sect2">
1.1 dsieger 8338: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8339: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1 dsieger 8340: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8341: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8342: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8343: with the name of each file to download as an argument, expecting
8344: it to output the URL of the directory from which to download
1.207 leot 8345: 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.1 dsieger 8346: example of this usage.</p>
8347: <p>If the download can't be automated, because the user must
8348: submit personal information to apply for a password, or must pay
8349: for the source, or whatever, you can set
8350: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8351: displayed to the user before aborting the build. Example:</p>
8352: <pre class="programlisting">
8353: FETCH_MESSAGE= "Please download the files"
8354: FETCH_MESSAGE+= " "${DISTFILES:Q}
8355: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 8356: </pre>
1.1 dsieger 8357: </div>
1.41 asau 8358: <div class="sect2">
1.1 dsieger 8359: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8360: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1 dsieger 8361: <p>Sometimes authors of a software package make some
8362: modifications after the software was released, and they put up a
8363: new distfile without changing the package's version number. If a
8364: package is already in pkgsrc at that time, the checksum will
8365: no longer match. The contents of the new distfile should be
8366: compared against the old one before changing anything, to make
8367: sure the distfile was really updated on purpose, and that
8368: no trojan horse or so crept in.
8369: Please mention that the distfiles were compared and what was found
1.53 rodent 8370: in your commit message.</p>
1.109 wiz 8371: <p>Then, the correct way to work around this is to set
8372: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8373: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8374: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8375: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 8376: <code class="varname">PATCHFILES</code> for this package will be put in that
1.266 martin 8377: subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="21.1.10. How to handle incrementing versions when fixing an existing package">Section 21.1.10, “How to handle incrementing versions when fixing an existing package”</a> for more details.) In case this
1.1 dsieger 8378: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 8379: including the <code class="filename">nbX</code> suffix) or a date stamp can
8380: be appended, like
8381: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169 rillig 8382: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8383: name does not contain a version and the distfile is apt to change. In
8384: cases where the likelihood of this is very small,
8385: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8386: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8387: distfile name changes, even if a package is being moved or
8388: renamed.</p>
1.53 rodent 8389: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8390: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8391: path in the filenames.
1.53 rodent 8392: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8393: Furthermore, a mail to the package's authors seems appropriate
8394: telling them that changing distfiles after releases without
8395: changing the file names is not good practice.</p>
8396: </div>
1.88 tnn 8397: <div class="sect2">
8398: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8399: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169 rillig 8400: <p>Helper methods exist for packages hosted on github.com which
8401: will often have distfile names that clash with other packages, for
8402: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8403: from below:</p>
1.88 tnn 8404: <div class="sect3">
8405: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8406: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169 rillig 8407: <p>If your distfile URL looks similar to
1.189 bacon 8408: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.169 rillig 8409: then you are packaging a tagged release.</p>
1.88 tnn 8410: <pre class="programlisting">
1.189 bacon 8411: DISTNAME= example-1.0
1.90 tnn 8412: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8413: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8414: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 8415: EXTRACT_SUFX= .zip
8416: </pre>
1.230 gutterid 8417: <p>Here, DISTNAME combined with use of GITHUB_TAG leads the
8418: file fetching infrastructure to save the resulting file locally as
8419: <code class="literal">example-1.0.zip</code>.</p>
1.88 tnn 8420: </div>
8421: <div class="sect3">
8422: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8423: <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>
1.189 bacon 8424: <p>If your distfile looks similar to
8425: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8426: release, then set the package version to 0.0.0.N, where N is the number
8427: of commits to the repository, and set GITHUB_TAG to the commit hash.
8428: This will (almost) ensure that the first tagged release will have a
8429: version greater than this one so that package upgrades will function
8430: properly.</p>
8431: <pre class="programlisting">
8432: DISTNAME= example-0.0.0.347
8433: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8434: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8435: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8436: </pre>
8437: </div>
8438: <div class="sect3">
8439: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8440: <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>
1.189 bacon 8441: <p>If your distfile looks similar to
8442: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8443: then include the last release version and the commit count since that
8444: release in the package version and set GITHUB_TAG to the commit hash.
8445: The latest release and commit count are shown in the output of
8446: "git describe --tags":
8447: </p>
8448: <pre class="screen">
8449: # git clone https://github.com/username/example
8450: # cd example
8451: # git describe --tags
8452: 1.2.3-5-g988881a
8453: </pre>
1.88 tnn 8454: <pre class="programlisting">
1.189 bacon 8455: DISTNAME= example-1.2.3.5
8456: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8457: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8458: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 8459: </pre>
1.88 tnn 8460: </div>
8461: <div class="sect3">
8462: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8463: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.169 rillig 8464: <p>If your distfile URL looks similar to
1.189 bacon 8465: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.169 rillig 8466: then you are packaging a release.</p>
1.88 tnn 8467: <pre class="programlisting">
8468: DISTNAME= offensive-1.6
1.90 tnn 8469: PKGNAME= ${DISTNAME:S/offensive/proper/}
8470: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8471: GITHUB_PROJECT= example
1.90 tnn 8472: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8473: EXTRACT_SUFX= .zip
1.111 sevan 8474: </pre>
1.88 tnn 8475: </div>
8476: </div>
1.1 dsieger 8477: </div>
1.41 asau 8478: <div class="sect1">
1.1 dsieger 8479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 8480: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8481: <div class="sect2">
1.1 dsieger 8482: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8483: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8484: <p>pkgsrc supports many different machines, with different
8485: object formats like a.out and ELF, and varying abilities to do
8486: shared library and dynamic loading at all. To accompany this,
8487: varying commands and options have to be passed to the
8488: compiler, linker, etc. to get the Right Thing, which can be
8489: pretty annoying especially if you don't have all the machines
8490: at your hand to test things. The
1.207 leot 8491: <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.266 martin 8492: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8493: both static and dynamic libraries from a set of source files,
8494: thus being platform-independent.</p>
8495: <p>Here's how to use libtool in a package in seven simple
8496: steps:</p>
1.23 wiz 8497: <div class="orderedlist"><ol class="orderedlist" type="1">
8498: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8499: Makefile.</p></li>
1.266 martin 8500: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8501: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8502: add it to the definition of <code class="varname">CC</code>, if only
8503: libraries are being built in a given Makefile. This one command
8504: will build both PIC and non-PIC library objects, so you need not
8505: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8506: <li class="listitem">
1.1 dsieger 8507: <p>For the linking of the library, remove any
1.266 martin 8508: <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
8509: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8510: <pre class="programlisting">
8511: ${LIBTOOL} --mode=link \
8512: ${CC} -o ${.TARGET:.a=.la} \
8513: ${OBJS:.o=.lo} \
8514: -rpath ${PREFIX}/lib \
8515: -version-info major:minor
1.111 sevan 8516: </pre>
1.1 dsieger 8517: <p>Note that the library is changed to have a
8518: <code class="filename">.la</code> extension, and the objects are
8519: changed to have a <code class="filename">.lo</code>
8520: extension. Change <code class="varname">OBJS</code> as
8521: necessary. This automatically creates all of the
8522: <code class="filename">.a</code>,
8523: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8524: necessary) in the build directory. Be sure to include
1.266 martin 8525: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8526: minor are zero, as libtool will otherwise strip off the
8527: shared library version.</p>
8528: <p>From the libtool manual:</p>
8529: <pre class="programlisting">
8530: So, libtool library versions are described by three integers:
8531:
8532: CURRENT
8533: The most recent interface number that this library implements.
8534:
8535: REVISION
8536: The implementation number of the CURRENT interface.
8537:
8538: AGE
8539: The difference between the newest and oldest interfaces that
8540: this library implements. In other words, the library implements
8541: all the interface numbers in the range from number `CURRENT -
8542: AGE' to `CURRENT'.
8543:
8544: If two libraries have identical CURRENT and AGE numbers, then the
8545: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 8546: </pre>
1.266 martin 8547: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8548: different results for a.out and ELF (excluding symlinks)
8549: in only one case. An ELF library of the form
1.266 martin 8550: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8551: will have a symlink of
1.266 martin 8552: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8553: on an a.out platform. This is handled
8554: automatically.</p>
1.266 martin 8555: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8556: directory of the library being built.</p>
8557: <p>In the <code class="filename">PLIST</code>, include only the
8558: <code class="filename">.la</code> file, the other files will be
8559: added automatically.</p>
8560: </li>
1.23 wiz 8561: <li class="listitem">
1.1 dsieger 8562: <p>When linking shared object (<code class="filename">.so</code>)
1.259 leot 8563: files, i.e. files that are loaded via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.266 martin 8564: shared libraries, use <span class="quote">“<span class="quote">-module
8565: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8566: tacked on.</p>
8567: <p>The <code class="filename">PLIST</code> file gets the
8568: <code class="filename">foo.so</code> entry.</p>
8569: </li>
1.23 wiz 8570: <li class="listitem">
1.1 dsieger 8571: <p>When linking programs that depend on these libraries
8572: <span class="emphasis"><em>before</em></span> they are installed, preface
1.266 martin 8573: the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/ld.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
8574: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8575: libraries (static or shared), but please be aware that
8576: libtool will not allow you to specify a relative path in
1.266 martin 8577: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8578: expects you to change that argument to be the
8579: <code class="filename">.la</code> file. e.g.</p>
8580: <pre class="programlisting">
8581: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 8582: </pre>
1.1 dsieger 8583: <p>should be changed to:</p>
8584: <pre class="programlisting">
8585: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 8586: </pre>
1.1 dsieger 8587: <p>and it will do the right thing with the libraries.</p>
8588: </li>
1.23 wiz 8589: <li class="listitem">
1.259 leot 8590: <p>When installing libraries, preface the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
1.266 martin 8591: or <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/cp.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
8592: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8593: <code class="filename">.la</code>. e.g.</p>
8594: <pre class="programlisting">
1.22 jakllsch 8595: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 8596: </pre>
1.1 dsieger 8597: <p>This will install the static <code class="filename">.a</code>,
8598: shared library, any needed symlinks, and run
1.259 leot 8599: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 8600: </li>
1.23 wiz 8601: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8602: the <code class="filename">.la</code>
8603: file (this is a change from previous behaviour).</p></li>
8604: </ol></div>
8605: </div>
1.41 asau 8606: <div class="sect2">
1.1 dsieger 8607: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8608: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8609: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8610: package Makefile. This will override the package's own libtool
8611: in most cases. For older libtool using packages, libtool is
8612: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8613: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8614: configure; find work*/ -name libtool</strong></span>.</p>
8615: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8616: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.266 martin 8617: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8618: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8619: package's libtool script(s), set it as appropriate.</p>
8620: <p>If you do not need <code class="filename">*.a</code> static
8621: libraries built and installed, then use
8622: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8623: <p>If your package makes use of the platform-independent library
8624: for loading dynamic shared objects, that comes with libtool
8625: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8626: <p>Some packages use libtool incorrectly so that the package
8627: may not work or build in some circumstances. Some of the more
8628: common errors are:</p>
1.41 asau 8629: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8630: <li class="listitem">
1.1 dsieger 8631: <p>The inclusion of a shared object (-module) as a dependent library in an
8632: executable or library. This in itself isn't a problem if one of two things
8633: has been done:</p>
1.23 wiz 8634: <div class="orderedlist"><ol class="orderedlist" type="1">
8635: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8636: <code class="filename">libfoo.la</code>, not
8637: <code class="filename">foo.la</code></p></li>
1.23 wiz 8638: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8639: </ol></div>
8640: </li>
1.23 wiz 8641: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8642: The function lt_dlinit() should be called and the macro
8643: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8644: executables.</p></li>
8645: </ul></div>
8646: </div>
1.41 asau 8647: <div class="sect2">
1.1 dsieger 8648: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8649: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8650: <p>If a package needs GNU autoconf or automake to be executed
1.223 nia 8651: to regenerate the
8652: <code class="filename">configure</code>
8653: script and <code class="filename">Makefile.in</code> makefile
8654: templates from <code class="filename">configure.ac</code> and
8655: <code class="filename">Makefile.am</code>,
8656: then they should be executed in a pre-configure target:</p>
1.1 dsieger 8657: <pre class="programlisting">
1.223 nia 8658: USE_TOOLS+= autoconf automake autoreconf
8659: GNU_CONFIGURE= yes
1.1 dsieger 8660: ...
8661:
8662: pre-configure:
1.223 nia 8663: set -e; cd ${WRKSRC} && autoreconf -fi
1.1 dsieger 8664: ...
1.111 sevan 8665: </pre>
1.223 nia 8666: <p>Packages which use GNU Automake will sometimes
8667: require GNU Make (<code class="literal">gmake</code> in
8668: <code class="varname">USE_TOOLS</code>),
8669: but not always. Note that autoreconf
8670: only needs to be executed if <code class="filename">configure.ac</code>
8671: or Makefiles are modified, or <code class="filename">configure</code>
8672: is not present.</p>
1.1 dsieger 8673: <p>There are times when the configure process makes
8674: additional changes to the generated files, which then causes
8675: the build process to try to re-execute the automake sequence.
8676: This is prevented by touching various files in the configure
8677: stage. If this causes problems with your package you can set
8678: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8679: Makefile.</p>
8680: </div>
1.223 nia 8681: <div class="sect2">
8682: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8683: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
1.223 nia 8684: <p>Packages using Meson to configure need to include:
8685:
8686: </p>
8687: <pre class="programlisting">
8688: .include "../../devel/meson/build.mk"
8689: </pre>
8690: <p>In nearly all cases (any program with dependencies),
8691: pkg-config needs to be added to
8692: <code class="varname">USE_TOOLS</code>. If the package installs
8693: translation files for non-English languages, also
8694: add msgfmt and xgettext:
8695:
8696: </p>
8697: <pre class="programlisting">
8698: USE_TOOLS+= pkg-config msgfmt xgettext
8699: </pre>
8700: <p>If any options need to be passed to Meson, use
8701: <code class="varname">MESON_ARGS</code> instead of
8702: <code class="varname">CONFIGURE_ARGS</code>:
8703:
8704: </p>
8705: <pre class="programlisting">
8706: MESON_ARGS+= -Dx11=false
8707: </pre>
8708: </div>
1.260 wiz 8709: <div class="sect2">
8710: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8711: <a name="endian"></a>21.3.5. Determining the endianness</h3></div></div></div>
1.260 wiz 8712: <p>To determine the endianness of the target platform,
8713: have a look at <code class="filename">mk/endian.mk</code>.</p>
8714: </div>
1.1 dsieger 8715: </div>
1.41 asau 8716: <div class="sect1">
1.1 dsieger 8717: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 8718: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41 asau 8719: <div class="sect2">
1.1 dsieger 8720: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8721: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.244 gutterid 8722: <p>Compilers for the C and C++ languages come with
1.1 dsieger 8723: the NetBSD base system. By default, pkgsrc assumes that a package
8724: is written in C and will hide all other compilers (via the wrapper
1.266 martin 8725: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.243 gutterid 8726: <p>To declare which languages should be made available through
8727: pkgsrc's compiler wrappers, use
1.1 dsieger 8728: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.212 wiz 8729: currently are:
1.238 wiz 8730: </p>
1.212 wiz 8731: <pre class="programlisting">
1.244 gutterid 8732: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.238 wiz 8733: </pre>
1.212 wiz 8734: <p>
8735: (and any combination). The default is
1.266 martin 8736: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8737: written in C++, usually need a C compiler for the configure
1.244 gutterid 8738: phase.</p>
1.250 jnemeth 8739: <p>To declare which features a package requires from the
1.243 gutterid 8740: compiler, set either <code class="varname">USE_CC_FEATURES</code>
8741: or <code class="varname">USE_CXX_FEATURES</code>. Allowed values for
8742: <code class="varname">USE_CC_FEATURES</code> are currently:
8743: </p>
8744: <pre class="programlisting">
8745: c11, c99, has_include
8746: </pre>
8747: <p>
8748: Allowed values for <code class="varname">USE_CXX_FEATURES</code> are
8749: currently:
8750: </p>
8751: <pre class="programlisting">
8752: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
8753: charconv, parallelism_ts, unique_ptr, put_time,
8754: is_trivially_copy_constructible
8755: </pre>
8756: <p>
1.251 gutterid 8757: Note at present these variables only affect use of GCC, not other
8758: compilers.
1.243 gutterid 8759: </p>
1.244 gutterid 8760: <p>Language variants like <code class="literal">gnu99</code> and
8761: <code class="literal">c++11</code> can be specified in <code class="varname">FORCE_C_STD</code>
8762: and <code class="varname">FORCE_CXX_STD</code> if the package does not explicitly set
8763: <code class="literal">-std=...</code> when compiling (i.e. the package
8764: assumes the compiler defaults to C++11 or some other standard).
8765: This is a common bug in upstream build systems.</p>
8766: <p>Allowed values for <code class="varname">FORCE_C_STD</code> are
8767: currently:
8768: </p>
8769: <pre class="programlisting">
8770: c90, c99, c11, gnu90, gnu99, gnu11
8771: </pre>
8772: <p>
8773: </p>
8774: <p>Allowed values for <code class="varname">FORCE_CXX_STD</code> are
8775: currently:
8776: </p>
8777: <pre class="programlisting">
8778: c++03, c++11, c++14, c++17, c++20,
8779: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
8780: </pre>
8781: <p>
1.251 gutterid 8782: Note at present these variables only affect use of GCC and Clang.
1.244 gutterid 8783: </p>
1.1 dsieger 8784: </div>
1.41 asau 8785: <div class="sect2">
1.1 dsieger 8786: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8787: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 8788: <p>If a program is written in Java, use the Java framework in
8789: pkgsrc. The package must include
8790: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8791: provides the following variables:</p>
1.41 asau 8792: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8793: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8794: dependency on the JDK is added. If
1.266 martin 8795: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8796: there is only a runtime dependency on the JDK. The default is
1.266 martin 8797: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8798: JDK.</p></li>
1.23 wiz 8799: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8800: a package needs a Java2 implementation. The supported values
1.266 martin 8801: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8802: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8803: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8804: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8805: above. This variable is not set by default.</p></li>
1.24 wiz 8806: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8807: automatically set to the runtime location of the used Java
8808: implementation dependency. It may be used to set
8809: <code class="varname">JAVA_HOME</code> to a good value if the program
8810: needs this variable to be defined.
8811: </p></li>
1.1 dsieger 8812: </ul></div>
8813: </div>
1.41 asau 8814: <div class="sect2">
1.1 dsieger 8815: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8816: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
1.205 wiz 8817: <p>If a program is written in Go and has any dependencies on
8818: other Go modules, have the package include
8819: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8820: <div class="orderedlist"><ol class="orderedlist" type="1">
8821: <li class="listitem"><p>Generate a list of those dependencies with
8822: <span class="command"><strong>make clean && make patch && make show-go-modules >
8823: go-modules.mk</strong></span>.</p></li>
1.223 nia 8824: <li class="listitem"><p>Prepend
8825: <code class="literal">.include "go-modules.mk"</code> to any other
8826: <code class="literal">.include</code>s.</p></li>
8827: <li class="listitem"><p>Incorporate these modules in
8828: <code class="filename">distinfo</code> with <span class="command"><strong>make
8829: makesum</strong></span>.</p></li>
8830: </ol></div>
8831: </div>
8832: <div class="sect2">
8833: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8834: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
1.223 nia 8835: <p>If a program is written in Rust and uses Cargo to build,
8836: have the package include
8837: <code class="filename">../../lang/rust/cargo.mk</code>.</p>
8838: <div class="orderedlist"><ol class="orderedlist" type="1">
8839: <li class="listitem"><p>Generate a list of those dependencies with
8840: <span class="command"><strong>make CARGO_ARGS="build --release" build &&
8841: make print-cargo-depends > cargo-depends.mk</strong></span>.</p></li>
8842: <li class="listitem"><p>Prepend
8843: <code class="literal">.include "cargo-depends.mk"</code> to any other
8844: <code class="literal">.include</code>s.</p></li>
1.205 wiz 8845: <li class="listitem"><p>Incorporate these modules in
8846: <code class="filename">distinfo</code> with <span class="command"><strong>make
8847: makesum</strong></span>.</p></li>
8848: </ol></div>
8849: </div>
8850: <div class="sect2">
8851: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8852: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.203 nia 8853: <p>If your package contains interpreted Perl scripts, add
1.266 martin 8854: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8855: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8856: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8857: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8858: that you want adjusted. Every occurrence of
8859: <code class="filename">*/bin/perl</code> in a she-bang line will be
1.210 gutterid 8860: replaced with the full path to the Perl executable.</p>
8861: <p>If a particular version of Perl is needed, set the
1.1 dsieger 8862: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.266 martin 8863: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
8864: <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.210 gutterid 8865: about handling Perl modules.</p>
8866: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
8867: for the language now known as Raku.</p>
1.1 dsieger 8868: </div>
1.41 asau 8869: <div class="sect2">
1.1 dsieger 8870: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8871: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 8872: <p><code class="varname">REPLACE_SH</code>,
8873: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8874: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.225 gutterid 8875: she-bangs in files. Please use the appropriate one, preferring
8876: <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.74 wiz 8877: Each should contain a list of scripts, relative to
8878: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8879: occurrence of the matching shell in a she-bang line will be
8880: replaced with the full path to the shell executable.
1.40 wiz 8881: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8882: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8883: </div>
1.41 asau 8884: <div class="sect2">
1.40 wiz 8885: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8886: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.210 gutterid 8887: <p>There are further similar REPLACE variables available, e.g.,
8888: <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
8889: and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.211 gutterid 8890: noted above, have their actions defined centrally in
1.210 gutterid 8891: <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.211 gutterid 8892: languages define the actions of these variables within their own
8893: dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
1.245 gutterid 8894: actioned in <code class="filename">lang/php/replace.mk</code>, and
1.211 gutterid 8895: <code class="varname">REPLACE_PYTHON</code> is actioned in
1.210 gutterid 8896: <code class="filename">lang/python/application.mk</code>. For other languages,
8897: consult the mk files found within their specific directories (the
1.216 gutterid 8898: naming convention varies), or check the list found in
1.266 martin 8899: <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.210 gutterid 8900: <p>Currently, special handling for other languages varies
1.1 dsieger 8901: in pkgsrc. If a compiler package provides a
8902: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8903: just add a (build) dependency on the appropriate compiler
8904: package.</p>
8905: </div>
8906: </div>
1.41 asau 8907: <div class="sect1">
1.1 dsieger 8908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 8909: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8910: <p>The most common failures when building a package are that
8911: some platforms do not provide certain header files, functions or
8912: libraries, or they provide the functions in a library that the
8913: original package author didn't know. To work around this, you
8914: can rewrite the source code in most cases so that it does not
8915: use the missing functions or provides a replacement function.</p>
1.41 asau 8916: <div class="sect2">
1.1 dsieger 8917: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 8918: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8919: <p>If a package already comes with a GNU configure script, the
8920: preferred way to fix the build failure is to change the
8921: configure script, not the code. In the other cases, you can
8922: utilize the C preprocessor, which defines certain macros
8923: depending on the operating system and hardware architecture it
8924: compiles for. These macros can be queried using for example
8925: <code class="varname">#if defined(__i386)</code>. Almost every operating
8926: system, hardware architecture and compiler has its own macro.
8927: For example, if the macros <code class="varname">__GNUC__</code>,
8928: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8929: are all defined, you know that you are using NetBSD on an i386
8930: compatible CPU, and your compiler is GCC.</p>
8931: <p>The list of the following macros for hardware and
8932: operating system depends on the compiler that is used. For
8933: example, if you want to conditionally compile code on Solaris,
8934: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8935: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8936: <div class="sect3">
1.1 dsieger 8937: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8938: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.223 nia 8939: <p>To distinguish between specific NetBSD versions,
8940: you should use the following code.</p>
8941: <pre class="programlisting">
8942: #ifdef __NetBSD__
8943: #include <sys/param.h>
8944: #if __NetBSD_Prereq__(9,99,17)
8945: /* use a newer feature */
8946: #else
8947: /* older code */
8948: #endif
8949: #endif
8950:
8951: #ifndef _WIN32
8952: /* Unix-like specific code */
8953: #endif
8954: </pre>
1.1 dsieger 8955: <p>To distinguish between 4.4 BSD-derived systems and the
8956: rest of the world, you should use the following code.</p>
8957: <pre class="programlisting">
8958: #include <sys/param.h>
8959: #if (defined(BSD) && BSD >= 199306)
8960: /* BSD-specific code goes here */
8961: #else
8962: /* non-BSD-specific code goes here */
8963: #endif
8964: </pre>
1.223 nia 8965: <p>You can also test for the following macros:</p>
1.1 dsieger 8966: <pre class="programlisting">
1.45 obache 8967: Cygwin __CYGWIN__
8968: DragonFly __DragonFly__
1.1 dsieger 8969: FreeBSD __FreeBSD__
1.45 obache 8970: Haiku __HAIKU__
1.1 dsieger 8971: IRIX __sgi (TODO: get a definite source for this)
1.223 nia 8972: Linux __linux
1.83 dholland 8973: Mac OS X __APPLE__
1.45 obache 8974: Minix3 __minix
1.1 dsieger 8975: NetBSD __NetBSD__
8976: OpenBSD __OpenBSD__
8977: Solaris sun, __sun
8978: </pre>
8979: </div>
1.41 asau 8980: <div class="sect3">
1.1 dsieger 8981: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8982: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1 dsieger 8983: <pre class="programlisting">
8984: i386 i386, __i386, __i386__
1.223 nia 8985: x86-64 __amd64__, __x86_64__
8986: ARM __arm__
1.1 dsieger 8987: MIPS __mips
8988: SPARC sparc, __sparc
1.223 nia 8989: PowerPC __powerpc
1.1 dsieger 8990: </pre>
8991: </div>
1.41 asau 8992: <div class="sect3">
1.1 dsieger 8993: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 8994: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1 dsieger 8995: <pre class="programlisting">
8996: GCC __GNUC__ (major version), __GNUC_MINOR__
8997: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8998: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8999: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
9000: </pre>
9001: </div>
9002: </div>
1.41 asau 9003: <div class="sect2">
1.1 dsieger 9004: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9005: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 9006: <p>Some source files trigger bugs in the compiler, based on
9007: combinations of compiler version and architecture and almost
9008: always relation to optimisation being enabled. Common symptoms
9009: are gcc internal errors or never finishing compiling a
9010: file.</p>
9011: <p>Typically, a workaround involves testing the
9012: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
9013: optimisation for that combination of file,
1.87 tnn 9014: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
9015: <p>This used to be a big problem in the past, but is rarely
9016: needed now as compiler technology has matured. If you still need
9017: to add a compiler specific workaround, please do so in the file
9018: <code class="filename">hacks.mk</code> and describe the symptom and
9019: compiler version as detailed as possible.</p>
1.1 dsieger 9020: </div>
1.41 asau 9021: <div class="sect2">
1.1 dsieger 9022: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9023: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
1.172 rillig 9024: <p>Compilation sometimes fails with an error message like this:</p>
9025: <pre class="programlisting">
9026: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
9027: fatal error: pango/pango.h: No such file or directory
9028: </pre>
9029: <p>The proper way to fix this problem depends on the type of the
9030: header, which is described in the following sections.</p>
9031: <div class="sect3">
9032: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9033: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
1.172 rillig 9034: <p>If the header name looks like it comes from a different package,
9035: that other package should be included via the buildlink3
9036: framework.</p>
9037: <p>First, look whether the header is somewhere in the buildlink3
9038: directory below <code class="varname">WRKDIR</code>. In the above case of
9039: the missing Pango header:</p>
9040: <pre class="programlisting">
9041: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
9042: </pre>
9043: <p>In the case of Pango, the output is:</p>
9044: <pre class="programlisting">
9045: work/.buildlink/include/pango-1.0/pango/pango.h
9046: </pre>
9047: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
9048: in the <code class="filename">.buildlink</code> directory, it would have been
9049: found automatically. There is an extra <code class="filename">pango-1.0</code>
9050: path component though, which means that the compiler command line must
9051: contain an option of the form
9052: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
9053: most cases this option is generated by the configure script, which can be examined using:</p>
9054: <pre class="programlisting">
9055: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
9056: -I/usr/pkg/include/pango-1.0
9057: -I/usr/pkg/include/pango-1.0
9058: -I/usr/pkg/include/pango-1.0
9059: -I/usr/pkg/include/pango-1.0
9060: -I/usr/pkg/include/pango-1.0
9061: </pre>
9062: <p>This looks good. These options are transformed by the buildlink
9063: wrapper to refer to the correct path inside
9064: <code class="filename">work/.buildlink</code>.</p>
9065: <p>Since the compilation fails though, examine the compiler command
9066: lines in <code class="filename">work/.work.log</code> to see whether the
9067: <code class="literal">-I</code> option is included in the particular command
9068: line.</p>
9069: <p>To further analyze the situation, run <span class="command"><strong>bmake
9070: build-env</strong></span>, which sets up an interactive, realistic environment
9071: including all the pkgsrc wrapper commands and environment variables. From
9072: there, try to compile some simple example programs that use the
9073: header.</p>
9074: </div>
9075: <div class="sect3">
9076: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9077: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
1.172 rillig 9078: <p>If the name of the header seems to come from the package itself,
9079: and if the build is run with parallel jobs, the package may have some
9080: undeclared dependencies between the <code class="filename">.c</code> and the
9081: <code class="filename">.h</code> files, and a C file is compiled before its
9082: required header is generated.</p>
9083: <p>To see whether the build runs with parallel jobs, run
9084: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
9085: like this:</p>
9086: <pre class="programlisting">
9087: usr MAKE_JOBS= 7
9088: pkg MAKE_JOBS_SAFE # undefined
9089: def _MAKE_JOBS_N= 7
9090: </pre>
9091: <p>In this case the pkgsrc user has asked pkgsrc to build packages
9092: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
9093: package could have disabled parallel builds by setting
9094: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
9095: in this case it hasn't.</p>
9096: <p>To see whether the build failure is caused by parallel builds,
9097: first save the exact error message and a bit of context, maybe you need
9098: it later for reporting a bug. Next, run:</p>
9099: <pre class="programlisting">
9100: MAKE_JOBS_SAFE=no bmake clean build
9101: </pre>
9102: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
9103: report</a> against the pkgsrc package, including the exact error
9104: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
9105: </div>
1.173 rillig 9106: <div class="sect3">
9107: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9108: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
1.173 rillig 9109: <p>Pkgsrc does not work reliably if any of
9110: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
9111: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
9112: bootstrap program prevents installing pkgsrc in symlink-based
9113: directories. Existing pkgsrc installations are not checked for symlinks
9114: though.</p>
9115: <p>The "No such file or directory" error messages are a typical
9116: symptom of symlinks, and it's quite difficult to find out that this is
9117: the actual cause.</p>
9118: </div>
9119: <div class="sect3">
9120: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9121: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
1.173 rillig 9122: <p>When building a hierarchy of packages, it may happen that one
9123: package is built and then pkgsrc is updated. This situation can provoke
9124: various hard to diagnose build errors. To clean up the situation:</p>
9125: <pre class="programlisting">
1.223 nia 9126: <code class="prompt">$</code> (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.173 rillig 9127: </pre>
1.223 nia 9128: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
9129: prevent running this command in the wrong directory.)</p>
1.173 rillig 9130: <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
9131: that directory as well.</p>
9132: </div>
9133: <div class="sect3">
9134: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9135: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
1.173 rillig 9136: <p>On platforms other than BSD, third-party packages are installed in
9137: <code class="filename">/usr/include</code>, together with the base system. This
9138: means that pkgsrc cannot distinguish between headers provided by the base
9139: system (which it needs) and headers from third-party packages (which are
9140: often included in pkgsrc as well). This can lead to subtle version
9141: mismatches.</p>
9142: <p>In pkgsrc installations that have been active for several years, it
9143: may happen that some files are manually deleted. To exclude this unlikely
9144: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
9145: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
9146: check/fix dependencies.</p>
1.266 martin 9147: <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>
1.173 rillig 9148: for contact information. Be prepared to describe what you have tried so
9149: far and what any error messages were.</p>
9150: </div>
1.172 rillig 9151: </div>
9152: <div class="sect2">
9153: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9154: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 9155: </h3></div></div></div>
1.1 dsieger 9156: <p>This error message often means that a package did not
9157: link to a shared library it needs. The following functions are
9158: known to cause this error message over and over.</p>
9159: <div class="informaltable">
1.106 tnn 9160: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 9161: <colgroup>
9162: <col>
9163: <col>
9164: <col>
9165: </colgroup>
9166: <thead><tr>
9167: <th>Function</th>
9168: <th>Library</th>
9169: <th>Affected platforms</th>
9170: </tr></thead>
9171: <tbody>
9172: <tr>
9173: <td>accept, bind, connect</td>
9174: <td>-lsocket</td>
9175: <td>Solaris</td>
9176: </tr>
9177: <tr>
9178: <td>crypt</td>
9179: <td>-lcrypt</td>
9180: <td>DragonFly, NetBSD</td>
9181: </tr>
9182: <tr>
9183: <td>dlopen, dlsym</td>
9184: <td>-ldl</td>
9185: <td>Linux</td>
9186: </tr>
9187: <tr>
9188: <td>gethost*</td>
9189: <td>-lnsl</td>
9190: <td>Solaris</td>
9191: </tr>
9192: <tr>
9193: <td>inet_aton</td>
9194: <td>-lresolv</td>
9195: <td>Solaris</td>
9196: </tr>
9197: <tr>
9198: <td>nanosleep, sem_*, timer_*</td>
9199: <td>-lrt</td>
9200: <td>Solaris</td>
9201: </tr>
9202: <tr>
9203: <td>openpty</td>
9204: <td>-lutil</td>
9205: <td>Linux</td>
9206: </tr>
9207: </tbody>
9208: </table>
9209: </div>
1.223 nia 9210: <p>To fix these linker errors, it is often sufficient to add
1.1 dsieger 9211: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
9212: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.223 nia 9213: <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.1 dsieger 9214: bmake</strong></span>.</p>
1.41 asau 9215: <div class="sect3">
1.1 dsieger 9216: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9217: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.1 dsieger 9218: <p>When you are using the SunPro compiler, there is another
9219: possibility. That compiler cannot handle the following code:</p>
9220: <pre class="programlisting">
9221: extern int extern_func(int);
9222:
9223: static inline int
9224: inline_func(int x)
9225: {
9226: return extern_func(x);
9227: }
9228:
9229: int main(void)
9230: {
9231: return 0;
9232: }
9233: </pre>
9234: <p>It generates the code for <code class="function">inline_func</code> even if
9235: that function is never used. This code then refers to
9236: <code class="function">extern_func</code>, which can usually not be resolved. To
9237: solve this problem you can try to tell the package to disable inlining
9238: of functions.</p>
9239: </div>
1.228 gutterid 9240: <div class="sect3">
9241: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 9242: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
1.228 gutterid 9243: <p>When building for older machine architectures (e.g., i386, PowerPC),
9244: builds may fail because the package expects modern 64-bit atomic functions
9245: which the underlying hardware either doesn't support, or will only support
9246: with specific compiler flags. This is generally handled via inclusion of
9247: mk/atomic64.mk.</p>
9248: </div>
1.1 dsieger 9249: </div>
1.41 asau 9250: <div class="sect2">
1.1 dsieger 9251: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9252: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1 dsieger 9253: <p>Sometimes packages fail to build because the compiler runs
9254: into an operating system specific soft limit. With the
9255: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.223 nia 9256: to unlimit the resources. The allowed values are any combination of
1.266 martin 9257: <span class="quote">“<span class="quote">cputime</span>”</span>,
9258: <span class="quote">“<span class="quote">datasize</span>”</span>,
9259: <span class="quote">“<span class="quote">memorysize</span>”</span>,
9260: <span class="quote">“<span class="quote">stacksize</span>”</span> and
9261: <span class="quote">“<span class="quote">virtualsize</span>”</span>.
1.1 dsieger 9262: Setting this variable is similar to running the shell builtin
1.10 hubertf 9263: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 9264: segment size or maximum stack size of a process, respectively, to
9265: their hard limits.</p>
9266: </div>
9267: </div>
1.41 asau 9268: <div class="sect1">
1.1 dsieger 9269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 9270: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 9271: <div class="sect2">
1.1 dsieger 9272: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9273: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 9274: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 9275: with some operating systems cannot create more than one
9276: directory at a time. As such, you should call
9277: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
9278: <pre class="programlisting">
9279: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
9280: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 9281: </pre>
1.223 nia 9282: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
1.266 martin 9283: directly, you can also append <span class="quote">“<span class="quote"><code class="literal">dir1
9284: dir2</code></span>”</span> to the <code class="varname">INSTALLATION_DIRS</code>
1.223 nia 9285: variable, which will automatically do the right thing.</p>
1.1 dsieger 9286: </div>
1.41 asau 9287: <div class="sect2">
1.1 dsieger 9288: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9289: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 9290: <p>In general, documentation should be installed into
9291: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.223 nia 9292: <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.1 dsieger 9293: includes the version number of the package).</p>
9294: <p>Many modern packages using GNU autoconf allow to set the
9295: directory where HTML documentation is installed with the
1.266 martin 9296: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag is
1.223 nia 9297: needed because otherwise the documentation ends up in
9298: <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
9299: pkgsrc, the HTML documentation should go into the package-specific
9300: directory, just like any other documentation.</p>
1.1 dsieger 9301: <p>An exception to the above is that library API documentation
1.207 leot 9302: 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.1 dsieger 9303: browsers (devhelp) should be left at their default location, which
9304: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
9305: documentation can be recognized from files ending in
9306: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
9307: (It is also acceptable to install such files in
9308: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
9309: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
9310: <code class="filename">.devhelp*</code> file must be directly in that
9311: directory then, no additional subdirectory level is allowed in
9312: this case. This is usually achieved by using
1.266 martin 9313: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 9314: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
9315: though.)</p>
9316: </div>
1.41 asau 9317: <div class="sect2">
1.1 dsieger 9318: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9319: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 9320: <p>Certain packages, most of them in the games category, install
9321: a score file that allows all users on the system to record their
9322: highscores. In order for this to work, the binaries need to be
9323: installed setgid and the score files owned by the appropriate
1.35 wiz 9324: group and/or owner (traditionally the "games" user/group). Set
9325: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 9326: following variables, documented in more detail in
9327: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 9328: behaviour: <code class="varname">GAMEDATAMODE</code>,
9329: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 9330: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
9331: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
9332: <code class="varname">GAMEDATA_PERMS</code> and
9333: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
9334: <p>An example that illustrates some of the variables described above is
9335: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
9336: used to properly set directory permissions of the directory where the
9337: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
9338: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
9339: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
9340: binary:</p>
9341: <pre class="programlisting">
1.112 rillig 9342: USE_GAMESGROUP= yes
1.100 leot 9343:
1.112 rillig 9344: BUILD_DEFS+= VARBASE
1.100 leot 9345:
1.112 rillig 9346: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
9347: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
9348: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 9349: </pre>
1.100 leot 9350: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
9351: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
9352: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
9353: needed to be accessed by setgid games and
9354: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 9355: <p>A package should therefore never hard code file ownership or
1.100 leot 9356: access permissions but rely on <code class="varname">*_PERMS</code> as described above
9357: or alternatively on <code class="varname">INSTALL_GAME</code>,
9358: <code class="varname">INSTALL_GAME_DATA</code> and
9359: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 9360: </div>
1.41 asau 9361: <div class="sect2">
1.1 dsieger 9362: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9363: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 9364: <p><code class="varname">DESTDIR</code> support means that a package
9365: installs into a staging directory, not the final location of the
9366: files. Then a binary package is created which can be used for
9367: installation as usual. There are two ways: Either the package must
1.266 martin 9368: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9369: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 9370: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9371: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.266 martin 9372: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
1.113 leot 9373: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.266 martin 9374: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
1.38 wiz 9375: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 9376: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9377: the inclusion.</p></li>
1.23 wiz 9378: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 9379: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 9380: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 9381: automatically. Many manual rules and pre/post-install often are
9382: incorrect; fix them.</p></li>
1.23 wiz 9383: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 9384: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 9385: <li class="listitem"><p>In general, packages should support
1.4 rillig 9386: <code class="varname">UNPRIVILEGED</code> to be able to use
9387: DESTDIR.</p></li>
9388: </ul></div>
9389: </div>
1.41 asau 9390: <div class="sect2">
1.4 rillig 9391: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9392: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 9393: <p>Your package may also contain scripts with hardcoded paths to
1.203 nia 9394: other interpreters besides (or as well as) Perl. To correct the
1.1 dsieger 9395: full pathname to the script interpreter, you need to set the
9396: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 9397: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 9398: <pre class="programlisting">
9399: REPLACE_INTERPRETER+= tcl
9400: REPLACE.tcl.old= .*/bin/tclsh
9401: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9402: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9403: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 9404: </pre>
1.1 dsieger 9405: </div>
1.41 asau 9406: <div class="sect2">
1.1 dsieger 9407: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9408: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.1 dsieger 9409: <p>Makefiles of packages providing perl5 modules should include
9410: the Makefile fragment
9411: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 9412: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 9413: configuration for such modules as well as various hooks to tune
9414: this configuration. See comments in this file for
9415: details.</p>
9416: <p>Perl5 modules will install into different places depending
9417: on the version of perl used during the build process. To
9418: address this, pkgsrc will append lines to the
9419: <code class="filename">PLIST</code> corresponding to the files listed in
9420: the installed <code class="filename">.packlist</code> file generated by
9421: most perl5 modules. This is invoked by defining
9422: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 9423: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9424: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9425: e.g.:</p>
1.1 dsieger 9426: <pre class="programlisting">
1.47 wiz 9427: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 9428: </pre>
1.47 wiz 9429: <p>The perl5 config variables
9430: <code class="varname">installarchlib</code>,
9431: <code class="varname">installscript</code>,
9432: <code class="varname">installvendorbin</code>,
9433: <code class="varname">installvendorscript</code>,
9434: <code class="varname">installvendorarch</code>,
9435: <code class="varname">installvendorlib</code>,
9436: <code class="varname">installvendorman1dir</code>, and
9437: <code class="varname">installvendorman3dir</code> represent those
9438: locations in which components of perl5 modules may be installed,
9439: provided as variable with uppercase and prefixed with
9440: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9441: and may be used by perl5 packages that don't have a packlist.
9442: These variables are also substituted for in the
9443: <code class="filename">PLIST</code> as uppercase prefixed with
9444: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 9445: </div>
1.41 asau 9446: <div class="sect2">
1.1 dsieger 9447: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9448: <a name="faq.pkg-config-files"></a>21.6.7. Packages installing pkg-config files</h3></div></div></div>
1.254 wiz 9449: <p>Some packages, usually those providing libraries, install
9450: pkg-config files so that their headers and libraries can easily be
9451: found. The file names end with <code class="filename">.pc</code>.</p>
9452: <p>Most of the time, these files only provide the linker flags
9453: for the library, but do not include the flags for setting the
9454: rpath so the libraries can also be found at runtime. Since this is
9455: so common, pkgsrc provides <code class="varname">PKGCONFIG_OVERRIDE</code>
9456: for this. Many packages generate the <code class="filename">.pc</code> from
9457: <code class="filename">.pc.in</code>, in that case add those files to the
9458: <code class="varname">PKGCONFIG_OVERRIDE</code> variable:</p>
9459: <pre class="programlisting">
9460: PKGCONFIG_OVERRIDE+= foo.pc.in
9461: </pre>
9462: <p>For packages using meson, the files are generated during
9463: build and you also need to change the phase in which the
9464: replacement is done. For example:</p>
9465: <pre class="programlisting">
9466: PKGCONFIG_OVERRIDE+= output/meson-private/foo.pc
9467: PKGCONFIG_OVERRIDE_STAGE= post-build
9468: </pre>
9469: </div>
9470: <div class="sect2">
9471: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9472: <a name="faq.info-files"></a>21.6.8. Packages installing info files</h3></div></div></div>
1.1 dsieger 9473: <p>Some packages install info files or use the
1.266 martin 9474: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 9475: commands. <code class="varname">INFO_FILES</code> should be defined in
9476: the package Makefile so that <code class="filename">INSTALL</code> and
9477: <code class="filename">DEINSTALL</code> scripts will be generated to
9478: handle registration of the info files in the Info directory
1.266 martin 9479: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 9480: files registration is either provided by the system, or by a
9481: special purpose package automatically added as dependency if
9482: needed.</p>
9483: <p><code class="varname">PKGINFODIR</code> is the directory under
9484: <code class="filename">${PREFIX}</code> where info files are primarily
9485: located. <code class="varname">PKGINFODIR</code> defaults to
1.266 martin 9486: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 9487: <p>The info files for the package should be listed in the
9488: package <code class="filename">PLIST</code>; however any split info files
9489: need not be listed.</p>
1.266 martin 9490: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9491: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 9492: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.266 martin 9493: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 9494: should be noted with the <code class="varname">TEXINFO_REQD</code>
9495: variable in the package <code class="filename">Makefile</code>. By
9496: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 9497: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 9498: does not match the required minimum, a build dependency on the
1.207 leot 9499: <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.1 dsieger 9500: be added automatically.</p>
9501: <p>The build and installation process of the software provided
9502: by the package should not use the
1.10 hubertf 9503: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 9504: info files is the task of the package
9505: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 9506: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 9507: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 9508: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9509: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 9510: in <code class="varname">PATH</code>.</p>
1.10 hubertf 9511: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 9512: no effect except the logging of a message. The script overriding
1.10 hubertf 9513: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 9514: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 9515: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 9516: </div>
1.41 asau 9517: <div class="sect2">
1.1 dsieger 9518: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9519: <a name="manpages"></a>21.6.9. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9520: <p>All packages that install manual pages should install them
9521: into the same directory, so that there is one common place to look
9522: for them. In pkgsrc, this place is
9523: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9524: should be used in packages. The default for
9525: <code class="varname">PKGMANDIR</code> is
1.266 martin 9526: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9527: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 9528: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9529: <h3 class="title">Note</h3>
9530: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9531: is far from complete.</p>
9532: </div>
9533: <p>The <code class="filename">PLIST</code> files can just use
9534: <code class="filename">man/</code> as the top level directory for the man
9535: page file entries, and the pkgsrc framework will convert as
9536: needed. In all other places, the correct
9537: <code class="varname">PKGMANDIR</code> must be used.</p>
9538: <p>Packages that are
9539: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.266 martin 9540: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 9541: <code class="filename">./configure</code>
9542: --mandir switch to set where the man pages should be installed.
9543: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9544: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9545: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9546: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.266 martin 9547: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 9548: Or if the <code class="filename">./configure</code> script uses
9549: a non-standard use of --mandir, you can set
9550: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.266 martin 9551: <p>See <a class="xref" href="#manpage-compression" title="19.5. Man page compression">Section 19.5, “Man page compression”</a> for
1.1 dsieger 9552: information on installation of compressed manual pages.</p>
9553: </div>
1.41 asau 9554: <div class="sect2">
1.1 dsieger 9555: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9556: <a name="x11-fonts"></a>21.6.10. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9557: <p>If a package installs font files, you will need to rebuild
9558: the fonts database in the directory where they get installed at
9559: installation and deinstallation time. This can be automatically
9560: done by using the pkginstall framework.</p>
9561: <p>You can list the directories where fonts are installed in the
9562: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9563: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.266 martin 9564: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.1 dsieger 9565: Also make sure that the database file
9566: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9567: <p>Note that you should not create new directories for fonts;
9568: instead use the standard ones to avoid that the user needs to
9569: manually configure his X server to find them.</p>
9570: </div>
1.41 asau 9571: <div class="sect2">
1.1 dsieger 9572: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9573: <a name="sgml-xml-data"></a>21.6.11. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9574: <p>If a package installs SGML or XML data files that need to be
9575: registered in system-wide catalogs (like DTDs, sub-catalogs,
9576: etc.), you need to take some extra steps:</p>
1.23 wiz 9577: <div class="orderedlist"><ol class="orderedlist" type="1">
9578: <li class="listitem"><p>Include
1.1 dsieger 9579: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9580: your <code class="filename">Makefile</code>, which takes care of
9581: registering those files in system-wide catalogs at
9582: installation and deinstallation time.</p></li>
1.23 wiz 9583: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9584: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9585: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9586: any XML catalogs installed by the package.</p></li>
1.23 wiz 9587: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9588: to be added to the SGML catalog. These come in groups of
9589: three strings; see xmlcatmgr(1) for more information
9590: (specifically, arguments recognized by the 'add' action).
9591: Note that you will normally not use this variable.</p></li>
1.23 wiz 9592: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9593: to be added to the XML catalog. These come in groups of three
9594: strings; see xmlcatmgr(1) for more information (specifically,
9595: arguments recognized by the 'add' action). Note that you will
9596: normally not use this variable.</p></li>
9597: </ol></div>
9598: </div>
1.41 asau 9599: <div class="sect2">
1.1 dsieger 9600: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9601: <a name="mime-database"></a>21.6.12. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9602: <p>If a package provides extensions to the MIME database by
9603: installing <code class="filename">.xml</code> files inside
9604: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9605: need to take some extra steps to ensure that the database is kept
9606: consistent with respect to these new files:</p>
1.23 wiz 9607: <div class="orderedlist"><ol class="orderedlist" type="1">
9608: <li class="listitem"><p>Include
1.1 dsieger 9609: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9610: (avoid using the <code class="filename">buildlink3.mk</code> file from
9611: this same directory, which is reserved for inclusion from
9612: other <code class="filename">buildlink3.mk</code> files). It takes
9613: care of rebuilding the MIME database at installation and
9614: deinstallation time, and disallows any access to it directly
9615: from the package.</p></li>
1.23 wiz 9616: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9617: <code class="filename">share/mime</code> directory,
9618: <span class="emphasis"><em>except</em></span> for files saved under
9619: <code class="filename">share/mime/packages</code>. The former are
9620: handled automatically by
9621: the update-mime-database program, but the latter are
9622: package-dependent and must be removed by the package that
9623: installed them in the first place.</p></li>
1.23 wiz 9624: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9625: from the PLIST. They will be handled by the shared-mime-info
9626: package.</p></li>
9627: </ol></div>
9628: </div>
1.41 asau 9629: <div class="sect2">
1.1 dsieger 9630: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9631: <a name="intltool"></a>21.6.13. Packages using intltool</h3></div></div></div>
1.1 dsieger 9632: <p>If a package uses intltool during its build, add
9633: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9634: which forces it to use the intltool package provided by pkgsrc,
9635: instead of the one bundled with the distribution file.</p>
9636: <p>This tracks intltool's build-time dependencies and uses the
9637: latest available version; this way, the package benefits of any
9638: bug fixes that may have appeared since it was released.</p>
9639: </div>
1.41 asau 9640: <div class="sect2">
1.1 dsieger 9641: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9642: <a name="startup-scripts"></a>21.6.14. Packages installing startup scripts</h3></div></div></div>
1.256 wiz 9643: <p>If a package contains an rc.d script, it won't be copied into
9644: the startup directory (<code class="filename">/etc/rc.d</code>) by default,
9645: but you can enable copying by setting the option
9646: <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
9647: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. With <code class="varname">PKG_RCD_SCRIPTS=YES</code>, rc.d scripts
9648: will be copied into <code class="filename">/etc/rc.d</code> when a package
9649: is installed, but only if the target does not already exist.
9650: Copies in <code class="filename">/etc/rc.d</code> will be automatically removed
9651: only if they have not been modified.
9652: </p>
9653: <p>Note that this alone does not enable the service: It must still be
9654: added to <code class="filename">/etc/rc.conf</code>.</p>
1.1 dsieger 9655: </div>
1.41 asau 9656: <div class="sect2">
1.1 dsieger 9657: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9658: <a name="tex-packages"></a>21.6.15. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9659: <p>If a package installs TeX packages into the texmf tree,
9660: the <code class="filename">ls-R</code> database of the tree needs to be
9661: updated.</p>
1.41 asau 9662: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9663: <h3 class="title">Note</h3>
1.22 jakllsch 9664: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9665: packages should install files
1.22 jakllsch 9666: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9667: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9668: </div>
1.23 wiz 9669: <div class="orderedlist"><ol class="orderedlist" type="1">
9670: <li class="listitem"><p>Include
1.22 jakllsch 9671: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9672: takes care of rebuilding the <code class="filename">ls-R</code>
9673: database at installation and deinstallation time.</p></li>
1.23 wiz 9674: <li class="listitem">
1.1 dsieger 9675: <p>If your package installs files into a texmf
9676: tree other than the one
1.22 jakllsch 9677: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9678: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9679: trees that need database update.</p>
9680: <p>If your package also installs font map files that need
1.10 hubertf 9681: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9682: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9683: set <code class="varname">TEX_MAP_FILES</code> and/or
9684: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9685: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9686: be run automatically at installation/deinstallation to
9687: enable/disable font map files for TeX output
9688: drivers.</p>
9689: </li>
1.23 wiz 9690: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9691: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9692: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9693: </ol></div>
9694: </div>
1.41 asau 9695: <div class="sect2">
1.1 dsieger 9696: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9697: <a name="emulation-packages"></a>21.6.16. Packages supporting running binaries in
1.1 dsieger 9698: emulation</h3></div></div></div>
9699: <p>There are some packages that provide libraries and
9700: executables for running binaries from a one operating system
9701: on a different one (if the latter supports it). One example
9702: is running Linux binaries on NetBSD.</p>
1.207 leot 9703: <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.1 dsieger 9704: helps in extracting and packaging Linux rpm packages.</p>
9705: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9706: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9707: if all libraries for each installed executable can be found by
9708: the dynamic linker. Since the standard dynamic linker is run,
9709: this fails for emulation packages, because the libraries used
9710: by the emulation are not in the standard directories.</p>
9711: </div>
1.184 rillig 9712: <div class="sect2">
9713: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9714: <a name="hicolor-theme"></a>21.6.17. Packages installing hicolor icons</h3></div></div></div>
1.184 rillig 9715: <p>If a package installs images under the
9716: <code class="filename">share/icons/hicolor</code> and/or updates the
9717: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9718: database, you need to take some extra steps to make sure that the
9719: shared theme directory is handled appropriately and that the cache
9720: database is rebuilt:</p>
9721: <div class="orderedlist"><ol class="orderedlist" type="1">
9722: <li class="listitem"><p>Include
9723: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9724: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9725: entry that refers to the theme cache.</p></li>
9726: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9727: directories from the <code class="filename">share/icons/hicolor</code>
9728: hierarchy because they will be handled automatically.</p></li>
9729: </ol></div>
9730: <p>The best way to verify that the PLIST is correct with
9731: respect to the last two points is to regenerate it using
9732: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9733: </div>
9734: <div class="sect2">
9735: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 9736: <a name="desktop-files"></a>21.6.18. Packages installing desktop files</h3></div></div></div>
1.184 rillig 9737: <p>If a package installs <code class="filename">.desktop</code> files
9738: under <code class="filename">share/applications</code> and these include
9739: MIME information (MimeType key), you need to take extra steps to
9740: ensure that they are registered into the MIME database:</p>
9741: <div class="orderedlist"><ol class="orderedlist" type="1">
9742: <li class="listitem"><p>Include
9743: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9744: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9745: <code class="filename">share/applications/mimeinfo.cache</code> file.
9746: It will be handled automatically.</p></li>
9747: </ol></div>
9748: <p>The best way to verify that the PLIST is correct with
9749: respect to the last point is to regenerate it using <span class="command"><strong>make
9750: print-PLIST</strong></span>.</p>
9751: </div>
9752: </div>
9753: <div class="sect1">
9754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 9755: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.184 rillig 9756: <p>In some cases one does not have the time to solve a problem
9757: immediately. In this case, one can plainly mark a package as broken. For
9758: this, one just sets the variable <code class="varname">BROKEN</code> to the
9759: reason why the package is broken (similar to the
9760: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9761: the package will immediately be shown this message, and the build
9762: will not be even tried.</p>
9763: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9764: intervals.</p>
9765: </div>
9766: </div>
9767: <div class="chapter">
9768: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 9769: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.184 rillig 9770: <div class="toc">
9771: <p><b>Table of Contents</b></p>
9772: <dl class="toc">
9773: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9774: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9775: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9776: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9777: </dl>
9778: </div>
9779: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9780: site</a>:</p>
9781: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9782: environment, an intuitive and attractive desktop for users, and the
9783: GNOME development platform, an extensive framework for building
9784: applications that integrate into the rest of the desktop.</p></blockquote></div>
9785: <p>pkgsrc provides a seamless way to automatically build and install
9786: a complete GNOME environment <span class="emphasis"><em>under many different
9787: platforms</em></span>. We can say with confidence that pkgsrc is one of
9788: the most advanced build and packaging systems for GNOME due to its
9789: included technologies buildlink3, the wrappers and tools framework and
9790: automatic configuration file management. Lots of efforts are put into
9791: achieving a completely clean deinstallation of installed software
9792: components.</p>
9793: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9794: the above also means that great efforts are put into making GNOME work
1.201 cirnatda 9795: under this operating system.</p>
1.184 rillig 9796: <p>This chapter is aimed at pkgsrc developers and other people
9797: interested in helping our GNOME porting and packaging efforts. It
9798: provides instructions on how to manage the existing packages and some
9799: important information regarding their internals.</p>
9800: <div class="sect1">
9801: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 9802: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.184 rillig 9803: <p>pkgsrc includes three GNOME-related meta packages:</p>
9804: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 9805: <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.184 rillig 9806: the core GNOME desktop environment. It only includes the necessary
9807: bits to get it to boot correctly, although it may lack important
9808: functionality for daily operation. The idea behind this package is
9809: to let end users build their own configurations on top of this one,
9810: first installing this meta package to achieve a functional setup and
9811: then adding individual applications.</p></li>
1.207 leot 9812: <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.184 rillig 9813: complete installation of the GNOME platform and desktop as defined
9814: by the GNOME project; this is based on the components distributed in
9815: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9816: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9817: official FTP server. Developer-only tools found in those
9818: directories are not installed unless required by some other
9819: component to work properly. Similarly, packages from the bindings
9820: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9821: in unless required as a dependency for an end-user component. This
1.207 leot 9822: 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>
9823: <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.184 rillig 9824: Installs all the tools required to build a GNOME component when
9825: fetched from the CVS repository. These are required to let the
9826: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9827: </ul></div>
9828: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9829: sorted in a way that eases updates: a package may depend on other
9830: packages listed before it but not on any listed after it. It is very
9831: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9832: change it to alphabetical sorting!</em></span></p>
9833: </div>
9834: <div class="sect1">
9835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 9836: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.184 rillig 9837: <p>Almost all GNOME applications are written in C and use a common
9838: set of tools as their build system. Things get different with the new
9839: bindings to other languages (such as Python), but the following will
9840: give you a general idea on the minimum required tools:</p>
9841: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9842: <li class="listitem">
9843: <p>Almost all GNOME applications use the GNU Autotools as their
9844: build system. As a general rule you will need to tell this to your
9845: package:</p>
9846: <pre class="programlisting">
1.223 nia 9847: GNU_CONFIGURE= yes
9848: USE_LIBTOOL= yes
9849: USE_TOOLS+= gmake
1.184 rillig 9850: </pre>
9851: </li>
9852: <li class="listitem">
9853: <p>If the package uses pkg-config to detect dependencies, add this
9854: tool to the list of required utilities:</p>
9855: <pre class="programlisting">
1.223 nia 9856: USE_TOOLS+= pkg-config
1.184 rillig 9857: </pre>
1.207 leot 9858: <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.184 rillig 9859: the end of the build process to ensure that you did not miss to
9860: specify any dependency in your package and that the version
9861: requirements are all correct.</p>
9862: </li>
9863: <li class="listitem"><p>If the package uses intltool, be sure to add
9864: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9865: to handle dependencies and to force the package to use the latest
9866: available version.</p></li>
9867: <li class="listitem">
9868: <p>If the package uses gtk-doc (a documentation generation
9869: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9870: tool is rather big and the distfile should come with pregenerated
9871: documentation anyway; if it does not, it is a bug that you ought to
9872: report. For such packages you should disable gtk-doc (unless it is
9873: the default):</p>
9874: <pre class="programlisting">
1.223 nia 9875: CONFIGURE_ARGS+= --disable-gtk-doc
1.184 rillig 9876: </pre>
9877: <p>The default location of installed HTML files
9878: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9879: and should not be changed unless the package insists on installing
9880: them somewhere else. Otherwise programs as
9881: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9882: do that with an entry similar to:</p>
9883: <pre class="programlisting">
1.223 nia 9884: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.184 rillig 9885: </pre>
9886: </li>
9887: </ul></div>
9888: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9889: files under the installation prefix to maintain databases. In this
9890: context, shared means that those exact same directories and files are
9891: used among several different packages, leading to conflicts in the
9892: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9893: handle the most common cases, so you have to forget about using
9894: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9895: omitting shared files from them. If you find yourself doing those,
9896: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9897: <p>The following table lists the common situations that result in
9898: using shared directories or files. For each of them, the appropriate
9899: solution is given. After applying the solution be sure to
9900: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9901: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9902: <div class="table">
1.266 martin 9903: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.184 rillig 9904: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9905: <colgroup>
9906: <col>
9907: <col>
9908: </colgroup>
9909: <thead><tr>
9910: <th>If the package...</th>
9911: <th>Then...</th>
9912: </tr></thead>
9913: <tbody>
9914: <tr>
9915: <td>Installs icons under the
9916: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9917: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.266 martin 9918: <td>See <a class="xref" href="#hicolor-theme" title="21.6.17. Packages installing hicolor icons">Section 21.6.17, “Packages installing hicolor icons”</a>.</td>
1.184 rillig 9919: </tr>
9920: <tr>
9921: <td>Installs files under
9922: <code class="filename">share/mime/packages</code>.</td>
1.266 martin 9923: <td>See <a class="xref" href="#mime-database" title="21.6.12. Packages installing extensions to the MIME database">Section 21.6.12, “Packages installing extensions to the MIME database”</a>.</td>
1.184 rillig 9924: </tr>
9925: <tr>
9926: <td>Installs <code class="filename">.desktop</code> files under
9927: <code class="filename">share/applications</code> and these include MIME
9928: information.</td>
1.266 martin 9929: <td>See <a class="xref" href="#desktop-files" title="21.6.18. Packages installing desktop files">Section 21.6.18, “Packages installing desktop files”</a>.</td>
1.184 rillig 9930: </tr>
9931: </tbody>
9932: </table></div>
1.1 dsieger 9933: </div>
1.184 rillig 9934: <br class="table-break">
1.1 dsieger 9935: </div>
1.41 asau 9936: <div class="sect1">
1.1 dsieger 9937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 9938: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.184 rillig 9939: <p>When seeing GNOME as a whole, there are two kinds of
9940: updates:</p>
9941: <div class="variablelist"><dl class="variablelist">
9942: <dt><span class="term">Major update</span></dt>
9943: <dd>
9944: <p>Given that there is still a very long way for GNOME 3 (if it
9945: ever appears), we consider a major update one that goes from a
9946: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9947: where <code class="literal">Y</code> is even and greater than
9948: <code class="literal">X</code>. These are hard to achieve because they
9949: introduce lots of changes in the components' code and almost all
9950: GNOME distfiles are updated to newer versions. Some of them can
9951: even break API and ABI compatibility with the previous major
9952: version series. As a result, the update needs to be done all at
9953: once to minimize breakage.</p>
9954: <p>A major update typically consists of around 80 package
9955: updates and the addition of some new ones.</p>
9956: </dd>
9957: <dt><span class="term">Minor update</span></dt>
9958: <dd>
9959: <p>We consider a minor update one that goes from a
9960: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9961: one where <code class="literal">Y</code> is greater than
9962: <code class="literal">X</code>. These are easy to achieve because they do
9963: not update all GNOME components, can be done in an incremental way
9964: and do not break API nor ABI compatibility.</p>
9965: <p>A minor update typically consists of around 50 package
9966: updates, although the numbers here may vary a lot.</p>
9967: </dd>
9968: </dl></div>
9969: <p>In order to update the GNOME components in pkgsrc to a new stable
9970: release (either major or minor), the following steps should be
9971: followed:</p>
9972: <div class="orderedlist"><ol class="orderedlist" type="1">
1.23 wiz 9973: <li class="listitem">
1.184 rillig 9974: <p>Get a list of all the tarballs that form the new release by
9975: using the following commands. These will leave the full list of the
9976: components' distfiles into the <code class="filename">list.txt</code>
9977: file:</p>
9978: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9979: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9980: awk '{ print $9 }' >list.txt</code></strong>
9981: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9982: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9983: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.1 dsieger 9984: </li>
1.184 rillig 9985: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9986: bump their version to the release you are updating them to. The
9987: three meta packages should be always consistent with versioning.
9988: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9989: in them.</p></li>
1.23 wiz 9990: <li class="listitem">
1.184 rillig 9991: <p>For each meta package, update all its
9992: <code class="varname">DEPENDS</code> lines to match the latest versions as
9993: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9994: newer version (even if found in the FTP) because the meta packages
9995: are supposed to list the exact versions that form a specific GNOME
9996: release. Exceptions are permitted here if a newer version solves a
9997: serious issue in the overall desktop experience; these typically
9998: come in the form of a revision bump in pkgsrc, not in newer versions
9999: from the developers.</p>
10000: <p>Packages not listed in the <code class="filename">list.txt</code> file
10001: should be updated to the latest version available (if found in
10002: pkgsrc). This is the case, for example, of the dependencies on the
1.207 leot 10003: 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.1 dsieger 10004: </li>
1.23 wiz 10005: <li class="listitem">
1.184 rillig 10006: <p>Generate a patch from the modified meta packages and extract the
10007: list of "new" lines. This will provide you an outline on what
10008: packages need to be updated in pkgsrc and in what order:</p>
10009: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
1.1 dsieger 10010: </li>
1.184 rillig 10011: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
10012: installed packages and start over from scratch at this point.</p></li>
10013: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
10014: of <code class="filename">todo.txt</code> and update the packages listed in
10015: it in order. For major desktop updates none of these should be
10016: committed until the entire set is completed because there are chances
10017: of breaking not-yet-updated packages.</p></li>
10018: <li class="listitem"><p>Once the packages are up to date and working, commit them to
10019: the tree one by one with appropriate log messages. At the end,
10020: commit the three meta package updates and all the corresponding
10021: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10022: <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>
10023: </ol></div>
10024: </div>
10025: <div class="sect1">
10026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10027: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.184 rillig 10028: <p>GNOME is a very big component in pkgsrc which approaches 100
10029: packages. Please, it is very important that you always, always,
10030: <span class="strong"><strong>always</strong></span> feed back any portability
1.266 martin 10031: 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
1.184 rillig 10032: their attention on portability issues and to ensure that future versions
10033: can be built out-of-the box on NetBSD. The less custom patches in
10034: pkgsrc, the easier further updates are. Those developers in charge of
10035: issuing major GNOME updates will be grateful if you do that.</p>
1.200 cirnatda 10036: <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
10037: GitLab</a>. Not all components use these to track bugs, but most
1.184 rillig 10038: of them do. Do not be short on your reports: always provide detailed
10039: explanations of the current failure, how it can be improved to achieve
1.200 cirnatda 10040: maximum portability and, if at all possible, provide a patch against the
10041: main Git branch. The more verbose you are, the higher chances of your
10042: patch being accepted.</p>
1.184 rillig 10043: <p>Also, please avoid using preprocessor magic to fix portability
10044: issues. While the FreeBSD GNOME people are doing a great job in porting
10045: GNOME to their operating system, the official GNOME sources are now
10046: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10047: and similar macros. This hurts portability. Please see our patching
1.266 martin 10048: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
1.184 rillig 10049: details.</p>
10050: </div>
1.1 dsieger 10051: </div>
1.41 asau 10052: <div class="chapter">
1.1 dsieger 10053: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 10054: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 10055: <div class="toc">
10056: <p><b>Table of Contents</b></p>
1.100 leot 10057: <dl class="toc">
1.154 rillig 10058: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
10059: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
10060: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
10061: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
10062: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
10063: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
10064: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
10065: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 10066: </dl>
10067: </div>
1.41 asau 10068: <div class="sect1">
1.1 dsieger 10069: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10070: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 10071: <p>Our policy is that we accept binaries only from pkgsrc
10072: developers to guarantee that the packages don't contain any
10073: trojan horses etc. This is not to annoy anyone but rather to
10074: protect our users! You're still free to put up your home-made
10075: binary packages and tell the world where to get them. NetBSD
10076: developers doing bulk builds and wanting to upload them please
1.266 martin 10077: see <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.66 asau 10078: builds)</i></a>.</p>
1.1 dsieger 10079: </div>
1.41 asau 10080: <div class="sect1">
1.1 dsieger 10081: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10082: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.218 nia 10083: <p>Firstly, you can import new packages into
1.266 martin 10084: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.218 nia 10085: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
10086: for details.</p>
10087: <p>Next, check that your package is complete, compiles and
1.266 martin 10088: 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.218 nia 10089: document. Run the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
10090: tool and fix any errors that appear.</p>
10091: <p>Finally, send a report to the pkgsrc bug tracking system,
1.259 leot 10092: either with the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1 dsieger 10093: that, go to the web page
1.174 leot 10094: <a class="ulink" href="https://www.NetBSD.org/support/send-pr.html" target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
1.21 snj 10095: which contains some instructions and a link to a form where you
10096: can submit packages. The
1.207 leot 10097: <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.21 snj 10098: also available as a substitute for either of the above two tools.
10099: </p>
1.1 dsieger 10100: <p>In the form of the problem report, the category should be
1.266 martin 10101: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 10102: and version number, and the description field should contain a
10103: short description of your package (contents of the COMMENT
1.218 nia 10104: variable or DESCR file are OK).</p>
1.1 dsieger 10105: </div>
1.41 asau 10106: <div class="sect1">
1.1 dsieger 10107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10108: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 10109: <p>Please note all package additions, updates, moves, and
10110: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
10111: important to keep this file up to date and conforming to the
10112: existing format, because it will be used by scripts to
1.174 leot 10113: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 10114: sites. Additionally, check the
10115: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
10116: for the package you updated or removed, in case it was mentioned
10117: there.</p>
10118: <p>When the <code class="varname">PKGREVISION</code> of a package is
10119: bumped, the change should appear in
10120: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
10121: related or otherwise relevant. Mass bumps that result from a
10122: dependency being updated should not be mentioned. In all other
10123: cases it's the developer's decision.</p>
10124: <p>There is a make target that helps in creating proper
1.10 hubertf 10125: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 10126: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
10127: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
10128: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
10129: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 10130: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
10131: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 10132: For new packages, or package moves or removals, set the
10133: <code class="varname">CTYPE</code> variable on the command line to "Added",
10134: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 10135: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 10136: not the same as your NetBSD login name. The target also automatically
10137: removes possibly existing entries for the package in the
10138: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 10139: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 10140: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
10141: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
10142: makes the cvs commands use the main repository.
10143: </p>
1.1 dsieger 10144: </div>
1.41 asau 10145: <div class="sect1">
1.1 dsieger 10146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10147: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 10148: <p>For several years, there have been mirrors of pkgsrc in
1.257 jkoshy 10149: fossil, git, and hg. Standard practice when using these tools is to
1.130 wiz 10150: make the first line of a commit message function as a summary that
10151: can be read without the rest, such as is commonly done with "git log
10152: --oneline". For this reason, we have the following guidelines for
10153: pkgsrc commit messages:</p>
10154: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10155: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 10156: big picture in 65 characters or less. When a commit is for one
1.130 wiz 10157: package, include the name of the package. For updates, include the
10158: version to which it is updated.</p></li>
10159: <li class="listitem"><p>Leave the next line empty.</p></li>
10160: <li class="listitem"><p>Then come the details for the commit (changes in that
10161: package, reason for a change) and any relevant PRs. Wrap this
10162: section.</p></li>
10163: </ul></div>
10164: <p>Here is an example:
1.238 wiz 10165: </p>
1.130 wiz 10166: <pre class="programlisting">
1.238 wiz 10167: libxslt: update to 1.0.30
1.130 wiz 10168:
1.238 wiz 10169: Changes since 1.0.29:
10170: ...
10171: </pre>
1.130 wiz 10172: <p>
10173: </p>
10174: <p>Here is another example:
1.238 wiz 10175: </p>
1.130 wiz 10176: <pre class="programlisting">
1.238 wiz 10177: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.130 wiz 10178:
1.238 wiz 10179: (rationale)
10180: </pre>
1.130 wiz 10181: <p>
10182: </p>
1.266 martin 10183: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
1.130 wiz 10184: allowed on the pkgsrc repository to change commit messages.</p>
10185: </div>
10186: <div class="sect1">
10187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10188: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 10189: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 10190: access to the pkgsrc repository.</p>
1.266 martin 10191: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
1.33 wiz 10192: Start by adding the directory and then files in the directory. Don't
10193: forget to add the new package to the category's
10194: <code class="filename">Makefile</code>. Make sure you don't forget any files;
1.266 martin 10195: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
1.33 wiz 10196: <pre class="programlisting">
10197: <code class="prompt">$</code> cd .../pkgsrc/category
10198: <code class="prompt">$</code> cvs add pkgname
10199: <code class="prompt">$</code> cd pkgname
10200: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
10201: <code class="prompt">$</code> cvs add patches/p*
10202: <code class="prompt">$</code> cvs status | less
1.34 wiz 10203: <code class="prompt">$</code> cvs commit
1.33 wiz 10204: <code class="prompt">$</code> cd ..
1.236 gutterid 10205: <code class="prompt">$</code> vi Makefile # add SUBDIR+=pkgname line
1.34 wiz 10206: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 10207: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 10208: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 10209: </pre>
1.1 dsieger 10210: <p>The commit message of the initial import should include part of the
10211: <code class="filename">DESCR</code> file, so people reading the mailing lists know
10212: what the package is/does.</p>
1.33 wiz 10213: <p>Also mention the new package in
10214: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
1.266 martin 10215: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
10216: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 10217: </div>
1.41 asau 10218: <div class="sect1">
1.1 dsieger 10219: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10220: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 10221: <p>Please always put a concise, appropriate and relevant summary of the
10222: changes between old and new versions into the commit log when updating
10223: a package. There are various reasons for this:</p>
1.41 asau 10224: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10225: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 10226: or its information may be overwritten by newer information.</p></li>
1.23 wiz 10227: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 10228: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 10229: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 10230: repository is very useful for people who read the pkgsrc-changes mailing
10231: list, so that they can make tactical decisions about when to upgrade
10232: the package.</p></li>
10233: </ul></div>
10234: <p>Please also recognize that, just because a new version of a package
10235: has been released, it should not automatically be upgraded in the CVS
10236: repository. We prefer to be conservative in the packages that are
10237: included in pkgsrc - development or beta packages are not really the
10238: best thing for most places in which pkgsrc is used. Please use your
10239: judgement about what should go into pkgsrc, and bear in mind that
10240: stability is to be preferred above new and possibly untested features.</p>
10241: </div>
1.41 asau 10242: <div class="sect1">
1.1 dsieger 10243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10244: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 10245: <p>Renaming packages is not recommended.</p>
1.175 gutterid 10246: <p>When renaming packages, be sure to fix any references to the old name
1.20 snj 10247: in other Makefiles, options, buildlink files, etc.</p>
1.167 leot 10248: <p>
1.175 gutterid 10249: Also, when renaming a package, please add
1.167 leot 10250: the package name and version pattern(s) of the previous package
10251: to <code class="varname">SUPERSEDES</code>.
1.20 snj 10252: This may be repeated for multiple renames.
10253: The new package would be an exact replacement.
1.167 leot 10254: Example:
1.20 snj 10255: </p>
1.167 leot 10256: <pre class="programlisting">
10257: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
10258: SUPERSEDES+= optcomp-[0-9]*
10259: </pre>
1.266 martin 10260: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 10261: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
10262: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
10263: not be an exact replacement but is a suggestion for the replaced
10264: functionality.</p>
10265: </div>
1.41 asau 10266: <div class="sect1">
1.20 snj 10267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10268: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 10269: <p>It is preferred that packages are not renamed or moved, but if needed
10270: please follow these steps.
10271: </p>
1.23 wiz 10272: <div class="orderedlist"><ol class="orderedlist" type="1">
10273: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
10274: <li class="listitem">
1.1 dsieger 10275: <p>Remove all CVS dirs.</p>
10276: <p>Alternatively to the first two steps you can also do:</p>
10277: <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>
10278: <p>and use that for further work.</p>
10279: </li>
1.23 wiz 10280: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
1.266 martin 10281: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
10282: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
1.23 wiz 10283: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 10284: <code class="varname">PREV_PKGPATH</code> to the previous category/package
10285: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
10286: for doing an update using pkgsrc building; for example, it can
1.259 leot 10287: search the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20 snj 10288: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
10289: new <code class="varname">PKGPATH</code> for that moved package. Note that
10290: it may have multiple matches, so the tool should also check on the
10291: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
10292: probably has no value unless <code class="varname">SUPERSEDES</code> is not
10293: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.237 gutterid 10294: <li class="listitem"><p><span class="command"><strong>cvs add</strong></span> the modified package in the new
1.1 dsieger 10295: place.</p></li>
1.23 wiz 10296: <li class="listitem">
1.1 dsieger 10297: <p>Check if any package depends on it:
10298: </p>
10299: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
10300: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
10301: </li>
1.23 wiz 10302: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
10303: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
10304: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
10305: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
10306: <li class="listitem">
1.1 dsieger 10307: <p>Commit the changed and removed files:</p>
10308: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
10309: <p>(and any packages from step 5, of course).</p>
10310: </li>
10311: </ol></div>
10312: </div>
10313: </div>
1.41 asau 10314: <div class="chapter">
1.1 dsieger 10315: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 10316: <a name="policies"></a>Chapter 24. pkgsrc Policies</h2></div></div></div>
1.263 wiz 10317: <div class="toc">
10318: <p><b>Table of Contents</b></p>
10319: <dl class="toc">
10320: <dt><span class="sect1"><a href="#stability">24.1. Packages for which updating is restricted</a></span></dt>
10321: <dd><dl>
10322: <dt><span class="sect2"><a href="#stability.abi">24.1.1. Limited Updates - ABI</a></span></dt>
10323: <dt><span class="sect2"><a href="#stability.bootstrap">24.1.2. Limited Updates - Bootstrap</a></span></dt>
10324: </dl></dd>
10325: </dl>
10326: </div>
10327: <div class="sect1">
10328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10329: <a name="stability"></a>24.1. Packages for which updating is restricted</h2></div></div></div>
1.263 wiz 10330: <p>In the past, some packages have caused more package failures than others, and we'd like to reduce this in the future.</p>
10331: <p>For this reason, pkgsrc-pmc marks some packages with <code class="varname">POLICY_UPDATE_LIMITED</code>. The possible values currently are:
10332: </p>
10333: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10334: <li class="listitem"><p><code class="literal">abi</code> for packages where ABI/API changes often broke the packages depending on them</p></li>
10335: <li class="listitem"><p><code class="literal">bootstrap</code> for packages that are used during the pkgsrc bootstrap</p></li>
10336: </ul></div>
10337: <p>
10338: <code class="filename">pkglint</code> will warn when committing updates to these packages.</p>
10339: <div class="sect2">
10340: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10341: <a name="stability.abi"></a>24.1.1. Limited Updates - ABI</h3></div></div></div>
1.263 wiz 10342: <p>Before committing non-micro version updates to packages marked
10343: with <code class="varname">POLICY_UPDATE_LIMITED=abi</code>, a limited bulk
10344: build of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/bulk-test-${PACKAGE}/index.html" target="_top"><code class="filename">meta-pkgs/bulk-test-${PACKAGE}</code></a> needs to be run
10345: and the result posted to the tech-pkg mailing list, highlighting
10346: what packages would stop building (if any).</p>
10347: <p>Depending on the result, pkgsrc-pmc then decides:
10348: </p>
10349: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10350: <li class="listitem"><p>go ahead with the update</p></li>
10351: <li class="listitem"><p>wait for packages X, Y, Z to be fixed (upstream or
10352: locally) with the updated version, which is put in wip in the
10353: meantime</p></li>
10354: <li class="listitem"><p>In the second case, all pkgsrc developers are
10355: encouraged to work on fixing this - it is not only the updater's
10356: task to fix them.</p></li>
10357: </ul></div>
10358: <p>
10359: </p>
10360: <p>The decision to wait for packages can be revisited.</p>
10361: </div>
10362: <div class="sect2">
10363: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10364: <a name="stability.bootstrap"></a>24.1.2. Limited Updates - Bootstrap</h3></div></div></div>
1.263 wiz 10365: <p>When updating packages used in the bootstrap, i.e. marked with
10366: <code class="varname">POLICY_UPDATE_LIMITED=bootstrap</code>, test the
10367: bootstrap process and preferably some basic packages and send the
10368: patch to the tech-pkg mailing list so it can be tested on other
10369: platforms as well. Give at least two weeks for feedback and testing
10370: by others.</p>
10371: </div>
10372: </div>
10373: </div>
10374: <div class="chapter">
10375: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 10376: <a name="devfaq"></a>Chapter 25. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 10377: <p>This section contains the answers to questions that may
10378: arise when you are writing a package. If you don't find your
10379: question answered here, first have a look in the other chapters,
10380: and if you still don't have the answer, ask on the
10381: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 10382: <div class="qandaset">
1.174 leot 10383: <a name="devfaq.qandaset"></a><dl>
1.263 wiz 10384: <dt>25.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 10385: MAKEFLAGS, .MAKEFLAGS and
10386: MAKE_FLAGS?</a>
10387: </dt>
1.263 wiz 10388: <dt>25.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 10389: MAKE, GMAKE and
10390: MAKE_PROGRAM?</a>
10391: </dt>
1.263 wiz 10392: <dt>25.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 10393: CC, PKG_CC and
10394: PKGSRC_COMPILER?</a>
10395: </dt>
1.263 wiz 10396: <dt>25.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 10397: VARNAME=BUILDLINK_PREFIX.foo
10398: say it's empty?</a>
10399: </dt>
1.263 wiz 10400: <dt>25.5. <a href="#devfaq.master_sites">What does
1.1 dsieger 10401: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
10402: don't understand the := inside
10403: it.</a>
10404: </dt>
1.263 wiz 10405: <dt>25.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 10406: developers?</a>
10407: </dt>
1.263 wiz 10408: <dt>25.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 10409: documentation?</a>
10410: </dt>
1.263 wiz 10411: <dt>25.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.174 leot 10412: What shall I do?</a>
1.1 dsieger 10413: </dt>
10414: </dl>
1.41 asau 10415: <table border="0" style="width: 100%;">
10416: <colgroup>
1.1 dsieger 10417: <col align="left" width="1%">
1.23 wiz 10418: <col>
1.41 asau 10419: </colgroup>
1.1 dsieger 10420: <tbody>
1.41 asau 10421: <tr class="question">
1.1 dsieger 10422: <td align="left" valign="top">
1.263 wiz 10423: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>25.1.</b></p>
1.1 dsieger 10424: </td>
10425: <td align="left" valign="top"><p>What is the difference between
10426: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10427: <code class="varname">MAKE_FLAGS</code>?</p></td>
10428: </tr>
10429: <tr class="answer">
10430: <td align="left" valign="top"></td>
1.223 nia 10431: <td align="left" valign="top">
10432: <p><code class="varname">MAKEFLAGS</code> are the flags passed
1.259 leot 10433: to the pkgsrc-internal invocations of <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.</p>
1.223 nia 10434: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
10435: passed to the <code class="varname">MAKE_PROGRAM</code> when building the
10436: package.</p>
10437: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
10438: <span class="command"><strong>bmake</strong></span> and should not be used by
10439: packages.</p>
10440: </td>
1.1 dsieger 10441: </tr>
1.41 asau 10442: <tr class="question">
1.1 dsieger 10443: <td align="left" valign="top">
1.263 wiz 10444: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>25.2.</b></p>
1.1 dsieger 10445: </td>
10446: <td align="left" valign="top"><p>What is the difference between
10447: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10448: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10449: </tr>
10450: <tr class="answer">
10451: <td align="left" valign="top"></td>
1.223 nia 10452: <td align="left" valign="top">
10453: <p><code class="varname">MAKE</code> is the path to the
1.259 leot 10454: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.223 nia 10455: infrastructure.</p>
10456: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
10457: need to say <code class="varname">USE_TOOLS+=gmake</code> to use
10458: that.</p>
10459: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
10460: program that is used for building the package.</p>
10461: </td>
1.1 dsieger 10462: </tr>
1.41 asau 10463: <tr class="question">
1.1 dsieger 10464: <td align="left" valign="top">
1.263 wiz 10465: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>25.3.</b></p>
1.1 dsieger 10466: </td>
10467: <td align="left" valign="top"><p>What is the difference between
10468: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10469: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10470: </tr>
10471: <tr class="answer">
10472: <td align="left" valign="top"></td>
10473: <td align="left" valign="top">
1.223 nia 10474: <p><code class="varname">CC</code> is the path to the real C
10475: compiler, which can be configured by the pkgsrc user.</p>
10476: <p><code class="varname">PKG_CC</code> is the path to the compiler
10477: wrapper.</p>
10478: <p><code class="varname">PKGSRC_COMPILER</code> is
10479: <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
10480: compiler that should be used. See
10481: <code class="filename">mk/compiler.mk</code> for more information about
10482: the latter variable.</p>
1.1 dsieger 10483: </td>
10484: </tr>
1.41 asau 10485: <tr class="question">
1.1 dsieger 10486: <td align="left" valign="top">
1.263 wiz 10487: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>25.4.</b></p>
1.1 dsieger 10488: </td>
1.10 hubertf 10489: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 10490: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10491: say it's empty?</p></td>
10492: </tr>
10493: <tr class="answer">
10494: <td align="left" valign="top"></td>
10495: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.266 martin 10496: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10497: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 10498: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 10499: command.</p></td>
10500: </tr>
1.41 asau 10501: <tr class="question">
1.1 dsieger 10502: <td align="left" valign="top">
1.263 wiz 10503: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>25.5.</b></p>
1.1 dsieger 10504: </td>
10505: <td align="left" valign="top"><p>What does
1.108 rillig 10506: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10507: don't understand the <code class="code">:=</code> inside
1.1 dsieger 10508: it.</p></td>
10509: </tr>
10510: <tr class="answer">
10511: <td align="left" valign="top"></td>
1.223 nia 10512: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
10513: assignment operator, even though it may look like one.
1.1 dsieger 10514: Instead, it is a degenerate form of
1.108 rillig 10515: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.259 leot 10516: which is documented in the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.108 rillig 10517: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 10518: case of <code class="varname">MASTER_SITE_*</code>,
10519: <em class="replaceable"><code>old_string</code></em> is the empty string and
10520: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 10521: <code class="code">package/</code>. That's where the
10522: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 10523: together.</p></td>
10524: </tr>
1.41 asau 10525: <tr class="question">
1.1 dsieger 10526: <td align="left" valign="top">
1.263 wiz 10527: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>25.6.</b></p>
1.1 dsieger 10528: </td>
10529: <td align="left" valign="top"><p>Which mailing lists are there for package
10530: developers?</p></td>
10531: </tr>
10532: <tr class="answer">
10533: <td align="left" valign="top"></td>
1.41 asau 10534: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.174 leot 10535: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1 dsieger 10536: <dd><p>This is a list for technical discussions related
10537: to pkgsrc development, e.g. soliciting feedback for changes to
10538: pkgsrc infrastructure, proposed new features, questions related
10539: to porting pkgsrc to a new platform, advice for maintaining a
10540: package, patches that affect many packages, help requests moved
10541: from pkgsrc-users when an infrastructure bug is found,
10542: etc.</p></dd>
1.174 leot 10543: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1 dsieger 10544: <dd><p>All bug reports in category "pkg" sent with
1.259 leot 10545: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1 dsieger 10546: directly; use one of the other mailing
10547: lists.</p></dd>
10548: </dl></div></td>
10549: </tr>
1.41 asau 10550: <tr class="question">
1.1 dsieger 10551: <td align="left" valign="top">
1.263 wiz 10552: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>25.7.</b></p>
1.1 dsieger 10553: </td>
10554: <td align="left" valign="top"><p>Where is the pkgsrc
10555: documentation?</p></td>
10556: </tr>
10557: <tr class="answer">
10558: <td align="left" valign="top"></td>
10559: <td align="left" valign="top">
10560: <p>There are many places where you can find
10561: documentation about pkgsrc:</p>
1.41 asau 10562: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10563: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 10564: of chapters that explain large parts of pkgsrc, but some
10565: chapters tend to be outdated. Which ones they are is hard to
10566: say.</p></li>
1.174 leot 10567: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>), you can find discussions
1.1 dsieger 10568: about certain features, announcements of new parts of the pkgsrc
10569: infrastructure and sometimes even announcements that a certain
10570: feature has been marked as obsolete. The benefit here is that
10571: each message has a date appended to it.</p></li>
1.23 wiz 10572: <li class="listitem"><p>Many of the files in the
1.1 dsieger 10573: <code class="filename">mk/</code> directory start with a comment that
10574: describes the purpose of the file and how it can be used by the
10575: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 10576: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 10577: help</strong></span>.</p></li>
1.23 wiz 10578: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 10579: information, but they tend to be highly abbreviated, especially
10580: for actions that occur often. Some contain a detailed
10581: description of what has changed, but they are geared towards the
10582: other pkgsrc developers, not towards an average pkgsrc user.
10583: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10584: don't know what has been before, these messages may not be worth
10585: too much to you.</p></li>
1.266 martin 10586: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10587: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 10588: mind of the developer who wrote the code. To get this
1.10 hubertf 10589: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 10590: to see who has written it and ask on the
10591: <code class="literal">tech-pkg</code> mailing list, so that others can
10592: find your questions later (see above). To be sure that the
10593: developer in charge reads the mail, you may CC him or
10594: her.</p></li>
10595: </ul></div>
1.184 rillig 10596: </td>
10597: </tr>
10598: <tr class="question">
10599: <td align="left" valign="top">
1.263 wiz 10600: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>25.8.</b></p>
1.184 rillig 10601: </td>
1.223 nia 10602: <td align="left" valign="top"><p>I have a little time to kill.
1.184 rillig 10603: What shall I do?</p></td>
10604: </tr>
10605: <tr class="answer">
10606: <td align="left" valign="top"></td>
10607: <td align="left" valign="top">
10608: <p>This is not really an FAQ yet, but here's the answer
10609: anyway.</p>
1.41 asau 10610: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 10611: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.207 leot 10612: <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.184 rillig 10613: will tell you about newer versions of installed packages that are
10614: available, but not yet updated in pkgsrc.</p></li>
10615: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10616: — it contains a list of suggested new packages and a list of
10617: cleanups and enhancements for pkgsrc that would be nice to
10618: have.</p></li>
10619: <li class="listitem"><p>Review packages for which review was requested on
10620: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10621: mailing list.</p></li>
1.1 dsieger 10622: </ul></div>
1.184 rillig 10623: </td>
1.1 dsieger 10624: </tr>
10625: </tbody>
1.184 rillig 10626: </table>
1.1 dsieger 10627: </div>
10628: </div>
10629: </div>
1.41 asau 10630: <div class="part">
1.1 dsieger 10631: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 10632: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10633: <div class="partintro">
1.1 dsieger 10634: <div></div>
10635: <p>This part of the guide deals with everything
10636: from the infrastructure that is behind the interfaces described
10637: in the developer's guide. A casual package maintainer should not
10638: need anything from this part.</p>
10639: <div class="toc">
10640: <p><b>Table of Contents</b></p>
1.100 leot 10641: <dl class="toc">
1.263 wiz 10642: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10643: <dd><dl>
1.263 wiz 10644: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
10645: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
10646: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 10647: <dd><dl>
1.263 wiz 10648: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
10649: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 10650: </dl></dd>
1.263 wiz 10651: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
10652: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10653: <dd><dl>
1.263 wiz 10654: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
10655: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10656: </dl></dd>
1.263 wiz 10657: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10658: <dd><dl>
1.263 wiz 10659: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10660: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10661: </dl></dd>
10662: </dl></dd>
1.263 wiz 10663: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1 dsieger 10664: <dd><dl>
1.263 wiz 10665: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
10666: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10667: <dd><dl>
1.263 wiz 10668: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
10669: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 10670: </dl></dd>
10671: </dl></dd>
1.263 wiz 10672: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
10673: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 10674: </dl>
10675: </div>
10676: </div>
1.41 asau 10677: <div class="chapter">
1.1 dsieger 10678: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 10679: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10680: <div class="toc">
10681: <p><b>Table of Contents</b></p>
1.100 leot 10682: <dl class="toc">
1.263 wiz 10683: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
10684: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
10685: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 10686: <dd><dl>
1.263 wiz 10687: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
10688: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 10689: </dl></dd>
1.263 wiz 10690: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
10691: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10692: <dd><dl>
1.263 wiz 10693: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
10694: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10695: </dl></dd>
1.263 wiz 10696: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10697: <dd><dl>
1.263 wiz 10698: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10699: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10700: </dl></dd>
10701: </dl>
10702: </div>
10703: <p>The pkgsrc infrastructure consists of many small Makefile
10704: fragments. Each such fragment needs a properly specified
10705: interface. This chapter explains how such an interface looks
10706: like.</p>
1.41 asau 10707: <div class="sect1">
1.1 dsieger 10708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10709: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10710: <p>Whenever a variable is defined in the pkgsrc
10711: infrastructure, the location and the way of definition provide
10712: much information about the intended use of that variable.
10713: Additionally, more documentation may be found in a header
10714: comment or in this pkgsrc guide.</p>
10715: <p>A special file is
10716: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10717: variables that are intended to be user-defined. They are either
10718: defined using the <code class="literal">?=</code> operator or they are
10719: left undefined because defining them to anything would
1.266 martin 10720: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10721: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10722: file.</p>
10723: <p>Outside this file, the following conventions apply:
10724: Variables that are defined using the <code class="literal">?=</code>
10725: operator may be overridden by a package.</p>
10726: <p>Variables that are defined using the <code class="literal">=</code>
10727: operator may be used read-only at run-time.</p>
10728: <p>Variables whose name starts with an underscore must not be
10729: accessed outside the pkgsrc infrastructure at all. They may
10730: change without further notice.</p>
1.41 asau 10731: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10732: <h3 class="title">Note</h3>
10733: <p>These conventions are currently not applied
10734: consistently to the complete pkgsrc
10735: infrastructure.</p>
10736: </div>
10737: </div>
1.41 asau 10738: <div class="sect1">
1.1 dsieger 10739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10740: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10741: <p>All variables that contain lists of things should default
10742: to being empty. Two examples that do not follow this rule are
10743: <code class="varname">USE_LANGUAGES</code> and
10744: <code class="varname">DISTFILES</code>. These variables cannot simply be
10745: modified using the <code class="literal">+=</code> operator in package
10746: <code class="filename">Makefile</code>s (or other files included by
10747: them), since there is no guarantee whether the variable is
10748: already set or not, and what its value is. In the case of
1.266 martin 10749: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10750: the default value and just define it as in the following
10751: example.</p>
10752: <pre class="programlisting">
10753: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10754: </pre>
10755: <p>Because of the selection of this default value, the same
10756: value appears in many package Makefiles. Similarly for
10757: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.266 martin 10758: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10759: doesn't stand out. Nevertheless it is mentioned in many
10760: files.</p>
10761: </div>
1.41 asau 10762: <div class="sect1">
1.1 dsieger 10763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10764: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.41 asau 10765: <div class="sect2">
1.1 dsieger 10766: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10767: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.1 dsieger 10768: <p>Variable evaluation takes place either at load time or at
10769: runtime, depending on the context in which they occur. The
10770: contexts where variables are evaluated at load time are:</p>
1.41 asau 10771: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10772: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10773: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10774: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10775: <code class="literal">.for</code>,</p></li>
1.23 wiz 10776: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10777: </ul></div>
10778: <p>A special exception are references to the iteration
10779: variables of <code class="literal">.for</code> loops, which are expanded
10780: inline, no matter in which context they appear.</p>
10781: <p>As the values of variables may change during load time,
10782: care must be taken not to evaluate them by accident. Typical
10783: examples for variables that should not be evaluated at load time
10784: are <code class="varname">DEPENDS</code> and
10785: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10786: clear, here is an example:</p>
10787: <pre class="programlisting">
10788: CONFIGURE_ARGS= # none
10789: CFLAGS= -O
10790: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10791:
10792: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10793:
10794: CFLAGS+= -Wall
1.111 sevan 10795: </pre>
1.1 dsieger 10796: <p>This code shows how the use of the <code class="literal">:=</code>
10797: operator can quickly lead to unexpected results. The first
10798: paragraph is fairly common code. The second paragraph evaluates
10799: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10800: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10801: <code class="literal">-Wall</code> is appended to the
10802: <code class="varname">CFLAGS</code>, but this addition will not appear in
10803: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10804: paragraphs from above typically occur in completely unrelated
10805: files.</p>
10806: </div>
1.41 asau 10807: <div class="sect2">
1.1 dsieger 10808: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10809: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10810: <p>After all the files have been loaded, the values of the
10811: variables cannot be changed anymore. Variables that are used in
10812: the shell commands are expanded at this point.</p>
10813: </div>
10814: </div>
1.41 asau 10815: <div class="sect1">
1.1 dsieger 10816: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10817: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10818: <p>There are many ways in which the definition and use of a
1.108 rillig 10819: variable can be restricted in order to detect bugs and violations
10820: of the (mostly unwritten) policies. A package can be checked with
10821: <code class="literal">pkglint -Wall</code> to see whether it meets these
10822: rules.</p>
1.1 dsieger 10823: </div>
1.41 asau 10824: <div class="sect1">
1.1 dsieger 10825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10826: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10827: <p>Most of the <code class="filename">.mk</code> files fall into one
10828: of the following classes. Cases where a file falls into more
10829: than one class should be avoided as it often leads to subtle
10830: bugs.</p>
1.41 asau 10831: <div class="sect2">
1.1 dsieger 10832: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10833: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10834: <p>In a traditional imperative programming language some of
10835: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10836: procedures. They take some input parameters and—after
10837: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10838: variables in <code class="filename">Makefile</code>s have global scope
10839: care must be taken not to use parameter names that have already
10840: another meaning. For example, <code class="varname">PKGNAME</code> is a
10841: bad choice for a parameter name.</p>
10842: <p>Procedures are completely evaluated at preprocessing time.
10843: That is, when calling a procedure all input parameters must be
10844: completely resolvable. For example,
10845: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10846: parameter since it is very likely that further text will be
10847: added after calling the procedure, which would effectively apply
10848: the procedure to only a part of the variable. Also, references
1.108 rillig 10849: to other variables will be modified after calling the
1.1 dsieger 10850: procedure.</p>
10851: <p>A procedure can declare its output parameters either as
10852: suitable for use in preprocessing directives or as only
10853: available at runtime. The latter alternative is for variables
10854: that contain references to other runtime variables.</p>
10855: <p>Procedures shall be written such that it is possible to
10856: call the procedure more than once. That is, the file must not
10857: contain multiple-inclusion guards.</p>
10858: <p>Examples for procedures are
10859: <code class="filename">mk/bsd.options.mk</code> and
10860: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10861: that the parameters are evaluated at load time, they should be
10862: assigned using the <code class="literal">:=</code> operator, which should
10863: be used only for this purpose.</p>
10864: </div>
1.41 asau 10865: <div class="sect2">
1.1 dsieger 10866: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10867: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10868: <p>Action files take some input parameters and may define
10869: runtime variables. They shall not define loadtime variables.
10870: There are action files that are included implicitly by the
10871: pkgsrc infrastructure, while other must be included
10872: explicitly.</p>
10873: <p>An example for action files is
10874: <code class="filename">mk/subst.mk</code>.</p>
10875: </div>
10876: </div>
1.41 asau 10877: <div class="sect1">
1.1 dsieger 10878: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10879: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10880: <p>Package <code class="filename">Makefile</code>s usually consist of
10881: a set of variable definitions, and include the file
10882: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10883: Before that, they may also include various other
10884: <code class="filename">*.mk</code> files if they need to query the
10885: availability of certain features like the type of compiler or
10886: the X11 implementation. Due to the heavy use of preprocessor
10887: directives like <code class="literal">.if</code> and
10888: <code class="literal">.for</code>, the order in which the files are loaded
10889: matters.</p>
10890: <p>This section describes at which point the various files
10891: are loaded and gives reasons for that order.</p>
1.41 asau 10892: <div class="sect2">
1.1 dsieger 10893: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10894: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10895: </h3></div></div></div>
10896: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10897: is to define some essential variables like
10898: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10899: <code class="varname">MACHINE_ARCH</code>.</p>
10900: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10901: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4 rillig 10902: After that, those variables
1.1 dsieger 10903: that have not been overridden by the user are loaded from
10904: <code class="filename">mk/defaults/mk.conf</code>.</p>
10905: <p>After the user settings, the system settings and platform
10906: settings are loaded, which may override the user
10907: settings.</p>
10908: <p>Then, the tool definitions are loaded. The tool wrappers
10909: are not yet in effect. This only happens when building a
10910: package, so the proper variables must be used instead of the
10911: direct tool names.</p>
10912: <p>As the last steps, some essential variables from the
10913: wrapper and the package system flavor are loaded, as well as the
10914: variables that have been cached in earlier phases of a package
10915: build.</p>
10916: </div>
1.41 asau 10917: <div class="sect2">
1.1 dsieger 10918: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10919: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10920: </h3></div></div></div>
10921: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10922: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10923: loaded, which fill default values for those variables that have
10924: not been defined by the package. These variables may later
10925: be used even in unrelated files.</p>
10926: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10927: provides the target <code class="literal">error-check</code> that is added
10928: as a special dependency to all other targets that use
10929: <code class="varname">DELAYED_ERROR_MSG</code> or
10930: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10931: <p>Then, the package-specific hacks from
10932: <code class="filename">hacks.mk</code> are included.</p>
10933: <p>Then, various other files follow. Most of them don't have
10934: any dependencies on what they need to have included before or
10935: after them, though some do.</p>
10936: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10937: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10938: restricts the use of these variables to all the files that have
10939: been included before. Appearances in later files will be
10940: silently ignored.</p>
10941: <p>Then, the files for the main targets are included, in the
10942: order of later execution, though the actual order should not
10943: matter.</p>
10944: <p>At last, some more files are included that don't set any
10945: interesting variables but rather just define make targets to be
10946: executed.</p>
10947: </div>
10948: </div>
10949: </div>
1.41 asau 10950: <div class="chapter">
1.1 dsieger 10951: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 10952: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.1 dsieger 10953: <div class="toc">
10954: <p><b>Table of Contents</b></p>
1.100 leot 10955: <dl class="toc">
1.263 wiz 10956: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
10957: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10958: <dd><dl>
1.263 wiz 10959: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
10960: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 10961: </dl></dd>
10962: </dl>
10963: </div>
10964: <p>The pkgsrc infrastructure consists of a large codebase,
10965: and there are many corners where every little bit of a file is
10966: well thought out, making pkgsrc likely to fail as soon as
10967: anything is changed near those parts. To prevent most changes
10968: from breaking anything, a suite of regression tests should go
10969: along with every important part of the pkgsrc infrastructure.
10970: This chapter describes how regression tests work in pkgsrc and
10971: how you can add new tests.</p>
1.41 asau 10972: <div class="sect1">
1.1 dsieger 10973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10974: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.207 leot 10975: <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.10 hubertf 10976: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10977: can simply run that command, which will run all tests in the
1.168 rillig 10978: <code class="filename">regress/</code> directory.</p>
1.1 dsieger 10979: </div>
1.41 asau 10980: <div class="sect1">
1.1 dsieger 10981: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 10982: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.168 rillig 10983: <p>Every directory in the <code class="filename">regress/</code>
10984: directory that contains a file called <code class="filename">spec</code>
1.1 dsieger 10985: is considered a regression test. This file is a shell program
1.10 hubertf 10986: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10987: The following functions can be overridden to suit your
10988: needs.</p>
1.41 asau 10989: <div class="sect2">
1.1 dsieger 10990: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 10991: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 10992: <p>These functions do not take any parameters. Although they
1.266 martin 10993: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.174 leot 10994: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108 rillig 10995: question</a> for details.</p>
1.41 asau 10996: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10997: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 10998: <dd><p>This function prepares the environment for the
10999: test. By default it does nothing.</p></dd>
1.108 rillig 11000: <dt><span class="term"><code class="varname">do_test</code></span></dt>
11001: <dd>
11002: <p>This function runs the actual test. By default,
1.1 dsieger 11003: it calls <code class="varname">TEST_MAKE</code> with the arguments
11004: <code class="varname">MAKEARGS_TEST</code> and writes its output including
11005: error messages into the file
1.108 rillig 11006: <code class="varname">TEST_OUTFILE</code>.</p>
11007: <p>When defining this function, make sure that all output that
11008: needs to be checked is written to the correct output file.
11009: Example:</p>
11010: <pre class="programlisting">
11011: do_test() {
1.112 rillig 11012: echo "Example output"
1.108 rillig 11013: } 1>$TEST_OUTFILE 2>&1
11014: </pre>
11015: </dd>
11016: <dt><span class="term"><code class="varname">check_result</code></span></dt>
11017: <dd>
11018: <p>This function is run after the test and is
1.1 dsieger 11019: typically used to compare the actual output from the one that is
11020: expected. It can make use of the various helper functions from
1.108 rillig 11021: the next section. Example:</p>
11022: <pre class="programlisting">
11023: check_result() {
1.112 rillig 11024: exit_status 0
11025: output_require "Example"
11026: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
11027: output_prohibit "no such file or directory"
1.168 rillig 11028: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 11029: }
11030: </pre>
11031: </dd>
11032: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 11033: <dd><p>This function cleans everything up after the
11034: test has been run. By default it does nothing.</p></dd>
11035: </dl></div>
11036: </div>
1.41 asau 11037: <div class="sect2">
1.1 dsieger 11038: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11039: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.41 asau 11040: <div class="variablelist"><dl class="variablelist">
1.168 rillig 11041: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
11042: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108 rillig 11043: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 11044: <dd><p>This function compares the exitcode of the
1.108 rillig 11045: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 11046: If they differ, the test will fail.</p></dd>
1.108 rillig 11047: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
11048: <dd>
11049: <p>This function checks for each of its parameters
11050: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 11051: extended regular expression. If it does not, the test will
1.108 rillig 11052: fail. Example:</p>
11053: <pre class="programlisting">
11054: output_require "looks fine"
11055: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
11056: </pre>
11057: </dd>
1.177 leot 11058: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.1 dsieger 11059: <dd><p>This function checks for each of its parameters
1.10 hubertf 11060: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 11061: <span class="emphasis"><em>not</em></span> match the extended regular expression.
11062: If any of the regular expressions matches, the test will
11063: fail.</p></dd>
11064: </dl></div>
11065: </div>
11066: </div>
11067: </div>
1.41 asau 11068: <div class="chapter">
1.1 dsieger 11069: <div class="titlepage"><div><div><h2 class="title">
1.266 martin 11070: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 11071: <div class="toc">
11072: <p><b>Table of Contents</b></p>
1.263 wiz 11073: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.1 dsieger 11074: </div>
11075: <p>The pkgsrc system has already been ported to many
11076: operating systems, hardware architectures and compilers. This
11077: chapter explains the necessary steps to make pkgsrc even more
11078: portable.</p>
1.41 asau 11079: <div class="sect1">
1.1 dsieger 11080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11081: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 11082: <p>To port pkgsrc to a new operating system (called
11083: <code class="literal">MyOS</code> in this example), you need to touch the
11084: following files:</p>
1.41 asau 11085: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 11086: <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>
11087: <dd><p>This file contains some basic definitions, for
11088: example the name of the C
11089: compiler.</p></dd>
11090: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
11091: <dd><p>Insert code that defines the variables
11092: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.212 wiz 11093: <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.1 dsieger 11094: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
11095: <code class="varname">APPEND_ELF</code>, and the other variables that
11096: appear in this file.</p></dd>
11097: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
11098: <dd><p>This file contains the platform-specific
11099: definitions that are used by pkgsrc. Start by copying one of the
11100: other files and edit it to your
11101: needs.</p></dd>
11102: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
11103: <dd><p>This file defines the paths to all the tools
11104: that are needed by one or the other package in pkgsrc, as well
11105: as by pkgsrc itself. Find out where these tools are on your
11106: platform and add them.</p></dd>
11107: </dl></div>
11108: <p>Now, you should be able to build some basic packages, like
1.207 leot 11109: <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.1 dsieger 11110: </div>
11111: </div>
11112: </div>
1.41 asau 11113: <div class="appendix">
11114: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 11115: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 11116: <div class="toc">
11117: <p><b>Table of Contents</b></p>
1.100 leot 11118: <dl class="toc">
1.1 dsieger 11119: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
11120: <dd><dl>
11121: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
11122: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
11123: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 11124: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 11125: </dl></dd>
11126: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
11127: </dl>
11128: </div>
11129: <p>We checked to find a piece of software that wasn't in the packages
11130: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 11131: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 11132: present in the tree is beyond us, but it's useful for the purposes of
11133: this exercise.</p>
1.41 asau 11134: <div class="sect1">
1.1 dsieger 11135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11136: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 11137: <div class="sect2">
1.1 dsieger 11138: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11139: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
1.1 dsieger 11140: <pre class="programlisting">
11141: # $NetBSD$
11142: #
11143:
11144: DISTNAME= bison-1.25
11145: CATEGORIES= devel
1.171 rillig 11146: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 11147:
1.29 dholland 11148: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 11149: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 11150: COMMENT= GNU yacc clone
11151:
11152: GNU_CONFIGURE= yes
1.46 wiz 11153: INFO_FILES= yes
1.1 dsieger 11154:
11155: .include "../../mk/bsd.pkg.mk"
11156: </pre>
11157: </div>
1.41 asau 11158: <div class="sect2">
1.1 dsieger 11159: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11160: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
1.1 dsieger 11161: <pre class="programlisting">
11162: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.259 leot 11163: improvements. Why you would want this when Berkeley <a class="citerefentry" href="//man.NetBSD.org/NetBSD-10.1/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 11164: of the NetBSD source tree is beyond me.
11165: </pre>
11166: </div>
1.41 asau 11167: <div class="sect2">
1.1 dsieger 11168: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11169: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
1.1 dsieger 11170: <pre class="programlisting">
11171: @comment $NetBSD$
11172: bin/bison
11173: man/man1/bison.1.gz
11174: share/bison.simple
11175: share/bison.hairy
11176: </pre>
11177: </div>
1.41 asau 11178: <div class="sect2">
1.1 dsieger 11179: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11180: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1 dsieger 11181: <p>The NetBSD package system comes with
1.207 leot 11182: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1 dsieger 11183: which helps to check the contents of these
11184: files. After installation it is quite easy to use, just change to the
1.171 rillig 11185: directory of the package you wish to examine and run
1.10 hubertf 11186: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 11187: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171 rillig 11188: ERROR: Makefile: Each package must define its LICENSE.
11189: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
11190: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
11191: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
11192: 1 error, 2 warnings and 1 note found.
11193: (Run "pkglint -e" to show explanations.)
11194: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 11195: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1 dsieger 11196: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170 rillig 11197: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1 dsieger 11198: -Wall</strong></span> for a very thorough check.</p>
11199: </div>
11200: </div>
1.41 asau 11201: <div class="sect1">
1.1 dsieger 11202: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11203: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
1.1 dsieger 11204: <p>Create the directory where the package lives,
11205: plus any auxiliary directories:</p>
11206: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
11207: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
11208: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
11209: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
11210: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.266 martin 11211: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 12. Package components - files, directories and contents">Chapter 12, <i>Package components - files, directories and contents</i></a>)
1.1 dsieger 11212: then continue with fetching the distfile:</p>
11213: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
11214: >> bison-1.25.tar.gz doesn't seem to exist on this system.
11215: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
11216: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11217: ftp: Error retrieving file: 500 Internal error
11218:
11219: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
11220: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11221: ftp: Error retrieving file: 500 Internal error
11222:
11223: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
11224: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11225: Successfully retrieved file.</pre>
11226: <p>Generate the checksum of the distfile into
11227: <code class="filename">distinfo</code>:</p>
11228: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
11229: <p>Now compile:</p>
11230: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11231: >> Checksum OK for bison-1.25.tar.gz.
11232: ===> Extracting for bison-1.25
11233: ===> Patching for bison-1.25
11234: ===> Ignoring empty patch directory
11235: ===> Configuring for bison-1.25
11236: creating cache ./config.cache
11237: checking for gcc... cc
11238: checking whether we are using GNU C... yes
11239: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
11240: checking how to run the C preprocessor... cc -E
11241: checking for minix/config.h... no
11242: checking for POSIXized ISC... no
11243: checking whether cross-compiling... no
11244: checking for ANSI C header files... yes
11245: checking for string.h... yes
11246: checking for stdlib.h... yes
11247: checking for memory.h... yes
11248: checking for working const... yes
11249: checking for working alloca.h... no
11250: checking for alloca... yes
11251: checking for strerror... yes
11252: updating cache ./config.cache
11253: creating ./config.status
11254: creating Makefile
11255: ===> Building for bison-1.25
11256: 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
11257: 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
11258: 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
11259: 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
11260: 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
11261: 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
11262: 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
11263: 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
11264: 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
11265: 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
11266: 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
11267: 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
11268: 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
11269: 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
11270: 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
11271: 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
11272: 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
11273: 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
11274: 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
11275: 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
11276: 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
11277: 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
11278: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
11279: rm -f bison.s1
11280: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
11281: <p>Everything seems OK, so install the files:</p>
11282: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11283: >> Checksum OK for bison-1.25.tar.gz.
11284: ===> Installing for bison-1.25
11285: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
11286: rm -f /usr/pkg/bin/bison
11287: cd /usr/pkg/share; rm -f bison.simple bison.hairy
11288: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
11289: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
11290: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
11291: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
11292: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
11293: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
11294: ===> Registering installation for bison-1.25</pre>
11295: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 11296: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 11297: binary package, do this now:</p>
11298: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11299: >> Checksum OK for bison-1.25.tar.gz.
11300: ===> Building package for bison-1.25
11301: Creating package bison-1.25.tgz
11302: Registering depends:.
11303: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
11304: <p>Now that you don't need the source and object files
11305: any more, clean up:</p>
11306: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
11307: ===> Cleaning for bison-1.25</pre>
11308: </div>
11309: </div>
1.41 asau 11310: <div class="appendix">
11311: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 11312: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.1 dsieger 11313: <div class="toc">
11314: <p><b>Table of Contents</b></p>
1.100 leot 11315: <dl class="toc">
1.207 leot 11316: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
11317: <dd><dl>
11318: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
11319: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
11320: </dl></dd>
11321: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
11322: <dd><dl>
11323: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
11324: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
11325: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
11326: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
11327: </dl></dd>
11328: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
11329: <dd><dl>
11330: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
11331: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
11332: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
11333: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
11334: </dl></dd>
1.1 dsieger 11335: </dl>
11336: </div>
1.207 leot 11337: <p>
11338: A number of mechanisms are available in pkgsrc to improve the security of the
11339: resulting system. This page describes the mechanisms, and gives hints
11340: about detecting and fixing problems.
11341: </p>
11342: <p>
11343: Mechanisms can be enabled individually in
11344: <code class="filename">mk.conf</code>, and are
11345: individually described below.
11346: </p>
11347: <p>
11348: Typically, a feature will cause some programs to fail to build or work
11349: when first enabled. This can be due to latent problems in the
11350: program, and can be due to other reasons. After enough testing to
11351: have confidence that user problems will be quite rare, individual
11352: mechanisms will be enabled by default.
11353: </p>
11354: <p>
11355: For each mechanism, see the Caveats section below for an explanation
11356: of what might go wrong at compile time and at run time, and how to
11357: notice and address these problems.
11358: </p>
1.41 asau 11359: <div class="sect1">
1.1 dsieger 11360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11361: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
1.207 leot 11362: <div class="sect2">
11363: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11364: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
1.207 leot 11365: <div class="sect3">
11366: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11367: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
1.207 leot 11368: <p>
11369: This allows substitute wrappers to be used for some commonly used
11370: library functions that do not have built-in bounds checking - but
11371: could in some cases.
11372: </p>
11373: <p>
11374: Two mitigation levels are available:
11375: </p>
11376: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11377: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
11378: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
11379: </ul></div>
11380: <p>
11381: "strong" has been enabled by default since pkgsrc-2017Q3.
11382: </p>
11383: </div>
11384: <div class="sect3">
11385: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11386: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
1.207 leot 11387: <p>
11388: This enables a stack-smashing protection mitigation. It is done by adding a
11389: guard variable to functions with vulnerable objects. The guards are initialized
11390: when a function is entered and then checked when the function exits. The guard
11391: check will fail and the program forcibly exited if the variable was modified in
11392: the meantime. This can happen in case of buffer overflows or memory corruption,
11393: and therefore exposing these bugs.
11394: </p>
11395: <p>
11396: Different mitigation levels are available:
11397: </p>
11398: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11399: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
11400: by the compiler;</p></li>
11401: <li class="listitem"><p>"all", which will protect every function;</p></li>
11402: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
11403: two settings above.</p></li>
11404: </ul></div>
11405: <p>
11406: This mitigation is supported by both GCC and clang. It may be supported in
11407: additional compilers, possibly under a different name. It is particularly useful
11408: for unsafe programming languages, such as C/C++.
11409: </p>
11410: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11411: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
11412: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
11413: </ul></div>
11414: <p>More details can be found here:</p>
11415: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11416: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
11417: </p></li></ul></div>
11418: </div>
11419: <div class="sect3">
11420: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11421: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
1.207 leot 11422: <p>
11423: This requests the creation of PIE (Position Independent Executables) for all
11424: executables. The PIE mechanism is normally used for shared libraries, so that
11425: they can be loaded at differing addresses at runtime. PIE itself does not have
11426: useful security properties; however, it is necessary to fully leverage some,
11427: such as ASLR. Some operating systems support Address Space Layout Randomization
11428: (ASLR), which causes different addresses to be used each time a program is run.
11429: This makes it more difficult for an attacker to guess addresses and thus makes
11430: exploits harder to construct. With PIE, ASLR can really be applied to the entire
11431: program, instead of the stack and heap only.
11432: </p>
11433: <p>
11434: PIE executables will only be built for toolchains that are known to support PIE.
11435: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
11436: </p>
11437: <p>
11438: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
11439: </p>
1.1 dsieger 11440: </div>
1.210 gutterid 11441: <div class="sect3">
11442: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11443: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.207 leot 11444: <p>
11445: This also makes the exploitation of some security vulnerabilities more
11446: difficult in some cases.
11447: </p>
11448: <p>Two different mitigation levels are available:</p>
11449: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11450: <li class="listitem"><p>
1.219 nia 11451: partial (the default): the ELF sections are reordered so that internal data sections
1.207 leot 11452: precede the program's own data sections, and non-PLT GOT is read-only;
11453: </p></li>
11454: <li class="listitem"><p>
11455: full: in addition to partial RELRO, every relocation is performed immediately
1.218 nia 11456: when starting the program, allowing the entire GOT to be read-only. This
11457: can greatly slow down startup of large programs.
1.207 leot 11458: </p></li>
11459: </ul></div>
11460: <p>
11461: This is currently supported by GCC. Many software distributions now enable this
1.220 nia 11462: feature by default, at the "partial" level.
1.207 leot 11463: </p>
11464: <p>
11465: More details can be found here:
11466: </p>
11467: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11468: <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>
11469: </p></li></ul></div>
1.1 dsieger 11470: </div>
1.219 nia 11471: </div>
11472: <div class="sect2">
11473: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11474: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
1.219 nia 11475: <div class="sect3">
11476: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11477: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
1.219 nia 11478: <p>
11479: With this option, pkgsrc will try to build packages reproducibly. This allows
11480: packages built from the same tree and with the same options, to produce
11481: identical results bit by bit. This option should be combined with ASLR and
11482: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
11483: attackers attempting to exploit security vulnerabilities.
11484: </p>
11485: <p>
11486: More details can be found here:
11487: </p>
11488: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11489: <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>
11490: </p></li></ul></div>
11491: <p>
11492: More work likely needs to be done before pkgsrc is fully reproducible.
11493: </p>
11494: </div>
1.207 leot 11495: <div class="sect3">
11496: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11497: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.207 leot 11498: <p>
11499: This uses <code class="literal">-fstack-check</code> with GCC for
11500: another stack protection mitigation.
11501: </p>
11502: <p>
11503: It asks the compiler to generate code verifying that it does not corrupt the
11504: stack. According to GCC's manual page, this is really only useful for
11505: multi-threaded programs.
11506: </p>
1.1 dsieger 11507: </div>
11508: </div>
11509: </div>
1.41 asau 11510: <div class="sect1">
1.1 dsieger 11511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11512: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
1.207 leot 11513: <div class="sect2">
11514: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11515: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
1.207 leot 11516: <div class="sect3">
11517: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11518: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
1.207 leot 11519: <p>
11520: A number of packages may fail to build with this option enabled. The
11521: failures are often related to the absence of the <code class="literal">-fPIC</code>
11522: compilation flag when building libraries or executables (or ideally
11523: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
11524: <code class="varname">CFLAGS</code> already, but requires the package to
11525: actually support it.
11526: </p>
11527: <div class="sect4">
11528: <div class="titlepage"><div><div><h5 class="title">
1.266 martin 11529: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
1.207 leot 11530: <p>
11531: These instructions are meant as a reference only; they likely need to be adapted
11532: for many packages individually.
11533: </p>
11534: <p>
11535: For packages using <code class="filename">Makefiles</code>:
11536: </p>
11537: <pre class="programlisting">
11538: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
11539: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
11540: </pre>
11541: <p>
11542: For packages using <code class="filename">Imakefiles</code>:
11543: </p>
11544: <pre class="programlisting">
11545: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
11546: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
11547: </pre>
11548: </div>
11549: </div>
11550: <div class="sect3">
11551: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11552: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
1.207 leot 11553: <p>
11554: Some programs may fail to run, or crash at random times once built as PIE. Two
11555: scenarios are essentially possible. This is nearly always due to a bug in
11556: the program being exposed due to ASLR.
11557: </p>
11558: </div>
11559: <div class="sect3">
11560: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11561: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
1.207 leot 11562: <p>
11563: Ideally, packages should be fixed for compatibility with MKPIE.
11564: However, in some cases this is very difficult, due to complex build systems,
11565: packages using non-standard toolchains, or programming languages with odd
11566: bootstrapping mechanisms.
11567: </p>
11568: <p>
11569: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
11570: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
11571: <code class="filename">bsd.prefs.mk</code> is included.
11572: </p>
11573: </div>
11574: </div>
11575: <div class="sect2">
11576: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11577: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
1.207 leot 11578: <div class="sect3">
11579: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11580: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
1.207 leot 11581: <p>
11582: This feature makes use of pre-processing directives to look for hardened,
11583: alternative implementations of essential library calls. Some programs may fail
11584: to build as a result; this usually happens for those trying too hard to be
11585: portable, or otherwise abusing definitions in the standard library.
11586: </p>
11587: </div>
11588: <div class="sect3">
11589: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11590: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
1.207 leot 11591: <p>
11592: This feature may cause some programs to crash, usually indicating an
11593: actual bug in the program. The fix will typically involve patching the
11594: original program's source code.
11595: </p>
11596: </div>
11597: <div class="sect3">
11598: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11599: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
1.207 leot 11600: <p>
11601: At least in the case of GCC, FORTIFY will only be applied if optimization is
11602: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
11603: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
11604: optimization level. This cannot easily be applied globally, as some packages
11605: may require specific optimization levels.
11606: </p>
11607: </div>
11608: <div class="sect3">
11609: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11610: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
1.207 leot 11611: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11612: <h3 class="title">Note</h3>
11613: <p>FORTIFY should not be disabled to work around runtime crashes in
11614: the program! This is a very bad idea and will expose you to security
11615: vulnerabilities.
11616: </p>
11617: </div>
11618: <p>
11619: To disable FORTIFY on a per-package basis, set the following
11620: in the package's <code class="filename">Makefile</code>
11621: before <code class="filename">bsd.prefs.mk</code> is included:
11622: </p>
11623: <pre class="programlisting">
11624: FORTIFY_SUPPORTED= no
11625: </pre>
11626: </div>
11627: </div>
11628: <div class="sect2">
11629: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11630: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
1.207 leot 11631: <div class="sect3">
11632: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11633: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
1.207 leot 11634: <p>
11635: For better protection, full RELRO requires every symbol to be resolved when the
11636: program starts, rather than simply when required at run-time. This will have
11637: more impact on programs using a lot of symbols, or linked to libraries exposing
11638: a lot of symbols. Therefore, daemons or programs otherwise running in
11639: background are affected only when started. Programs loading plug-ins at
11640: run-time are affected when loading the plug-ins.
11641: </p>
11642: <p>
11643: The impact is not expected to be noticeable on modern hardware, except in some
11644: cases for big programs.
11645: </p>
11646: </div>
11647: <div class="sect3">
11648: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11649: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
1.207 leot 11650: <p>
11651: Some programs handle plug-ins and dependencies in a way that conflicts with
11652: RELRO: for instance, with an initialization routine listing any other plug-in
11653: required. With full RELRO, the missing symbols are resolved before the
11654: initialization routine can run, and the dynamic loader will not be able to find
11655: them directly and abort as a result. Unfortunately, this is how Xorg loads its
11656: drivers. Partial RELRO can be applied instead in this case.
11657: </p>
11658: </div>
11659: <div class="sect3">
11660: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11661: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
1.207 leot 11662: <p>
11663: To disable RELRO on a per-package basis, set the following
11664: in the package's <code class="filename">Makefile</code>
11665: before <code class="filename">bsd.prefs.mk</code> is included:
11666: </p>
11667: <pre class="programlisting">
11668: RELRO_SUPPORTED= no
11669: </pre>
1.209 nia 11670: <p>
11671: It is also possible to at most enable partial RELRO, by
11672: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
11673: </p>
1.207 leot 11674: </div>
11675: </div>
11676: <div class="sect2">
11677: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11678: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
1.207 leot 11679: <div class="sect3">
11680: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11681: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
1.207 leot 11682: <p>
11683: The stack-smashing protection provided by this option does not work for some
11684: programs. The most common situation in which this happens is when the program
11685: allocates variables on the stack, with the size determined at run-time.
11686: </p>
11687: </div>
11688: <div class="sect3">
11689: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11690: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
1.207 leot 11691: <p>
11692: Again, this feature may cause some programs to crash via a
11693: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
11694: </p>
11695: <p>
11696: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
11697: messages are sent and - by default -
11698: appended to <code class="filename">/var/log/messages</code>, e.g.:
11699: </p>
11700: <pre class="programlisting">
11701: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
11702: </pre>
11703: <p>
11704: (where <code class="literal">hostname</code> is the hostname(1) and
11705: <code class="literal">program</code> is the basename(1) of the program crashed).
11706: </p>
11707: <p>
11708: Patching the original program is then required.
11709: </p>
11710: <p>
11711: Rebuilding the package via:
11712: </p>
11713: <pre class="programlisting">
11714: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
11715: </pre>
11716: <p>
11717: and inspecting the backtrace of the coredump via the debugger
11718: should point out the problematic call by inspecting the frame
11719: calling the _chk() (SSP) function.
11720: </p>
11721: </div>
11722: <div class="sect3">
11723: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11724: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
1.207 leot 11725: <p>
11726: The compiler emits extra code when using this feature: a check for buffer
11727: overflows is performed when entering and exiting functions, requiring an extra
11728: variable on the stack. The level of protection can otherwise be adjusted to
11729: affect only those functions considered more sensitive by the compiler (with
11730: -fstack-protector instead of -fstack-protector-all).
11731: </p>
11732: <p>
11733: The impact is not expected to be noticeable on modern hardware. However,
11734: programs with a hard requirement to run at the fastest possible speed should
11735: avoid using this feature, or using libraries built with this feature.
11736: </p>
11737: </div>
11738: <div class="sect3">
11739: <div class="titlepage"><div><div><h4 class="title">
1.266 martin 11740: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
1.207 leot 11741: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11742: <h3 class="title">Note</h3>
11743: <p>SSP should not be disabled to work around runtime crashes in
11744: the program! This is a very bad idea and will expose you to security
11745: vulnerabilities.</p>
11746: </div>
11747: <p>
11748: To disable SSP on a per-package basis, set the following
11749: in the package's <code class="filename">Makefile</code>
11750: before <code class="filename">bsd.prefs.mk</code> is included:
11751: </p>
11752: <pre class="programlisting">
11753: SSP_SUPPORTED= no
11754: </pre>
11755: </div>
11756: </div>
11757: </div>
11758: <div class="sect1">
11759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11760: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
1.207 leot 11761: <p>
11762: The illusion of security is worse than having no security at all. This section
11763: lists a number of ways to ensure the security features requested are actually
11764: effective.
11765: </p>
11766: <p>
11767: These instructions were obtained and tested on a system derived from NetBSD 7
11768: (amd64). YMMV.
11769: </p>
11770: <div class="sect2">
11771: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11772: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
1.207 leot 11773: <p>
11774: The ELF executable type in use changes for binaries built as PIE; without:
11775: </p>
11776: <pre class="programlisting">
11777: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
11778: /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
11779: </pre>
11780: <p>as opposed to the following binary, built as PIE:</p>
11781: <pre class="programlisting">
11782: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
11783: /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
11784: </pre>
11785: <p>
11786: The latter result is then what is expected.
11787: </p>
11788: </div>
11789: <div class="sect2">
11790: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11791: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
1.207 leot 11792: <p>
11793: The following command should list a section called RELRO:
11794: </p>
11795: <pre class="programlisting">
11796: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
11797:
11798: /path/to/bin/ary: file format elf64-x86-64
11799:
11800: Program Header:
11801: [...]
11802: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
11803: </pre>
11804: <p>
11805: This check is now performed automatically if
11806: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
11807: </p>
11808: </div>
11809: <div class="sect2">
11810: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11811: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
1.207 leot 11812: <p>
11813: The dynamic loader will apply RELRO immediately when detecting the presence of
11814: the <code class="varname">BIND_NOW</code> flag:
11815: </p>
11816: <pre class="programlisting">
11817: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
11818:
11819: /path/to/bin/ary: file format elf64-x86-64
11820:
11821: Dynamic Section:
11822: [...]
11823: BIND_NOW 0x0000000000000000
11824: </pre>
11825: <p>
11826: This has to be combined with partial RELRO (see above) to be fully efficient.
11827: </p>
11828: <p>
11829: This check is now performed automatically (where supported) if
11830: <code class="varname">PKG_DEVELOPER</code> is set.
11831: </p>
11832: </div>
11833: <div class="sect2">
11834: <div class="titlepage"><div><div><h3 class="title">
1.266 martin 11835: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.208 nia 11836: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11837: <h3 class="title">Note</h3>
11838: <p>
11839: Checking for SSP using this method only works where the operating system
11840: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
11841: on recent NetBSD/FreeBSD/Linux versions.
11842: </p>
11843: </div>
1.207 leot 11844: <p>
11845: Building objects, binaries and libraries with SSP will affect the presence of
11846: additional symbols in the resulting file:
11847: </p>
11848: <pre class="programlisting">
11849: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
11850: [...]
11851: U __stack_chk_fail
11852: 0000000000600ea0 B __stack_chk_guard
11853: </pre>
11854: <p>
11855: This is an indicator that the program was indeed built with support for SSP.
11856: </p>
11857: <p>
11858: This check is now performed automatically (where supported) if
11859: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
11860: </p>
11861: </div>
11862: </div>
11863: </div>
11864: <div class="appendix">
11865: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 11866: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
1.207 leot 11867: <div class="toc">
11868: <p><b>Table of Contents</b></p>
11869: <dl class="toc">
11870: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
11871: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
11872: </dl>
11873: </div>
11874: <div class="sect1">
11875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11876: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
1.207 leot 11877: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11878: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11879: => figlet221.tar.gz doesn't seem to exist on this system.
11880: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11881: => [172219 bytes]
11882: Connected to ftp.plig.net.
11883: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11884: 331 Guest login ok, send your complete e-mail address as password.
11885: 230-You are user #5 of 500 simultaneous users allowed.
11886: 230-
11887: 230- ___ _ _ _
11888: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11889: 230- | _| _| . |_| . | | | . |_| . | _| . |
11890: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11891: 230- |_| |_| |___| |___|
11892: 230-
11893: 230-** Welcome to ftp.plig.org **
11894: 230-
11895: 230-Please note that all transfers from this FTP site are logged. If you
11896: 230-do not like this, please disconnect now.
11897: 230-
11898: 230-This archive is available via
11899: 230-
11900: 230-HTTP: http://ftp.plig.org/
11901: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11902: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11903: 230-
11904: 230-Please email comments, bug reports and requests for packages to be
11905: 230-mirrored to ftp-admin@plig.org.
11906: 230-
11907: 230-
11908: 230 Logged in anonymously.
11909: Remote system type is UNIX.
11910: Using binary mode to transfer files.
11911: 200 Type okay.
11912: 250 "/pub" is new cwd.
11913: 250-"/pub/figlet" is new cwd.
11914: 250-
11915: 250-Welcome to the figlet archive at ftp.figlet.org
11916: 250-
11917: 250- ftp://ftp.figlet.org/pub/figlet/
11918: 250-
11919: 250-The official FIGlet web page is:
11920: 250- http://www.figlet.org/
11921: 250-
11922: 250-If you have questions, please mailto:info@figlet.org. If you want to
11923: 250-contribute a font or something else, you can email us.
11924: 250
11925: 250 "/pub/figlet/program" is new cwd.
11926: 250 "/pub/figlet/program/unix" is new cwd.
11927: local: figlet221.tar.gz remote: figlet221.tar.gz
11928: 502 Unimplemented command.
11929: 227 Entering Passive Mode (195,40,6,41,246,104)
11930: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11931: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11932: 226 Transfer completed.
11933: 172219 bytes received in 00:02 (75.99 KB/s)
11934: 221 Goodbye.
11935: => Checksum OK for figlet221.tar.gz.
11936: ===> Extracting for figlet-2.2.1nb2
11937: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11938: ===> Patching for figlet-2.2.1nb2
11939: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11940: ===> Overriding tools for figlet-2.2.1nb2
11941: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11942: ===> Configuring for figlet-2.2.1nb2
11943: ===> Building for figlet-2.2.1nb2
11944: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11945: chmod a+x figlet
11946: gcc -O2 -o chkfont chkfont.c
11947: => Unwrapping files-to-be-installed.
11948: <code class="prompt">#</code>
11949: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11950: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11951: ===> Installing for figlet-2.2.1nb2
11952: install -d -o root -g wheel -m 755 /usr/pkg/bin
11953: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11954: mkdir -p /usr/pkg/share/figlet
11955: cp figlet /usr/pkg/bin
11956: cp chkfont /usr/pkg/bin
11957: chmod 555 figlist showfigfonts
11958: cp figlist /usr/pkg/bin
11959: cp showfigfonts /usr/pkg/bin
11960: cp fonts/*.flf /usr/pkg/share/figlet
11961: cp fonts/*.flc /usr/pkg/share/figlet
11962: cp figlet.6 /usr/pkg/man/man6
11963: ===> Registering installation for figlet-2.2.1nb2
11964: <code class="prompt">#</code></pre>
11965: </div>
11966: <div class="sect1">
11967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 11968: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
1.207 leot 11969: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11970: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11971: ===> Packaging figlet-2.2.1nb2
11972: ===> Building binary package for figlet-2.2.1nb2
11973: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11974: Using SrcDir value of /usr/pkg
11975: Registering depends:.
11976: <code class="prompt">#</code></pre>
11977: </div>
11978: </div>
11979: <div class="appendix">
11980: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 11981: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.207 leot 11982: <div class="toc">
11983: <p><b>Table of Contents</b></p>
11984: <dl class="toc">
11985: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11986: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11987: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11988: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11989: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
11990: <code class="filename">stable</code>,
11991: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11992: source packages</a></span></dt>
11993: </dl>
11994: </div>
11995: <p>As in other big projects, the directory layout of pkgsrc
11996: is quite complex for newbies. This chapter explains where you
11997: find things on the FTP server. The base directory on
11998: <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>.
11999: On other servers it may be different, but inside this directory,
12000: everything should look the same, no matter on which server you
12001: are. This directory contains some subdirectories, which are
12002: explained below.</p>
12003: <div class="sect1">
12004: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 12005: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.207 leot 12006: <p>The directory <code class="filename">distfiles</code> contains lots
12007: of archive files from all pkgsrc packages, which are mirrored
12008: here. The subdirectories are called after their package names
12009: and are used when the distributed files have names that don't
12010: explicitly contain a version number or are otherwise too generic
12011: (for example <code class="filename">release.tar.gz</code>).</p>
12012: </div>
12013: <div class="sect1">
12014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 12015: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.207 leot 12016: <p>This directory contains things that individual pkgsrc
12017: developers find worth publishing.</p>
12018: </div>
12019: <div class="sect1">
12020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 12021: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.207 leot 12022: <p>This directory contains binary packages for the various
12023: platforms that are supported by pkgsrc.
12024: 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>
12025: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
12026: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
12027: operating system for which the packages have been built. The
12028: name is taken from the output of the <span class="command"><strong>uname</strong></span>
12029: command, so it may differ from the one you are used to
12030: hear.</p></li>
12031: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
12032: architecture of the platform for which the packages have been
12033: built. It also includes the <code class="varname">ABI</code> (Application
12034: Binary Interface) for platforms that have several of
12035: them.</p></li>
12036: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.255 wiz 12037: the operating system. Typically it is the version defining an
12038: ABI, e.g. 9.0.</p></li>
1.207 leot 12039: <li class="listitem"><p><code class="varname">TAG</code> is either
1.255 wiz 12040: <code class="literal">20<em class="replaceable"><code>YY</code></em>Q<em class="replaceable"><code>N</code></em></code>
12041: for a stable branch, or <code class="literal">current</code> for packages
1.207 leot 12042: built from the HEAD branch. The latter should only be used when
1.255 wiz 12043: the packages are updated on a regular basis.</p></li>
1.207 leot 12044: </ul></div>
1.255 wiz 12045: <p>The rationale for this scheme is that users can first
12046: search by OPSYS and ARCH, since these are more or less
12047: unchangeable. After that, there is a management set of
12048: directories with OSVERSION and TAG.</p>
12049: <p>See also <code class="filename">README.md</code> in
12050: <code class="filename">packages</code> for more details, including
12051: about symlinks.</p>
1.207 leot 12052: <p>In each of these directories, there is a
12053: whole binary packages collection for a specific platform. It has a directory called
12054: <code class="filename">All</code> which contains all binary packages.
1.255 wiz 12055: </p>
1.207 leot 12056: </div>
12057: <div class="sect1">
12058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 12059: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 12060: <p>Here are the reports from bulk builds, for those who want
12061: to fix packages that didn't build on some of the platforms. The
1.266 martin 12062: 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.8 rillig 12063: </div>
1.41 asau 12064: <div class="sect1">
1.8 rillig 12065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 12066: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.148 leot 12067: <code class="filename">stable</code>,
1.22 jakllsch 12068: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 12069: source packages</h2></div></div></div>
1.266 martin 12070: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 12071: that is the files that define how to create binary packages from
12072: source archives.</p>
1.149 leot 12073: <p>Each of the <code class="filename">current</code>,
12074: <code class="filename">stable</code> and
12075: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
12076: directories share the same structure. They each contain a
12077: <code class="filename">pkgsrc</code> directory and
12078: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 12079: <p>The directory <code class="filename">pkgsrc</code> contains a
12080: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 12081: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
12082: as the directory, ready to be downloaded as a whole.</p>
12083: <p>The <code class="filename">current</code> directory contains files
12084: related to the HEAD branch of the CVS repository.
12085: In this directory there is an additional file called
12086: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
12087: all pkgsrc <code class="filename">README</code>s with information about
12088: categories and packages.
12089: </p>
12090: <p>The <code class="filename">stable</code> directory is a symlink to
12091: the latest
12092: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
12093: </p>
12094: <p>The
12095: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
12096: directories contain files related to the
12097: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
12098: stable branch of the CVS repository. In these directories there is
12099: an additional file called
12100: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.{bz,gz,xz}</code>,
1.1 dsieger 12101: which contains the state of pkgsrc when it was branched.</p>
12102: </div>
12103: </div>
1.41 asau 12104: <div class="appendix">
12105: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 12106: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.154 rillig 12107: <p>
12108: The following list contains all help topics that are available
12109: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
12110: </p>
1.156 leot 12111: <table border="0" summary="Simple list" class="simplelist">
12112: <tr>
12113: <td>#!</td>
12114: <td>-lintl</td>
12115: </tr>
12116: <tr>
1.205 wiz 12117: <td>32bit</td>
1.156 leot 12118: <td>64bit</td>
1.205 wiz 12119: </tr>
12120: <tr>
1.156 leot 12121: <td>ABI</td>
1.205 wiz 12122: <td>ACCEPTABLE_LICENSES</td>
1.156 leot 12123: </tr>
12124: <tr>
12125: <td>ACROREAD_FONTPATH</td>
1.265 leot 12126: <td>AFAIK</td>
1.156 leot 12127: </tr>
12128: <tr>
1.205 wiz 12129: <td>AIX</td>
1.265 leot 12130: <td>ALLOW_NETWORK_ACCESS</td>
1.156 leot 12131: </tr>
12132: <tr>
1.243 gutterid 12133: <td>ALLOW_NEWER_COMPILER</td>
1.265 leot 12134: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.156 leot 12135: </tr>
12136: <tr>
1.243 gutterid 12137: <td>ALL_ENV</td>
1.265 leot 12138: <td>ALSA_PC</td>
1.254 wiz 12139: </tr>
12140: <tr>
1.249 gutterid 12141: <td>ALTERNATIVES_SRC</td>
1.265 leot 12142: <td>AMANDA_TMP</td>
1.263 wiz 12143: </tr>
12144: <tr>
12145: <td>AMANDA_USER</td>
1.265 leot 12146: <td>AMANDA_VAR</td>
1.258 wiz 12147: </tr>
12148: <tr>
1.263 wiz 12149: <td>APACHE_GROUP</td>
1.265 leot 12150: <td>APACHE_MODULE_NAME</td>
1.246 leot 12151: </tr>
12152: <tr>
1.263 wiz 12153: <td>APACHE_MODULE_SRC</td>
1.265 leot 12154: <td>APACHE_MODULE_SRCDIR</td>
1.241 rillig 12155: </tr>
12156: <tr>
1.263 wiz 12157: <td>APACHE_PKG_PREFIX</td>
1.265 leot 12158: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.238 wiz 12159: </tr>
12160: <tr>
1.263 wiz 12161: <td>APACHE_SUEXEC_DOCROOT</td>
1.265 leot 12162: <td>APACHE_USER</td>
1.233 wiz 12163: </tr>
12164: <tr>
1.263 wiz 12165: <td>ARGMAX_REQ</td>
1.265 leot 12166: <td>ARG_MAX</td>
1.227 wiz 12167: </tr>
12168: <tr>
1.263 wiz 12169: <td>ARLA_CACHE</td>
1.265 leot 12170: <td>AUDIT_PACKAGES_FLAGS</td>
1.223 nia 12171: </tr>
12172: <tr>
1.263 wiz 12173: <td>AUTOCONF_REQD</td>
1.265 leot 12174: <td>AUTOMAKE_OVERRIDE</td>
1.258 wiz 12175: </tr>
12176: <tr>
1.263 wiz 12177: <td>AUTOMAKE_REQD</td>
1.265 leot 12178: <td>AUTO_MKDIRS</td>
1.217 rillig 12179: </tr>
12180: <tr>
1.263 wiz 12181: <td>AUX</td>
1.265 leot 12182: <td>BDB185_DEFAULT</td>
1.214 leot 12183: </tr>
12184: <tr>
1.263 wiz 12185: <td>BDBBASE</td>
1.265 leot 12186: <td>BDB_ACCEPTED</td>
1.212 wiz 12187: </tr>
12188: <tr>
1.263 wiz 12189: <td>BDB_DEFAULT</td>
1.265 leot 12190: <td>BDB_LIBS</td>
1.197 leot 12191: </tr>
12192: <tr>
1.263 wiz 12193: <td>BDB_TYPE</td>
1.265 leot 12194: <td>BINCIMAP_GROUP</td>
1.177 leot 12195: </tr>
12196: <tr>
1.263 wiz 12197: <td>BINCIMAP_LOG_USER</td>
1.265 leot 12198: <td>BINCIMAP_USER</td>
1.161 leot 12199: </tr>
12200: <tr>
1.263 wiz 12201: <td>BIND_DIR</td>
1.265 leot 12202: <td>BIND_GROUP</td>
1.159 rillig 12203: </tr>
12204: <tr>
1.263 wiz 12205: <td>BIND_USER</td>
1.265 leot 12206: <td>BINOWN</td>
1.156 leot 12207: </tr>
12208: <tr>
1.263 wiz 12209: <td>BINPKG_SITES</td>
1.265 leot 12210: <td>BIN_INSTALL_FLAGS</td>
1.254 wiz 12211: </tr>
12212: <tr>
1.263 wiz 12213: <td>BISON_PKGDATADIR</td>
1.265 leot 12214: <td>BLAS</td>
1.156 leot 12215: </tr>
12216: <tr>
1.263 wiz 12217: <td>BLAS_ACCEPTED</td>
1.265 leot 12218: <td>BLAS_C_INTERFACE</td>
1.156 leot 12219: </tr>
12220: <tr>
1.263 wiz 12221: <td>BLAS_INCLUDES</td>
1.265 leot 12222: <td>BLAS_INDEX64</td>
1.156 leot 12223: </tr>
12224: <tr>
1.263 wiz 12225: <td>BLAS_LIBS</td>
1.265 leot 12226: <td>BLAS_PC</td>
1.156 leot 12227: </tr>
12228: <tr>
1.263 wiz 12229: <td>BLAS_TYPE</td>
1.265 leot 12230: <td>BOOTSTRAP_DEPENDS</td>
1.156 leot 12231: </tr>
12232: <tr>
1.263 wiz 12233: <td>BROKEN</td>
1.265 leot 12234: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.156 leot 12235: </tr>
12236: <tr>
1.263 wiz 12237: <td>BROKEN_ON_PLATFORM</td>
1.265 leot 12238: <td>BSDSRCDIR</td>
1.156 leot 12239: </tr>
12240: <tr>
1.265 leot 12241: <td>BSD_MAKE_ENV</td>
1.268 wiz 12242: <td>BUILDLINK_AUTO_DIRS</td>
1.156 leot 12243: </tr>
12244: <tr>
1.265 leot 12245: <td>BUILDLINK_AUTO_VARS</td>
1.268 wiz 12246: <td>BUILDLINK_CFLAGS</td>
1.156 leot 12247: </tr>
12248: <tr>
1.265 leot 12249: <td>BUILDLINK_CONTENTS_FILTER</td>
1.268 wiz 12250: <td>BUILDLINK_CPPFLAGS</td>
1.198 leot 12251: </tr>
12252: <tr>
1.265 leot 12253: <td>BUILDLINK_DEPMETHOD</td>
1.268 wiz 12254: <td>BUILDLINK_FILES</td>
1.229 gutterid 12255: </tr>
12256: <tr>
1.265 leot 12257: <td>BUILDLINK_FILES_CMD</td>
1.268 wiz 12258: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.156 leot 12259: </tr>
12260: <tr>
1.265 leot 12261: <td>BUILDLINK_LDFLAGS</td>
1.268 wiz 12262: <td>BUILDLINK_LIBS</td>
1.205 wiz 12263: </tr>
12264: <tr>
1.265 leot 12265: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.268 wiz 12266: <td>BUILDLINK_PKGNAME</td>
1.156 leot 12267: </tr>
12268: <tr>
1.265 leot 12269: <td>BUILDLINK_PREFIX</td>
1.268 wiz 12270: <td>BUILDLINK_RPATHDIRS</td>
1.156 leot 12271: </tr>
12272: <tr>
1.265 leot 12273: <td>BUILDLINK_TREE</td>
1.268 wiz 12274: <td>BUILD_DEFS</td>
1.156 leot 12275: </tr>
12276: <tr>
1.265 leot 12277: <td>BUILD_DEFS_EFFECTS</td>
1.268 wiz 12278: <td>BUILD_DEPENDS</td>
1.156 leot 12279: </tr>
12280: <tr>
1.265 leot 12281: <td>BUILD_DIRS</td>
1.268 wiz 12282: <td>BUILD_ENV_SHELL</td>
1.156 leot 12283: </tr>
12284: <tr>
1.265 leot 12285: <td>BUILD_MAKE_CMD</td>
1.268 wiz 12286: <td>BUILD_MAKE_FLAGS</td>
1.156 leot 12287: </tr>
12288: <tr>
1.265 leot 12289: <td>BUILD_TARGET</td>
1.268 wiz 12290: <td>BUILTIN_FIND_FILES</td>
1.156 leot 12291: </tr>
12292: <tr>
1.265 leot 12293: <td>BUILTIN_FIND_FILES_VAR</td>
1.268 wiz 12294: <td>BUILTIN_FIND_GREP</td>
1.156 leot 12295: </tr>
12296: <tr>
1.265 leot 12297: <td>BUILTIN_FIND_HEADERS</td>
1.268 wiz 12298: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.156 leot 12299: </tr>
12300: <tr>
1.265 leot 12301: <td>BUILTIN_FIND_PKGCONFIG</td>
1.268 wiz 12302: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.156 leot 12303: </tr>
12304: <tr>
1.265 leot 12305: <td>BUILTIN_PKG</td>
1.268 wiz 12306: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.156 leot 12307: </tr>
12308: <tr>
1.265 leot 12309: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.268 wiz 12310: <td>BUILTIN_VERSION_SCRIPT</td>
1.195 gutterid 12311: </tr>
12312: <tr>
1.265 leot 12313: <td>BUILTIN_X11_TYPE</td>
1.268 wiz 12314: <td>BUILTIN_X11_VERSION</td>
1.156 leot 12315: </tr>
12316: <tr>
1.265 leot 12317: <td>CACTI_GROUP</td>
1.268 wiz 12318: <td>CACTI_USER</td>
1.156 leot 12319: </tr>
12320: <tr>
1.265 leot 12321: <td>CANNA_GROUP</td>
1.268 wiz 12322: <td>CANNA_USER</td>
1.156 leot 12323: </tr>
12324: <tr>
1.265 leot 12325: <td>CAT</td>
1.268 wiz 12326: <td>CBLAS_LIBS</td>
1.156 leot 12327: </tr>
12328: <tr>
1.265 leot 12329: <td>CBLAS_PC</td>
1.268 wiz 12330: <td>CCACHE_BASE</td>
1.156 leot 12331: </tr>
12332: <tr>
1.265 leot 12333: <td>CCACHE_DIR</td>
1.268 wiz 12334: <td>CCACHE_LOGFILE</td>
1.156 leot 12335: </tr>
12336: <tr>
1.265 leot 12337: <td>CCACHE_RECACHE</td>
1.268 wiz 12338: <td>CC_VERSION</td>
1.156 leot 12339: </tr>
12340: <tr>
1.268 wiz 12341: <td>CDRECORD_CONF</td>
1.271 wiz 12342: <td>CDROM_PKG_URL_DIR</td>
1.156 leot 12343: </tr>
12344: <tr>
1.268 wiz 12345: <td>CDROM_PKG_URL_HOST</td>
1.271 wiz 12346: <td>CHANGES</td>
1.156 leot 12347: </tr>
12348: <tr>
1.268 wiz 12349: <td>CHECKOUT_DATE</td>
1.271 wiz 12350: <td>CHECK_COMPILER</td>
1.223 nia 12351: </tr>
12352: <tr>
1.268 wiz 12353: <td>CHECK_FAKEHOME</td>
1.271 wiz 12354: <td>CHECK_FILES</td>
1.263 wiz 12355: </tr>
12356: <tr>
1.268 wiz 12357: <td>CHECK_FILES_ONLY_PREFIX</td>
1.271 wiz 12358: <td>CHECK_FILES_SKIP</td>
1.258 wiz 12359: </tr>
12360: <tr>
1.268 wiz 12361: <td>CHECK_FILES_STRICT</td>
1.271 wiz 12362: <td>CHECK_HEADERS</td>
1.254 wiz 12363: </tr>
12364: <tr>
1.268 wiz 12365: <td>CHECK_HEADERS_SKIP</td>
1.271 wiz 12366: <td>CHECK_INTERPRETER</td>
1.246 leot 12367: </tr>
12368: <tr>
1.268 wiz 12369: <td>CHECK_INTERPRETER_SKIP</td>
1.271 wiz 12370: <td>CHECK_PERMS</td>
1.241 rillig 12371: </tr>
12372: <tr>
1.268 wiz 12373: <td>CHECK_PERMS_AUTOFIX</td>
1.271 wiz 12374: <td>CHECK_PERMS_SKIP</td>
1.238 wiz 12375: </tr>
12376: <tr>
1.268 wiz 12377: <td>CHECK_PIE</td>
1.271 wiz 12378: <td>CHECK_PIE_SKIP</td>
1.233 wiz 12379: </tr>
12380: <tr>
1.268 wiz 12381: <td>CHECK_PIE_SUPPORTED</td>
1.271 wiz 12382: <td>CHECK_PORTABILITY</td>
1.227 wiz 12383: </tr>
12384: <tr>
1.268 wiz 12385: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.271 wiz 12386: <td>CHECK_PORTABILITY_SKIP</td>
1.217 rillig 12387: </tr>
12388: <tr>
1.268 wiz 12389: <td>CHECK_RELRO</td>
1.271 wiz 12390: <td>CHECK_RELRO_SKIP</td>
1.214 leot 12391: </tr>
12392: <tr>
1.268 wiz 12393: <td>CHECK_RELRO_SUPPORTED</td>
1.271 wiz 12394: <td>CHECK_SHLIBS</td>
1.212 wiz 12395: </tr>
12396: <tr>
1.268 wiz 12397: <td>CHECK_SHLIBS_SKIP</td>
1.271 wiz 12398: <td>CHECK_SHLIBS_SUPPORTED</td>
1.205 wiz 12399: </tr>
12400: <tr>
1.268 wiz 12401: <td>CHECK_SHLIBS_TOXIC</td>
1.271 wiz 12402: <td>CHECK_SSP</td>
1.197 leot 12403: </tr>
12404: <tr>
1.268 wiz 12405: <td>CHECK_SSP_SKIP</td>
1.271 wiz 12406: <td>CHECK_SSP_SUPPORTED</td>
1.177 leot 12407: </tr>
12408: <tr>
1.268 wiz 12409: <td>CHECK_STRIPPED</td>
1.271 wiz 12410: <td>CHECK_STRIPPED_SKIP</td>
1.161 leot 12411: </tr>
12412: <tr>
1.268 wiz 12413: <td>CHECK_WRKREF</td>
1.271 wiz 12414: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.216 gutterid 12415: </tr>
12416: <tr>
1.268 wiz 12417: <td>CHECK_WRKREF_SKIP</td>
1.271 wiz 12418: <td>CLAMAV_DBDIR</td>
1.159 rillig 12419: </tr>
12420: <tr>
1.268 wiz 12421: <td>CLAMAV_GROUP</td>
1.271 wiz 12422: <td>CLAMAV_USER</td>
1.156 leot 12423: </tr>
12424: <tr>
1.268 wiz 12425: <td>CLANGBASE</td>
1.271 wiz 12426: <td>CLEANDEPENDS</td>
1.156 leot 12427: </tr>
12428: <tr>
1.268 wiz 12429: <td>CLT</td>
1.271 wiz 12430: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.156 leot 12431: </tr>
12432: <tr>
1.268 wiz 12433: <td>CMAKE_INSTALL_NAME_DIR</td>
1.271 wiz 12434: <td>CMAKE_INSTALL_PREFIX</td>
1.156 leot 12435: </tr>
12436: <tr>
1.268 wiz 12437: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.271 wiz 12438: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.156 leot 12439: </tr>
12440: <tr>
1.268 wiz 12441: <td>CMAKE_PREFIX_PATH</td>
1.271 wiz 12442: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.254 wiz 12443: </tr>
12444: <tr>
1.268 wiz 12445: <td>COMMON_LISP_DOCFILES</td>
1.271 wiz 12446: <td>COMMON_LISP_EXAMPLES</td>
1.156 leot 12447: </tr>
12448: <tr>
1.268 wiz 12449: <td>COMMON_LISP_EXTRAFILES</td>
1.271 wiz 12450: <td>COMMON_LISP_PACKAGES</td>
1.263 wiz 12451: </tr>
12452: <tr>
1.268 wiz 12453: <td>COMMON_LISP_SYSTEM</td>
1.271 wiz 12454: <td>COMPILER_RPATH_FLAG</td>
1.263 wiz 12455: </tr>
12456: <tr>
1.268 wiz 12457: <td>COMPILER_USE_SYMLINKS</td>
1.271 wiz 12458: <td>CONFIGURE_ARGS</td>
1.156 leot 12459: </tr>
12460: <tr>
1.268 wiz 12461: <td>CONFIGURE_DIRS</td>
1.271 wiz 12462: <td>CONFIGURE_ENV</td>
1.156 leot 12463: </tr>
12464: <tr>
1.268 wiz 12465: <td>CONFIGURE_ENV_SHELL</td>
1.271 wiz 12466: <td>CONFIGURE_HAS_INFODIR</td>
1.156 leot 12467: </tr>
12468: <tr>
1.268 wiz 12469: <td>CONFIGURE_HAS_MANDIR</td>
1.271 wiz 12470: <td>CONFIGURE_SCRIPT</td>
1.156 leot 12471: </tr>
12472: <tr>
1.268 wiz 12473: <td>CONFIG_SHELL</td>
1.271 wiz 12474: <td>CONFIG_SHELL_FLAGS</td>
1.156 leot 12475: </tr>
12476: <tr>
1.268 wiz 12477: <td>CONF_FILES</td>
1.271 wiz 12478: <td>CONF_FILES_MODE</td>
1.156 leot 12479: </tr>
12480: <tr>
1.268 wiz 12481: <td>CONF_FILES_PERMS</td>
1.271 wiz 12482: <td>CONSERVER_DEFAULTHOST</td>
1.156 leot 12483: </tr>
12484: <tr>
1.268 wiz 12485: <td>CONSERVER_DEFAULTPORT</td>
1.271 wiz 12486: <td>CP</td>
1.156 leot 12487: </tr>
12488: <tr>
1.268 wiz 12489: <td>CPE</td>
1.271 wiz 12490: <td>CPE_EDITION</td>
1.156 leot 12491: </tr>
12492: <tr>
1.268 wiz 12493: <td>CPE_LANG</td>
1.271 wiz 12494: <td>CPE_OTHER</td>
1.232 gutterid 12495: </tr>
12496: <tr>
1.268 wiz 12497: <td>CPE_PART</td>
1.271 wiz 12498: <td>CPE_PRODUCT</td>
1.232 gutterid 12499: </tr>
12500: <tr>
1.268 wiz 12501: <td>CPE_SW_EDITION</td>
1.271 wiz 12502: <td>CPE_TARGET_HW</td>
1.232 gutterid 12503: </tr>
12504: <tr>
1.268 wiz 12505: <td>CPE_TARGET_SW</td>
1.271 wiz 12506: <td>CPE_UPDATE</td>
1.232 gutterid 12507: </tr>
12508: <tr>
1.268 wiz 12509: <td>CPE_URI</td>
1.271 wiz 12510: <td>CPE_VENDOR</td>
1.232 gutterid 12511: </tr>
12512: <tr>
1.268 wiz 12513: <td>CPE_VERSION</td>
1.271 wiz 12514: <td>CPP</td>
1.232 gutterid 12515: </tr>
12516: <tr>
1.268 wiz 12517: <td>CPP_PRECOMP_FLAGS</td>
1.271 wiz 12518: <td>CREATE_WRKDIR_SYMLINK</td>
1.156 leot 12519: </tr>
12520: <tr>
1.268 wiz 12521: <td>CROSSBASE</td>
1.271 wiz 12522: <td>CTFCONVERT</td>
1.156 leot 12523: </tr>
12524: <tr>
1.268 wiz 12525: <td>CTF_FILES_SKIP</td>
1.271 wiz 12526: <td>CTF_SUPPORTED</td>
1.156 leot 12527: </tr>
12528: <tr>
1.268 wiz 12529: <td>CTYPE</td>
1.271 wiz 12530: <td>CUPS_GROUP</td>
1.156 leot 12531: </tr>
12532: <tr>
1.268 wiz 12533: <td>CUPS_SYSTEM_GROUPS</td>
1.271 wiz 12534: <td>CUPS_USER</td>
1.156 leot 12535: </tr>
12536: <tr>
1.268 wiz 12537: <td>CURSES_DEFAULT</td>
1.271 wiz 12538: <td>CURSES_TYPE</td>
1.177 leot 12539: </tr>
12540: <tr>
1.268 wiz 12541: <td>CVS_EXTRACTDIR</td>
1.271 wiz 12542: <td>CVS_MODULE</td>
1.227 wiz 12543: </tr>
12544: <tr>
1.268 wiz 12545: <td>CVS_PROJECT</td>
1.271 wiz 12546: <td>CVS_REPOSITORIES</td>
1.263 wiz 12547: </tr>
12548: <tr>
1.268 wiz 12549: <td>CVS_ROOT</td>
1.271 wiz 12550: <td>CVS_ROOT_GNU</td>
1.263 wiz 12551: </tr>
12552: <tr>
1.268 wiz 12553: <td>CVS_ROOT_NONGNU</td>
1.271 wiz 12554: <td>CVS_ROOT_SOURCEFORGE</td>
1.263 wiz 12555: </tr>
12556: <tr>
1.268 wiz 12557: <td>CVS_TAG</td>
1.271 wiz 12558: <td>CYRUS_GROUP</td>
1.263 wiz 12559: </tr>
12560: <tr>
1.268 wiz 12561: <td>CYRUS_IDLE</td>
1.271 wiz 12562: <td>CYRUS_USER</td>
1.258 wiz 12563: </tr>
12564: <tr>
1.268 wiz 12565: <td>DAEMONTOOLS_GROUP</td>
1.271 wiz 12566: <td>DAEMONTOOLS_LOG_USER</td>
1.254 wiz 12567: </tr>
12568: <tr>
1.268 wiz 12569: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.271 wiz 12570: <td>DARWIN_REQUIRES_FILTER</td>
1.246 leot 12571: </tr>
12572: <tr>
1.268 wiz 12573: <td>DBUS_GROUP</td>
1.271 wiz 12574: <td>DBUS_USER</td>
1.238 wiz 12575: </tr>
12576: <tr>
1.268 wiz 12577: <td>DEFANG_GROUP</td>
1.271 wiz 12578: <td>DEFANG_USER</td>
1.233 wiz 12579: </tr>
12580: <tr>
1.268 wiz 12581: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.271 wiz 12582: <td>DEFAULT_DISTFILES</td>
1.217 rillig 12583: </tr>
12584: <tr>
1.268 wiz 12585: <td>DEFAULT_IRC_SERVER</td>
1.271 wiz 12586: <td>DEFAULT_SERIAL_DEVICE</td>
1.214 leot 12587: </tr>
12588: <tr>
1.268 wiz 12589: <td>DEF_UMASK</td>
1.271 wiz 12590: <td>DEINSTALLDEPENDS</td>
1.212 wiz 12591: </tr>
12592: <tr>
1.268 wiz 12593: <td>DEINSTALL_SRC</td>
1.271 wiz 12594: <td>DEINSTALL_TEMPLATES</td>
1.205 wiz 12595: </tr>
12596: <tr>
1.268 wiz 12597: <td>DELAYED_ERROR_MSG</td>
1.271 wiz 12598: <td>DELAYED_WARNING_MSG</td>
1.197 leot 12599: </tr>
12600: <tr>
1.268 wiz 12601: <td>DEPENDS</td>
1.271 wiz 12602: <td>DEPENDS_TARGET</td>
1.159 rillig 12603: </tr>
12604: <tr>
1.268 wiz 12605: <td>DEPENDS_TYPE</td>
1.271 wiz 12606: <td>DESTDIR</td>
1.156 leot 12607: </tr>
12608: <tr>
1.268 wiz 12609: <td>DESTDIR_VARNAME</td>
1.271 wiz 12610: <td>DIALER_GROUP</td>
1.156 leot 12611: </tr>
12612: <tr>
1.268 wiz 12613: <td>DIGEST_REQD</td>
1.271 wiz 12614: <td>DISTDIR</td>
1.195 gutterid 12615: </tr>
12616: <tr>
1.268 wiz 12617: <td>DISTFILES</td>
1.271 wiz 12618: <td>DISTINFO_FILE</td>
1.156 leot 12619: </tr>
12620: <tr>
1.268 wiz 12621: <td>DISTNAME</td>
1.271 wiz 12622: <td>DIST_PATH</td>
1.156 leot 12623: </tr>
12624: <tr>
1.268 wiz 12625: <td>DIST_SUBDIR</td>
1.271 wiz 12626: <td>DJBDNS_AXFR_USER</td>
1.156 leot 12627: </tr>
12628: <tr>
1.268 wiz 12629: <td>DJBDNS_CACHE_USER</td>
1.271 wiz 12630: <td>DJBDNS_DJBDNS_GROUP</td>
1.156 leot 12631: </tr>
12632: <tr>
1.268 wiz 12633: <td>DJBDNS_LOG_USER</td>
1.271 wiz 12634: <td>DJBDNS_RBL_USER</td>
1.156 leot 12635: </tr>
12636: <tr>
1.268 wiz 12637: <td>DJBDNS_TINY_USER</td>
1.271 wiz 12638: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.156 leot 12639: </tr>
12640: <tr>
1.268 wiz 12641: <td>DL_AUTO_VARS</td>
1.271 wiz 12642: <td>DL_CFLAGS</td>
1.156 leot 12643: </tr>
12644: <tr>
1.268 wiz 12645: <td>DL_LDFLAGS</td>
1.271 wiz 12646: <td>DL_LIBS</td>
1.156 leot 12647: </tr>
12648: <tr>
1.268 wiz 12649: <td>DNS</td>
1.271 wiz 12650: <td>DOCOWN</td>
1.156 leot 12651: </tr>
12652: <tr>
1.268 wiz 12653: <td>DOWNLOADED_DISTFILE</td>
1.271 wiz 12654: <td>DQCACHE_GROUP</td>
1.156 leot 12655: </tr>
12656: <tr>
1.268 wiz 12657: <td>DQCACHE_USER</td>
1.271 wiz 12658: <td>DT_LAYOUT</td>
1.156 leot 12659: </tr>
12660: <tr>
1.268 wiz 12661: <td>DYNAMIC_SITES_CMD</td>
1.271 wiz 12662: <td>DYNAMIC_SITES_SCRIPT</td>
1.156 leot 12663: </tr>
12664: <tr>
1.268 wiz 12665: <td>ECHO</td>
1.271 wiz 12666: <td>ECHO_N</td>
1.156 leot 12667: </tr>
12668: <tr>
1.268 wiz 12669: <td>ELK_GUI</td>
1.271 wiz 12670: <td>EMACS_TYPE</td>
1.156 leot 12671: </tr>
12672: <tr>
1.268 wiz 12673: <td>EMULDIR</td>
1.271 wiz 12674: <td>EMULSUBDIR</td>
1.156 leot 12675: </tr>
12676: <tr>
1.268 wiz 12677: <td>EMULSUBDIRSLASH</td>
1.271 wiz 12678: <td>EMUL_ARCH</td>
1.156 leot 12679: </tr>
12680: <tr>
1.268 wiz 12681: <td>EMUL_DISTRO</td>
1.271 wiz 12682: <td>EMUL_EXEC_FMT</td>
1.243 gutterid 12683: </tr>
12684: <tr>
1.268 wiz 12685: <td>EMUL_IS_NATIVE</td>
1.271 wiz 12686: <td>EMUL_MODULES</td>
1.218 nia 12687: </tr>
12688: <tr>
1.268 wiz 12689: <td>EMUL_OPSYS</td>
1.271 wiz 12690: <td>EMUL_PKG_FMT</td>
1.156 leot 12691: </tr>
12692: <tr>
1.268 wiz 12693: <td>EMUL_PLATFORM</td>
1.271 wiz 12694: <td>EMUL_PLATFORMS</td>
1.156 leot 12695: </tr>
12696: <tr>
1.268 wiz 12697: <td>EMUL_PREFER</td>
1.271 wiz 12698: <td>EMUL_REQD</td>
1.156 leot 12699: </tr>
12700: <tr>
1.268 wiz 12701: <td>EMUL_TYPE</td>
1.271 wiz 12702: <td>ERROR_MSG</td>
1.156 leot 12703: </tr>
12704: <tr>
1.268 wiz 12705: <td>EXIM_GROUP</td>
1.271 wiz 12706: <td>EXIM_USER</td>
1.156 leot 12707: </tr>
12708: <tr>
1.268 wiz 12709: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.271 wiz 12710: <td>EXTRACTOR</td>
1.156 leot 12711: </tr>
12712: <tr>
1.268 wiz 12713: <td>EXTRACT_CMD</td>
1.271 wiz 12714: <td>EXTRACT_CMD_DEFAULT</td>
1.156 leot 12715: </tr>
12716: <tr>
1.268 wiz 12717: <td>EXTRACT_DIR</td>
1.271 wiz 12718: <td>EXTRACT_ELEMENTS</td>
1.156 leot 12719: </tr>
12720: <tr>
1.268 wiz 12721: <td>EXTRACT_ENV</td>
1.271 wiz 12722: <td>EXTRACT_ONLY</td>
1.156 leot 12723: </tr>
12724: <tr>
1.268 wiz 12725: <td>EXTRACT_OPTS</td>
1.271 wiz 12726: <td>EXTRACT_SUFX</td>
1.156 leot 12727: </tr>
12728: <tr>
1.268 wiz 12729: <td>EXTRACT_USING</td>
1.271 wiz 12730: <td>FAIL</td>
1.156 leot 12731: </tr>
12732: <tr>
1.268 wiz 12733: <td>FAILOVER_FETCH</td>
1.271 wiz 12734: <td>FAIL_MSG</td>
1.156 leot 12735: </tr>
12736: <tr>
1.268 wiz 12737: <td>FAKE_NCURSES</td>
1.271 wiz 12738: <td>FAM</td>
1.156 leot 12739: </tr>
12740: <tr>
1.268 wiz 12741: <td>FAM_ACCEPTED</td>
1.271 wiz 12742: <td>FAM_DEFAULT</td>
1.223 nia 12743: </tr>
12744: <tr>
1.268 wiz 12745: <td>FAM_SERVER</td>
1.271 wiz 12746: <td>FCPATH</td>
1.156 leot 12747: </tr>
12748: <tr>
1.268 wiz 12749: <td>FETCH_AFTER_ARGS</td>
1.271 wiz 12750: <td>FETCH_BEFORE_ARGS</td>
1.156 leot 12751: </tr>
12752: <tr>
1.268 wiz 12753: <td>FETCH_CMD</td>
1.271 wiz 12754: <td>FETCH_INSECURE</td>
1.156 leot 12755: </tr>
12756: <tr>
1.262 dholland 12757: <td>FETCH_OUTPUT_ARGS</td>
1.271 wiz 12758: <td>FETCH_PROXY</td>
1.156 leot 12759: </tr>
12760: <tr>
1.262 dholland 12761: <td>FETCH_RESUME_ARGS</td>
1.271 wiz 12762: <td>FETCH_TIMEOUT</td>
1.259 leot 12763: </tr>
12764: <tr>
1.262 dholland 12765: <td>FETCH_USE_IPV4_ONLY</td>
1.271 wiz 12766: <td>FETCH_USING</td>
1.156 leot 12767: </tr>
12768: <tr>
1.262 dholland 12769: <td>FILES_SUBST</td>
1.271 wiz 12770: <td>FILES_SUBST_SED</td>
1.156 leot 12771: </tr>
12772: <tr>
1.259 leot 12773: <td>FIX_SYSTEM_HEADERS</td>
1.271 wiz 12774: <td>FONTDIR</td>
1.177 leot 12775: </tr>
12776: <tr>
1.259 leot 12777: <td>FONTS_DIRS</td>
1.271 wiz 12778: <td>FONTS_VERBOSE</td>
1.263 wiz 12779: </tr>
12780: <tr>
12781: <td>FOO_HACKS_MK</td>
1.271 wiz 12782: <td>FORCE_CXX_STD</td>
1.156 leot 12783: </tr>
12784: <tr>
1.263 wiz 12785: <td>FORCE_C_STD</td>
1.271 wiz 12786: <td>FOSSIL_EXTRACTDIR</td>
1.263 wiz 12787: </tr>
12788: <tr>
12789: <td>FOSSIL_REPO</td>
1.271 wiz 12790: <td>FOSSIL_REPOSITORIES</td>
1.263 wiz 12791: </tr>
12792: <tr>
12793: <td>FOSSIL_VERSION</td>
1.271 wiz 12794: <td>FOX_USE_XUNICODE</td>
1.177 leot 12795: </tr>
12796: <tr>
1.263 wiz 12797: <td>FREEWNN_GROUP</td>
1.271 wiz 12798: <td>FREEWNN_USER</td>
1.258 wiz 12799: </tr>
12800: <tr>
1.263 wiz 12801: <td>FTP_PKG_URL_DIR</td>
1.271 wiz 12802: <td>FTP_PKG_URL_HOST</td>
1.156 leot 12803: </tr>
12804: <tr>
1.263 wiz 12805: <td>GAMEDATAMODE</td>
1.271 wiz 12806: <td>GAMEDATA_PERMS</td>
1.156 leot 12807: </tr>
12808: <tr>
1.263 wiz 12809: <td>GAMEDIRMODE</td>
1.271 wiz 12810: <td>GAMEDIR_PERMS</td>
1.156 leot 12811: </tr>
12812: <tr>
1.263 wiz 12813: <td>GAMEGRP</td>
1.271 wiz 12814: <td>GAMEMODE</td>
1.156 leot 12815: </tr>
12816: <tr>
1.263 wiz 12817: <td>GAMEOWN</td>
1.271 wiz 12818: <td>GAMES_GROUP</td>
1.156 leot 12819: </tr>
12820: <tr>
1.263 wiz 12821: <td>GAMES_USER</td>
1.271 wiz 12822: <td>GCC</td>
1.156 leot 12823: </tr>
12824: <tr>
1.263 wiz 12825: <td>GCCBASE</td>
1.271 wiz 12826: <td>GCC_REQD</td>
1.156 leot 12827: </tr>
12828: <tr>
1.263 wiz 12829: <td>GCC_VERSION_SUFFIX</td>
1.271 wiz 12830: <td>GEM_BUILD</td>
1.156 leot 12831: </tr>
12832: <tr>
1.263 wiz 12833: <td>GEM_CLEANBUILD</td>
1.271 wiz 12834: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.156 leot 12835: </tr>
12836: <tr>
1.263 wiz 12837: <td>GEM_DOCDIR</td>
1.271 wiz 12838: <td>GEM_EXTSDIR</td>
1.156 leot 12839: </tr>
12840: <tr>
1.263 wiz 12841: <td>GEM_HOME</td>
1.271 wiz 12842: <td>GEM_KEEPBUILD</td>
1.156 leot 12843: </tr>
12844: <tr>
1.263 wiz 12845: <td>GEM_LIBDIR</td>
1.271 wiz 12846: <td>GEM_NAME</td>
1.256 wiz 12847: </tr>
12848: <tr>
1.263 wiz 12849: <td>GEM_PATH</td>
1.271 wiz 12850: <td>GEM_PLUGINSDIR</td>
1.177 leot 12851: </tr>
12852: <tr>
1.263 wiz 12853: <td>GEM_SPECFILE</td>
1.271 wiz 12854: <td>GENERATE_PLIST</td>
1.156 leot 12855: </tr>
12856: <tr>
1.263 wiz 12857: <td>GHC</td>
1.271 wiz 12858: <td>GHOSTSCRIPT_REQD</td>
1.156 leot 12859: </tr>
12860: <tr>
1.263 wiz 12861: <td>GITHUB_PROJECT</td>
1.271 wiz 12862: <td>GITHUB_RELEASE</td>
1.198 leot 12863: </tr>
12864: <tr>
1.263 wiz 12865: <td>GITHUB_SUBMODULES</td>
1.271 wiz 12866: <td>GITHUB_TAG</td>
1.156 leot 12867: </tr>
12868: <tr>
1.263 wiz 12869: <td>GITHUB_TYPE</td>
1.271 wiz 12870: <td>GITLAB_PROJECT</td>
1.156 leot 12871: </tr>
12872: <tr>
1.263 wiz 12873: <td>GITLAB_RELEASE</td>
1.271 wiz 12874: <td>GITLAB_SUBMODULES</td>
1.177 leot 12875: </tr>
12876: <tr>
1.263 wiz 12877: <td>GITLAB_TAG</td>
1.271 wiz 12878: <td>GITLAB_TYPE</td>
1.159 rillig 12879: </tr>
12880: <tr>
1.263 wiz 12881: <td>GIT_BRANCH</td>
1.271 wiz 12882: <td>GIT_ENV</td>
1.263 wiz 12883: </tr>
12884: <tr>
12885: <td>GIT_EXTRACTDIR</td>
1.271 wiz 12886: <td>GIT_REPO</td>
1.263 wiz 12887: </tr>
12888: <tr>
12889: <td>GIT_REPOSITORIES</td>
1.271 wiz 12890: <td>GIT_REVISION</td>
1.263 wiz 12891: </tr>
12892: <tr>
12893: <td>GIT_TAG</td>
1.271 wiz 12894: <td>GNAT</td>
1.223 nia 12895: </tr>
12896: <tr>
1.260 wiz 12897: <td>GNU</td>
1.271 wiz 12898: <td>GNU_CONFIGURE</td>
1.258 wiz 12899: </tr>
12900: <tr>
1.260 wiz 12901: <td>GNU_CONFIGURE_ICONV</td>
1.271 wiz 12902: <td>GNU_CONFIGURE_INFODIR</td>
1.258 wiz 12903: </tr>
12904: <tr>
1.260 wiz 12905: <td>GNU_CONFIGURE_MANDIR</td>
1.271 wiz 12906: <td>GNU_CONFIGURE_QUIET</td>
1.254 wiz 12907: </tr>
12908: <tr>
1.260 wiz 12909: <td>GNU_CONFIGURE_STRICT</td>
1.271 wiz 12910: <td>GO_BUILD_PATTERN</td>
1.246 leot 12911: </tr>
12912: <tr>
1.260 wiz 12913: <td>GO_DIST_BASE</td>
1.271 wiz 12914: <td>GO_EXTRA_MOD_DIRS</td>
1.241 rillig 12915: </tr>
12916: <tr>
1.260 wiz 12917: <td>GO_MODULE_EXTRACT</td>
1.271 wiz 12918: <td>GO_MODULE_FILES</td>
1.233 wiz 12919: </tr>
12920: <tr>
1.260 wiz 12921: <td>GO_SRCPATH</td>
1.271 wiz 12922: <td>GROUP_SPECIFIC_PKGS</td>
1.156 leot 12923: </tr>
12924: <tr>
1.260 wiz 12925: <td>GRUB_NETWORK_CARDS</td>
1.271 wiz 12926: <td>GRUB_PRESET_COMMAND</td>
1.156 leot 12927: </tr>
12928: <tr>
1.260 wiz 12929: <td>GRUB_SCAN_ARGS</td>
1.271 wiz 12930: <td>GZIP</td>
1.238 wiz 12931: </tr>
12932: <tr>
1.263 wiz 12933: <td>HASKELL_COMPILER</td>
1.271 wiz 12934: <td>HASKELL_DISABLE_EXECUTABLES</td>
1.263 wiz 12935: </tr>
12936: <tr>
1.260 wiz 12937: <td>HASKELL_DISABLE_LIBRARIES</td>
1.271 wiz 12938: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.156 leot 12939: </tr>
12940: <tr>
1.260 wiz 12941: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.271 wiz 12942: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.156 leot 12943: </tr>
12944: <tr>
1.260 wiz 12945: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.271 wiz 12946: <td>HASKELL_ENABLE_TESTS</td>
1.217 rillig 12947: </tr>
12948: <tr>
1.260 wiz 12949: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.271 wiz 12950: <td>HASKELL_PKG_NAME</td>
1.226 gutterid 12951: </tr>
12952: <tr>
1.260 wiz 12953: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
1.271 wiz 12954: <td>HEADER_TEMPLATES</td>
1.263 wiz 12955: </tr>
12956: <tr>
12957: <td>HG_REPO</td>
1.271 wiz 12958: <td>HG_REPOSITORIES</td>
1.220 nia 12959: </tr>
12960: <tr>
1.263 wiz 12961: <td>HG_TAG</td>
1.271 wiz 12962: <td>HOMEPAGE</td>
1.258 wiz 12963: </tr>
12964: <tr>
1.260 wiz 12965: <td>HOST_PKGTOOLS_ARGS</td>
1.271 wiz 12966: <td>HOST_SPECIFIC_PKGS</td>
1.258 wiz 12967: </tr>
12968: <tr>
1.260 wiz 12969: <td>HOWL_GROUP</td>
1.271 wiz 12970: <td>HOWL_USER</td>
1.246 leot 12971: </tr>
12972: <tr>
1.260 wiz 12973: <td>ICCBASE</td>
1.271 wiz 12974: <td>ICECAST_CHROOTDIR</td>
1.241 rillig 12975: </tr>
12976: <tr>
1.260 wiz 12977: <td>ICON_THEMES</td>
1.271 wiz 12978: <td>IDOBASE</td>
1.233 wiz 12979: </tr>
12980: <tr>
1.260 wiz 12981: <td>IGNORE_CCACHE</td>
1.271 wiz 12982: <td>IGNORE_INFO_DIRS</td>
1.227 wiz 12983: </tr>
12984: <tr>
1.260 wiz 12985: <td>IGNORE_INTERACTIVE_FETCH</td>
1.271 wiz 12986: <td>IMAKE</td>
1.223 nia 12987: </tr>
12988: <tr>
1.260 wiz 12989: <td>IMAKEOPTS</td>
1.271 wiz 12990: <td>IMAKE_MAKE</td>
1.156 leot 12991: </tr>
12992: <tr>
1.260 wiz 12993: <td>IMAKE_MANINSTALL</td>
1.271 wiz 12994: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.156 leot 12995: </tr>
12996: <tr>
1.260 wiz 12997: <td>IMDICTDIR</td>
1.271 wiz 12998: <td>INCOMPAT_CURSES</td>
1.191 bacon 12999: </tr>
13000: <tr>
1.260 wiz 13001: <td>INFO_DIR</td>
1.271 wiz 13002: <td>INFO_FILES</td>
1.156 leot 13003: </tr>
13004: <tr>
1.260 wiz 13005: <td>INFO_MSG</td>
1.271 wiz 13006: <td>INIT_SYSTEM</td>
1.156 leot 13007: </tr>
13008: <tr>
1.260 wiz 13009: <td>INN_DATA_DIR</td>
1.271 wiz 13010: <td>INN_GROUP</td>
1.156 leot 13011: </tr>
13012: <tr>
1.260 wiz 13013: <td>INN_USER</td>
1.271 wiz 13014: <td>INSTALLATION_DIRS</td>
1.156 leot 13015: </tr>
13016: <tr>
1.260 wiz 13017: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.271 wiz 13018: <td>INSTALL_ENV</td>
1.156 leot 13019: </tr>
13020: <tr>
1.260 wiz 13021: <td>INSTALL_ENV_SHELL</td>
1.271 wiz 13022: <td>INSTALL_SH_OVERRIDE</td>
1.156 leot 13023: </tr>
13024: <tr>
1.259 leot 13025: <td>INSTALL_SRC</td>
1.271 wiz 13026: <td>INSTALL_TEMPLATES</td>
1.156 leot 13027: </tr>
13028: <tr>
1.259 leot 13029: <td>INSTALL_UNSTRIPPED</td>
1.271 wiz 13030: <td>IRCD_HYBRID_IRC_GROUP</td>
1.156 leot 13031: </tr>
13032: <tr>
1.259 leot 13033: <td>IRCD_HYBRID_IRC_USER</td>
1.271 wiz 13034: <td>IRCD_HYBRID_MAXCONN</td>
1.254 wiz 13035: </tr>
13036: <tr>
1.259 leot 13037: <td>IRCD_HYBRID_NICLEN</td>
1.271 wiz 13038: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.172 rillig 13039: </tr>
13040: <tr>
1.259 leot 13041: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.271 wiz 13042: <td>IRCD_HYBRID_TOPICLEN</td>
1.156 leot 13043: </tr>
13044: <tr>
1.259 leot 13045: <td>IRIX</td>
1.271 wiz 13046: <td>IRRD_USE_PGP</td>
1.156 leot 13047: </tr>
13048: <tr>
1.259 leot 13049: <td>JABBERD_GROUP</td>
1.271 wiz 13050: <td>JABBERD_LOGDIR</td>
1.156 leot 13051: </tr>
13052: <tr>
1.259 leot 13053: <td>JABBERD_PIDDIR</td>
1.271 wiz 13054: <td>JABBERD_SPOOLDIR</td>
1.156 leot 13055: </tr>
13056: <tr>
1.259 leot 13057: <td>JABBERD_USER</td>
1.271 wiz 13058: <td>JAVA_APP_PATH</td>
1.263 wiz 13059: </tr>
13060: <tr>
13061: <td>JAVA_APP_TARGETS</td>
1.271 wiz 13062: <td>JAVA_BINPREFIX</td>
1.156 leot 13063: </tr>
13064: <tr>
1.259 leot 13065: <td>JAVA_CLASSPATH</td>
1.271 wiz 13066: <td>JAVA_HOME</td>
1.258 wiz 13067: </tr>
13068: <tr>
1.259 leot 13069: <td>JAVA_LD_LIBRARY_PATH</td>
1.271 wiz 13070: <td>JAVA_NAME</td>
1.246 leot 13071: </tr>
13072: <tr>
1.259 leot 13073: <td>JAVA_UNLIMIT</td>
1.271 wiz 13074: <td>JAVA_WRAPPERS</td>
1.156 leot 13075: </tr>
13076: <tr>
1.259 leot 13077: <td>JPEG_ACCEPTED</td>
1.271 wiz 13078: <td>JPEG_DEFAULT</td>
1.233 wiz 13079: </tr>
13080: <tr>
1.259 leot 13081: <td>KERBEROS</td>
1.271 wiz 13082: <td>KERMIT_SUID_UUCP</td>
1.156 leot 13083: </tr>
13084: <tr>
1.259 leot 13085: <td>KJS_USE_PCRE</td>
1.271 wiz 13086: <td>KNEWS_DOMAIN_FILE</td>
1.227 wiz 13087: </tr>
13088: <tr>
1.259 leot 13089: <td>KNEWS_DOMAIN_NAME</td>
1.271 wiz 13090: <td>KRB5_ACCEPTED</td>
1.177 leot 13091: </tr>
13092: <tr>
1.259 leot 13093: <td>KRB5_DEFAULT</td>
1.271 wiz 13094: <td>LANGUAGES</td>
1.156 leot 13095: </tr>
13096: <tr>
1.259 leot 13097: <td>LAPACKE_LIBS</td>
1.271 wiz 13098: <td>LAPACKE_PC</td>
1.217 rillig 13099: </tr>
13100: <tr>
1.259 leot 13101: <td>LAPACK_LIBS</td>
1.271 wiz 13102: <td>LAPACK_PC</td>
1.156 leot 13103: </tr>
13104: <tr>
1.259 leot 13105: <td>LATEX2HTML_ICONPATH</td>
1.271 wiz 13106: <td>LDCONFIG_ADD_CMD</td>
1.156 leot 13107: </tr>
13108: <tr>
1.259 leot 13109: <td>LDCONFIG_REMOVE_CMD</td>
1.271 wiz 13110: <td>LDD</td>
1.156 leot 13111: </tr>
13112: <tr>
1.259 leot 13113: <td>LEAFNODE_DATA_DIR</td>
1.271 wiz 13114: <td>LEAFNODE_GROUP</td>
1.156 leot 13115: </tr>
13116: <tr>
1.259 leot 13117: <td>LEAFNODE_USER</td>
1.271 wiz 13118: <td>LIBDVDCSS_HOMEPAGE</td>
1.156 leot 13119: </tr>
13120: <tr>
1.259 leot 13121: <td>LIBDVDCSS_MASTER_SITES</td>
1.271 wiz 13122: <td>LIBIMAGEQUANT_TYPE</td>
1.177 leot 13123: </tr>
13124: <tr>
1.259 leot 13125: <td>LIBRSVG_TYPE</td>
1.271 wiz 13126: <td>LIBTOOL</td>
1.156 leot 13127: </tr>
13128: <tr>
1.259 leot 13129: <td>LIBTOOLIZE_PLIST</td>
1.271 wiz 13130: <td>LIBTOOL_M4_OVERRIDE</td>
1.156 leot 13131: </tr>
13132: <tr>
1.259 leot 13133: <td>LIBUSB_TYPE</td>
1.271 wiz 13134: <td>LICENSE</td>
1.156 leot 13135: </tr>
13136: <tr>
1.259 leot 13137: <td>LINKER_RPATH_FLAG</td>
1.271 wiz 13138: <td>LINK_RPATH_FLAG</td>
1.258 wiz 13139: </tr>
13140: <tr>
1.263 wiz 13141: <td>LINUX_BASE_NODEPS</td>
1.271 wiz 13142: <td>LINUX_BASE_PREFERRED</td>
1.263 wiz 13143: </tr>
13144: <tr>
13145: <td>LINUX_BASE_REQUIRED</td>
1.271 wiz 13146: <td>LINUX_LOCALES</td>
1.241 rillig 13147: </tr>
13148: <tr>
1.263 wiz 13149: <td>LOCALBASE</td>
1.271 wiz 13150: <td>LOCALBASE_LOCKTYPE</td>
1.156 leot 13151: </tr>
13152: <tr>
1.263 wiz 13153: <td>LOCALPATCHES</td>
1.271 wiz 13154: <td>LOVE_DATA</td>
1.255 wiz 13155: </tr>
13156: <tr>
1.263 wiz 13157: <td>LOVE_GAME</td>
1.271 wiz 13158: <td>LOVE_VERSION</td>
1.238 wiz 13159: </tr>
13160: <tr>
1.263 wiz 13161: <td>LOWER_OPSYS</td>
1.271 wiz 13162: <td>LOWER_OPSYS_VERSUFFIX</td>
1.255 wiz 13163: </tr>
13164: <tr>
1.263 wiz 13165: <td>LOWER_VARIANT_VERSION</td>
1.271 wiz 13166: <td>LOWER_VENDOR</td>
1.223 nia 13167: </tr>
13168: <tr>
1.263 wiz 13169: <td>LP32PLATFORMS</td>
1.271 wiz 13170: <td>LP64PLATFORMS</td>
1.177 leot 13171: </tr>
13172: <tr>
1.263 wiz 13173: <td>LUA_BUSTED_ARGS</td>
1.271 wiz 13174: <td>LUA_CDIR</td>
1.214 leot 13175: </tr>
13176: <tr>
1.263 wiz 13177: <td>LUA_COMPILER</td>
1.271 wiz 13178: <td>LUA_DOCDIR</td>
1.197 leot 13179: </tr>
13180: <tr>
1.263 wiz 13181: <td>LUA_EXAMPLESDIR</td>
1.271 wiz 13182: <td>LUA_INCDIR</td>
1.156 leot 13183: </tr>
13184: <tr>
1.263 wiz 13185: <td>LUA_INTERPRETER</td>
1.271 wiz 13186: <td>LUA_LDIR</td>
1.156 leot 13187: </tr>
13188: <tr>
1.263 wiz 13189: <td>LUA_LINKER_MAGIC</td>
1.271 wiz 13190: <td>LUA_PKGPREFIX</td>
1.221 nia 13191: </tr>
13192: <tr>
1.263 wiz 13193: <td>LUA_SELF_CONFLICT</td>
1.271 wiz 13194: <td>LUA_USE_BUSTED</td>
1.218 nia 13195: </tr>
13196: <tr>
1.263 wiz 13197: <td>LUA_VERSIONS_ACCEPTED</td>
1.271 wiz 13198: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.263 wiz 13199: </tr>
13200: <tr>
1.259 leot 13201: <td>LUA_VERSION_DEFAULT</td>
1.271 wiz 13202: <td>LUA_VERSION_REQD</td>
1.218 nia 13203: </tr>
13204: <tr>
1.259 leot 13205: <td>Lua</td>
1.271 wiz 13206: <td>MACHINE_PLATFORM</td>
1.218 nia 13207: </tr>
13208: <tr>
1.259 leot 13209: <td>MAILAGENT_DOMAIN</td>
1.271 wiz 13210: <td>MAILAGENT_EMAIL</td>
1.218 nia 13211: </tr>
13212: <tr>
1.259 leot 13213: <td>MAILAGENT_FQDN</td>
1.271 wiz 13214: <td>MAILAGENT_ORGANIZATION</td>
1.218 nia 13215: </tr>
13216: <tr>
1.259 leot 13217: <td>MAJORDOMO_HOMEDIR</td>
1.271 wiz 13218: <td>MAJOR_OS_VERSION</td>
1.218 nia 13219: </tr>
13220: <tr>
1.259 leot 13221: <td>MAKEINFO_ARGS</td>
1.271 wiz 13222: <td>MAKE_DIRS</td>
1.258 wiz 13223: </tr>
13224: <tr>
1.259 leot 13225: <td>MAKE_DIRS_PERMS</td>
1.271 wiz 13226: <td>MAKE_ENV</td>
1.246 leot 13227: </tr>
13228: <tr>
1.259 leot 13229: <td>MAKE_FILE</td>
1.271 wiz 13230: <td>MAKE_FLAGS</td>
1.205 wiz 13231: </tr>
13232: <tr>
1.259 leot 13233: <td>MAKE_JOBS</td>
1.271 wiz 13234: <td>MAKE_JOBS_SAFE</td>
1.233 wiz 13235: </tr>
13236: <tr>
1.259 leot 13237: <td>MAKE_PROGRAM</td>
1.271 wiz 13238: <td>MANCOMPRESSED_IF_MANZ</td>
1.227 wiz 13239: </tr>
13240: <tr>
1.259 leot 13241: <td>MANINSTALL</td>
1.271 wiz 13242: <td>MANZ</td>
1.156 leot 13243: </tr>
13244: <tr>
1.259 leot 13245: <td>MARIADB_VERSIONS_ALL</td>
1.271 wiz 13246: <td>MASTER_SITES</td>
1.212 wiz 13247: </tr>
13248: <tr>
1.259 leot 13249: <td>MASTER_SITE_BACKUP</td>
1.271 wiz 13250: <td>MASTER_SITE_LOCAL</td>
1.156 leot 13251: </tr>
13252: <tr>
1.259 leot 13253: <td>MASTER_SITE_MOZILLA</td>
1.271 wiz 13254: <td>MASTER_SITE_OVERRIDE</td>
1.156 leot 13255: </tr>
13256: <tr>
1.259 leot 13257: <td>MASTER_SITE_PERL_CPAN</td>
1.271 wiz 13258: <td>MASTER_SORT</td>
1.156 leot 13259: </tr>
13260: <tr>
1.259 leot 13261: <td>MASTER_SORT_RANDOM</td>
1.271 wiz 13262: <td>MASTER_SORT_REGEX</td>
1.156 leot 13263: </tr>
13264: <tr>
1.259 leot 13265: <td>MECAB_CHARSET</td>
1.271 wiz 13266: <td>MEDIATOMB_GROUP</td>
1.189 bacon 13267: </tr>
13268: <tr>
1.259 leot 13269: <td>MEDIATOMB_USER</td>
1.271 wiz 13270: <td>MIPSPROBASE</td>
1.156 leot 13271: </tr>
13272: <tr>
1.259 leot 13273: <td>MIREDO_GROUP</td>
1.271 wiz 13274: <td>MIREDO_USER</td>
1.156 leot 13275: </tr>
13276: <tr>
1.259 leot 13277: <td>MISSING_FEATURES</td>
1.271 wiz 13278: <td>MKDIR</td>
1.156 leot 13279: </tr>
13280: <tr>
1.259 leot 13281: <td>MKPIE_SUPPORTED</td>
1.271 wiz 13282: <td>MLDONKEY_GROUP</td>
1.156 leot 13283: </tr>
13284: <tr>
1.259 leot 13285: <td>MLDONKEY_HOME</td>
1.271 wiz 13286: <td>MLDONKEY_USER</td>
1.156 leot 13287: </tr>
13288: <tr>
1.259 leot 13289: <td>MONOTONE_GROUP</td>
1.271 wiz 13290: <td>MONOTONE_USER</td>
1.156 leot 13291: </tr>
13292: <tr>
1.259 leot 13293: <td>MOTIFBASE</td>
1.271 wiz 13294: <td>MOTIF_TYPE</td>
1.156 leot 13295: </tr>
13296: <tr>
1.259 leot 13297: <td>MOTIF_TYPE_DEFAULT</td>
1.271 wiz 13298: <td>MPI_TYPE</td>
1.156 leot 13299: </tr>
13300: <tr>
1.259 leot 13301: <td>MSGFMT_STRIP_MSGCTXT</td>
1.271 wiz 13302: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.156 leot 13303: </tr>
13304: <tr>
1.259 leot 13305: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.271 wiz 13306: <td>MUST</td>
1.263 wiz 13307: </tr>
13308: <tr>
1.259 leot 13309: <td>MV</td>
1.271 wiz 13310: <td>MYSQL_CHARSET</td>
1.241 rillig 13311: </tr>
13312: <tr>
1.259 leot 13313: <td>MYSQL_DATADIR</td>
1.271 wiz 13314: <td>MYSQL_EXTRA_CHARSET</td>
1.156 leot 13315: </tr>
13316: <tr>
1.259 leot 13317: <td>MYSQL_GROUP</td>
1.271 wiz 13318: <td>MYSQL_USER</td>
1.238 wiz 13319: </tr>
13320: <tr>
1.259 leot 13321: <td>MYSQL_VERSION</td>
1.271 wiz 13322: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.223 nia 13323: </tr>
13324: <tr>
1.259 leot 13325: <td>MYSQL_VERSION_DEFAULT</td>
1.271 wiz 13326: <td>NAGIOSCMD_GROUP</td>
1.214 leot 13327: </tr>
13328: <tr>
1.259 leot 13329: <td>NAGIOSDIR</td>
1.271 wiz 13330: <td>NAGIOS_GROUP</td>
1.197 leot 13331: </tr>
13332: <tr>
1.259 leot 13333: <td>NAGIOS_USER</td>
1.271 wiz 13334: <td>NATIVE_EXEC_FMT</td>
1.205 wiz 13335: </tr>
13336: <tr>
1.259 leot 13337: <td>NATIVE_LOWER_OPSYS</td>
1.271 wiz 13338: <td>NATIVE_LOWER_VENDOR</td>
1.156 leot 13339: </tr>
13340: <tr>
1.259 leot 13341: <td>NATIVE_MACHINE_PLATFORM</td>
1.271 wiz 13342: <td>NATIVE_OBJECT_FMT</td>
1.156 leot 13343: </tr>
13344: <tr>
1.259 leot 13345: <td>NATIVE_OPSYS_VERSION</td>
1.271 wiz 13346: <td>NATIVE_OS_VARIANT</td>
1.156 leot 13347: </tr>
13348: <tr>
1.259 leot 13349: <td>NATIVE_OS_VERSION</td>
1.271 wiz 13350: <td>NBPAX_PROGRAM_PREFIX</td>
1.255 wiz 13351: </tr>
13352: <tr>
1.259 leot 13353: <td>NETBSD_LOGIN_NAME</td>
1.271 wiz 13354: <td>NMH_EDITOR</td>
1.255 wiz 13355: </tr>
13356: <tr>
1.259 leot 13357: <td>NMH_MTA</td>
1.271 wiz 13358: <td>NMH_PAGER</td>
1.156 leot 13359: </tr>
13360: <tr>
1.259 leot 13361: <td>NODE_VERSIONS_ACCEPTED</td>
1.271 wiz 13362: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.195 gutterid 13363: </tr>
13364: <tr>
1.259 leot 13365: <td>NODE_VERSION_DEFAULT</td>
1.271 wiz 13366: <td>NODE_VERSION_REQD</td>
1.156 leot 13367: </tr>
13368: <tr>
1.259 leot 13369: <td>NOLOGIN</td>
1.271 wiz 13370: <td>NOTE</td>
1.156 leot 13371: </tr>
13372: <tr>
1.259 leot 13373: <td>NOT_FOR_PLATFORM</td>
1.271 wiz 13374: <td>NOT_PAX_ASLR_SAFE</td>
1.156 leot 13375: </tr>
13376: <tr>
1.259 leot 13377: <td>NOT_PAX_MPROTECT_SAFE</td>
1.271 wiz 13378: <td>NO_BUILD</td>
1.156 leot 13379: </tr>
13380: <tr>
1.259 leot 13381: <td>NO_CHECKSUM</td>
1.271 wiz 13382: <td>NO_CONFIGURE</td>
1.156 leot 13383: </tr>
13384: <tr>
1.259 leot 13385: <td>NO_SKIP</td>
1.271 wiz 13386: <td>NSD_GROUP</td>
1.229 gutterid 13387: </tr>
13388: <tr>
1.260 wiz 13389: <td>NSD_LOG_FACILITY</td>
1.271 wiz 13390: <td>NSD_USER</td>
1.260 wiz 13391: </tr>
13392: <tr>
1.257 jkoshy 13393: <td>NS_PREFERRED</td>
1.271 wiz 13394: <td>NULLMAILER_GROUP</td>
1.218 nia 13395: </tr>
13396: <tr>
1.257 jkoshy 13397: <td>NULLMAILER_USER</td>
1.271 wiz 13398: <td>OBJECT_FMT</td>
1.218 nia 13399: </tr>
13400: <tr>
1.257 jkoshy 13401: <td>OBJHOSTNAME</td>
1.271 wiz 13402: <td>OBJMACHINE</td>
1.156 leot 13403: </tr>
13404: <tr>
1.257 jkoshy 13405: <td>OCAML_FINDLIB_DIRS</td>
1.271 wiz 13406: <td>OCAML_FINDLIB_REGISTER</td>
1.178 rillig 13407: </tr>
13408: <tr>
1.257 jkoshy 13409: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.271 wiz 13410: <td>OCAML_SITELIBDIR</td>
1.156 leot 13411: </tr>
13412: <tr>
1.257 jkoshy 13413: <td>OMF</td>
1.271 wiz 13414: <td>ONLY_FOR_COMPILER</td>
1.156 leot 13415: </tr>
13416: <tr>
1.257 jkoshy 13417: <td>ONLY_FOR_PLATFORM</td>
1.271 wiz 13418: <td>OPENSSH_CHROOT</td>
1.156 leot 13419: </tr>
13420: <tr>
1.257 jkoshy 13421: <td>OPENSSH_GROUP</td>
1.271 wiz 13422: <td>OPENSSH_USER</td>
1.156 leot 13423: </tr>
13424: <tr>
1.257 jkoshy 13425: <td>OPSYS</td>
1.271 wiz 13426: <td>OPSYS_EMULDIR</td>
1.156 leot 13427: </tr>
13428: <tr>
1.257 jkoshy 13429: <td>OPSYS_VERSION</td>
1.271 wiz 13430: <td>OS</td>
1.156 leot 13431: </tr>
13432: <tr>
1.257 jkoshy 13433: <td>OSS_TYPE</td>
1.271 wiz 13434: <td>OSX</td>
1.156 leot 13435: </tr>
13436: <tr>
1.257 jkoshy 13437: <td>OSX_PATH_TO_M4</td>
1.271 wiz 13438: <td>OSX_PATH_TO_YACC</td>
1.263 wiz 13439: </tr>
13440: <tr>
13441: <td>OS_HAVE_ALSA</td>
1.271 wiz 13442: <td>OS_HAVE_RCD</td>
1.254 wiz 13443: </tr>
13444: <tr>
1.257 jkoshy 13445: <td>OS_VARIANT</td>
1.271 wiz 13446: <td>OS_VERSION</td>
1.254 wiz 13447: </tr>
13448: <tr>
1.257 jkoshy 13449: <td>OTF_FONTS_DIR</td>
1.271 wiz 13450: <td>OVERRIDE_DIRDEPTH</td>
1.238 wiz 13451: </tr>
13452: <tr>
1.257 jkoshy 13453: <td>OVERRIDE_GEMSPEC</td>
1.271 wiz 13454: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.156 leot 13455: </tr>
13456: <tr>
1.263 wiz 13457: <td>OVERRIDE_ROCKSPEC</td>
1.271 wiz 13458: <td>OWN_DIRS</td>
1.258 wiz 13459: </tr>
13460: <tr>
13461: <td>OWN_DIRS_PERMS</td>
1.271 wiz 13462: <td>P4GROUP</td>
1.246 leot 13463: </tr>
13464: <tr>
1.258 wiz 13465: <td>P4PORT</td>
1.271 wiz 13466: <td>P4ROOT</td>
1.233 wiz 13467: </tr>
13468: <tr>
1.258 wiz 13469: <td>P4USER</td>
1.271 wiz 13470: <td>PACKAGES</td>
1.214 leot 13471: </tr>
13472: <tr>
1.258 wiz 13473: <td>PALMOS_DEFAULT_SDK</td>
1.271 wiz 13474: <td>PAMBASE</td>
1.227 wiz 13475: </tr>
13476: <tr>
1.258 wiz 13477: <td>PAM_DEFAULT</td>
1.271 wiz 13478: <td>PAPERSIZE</td>
1.205 wiz 13479: </tr>
13480: <tr>
1.258 wiz 13481: <td>PASSIVE_FETCH</td>
1.271 wiz 13482: <td>PATCHDIR</td>
1.161 leot 13483: </tr>
13484: <tr>
1.258 wiz 13485: <td>PATCHFILES</td>
1.271 wiz 13486: <td>PATCH_ARGS</td>
1.156 leot 13487: </tr>
13488: <tr>
1.258 wiz 13489: <td>PATCH_DEBUG</td>
1.271 wiz 13490: <td>PATCH_DIST_ARGS</td>
1.156 leot 13491: </tr>
13492: <tr>
1.258 wiz 13493: <td>PATCH_DIST_CAT</td>
1.271 wiz 13494: <td>PATCH_DIST_STRIP</td>
1.156 leot 13495: </tr>
13496: <tr>
1.258 wiz 13497: <td>PATCH_FUZZ_FACTOR</td>
1.271 wiz 13498: <td>PATCH_STRIP</td>
1.156 leot 13499: </tr>
13500: <tr>
1.258 wiz 13501: <td>PATH</td>
1.271 wiz 13502: <td>PCCBASE</td>
1.254 wiz 13503: </tr>
13504: <tr>
1.263 wiz 13505: <td>PEAR</td>
1.271 wiz 13506: <td>PEAR_CHANNEL</td>
1.263 wiz 13507: </tr>
13508: <tr>
13509: <td>PEAR_CHANNEL_ALIAS</td>
1.271 wiz 13510: <td>PEAR_CHANNEL_VERSION</td>
1.263 wiz 13511: </tr>
13512: <tr>
1.256 wiz 13513: <td>PEAR_CMD</td>
1.271 wiz 13514: <td>PEAR_LIB</td>
1.258 wiz 13515: </tr>
13516: <tr>
13517: <td>PEAR_PACKAGE_XML</td>
1.271 wiz 13518: <td>PEP-518</td>
1.227 wiz 13519: </tr>
13520: <tr>
1.249 gutterid 13521: <td>PERL5</td>
1.271 wiz 13522: <td>PERL5_CONFIGURE</td>
1.156 leot 13523: </tr>
13524: <tr>
1.249 gutterid 13525: <td>PERL5_CONFIGURE_DIRS</td>
1.271 wiz 13526: <td>PERL5_LDFLAGS</td>
1.217 rillig 13527: </tr>
13528: <tr>
1.249 gutterid 13529: <td>PERL5_LICENSE</td>
1.271 wiz 13530: <td>PERL5_MODULE_TYPE</td>
1.205 wiz 13531: </tr>
13532: <tr>
1.249 gutterid 13533: <td>PERL5_PACKLIST</td>
1.271 wiz 13534: <td>PERL5_PACKLIST_DIR</td>
1.177 leot 13535: </tr>
13536: <tr>
1.249 gutterid 13537: <td>PERL5_PERLBASE</td>
1.271 wiz 13538: <td>PERL5_SITEBASE</td>
1.161 leot 13539: </tr>
13540: <tr>
1.249 gutterid 13541: <td>PERL5_USE_PACKLIST</td>
1.271 wiz 13542: <td>PERL5_VENDORBASE</td>
1.161 leot 13543: </tr>
13544: <tr>
1.249 gutterid 13545: <td>PFCTL</td>
1.271 wiz 13546: <td>PFVAR_H</td>
1.156 leot 13547: </tr>
13548: <tr>
1.249 gutterid 13549: <td>PF_VERSION</td>
1.271 wiz 13550: <td>PGGROUP</td>
1.156 leot 13551: </tr>
13552: <tr>
1.249 gutterid 13553: <td>PGHOME</td>
1.271 wiz 13554: <td>PGPKGSRCDIR</td>
1.156 leot 13555: </tr>
13556: <tr>
1.249 gutterid 13557: <td>PGSQL_TYPE</td>
1.271 wiz 13558: <td>PGSQL_VERSION</td>
1.156 leot 13559: </tr>
13560: <tr>
1.249 gutterid 13561: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.271 wiz 13562: <td>PGSQL_VERSION_DEFAULT</td>
1.156 leot 13563: </tr>
13564: <tr>
1.249 gutterid 13565: <td>PGUSER</td>
1.271 wiz 13566: <td>PG_LIB_EXT</td>
1.156 leot 13567: </tr>
13568: <tr>
1.249 gutterid 13569: <td>PHP</td>
1.271 wiz 13570: <td>PHPCOMMON_MK</td>
1.260 wiz 13571: </tr>
13572: <tr>
13573: <td>PHPPKGSRCDIR</td>
1.271 wiz 13574: <td>PHP_BASE_VERS</td>
1.156 leot 13575: </tr>
13576: <tr>
1.260 wiz 13577: <td>PHP_EGDIR</td>
1.271 wiz 13578: <td>PHP_EXTENSION_DIR</td>
1.156 leot 13579: </tr>
13580: <tr>
1.260 wiz 13581: <td>PHP_INCDIR</td>
1.271 wiz 13582: <td>PHP_LIBDIR</td>
1.260 wiz 13583: </tr>
13584: <tr>
13585: <td>PHP_MAJOR_VERS</td>
1.271 wiz 13586: <td>PHP_MINIMUM_TEENY</td>
1.260 wiz 13587: </tr>
13588: <tr>
13589: <td>PHP_MINOR_VERS</td>
1.271 wiz 13590: <td>PHP_PKG_PREFIX</td>
1.156 leot 13591: </tr>
13592: <tr>
1.260 wiz 13593: <td>PHP_SHAREDIR</td>
1.271 wiz 13594: <td>PHP_VER</td>
1.156 leot 13595: </tr>
13596: <tr>
1.249 gutterid 13597: <td>PHP_VERSION</td>
1.271 wiz 13598: <td>PHP_VERSIONS_ACCEPTED</td>
1.156 leot 13599: </tr>
13600: <tr>
1.249 gutterid 13601: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.271 wiz 13602: <td>PHP_VERSION_DEFAULT</td>
1.156 leot 13603: </tr>
13604: <tr>
1.249 gutterid 13605: <td>PHP_VERSION_REQD</td>
1.271 wiz 13606: <td>PILRC_USE_GTK</td>
1.156 leot 13607: </tr>
13608: <tr>
1.249 gutterid 13609: <td>PKGCONFIG_BASE</td>
1.271 wiz 13610: <td>PKGCONFIG_FILE</td>
1.156 leot 13611: </tr>
13612: <tr>
1.249 gutterid 13613: <td>PKGCONFIG_OVERRIDE</td>
1.271 wiz 13614: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.156 leot 13615: </tr>
13616: <tr>
1.249 gutterid 13617: <td>PKGDIR</td>
1.271 wiz 13618: <td>PKGGNUDIR</td>
1.156 leot 13619: </tr>
13620: <tr>
1.249 gutterid 13621: <td>PKGINFODIR</td>
1.271 wiz 13622: <td>PKGLOCALEDIR</td>
1.156 leot 13623: </tr>
13624: <tr>
1.249 gutterid 13625: <td>PKGMANDIR</td>
1.271 wiz 13626: <td>PKGNAME</td>
1.156 leot 13627: </tr>
13628: <tr>
1.249 gutterid 13629: <td>PKGNAME_REQD</td>
1.271 wiz 13630: <td>PKGPATH</td>
1.156 leot 13631: </tr>
13632: <tr>
1.249 gutterid 13633: <td>PKGREVISION</td>
1.271 wiz 13634: <td>PKGSRC_BLAS_TYPES</td>
1.156 leot 13635: </tr>
13636: <tr>
1.249 gutterid 13637: <td>PKGSRC_CHANGES</td>
1.271 wiz 13638: <td>PKGSRC_COMPILER</td>
1.156 leot 13639: </tr>
13640: <tr>
1.249 gutterid 13641: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.271 wiz 13642: <td>PKGSRC_LOCKTYPE</td>
1.156 leot 13643: </tr>
13644: <tr>
1.249 gutterid 13645: <td>PKGSRC_MAKE_ENV</td>
1.271 wiz 13646: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.156 leot 13647: </tr>
13648: <tr>
1.249 gutterid 13649: <td>PKGSRC_MKPIE</td>
1.271 wiz 13650: <td>PKGSRC_MKREPRO</td>
1.156 leot 13651: </tr>
13652: <tr>
1.249 gutterid 13653: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.271 wiz 13654: <td>PKGSRC_RUN_TEST</td>
1.177 leot 13655: </tr>
13656: <tr>
1.249 gutterid 13657: <td>PKGSRC_SETENV</td>
1.271 wiz 13658: <td>PKGSRC_SLEEPSECS</td>
1.156 leot 13659: </tr>
13660: <tr>
1.249 gutterid 13661: <td>PKGSRC_TODO</td>
1.271 wiz 13662: <td>PKGSRC_USE_CTF</td>
1.159 rillig 13663: </tr>
13664: <tr>
1.249 gutterid 13665: <td>PKGSRC_USE_FORTIFY</td>
1.271 wiz 13666: <td>PKGSRC_USE_MKTOOLS</td>
1.156 leot 13667: </tr>
13668: <tr>
1.249 gutterid 13669: <td>PKGSRC_USE_RELRO</td>
1.271 wiz 13670: <td>PKGSRC_USE_SSP</td>
1.156 leot 13671: </tr>
13672: <tr>
1.249 gutterid 13673: <td>PKGSRC_USE_STACK_CHECK</td>
1.271 wiz 13674: <td>PKGTASKS_DATAFILE</td>
1.156 leot 13675: </tr>
13676: <tr>
1.249 gutterid 13677: <td>PKGTOOLS_ARGS</td>
1.271 wiz 13678: <td>PKGTOOLS_ENV</td>
1.156 leot 13679: </tr>
13680: <tr>
1.249 gutterid 13681: <td>PKG_ALTERNATIVES</td>
1.271 wiz 13682: <td>PKG_APACHE</td>
1.156 leot 13683: </tr>
13684: <tr>
1.249 gutterid 13685: <td>PKG_APACHE_ACCEPTED</td>
1.271 wiz 13686: <td>PKG_APACHE_DEFAULT</td>
1.156 leot 13687: </tr>
13688: <tr>
1.249 gutterid 13689: <td>PKG_BEST_EXISTS</td>
1.271 wiz 13690: <td>PKG_BUILD_OPTIONS</td>
1.156 leot 13691: </tr>
13692: <tr>
1.249 gutterid 13693: <td>PKG_COMPRESSION</td>
1.271 wiz 13694: <td>PKG_CONFIG</td>
1.156 leot 13695: </tr>
13696: <tr>
1.249 gutterid 13697: <td>PKG_CONFIG_PERMS</td>
1.271 wiz 13698: <td>PKG_CREATE_USERGROUP</td>
1.156 leot 13699: </tr>
13700: <tr>
1.255 wiz 13701: <td>PKG_DBDIR</td>
1.271 wiz 13702: <td>PKG_DB_TMPDIR</td>
1.156 leot 13703: </tr>
13704: <tr>
1.255 wiz 13705: <td>PKG_DEBUG_LEVEL</td>
1.271 wiz 13706: <td>PKG_DEFAULT_OPTIONS</td>
1.156 leot 13707: </tr>
13708: <tr>
1.255 wiz 13709: <td>PKG_DESTDIR_SUPPORT</td>
1.271 wiz 13710: <td>PKG_DEVELOPER</td>
1.156 leot 13711: </tr>
13712: <tr>
1.255 wiz 13713: <td>PKG_DISABLED_OPTIONS</td>
1.271 wiz 13714: <td>PKG_FATAL_ERRORS</td>
1.233 wiz 13715: </tr>
13716: <tr>
1.255 wiz 13717: <td>PKG_FC</td>
1.271 wiz 13718: <td>PKG_FILELIST_CMD</td>
1.246 leot 13719: </tr>
13720: <tr>
1.255 wiz 13721: <td>PKG_GECOS</td>
1.271 wiz 13722: <td>PKG_GID</td>
1.156 leot 13723: </tr>
13724: <tr>
1.255 wiz 13725: <td>PKG_GROUPS</td>
1.271 wiz 13726: <td>PKG_GROUPS_VARS</td>
1.156 leot 13727: </tr>
13728: <tr>
1.255 wiz 13729: <td>PKG_HOME</td>
1.271 wiz 13730: <td>PKG_INIT_SCRIPTS</td>
1.156 leot 13731: </tr>
13732: <tr>
1.255 wiz 13733: <td>PKG_JAVA_HOME</td>
1.271 wiz 13734: <td>PKG_JVM</td>
1.156 leot 13735: </tr>
13736: <tr>
1.255 wiz 13737: <td>PKG_JVMS_ACCEPTED</td>
1.271 wiz 13738: <td>PKG_JVM_DEFAULT</td>
1.156 leot 13739: </tr>
13740: <tr>
1.255 wiz 13741: <td>PKG_LEGACY_OPTIONS</td>
1.271 wiz 13742: <td>PKG_LIBTOOL</td>
1.156 leot 13743: </tr>
13744: <tr>
1.255 wiz 13745: <td>PKG_MKSYMLINKS</td>
1.271 wiz 13746: <td>PKG_OPTIONS</td>
1.156 leot 13747: </tr>
13748: <tr>
1.255 wiz 13749: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.271 wiz 13750: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.156 leot 13751: </tr>
13752: <tr>
1.255 wiz 13753: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.271 wiz 13754: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.156 leot 13755: </tr>
13756: <tr>
1.255 wiz 13757: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.271 wiz 13758: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.226 gutterid 13759: </tr>
13760: <tr>
1.255 wiz 13761: <td>PKG_OPTIONS_VAR</td>
1.271 wiz 13762: <td>PKG_RCD_SCRIPTS</td>
1.156 leot 13763: </tr>
13764: <tr>
1.258 wiz 13765: <td>PKG_REFCOUNT_DBDIR</td>
1.271 wiz 13766: <td>PKG_REGISTER_SHELLS</td>
1.156 leot 13767: </tr>
13768: <tr>
1.258 wiz 13769: <td>PKG_RESUME_TRANSFERS</td>
1.271 wiz 13770: <td>PKG_SHELL</td>
1.156 leot 13771: </tr>
13772: <tr>
1.258 wiz 13773: <td>PKG_SUGGESTED_OPTIONS</td>
1.271 wiz 13774: <td>PKG_SUPPORTED_OPTIONS</td>
1.156 leot 13775: </tr>
13776: <tr>
1.258 wiz 13777: <td>PKG_SYSCONFBASE</td>
1.271 wiz 13778: <td>PKG_SYSCONFBASEDIR</td>
1.156 leot 13779: </tr>
13780: <tr>
1.258 wiz 13781: <td>PKG_SYSCONFDIR</td>
1.271 wiz 13782: <td>PKG_SYSCONFDIR_PERMS</td>
1.156 leot 13783: </tr>
13784: <tr>
1.258 wiz 13785: <td>PKG_SYSCONFSUBDIR</td>
1.271 wiz 13786: <td>PKG_SYSCONFVAR</td>
1.156 leot 13787: </tr>
13788: <tr>
1.258 wiz 13789: <td>PKG_TOOLS_BIN</td>
1.271 wiz 13790: <td>PKG_UID</td>
1.156 leot 13791: </tr>
13792: <tr>
1.258 wiz 13793: <td>PKG_UPDATE_FONTS_DB</td>
1.271 wiz 13794: <td>PKG_USERS</td>
1.156 leot 13795: </tr>
13796: <tr>
1.258 wiz 13797: <td>PKG_USERS_VARS</td>
1.271 wiz 13798: <td>PKG_VERBOSE</td>
1.156 leot 13799: </tr>
13800: <tr>
1.258 wiz 13801: <td>PLEASE</td>
1.271 wiz 13802: <td>PLIST</td>
1.156 leot 13803: </tr>
13804: <tr>
1.258 wiz 13805: <td>PLIST_AWK</td>
1.271 wiz 13806: <td>PLIST_AWK_ENV</td>
1.156 leot 13807: </tr>
13808: <tr>
1.258 wiz 13809: <td>PLIST_SRC</td>
1.271 wiz 13810: <td>PLIST_SUBST</td>
1.156 leot 13811: </tr>
13812: <tr>
1.258 wiz 13813: <td>PLIST_TYPE</td>
1.271 wiz 13814: <td>PLIST_VARS</td>
1.156 leot 13815: </tr>
13816: <tr>
1.258 wiz 13817: <td>POPTOP_USE_MPPE</td>
1.271 wiz 13818: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.156 leot 13819: </tr>
13820: <tr>
1.258 wiz 13821: <td>POST_FETCH_HOOK</td>
1.271 wiz 13822: <td>PREFER</td>
1.156 leot 13823: </tr>
13824: <tr>
1.258 wiz 13825: <td>PREFER_NATIVE</td>
1.271 wiz 13826: <td>PREFER_NATIVE_PTHREADS</td>
1.156 leot 13827: </tr>
13828: <tr>
1.258 wiz 13829: <td>PREFER_PKGSRC</td>
1.271 wiz 13830: <td>PREFIX</td>
1.156 leot 13831: </tr>
13832: <tr>
1.258 wiz 13833: <td>PREPEND_PATH</td>
1.271 wiz 13834: <td>PRE_ROOT_CMD</td>
1.156 leot 13835: </tr>
13836: <tr>
1.258 wiz 13837: <td>PRIVILEGED_STAGES</td>
1.271 wiz 13838: <td>PS</td>
1.156 leot 13839: </tr>
13840: <tr>
1.258 wiz 13841: <td>PTHREAD_AUTO_VARS</td>
1.271 wiz 13842: <td>PTHREAD_CFLAGS</td>
1.156 leot 13843: </tr>
13844: <tr>
1.258 wiz 13845: <td>PTHREAD_LDFLAGS</td>
1.271 wiz 13846: <td>PTHREAD_LIBS</td>
1.156 leot 13847: </tr>
13848: <tr>
1.258 wiz 13849: <td>PTHREAD_OPTS</td>
1.271 wiz 13850: <td>PTHREAD_TYPE</td>
1.156 leot 13851: </tr>
13852: <tr>
1.258 wiz 13853: <td>PVM_SSH</td>
1.271 wiz 13854: <td>PYPKGPREFIX</td>
1.156 leot 13855: </tr>
13856: <tr>
1.265 leot 13857: <td>PYSOABISUFFIX</td>
1.271 wiz 13858: <td>PYTHON_27_ACCEPTED</td>
1.265 leot 13859: </tr>
13860: <tr>
1.266 martin 13861: <td>PYTHON_FOR_BUILD_ONLY</td>
1.271 wiz 13862: <td>PYTHON_SELF_CONFLICT</td>
1.156 leot 13863: </tr>
13864: <tr>
1.266 martin 13865: <td>PYTHON_VERSION</td>
1.271 wiz 13866: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.156 leot 13867: </tr>
13868: <tr>
1.266 martin 13869: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.271 wiz 13870: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.156 leot 13871: </tr>
13872: <tr>
1.266 martin 13873: <td>PYTHON_VERSION_DEFAULT</td>
1.271 wiz 13874: <td>PYTHON_VERSION_REQD</td>
1.156 leot 13875: </tr>
13876: <tr>
1.266 martin 13877: <td>PYVERSSUFFIX</td>
1.271 wiz 13878: <td>QMAILDIR</td>
1.156 leot 13879: </tr>
13880: <tr>
1.266 martin 13881: <td>QMAIL_ALIAS_USER</td>
1.271 wiz 13882: <td>QMAIL_DAEMON_USER</td>
1.156 leot 13883: </tr>
13884: <tr>
1.266 martin 13885: <td>QMAIL_LOG_USER</td>
1.271 wiz 13886: <td>QMAIL_NOFILES_GROUP</td>
1.156 leot 13887: </tr>
13888: <tr>
1.266 martin 13889: <td>QMAIL_PASSWD_USER</td>
1.271 wiz 13890: <td>QMAIL_QMAIL_GROUP</td>
1.156 leot 13891: </tr>
13892: <tr>
1.266 martin 13893: <td>QMAIL_QUEUE_DIR</td>
1.271 wiz 13894: <td>QMAIL_QUEUE_EXTRA</td>
1.156 leot 13895: </tr>
13896: <tr>
1.266 martin 13897: <td>QMAIL_QUEUE_USER</td>
1.271 wiz 13898: <td>QMAIL_REMOTE_USER</td>
1.156 leot 13899: </tr>
13900: <tr>
1.266 martin 13901: <td>QMAIL_ROOT_USER</td>
1.271 wiz 13902: <td>QMAIL_SEND_USER</td>
1.156 leot 13903: </tr>
13904: <tr>
1.266 martin 13905: <td>QORE_LATEST_MODULE_API</td>
1.271 wiz 13906: <td>QORE_MODULE_API</td>
1.156 leot 13907: </tr>
13908: <tr>
1.266 martin 13909: <td>QORE_MODULE_DIR</td>
1.271 wiz 13910: <td>QORE_USER_MODULE_DIR</td>
1.156 leot 13911: </tr>
13912: <tr>
1.266 martin 13913: <td>QORE_VERSION</td>
1.271 wiz 13914: <td>QPOPPER_FAC</td>
1.156 leot 13915: </tr>
13916: <tr>
1.266 martin 13917: <td>QPOPPER_SPOOL_DIR</td>
1.271 wiz 13918: <td>QPOPPER_USER</td>
1.156 leot 13919: </tr>
13920: <tr>
1.266 martin 13921: <td>RAKE_NAME</td>
1.271 wiz 13922: <td>RASMOL_DEPTH</td>
1.156 leot 13923: </tr>
13924: <tr>
1.266 martin 13925: <td>RCD_DIR</td>
1.271 wiz 13926: <td>RCD_ORDER</td>
1.263 wiz 13927: </tr>
13928: <tr>
1.266 martin 13929: <td>RCD_SCRIPTS</td>
1.271 wiz 13930: <td>RCD_SCRIPTS_DIR</td>
1.258 wiz 13931: </tr>
13932: <tr>
1.266 martin 13933: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.271 wiz 13934: <td>RCD_SCRIPTS_MODE</td>
1.218 nia 13935: </tr>
13936: <tr>
1.266 martin 13937: <td>RCD_SCRIPTS_SHELL</td>
1.271 wiz 13938: <td>RCD_SCRIPT_SRC</td>
1.241 rillig 13939: </tr>
13940: <tr>
1.266 martin 13941: <td>RCD_SUBR</td>
1.271 wiz 13942: <td>RDOC</td>
1.214 leot 13943: </tr>
13944: <tr>
1.266 martin 13945: <td>READLINE_DEFAULT</td>
1.271 wiz 13946: <td>READLINE_TYPE</td>
1.205 wiz 13947: </tr>
13948: <tr>
1.266 martin 13949: <td>REAL_ROOT_GROUP</td>
1.271 wiz 13950: <td>REAL_ROOT_USER</td>
1.223 nia 13951: </tr>
13952: <tr>
1.266 martin 13953: <td>RECURSIVE_MAKE</td>
1.271 wiz 13954: <td>RELAY_CTRL_DIR</td>
1.177 leot 13955: </tr>
13956: <tr>
1.266 martin 13957: <td>RELRO_SUPPORTED</td>
1.271 wiz 13958: <td>REPLACE_AWK</td>
1.214 leot 13959: </tr>
13960: <tr>
1.266 martin 13961: <td>REPLACE_BASH</td>
1.271 wiz 13962: <td>REPLACE_CSH</td>
1.212 wiz 13963: </tr>
13964: <tr>
1.266 martin 13965: <td>REPLACE_KSH</td>
1.271 wiz 13966: <td>REPLACE_LUA</td>
1.156 leot 13967: </tr>
13968: <tr>
1.266 martin 13969: <td>REPLACE_NODEJS</td>
1.271 wiz 13970: <td>REPLACE_OCTAVE</td>
1.205 wiz 13971: </tr>
13972: <tr>
1.266 martin 13973: <td>REPLACE_PERL</td>
1.271 wiz 13974: <td>REPLACE_PERL6</td>
1.197 leot 13975: </tr>
13976: <tr>
1.266 martin 13977: <td>REPLACE_PHP</td>
1.271 wiz 13978: <td>REPLACE_PYTHON</td>
1.156 leot 13979: </tr>
13980: <tr>
1.266 martin 13981: <td>REPLACE_QORE</td>
1.271 wiz 13982: <td>REPLACE_R</td>
1.218 nia 13983: </tr>
13984: <tr>
1.266 martin 13985: <td>REPLACE_RUBY</td>
1.271 wiz 13986: <td>REPLACE_RUBY_DIRS</td>
1.161 leot 13987: </tr>
13988: <tr>
1.266 martin 13989: <td>REPLACE_RUBY_PAT</td>
1.271 wiz 13990: <td>REPLACE_SH</td>
1.254 wiz 13991: </tr>
13992: <tr>
1.266 martin 13993: <td>REPLACE_TEXLUA</td>
1.271 wiz 13994: <td>REPLACE_TOOL_PYTHON</td>
1.216 gutterid 13995: </tr>
13996: <tr>
1.266 martin 13997: <td>REPLACE_WISH</td>
1.271 wiz 13998: <td>REQD_DIRS</td>
1.156 leot 13999: </tr>
14000: <tr>
1.266 martin 14001: <td>REQD_DIRS_PERMS</td>
1.271 wiz 14002: <td>REQD_FILES</td>
1.218 nia 14003: </tr>
14004: <tr>
1.266 martin 14005: <td>REQD_FILES_MODE</td>
1.271 wiz 14006: <td>REQD_FILES_PERMS</td>
1.156 leot 14007: </tr>
14008: <tr>
1.266 martin 14009: <td>RESOLV_AUTO_VARS</td>
1.271 wiz 14010: <td>RESOLV_LDFLAGS</td>
1.254 wiz 14011: </tr>
14012: <tr>
1.266 martin 14013: <td>RESOLV_LIBS</td>
1.271 wiz 14014: <td>RM</td>
1.258 wiz 14015: </tr>
14016: <tr>
1.266 martin 14017: <td>ROCKSPEC_NAME</td>
1.271 wiz 14018: <td>ROCKSPEC_SPECFILE</td>
1.263 wiz 14019: </tr>
14020: <tr>
1.266 martin 14021: <td>ROOT_CMD</td>
1.271 wiz 14022: <td>ROOT_GROUP</td>
1.238 wiz 14023: </tr>
14024: <tr>
1.266 martin 14025: <td>ROOT_USER</td>
1.271 wiz 14026: <td>RPCGEN</td>
1.156 leot 14027: </tr>
14028: <tr>
1.266 martin 14029: <td>RPM</td>
1.271 wiz 14030: <td>RPM2PKG_PLIST</td>
1.156 leot 14031: </tr>
14032: <tr>
1.266 martin 14033: <td>RPM2PKG_PREFIX</td>
1.271 wiz 14034: <td>RPM2PKG_STAGE</td>
1.205 wiz 14035: </tr>
14036: <tr>
1.266 martin 14037: <td>RPM2PKG_STRIP</td>
1.271 wiz 14038: <td>RPM2PKG_SUBPREFIX</td>
1.217 rillig 14039: </tr>
14040: <tr>
1.266 martin 14041: <td>RPMFILES</td>
1.271 wiz 14042: <td>RPMIGNOREPATH</td>
1.214 leot 14043: </tr>
14044: <tr>
1.266 martin 14045: <td>RPM_DB_PREFIX</td>
1.271 wiz 14046: <td>RSSH_CVS_PATH</td>
1.212 wiz 14047: </tr>
14048: <tr>
1.266 martin 14049: <td>RSSH_RDIST_PATH</td>
1.271 wiz 14050: <td>RSSH_RSYNC_PATH</td>
1.156 leot 14051: </tr>
14052: <tr>
1.266 martin 14053: <td>RSSH_SCP_PATH</td>
1.271 wiz 14054: <td>RSSH_SFTP_SERVER_PATH</td>
1.197 leot 14055: </tr>
14056: <tr>
1.266 martin 14057: <td>RUBY</td>
1.271 wiz 14058: <td>RUBYGEM</td>
1.156 leot 14059: </tr>
14060: <tr>
1.266 martin 14061: <td>RUBYGEM_MANPAGES</td>
1.271 wiz 14062: <td>RUBYGEM_NAME</td>
1.156 leot 14063: </tr>
14064: <tr>
1.266 martin 14065: <td>RUBYGEM_OPTIONS</td>
1.271 wiz 14066: <td>RUBYGEM_USE_MANPAGES</td>
1.156 leot 14067: </tr>
14068: <tr>
1.266 martin 14069: <td>RUBYGEM_VERBOSE</td>
1.271 wiz 14070: <td>RUBY_ABI_VERSION</td>
1.231 jnemeth 14071: </tr>
14072: <tr>
1.266 martin 14073: <td>RUBY_ARCH</td>
1.271 wiz 14074: <td>RUBY_ARCHINC</td>
1.156 leot 14075: </tr>
14076: <tr>
1.266 martin 14077: <td>RUBY_ARCHLIB</td>
1.271 wiz 14078: <td>RUBY_BASE</td>
1.156 leot 14079: </tr>
14080: <tr>
1.266 martin 14081: <td>RUBY_BASERIDIR</td>
1.271 wiz 14082: <td>RUBY_BUILD_DOCUMENT</td>
1.156 leot 14083: </tr>
14084: <tr>
1.266 martin 14085: <td>RUBY_DLEXT</td>
1.271 wiz 14086: <td>RUBY_DOC</td>
1.156 leot 14087: </tr>
14088: <tr>
1.266 martin 14089: <td>RUBY_DYNAMIC_DIRS</td>
1.271 wiz 14090: <td>RUBY_EG</td>
1.156 leot 14091: </tr>
14092: <tr>
1.266 martin 14093: <td>RUBY_ENCODING_ARG</td>
1.271 wiz 14094: <td>RUBY_EXTCONF</td>
1.156 leot 14095: </tr>
14096: <tr>
1.266 martin 14097: <td>RUBY_EXTCONF_CHECK</td>
1.271 wiz 14098: <td>RUBY_EXTCONF_DEBUG</td>
1.156 leot 14099: </tr>
14100: <tr>
1.266 martin 14101: <td>RUBY_EXTCONF_MAKEFILE</td>
1.271 wiz 14102: <td>RUBY_GEM_ARCH</td>
1.198 leot 14103: </tr>
14104: <tr>
1.266 martin 14105: <td>RUBY_GEM_BASE</td>
1.271 wiz 14106: <td>RUBY_INC</td>
1.156 leot 14107: </tr>
14108: <tr>
1.266 martin 14109: <td>RUBY_LIB</td>
1.271 wiz 14110: <td>RUBY_LIB_BASE</td>
1.156 leot 14111: </tr>
14112: <tr>
1.266 martin 14113: <td>RUBY_NAME</td>
1.271 wiz 14114: <td>RUBY_NOVERSION</td>
1.156 leot 14115: </tr>
14116: <tr>
1.266 martin 14117: <td>RUBY_PKGPREFIX</td>
1.271 wiz 14118: <td>RUBY_RAILS</td>
1.156 leot 14119: </tr>
14120: <tr>
1.266 martin 14121: <td>RUBY_RAILS61_VERSION</td>
1.271 wiz 14122: <td>RUBY_RAILS70_VERSION</td>
1.223 nia 14123: </tr>
14124: <tr>
1.266 martin 14125: <td>RUBY_RAILS71_VERSION</td>
1.271 wiz 14126: <td>RUBY_RAILS72_VERSION</td>
1.156 leot 14127: </tr>
14128: <tr>
1.266 martin 14129: <td>RUBY_RAILS80_VERSION</td>
1.271 wiz 14130: <td>RUBY_RAILS_ACCEPTED</td>
1.259 leot 14131: </tr>
14132: <tr>
1.266 martin 14133: <td>RUBY_RAILS_DEFAULT</td>
1.271 wiz 14134: <td>RUBY_RAILS_REQD</td>
1.156 leot 14135: </tr>
14136: <tr>
1.266 martin 14137: <td>RUBY_RAILS_STRICT_DEP</td>
1.271 wiz 14138: <td>RUBY_RIDIR</td>
1.156 leot 14139: </tr>
14140: <tr>
1.266 martin 14141: <td>RUBY_SETUP</td>
1.271 wiz 14142: <td>RUBY_SHLIB</td>
1.156 leot 14143: </tr>
14144: <tr>
1.266 martin 14145: <td>RUBY_SHLIBALIAS</td>
1.271 wiz 14146: <td>RUBY_SHLIBVER</td>
1.156 leot 14147: </tr>
14148: <tr>
1.266 martin 14149: <td>RUBY_SIMPLE_INSTALL</td>
1.271 wiz 14150: <td>RUBY_SITEARCHLIB</td>
1.156 leot 14151: </tr>
14152: <tr>
1.266 martin 14153: <td>RUBY_SITELIB</td>
1.271 wiz 14154: <td>RUBY_SITELIB_BASE</td>
1.156 leot 14155: </tr>
14156: <tr>
1.266 martin 14157: <td>RUBY_SITERIDIR</td>
1.271 wiz 14158: <td>RUBY_SLEXT</td>
1.156 leot 14159: </tr>
14160: <tr>
1.266 martin 14161: <td>RUBY_SRCDIR</td>
1.271 wiz 14162: <td>RUBY_STATICLIB</td>
1.156 leot 14163: </tr>
14164: <tr>
1.266 martin 14165: <td>RUBY_SUFFIX</td>
1.271 wiz 14166: <td>RUBY_SYSRIDIR</td>
1.174 leot 14167: </tr>
14168: <tr>
1.266 martin 14169: <td>RUBY_USE_PTHREAD</td>
1.271 wiz 14170: <td>RUBY_VENDORARCHLIB</td>
1.156 leot 14171: </tr>
14172: <tr>
1.266 martin 14173: <td>RUBY_VENDORLIB</td>
1.271 wiz 14174: <td>RUBY_VENDORLIB_BASE</td>
1.156 leot 14175: </tr>
14176: <tr>
1.266 martin 14177: <td>RUBY_VER</td>
1.271 wiz 14178: <td>RUBY_VERSION</td>
1.156 leot 14179: </tr>
14180: <tr>
1.266 martin 14181: <td>RUBY_VERSIONS_ACCEPTED</td>
1.271 wiz 14182: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.156 leot 14183: </tr>
14184: <tr>
1.266 martin 14185: <td>RUBY_VERSION_DEFAULT</td>
1.271 wiz 14186: <td>RUBY_VERSION_REQD</td>
1.156 leot 14187: </tr>
14188: <tr>
1.266 martin 14189: <td>RUBY_VER_DIR</td>
1.271 wiz 14190: <td>RUN</td>
1.156 leot 14191: </tr>
14192: <tr>
1.266 martin 14193: <td>RUN_LDCONFIG</td>
1.271 wiz 14194: <td>RUST_TYPE</td>
1.156 leot 14195: </tr>
14196: <tr>
1.266 martin 14197: <td>SCO</td>
1.271 wiz 14198: <td>SCREWS_GROUP</td>
1.156 leot 14199: </tr>
14200: <tr>
1.266 martin 14201: <td>SCREWS_USER</td>
1.271 wiz 14202: <td>SCRIPTS_ENV</td>
1.156 leot 14203: </tr>
14204: <tr>
1.266 martin 14205: <td>SCROLLKEEPER_DATADIR</td>
1.271 wiz 14206: <td>SCROLLKEEPER_REBUILDDB</td>
1.156 leot 14207: </tr>
14208: <tr>
1.266 martin 14209: <td>SCROLLKEEPER_UPDATEDB</td>
1.271 wiz 14210: <td>SDIST_PAWD</td>
1.156 leot 14211: </tr>
14212: <tr>
1.266 martin 14213: <td>SDL12_TYPE</td>
1.271 wiz 14214: <td>SERIAL_DEVICES</td>
1.156 leot 14215: </tr>
14216: <tr>
1.266 martin 14217: <td>SETGIDGAME</td>
1.271 wiz 14218: <td>SETGID_GAMES_PERMS</td>
1.156 leot 14219: </tr>
14220: <tr>
1.266 martin 14221: <td>SETUID_ROOT_PERMS</td>
1.271 wiz 14222: <td>SH</td>
1.156 leot 14223: </tr>
14224: <tr>
1.267 leot 14225: <td>SHAIRPORT_GROUP</td>
1.271 wiz 14226: <td>SHAIRPORT_USER</td>
1.267 leot 14227: </tr>
14228: <tr>
1.266 martin 14229: <td>SHLIB_EXT</td>
1.271 wiz 14230: <td>SHORTNAME</td>
1.263 wiz 14231: </tr>
14232: <tr>
1.266 martin 14233: <td>SIGN_PACKAGES</td>
1.271 wiz 14234: <td>SILC_CLIENT_WITH_PERL</td>
1.258 wiz 14235: </tr>
14236: <tr>
1.266 martin 14237: <td>SITE_SPECIFIC_PKGS</td>
1.271 wiz 14238: <td>SKIP_DEPENDS</td>
1.156 leot 14239: </tr>
14240: <tr>
1.266 martin 14241: <td>SMF_INSTANCES</td>
1.271 wiz 14242: <td>SMF_MANIFEST</td>
1.227 wiz 14243: </tr>
14244: <tr>
1.266 martin 14245: <td>SMF_METHODS</td>
1.271 wiz 14246: <td>SMF_METHOD_SHELL</td>
1.156 leot 14247: </tr>
14248: <tr>
1.266 martin 14249: <td>SMF_METHOD_SRC</td>
1.271 wiz 14250: <td>SMF_NAME</td>
1.156 leot 14251: </tr>
14252: <tr>
1.266 martin 14253: <td>SMF_PREFIX</td>
1.271 wiz 14254: <td>SMF_SRCDIR</td>
1.177 leot 14255: </tr>
14256: <tr>
1.266 martin 14257: <td>SNIPROXY_GROUP</td>
1.271 wiz 14258: <td>SNIPROXY_USER</td>
1.156 leot 14259: </tr>
14260: <tr>
1.266 martin 14261: <td>SOURCE_BUFFSIZE</td>
1.271 wiz 14262: <td>SPECIAL_PERMS</td>
1.217 rillig 14263: </tr>
14264: <tr>
1.266 martin 14265: <td>SPECIFIC_PKGS</td>
1.271 wiz 14266: <td>SSH_SUID</td>
1.156 leot 14267: </tr>
14268: <tr>
1.266 martin 14269: <td>SSLCERTBUNDLE</td>
1.271 wiz 14270: <td>SSLCERTS</td>
1.259 leot 14271: </tr>
14272: <tr>
1.266 martin 14273: <td>SSLDIR</td>
1.271 wiz 14274: <td>SSLKEYS</td>
1.259 leot 14275: </tr>
14276: <tr>
1.266 martin 14277: <td>SSP_SUPPORTED</td>
1.271 wiz 14278: <td>SSYNC_PAWD</td>
1.159 rillig 14279: </tr>
14280: <tr>
1.266 martin 14281: <td>STEP_MSG</td>
1.271 wiz 14282: <td>STRIP</td>
1.156 leot 14283: </tr>
14284: <tr>
1.266 martin 14285: <td>STRIP_DBG</td>
1.271 wiz 14286: <td>STRIP_DEBUG</td>
1.156 leot 14287: </tr>
14288: <tr>
1.266 martin 14289: <td>STRIP_DEBUG_SUPPORTED</td>
1.271 wiz 14290: <td>STRIP_FILES_SKIP</td>
1.156 leot 14291: </tr>
14292: <tr>
1.266 martin 14293: <td>SU</td>
1.271 wiz 14294: <td>SUBDIR</td>
1.156 leot 14295: </tr>
14296: <tr>
1.266 martin 14297: <td>SUBST</td>
1.271 wiz 14298: <td>SUBST_CLASSES</td>
1.156 leot 14299: </tr>
14300: <tr>
1.266 martin 14301: <td>SUBST_FILES</td>
1.271 wiz 14302: <td>SUBST_FILTER_CMD</td>
1.156 leot 14303: </tr>
14304: <tr>
1.266 martin 14305: <td>SUBST_MESSAGE</td>
1.271 wiz 14306: <td>SUBST_NOOP_OK</td>
1.156 leot 14307: </tr>
14308: <tr>
1.266 martin 14309: <td>SUBST_SED</td>
1.271 wiz 14310: <td>SUBST_SHOW_DIFF</td>
1.156 leot 14311: </tr>
14312: <tr>
1.266 martin 14313: <td>SUBST_SKIP_TEXT_CHECK</td>
1.271 wiz 14314: <td>SUBST_STAGE</td>
1.156 leot 14315: </tr>
14316: <tr>
1.266 martin 14317: <td>SUBST_VARS</td>
1.271 wiz 14318: <td>SUNWSPROBASE</td>
1.156 leot 14319: </tr>
14320: <tr>
1.266 martin 14321: <td>SUSE_PREFER</td>
1.271 wiz 14322: <td>SU_CMD</td>
1.263 wiz 14323: </tr>
14324: <tr>
1.266 martin 14325: <td>SVN_EXTRACTDIR</td>
1.271 wiz 14326: <td>SVN_REPO</td>
1.263 wiz 14327: </tr>
14328: <tr>
1.266 martin 14329: <td>SVN_REPOSITORIES</td>
1.271 wiz 14330: <td>SVN_REVISION</td>
1.246 leot 14331: </tr>
14332: <tr>
1.266 martin 14333: <td>SYSCONFBASE</td>
1.271 wiz 14334: <td>TARGET_MACHINE_ARCH</td>
1.258 wiz 14335: </tr>
14336: <tr>
1.266 martin 14337: <td>TBL</td>
1.271 wiz 14338: <td>TERMCAP_TYPE</td>
1.255 wiz 14339: </tr>
14340: <tr>
1.266 martin 14341: <td>TERMINFO_DEFAULT</td>
1.271 wiz 14342: <td>TERMINFO_TYPE</td>
1.156 leot 14343: </tr>
14344: <tr>
1.266 martin 14345: <td>TEST</td>
1.271 wiz 14346: <td>TEST_DEPENDS</td>
1.227 wiz 14347: </tr>
14348: <tr>
1.266 martin 14349: <td>TEST_DIRS</td>
1.271 wiz 14350: <td>TEST_ENV</td>
1.156 leot 14351: </tr>
14352: <tr>
1.266 martin 14353: <td>TEST_ENV_SHELL</td>
1.271 wiz 14354: <td>TEST_MAKE_CMD</td>
1.217 rillig 14355: </tr>
14356: <tr>
1.266 martin 14357: <td>TEST_MAKE_FLAGS</td>
1.271 wiz 14358: <td>TEST_TARGET</td>
1.212 wiz 14359: </tr>
14360: <tr>
1.266 martin 14361: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.271 wiz 14362: <td>TEXLIVE_REV</td>
1.217 rillig 14363: </tr>
14364: <tr>
1.266 martin 14365: <td>TEXLIVE_UNVERSIONED</td>
1.271 wiz 14366: <td>TEXMFSITE</td>
1.205 wiz 14367: </tr>
14368: <tr>
1.266 martin 14369: <td>TEX_FORMATS</td>
1.271 wiz 14370: <td>TEX_HYPHEN_DAT</td>
1.189 bacon 14371: </tr>
14372: <tr>
1.266 martin 14373: <td>TEX_HYPHEN_DEF</td>
1.271 wiz 14374: <td>TEX_TEXMF_DIRS</td>
1.161 leot 14375: </tr>
14376: <tr>
1.266 martin 14377: <td>THTTPD_LOG_FACILITY</td>
1.271 wiz 14378: <td>TINYDYN_USER</td>
1.159 rillig 14379: </tr>
14380: <tr>
1.266 martin 14381: <td>TLS</td>
1.271 wiz 14382: <td>TLSWRAPPER_CHROOT</td>
1.259 leot 14383: </tr>
14384: <tr>
1.266 martin 14385: <td>TO</td>
1.271 wiz 14386: <td>TOOLDIR</td>
1.156 leot 14387: </tr>
14388: <tr>
1.266 martin 14389: <td>TOOLS_ALIASES</td>
1.271 wiz 14390: <td>TOOLS_ALWAYS_WRAP</td>
1.156 leot 14391: </tr>
14392: <tr>
1.266 martin 14393: <td>TOOLS_ARGS</td>
1.271 wiz 14394: <td>TOOLS_BROKEN</td>
1.156 leot 14395: </tr>
14396: <tr>
1.266 martin 14397: <td>TOOLS_CMD</td>
1.271 wiz 14398: <td>TOOLS_CMDLINE_SED</td>
1.156 leot 14399: </tr>
14400: <tr>
1.266 martin 14401: <td>TOOLS_CREATE</td>
1.271 wiz 14402: <td>TOOLS_CROSS_DESTDIR</td>
1.156 leot 14403: </tr>
14404: <tr>
1.266 martin 14405: <td>TOOLS_DIR</td>
1.271 wiz 14406: <td>TOOLS_FAIL</td>
1.156 leot 14407: </tr>
14408: <tr>
1.266 martin 14409: <td>TOOLS_GNU_MISSING</td>
1.271 wiz 14410: <td>TOOLS_LDCONFIG</td>
1.156 leot 14411: </tr>
14412: <tr>
1.266 martin 14413: <td>TOOLS_NOOP</td>
1.271 wiz 14414: <td>TOOLS_PATH</td>
1.156 leot 14415: </tr>
14416: <tr>
1.266 martin 14417: <td>TOOLS_SCRIPT</td>
1.271 wiz 14418: <td>TOOLS_USE_CROSS_COMPILE</td>
1.156 leot 14419: </tr>
14420: <tr>
1.266 martin 14421: <td>TOOL_DEPENDS</td>
1.271 wiz 14422: <td>TTF_FONTDIR</td>
1.156 leot 14423: </tr>
14424: <tr>
1.266 martin 14425: <td>TTF_FONTS_DIR</td>
1.271 wiz 14426: <td>TYPE</td>
1.254 wiz 14427: </tr>
14428: <tr>
1.266 martin 14429: <td>UAC_REQD_EXECS</td>
1.271 wiz 14430: <td>UCSPI_SSL_GROUP</td>
1.241 rillig 14431: </tr>
14432: <tr>
1.266 martin 14433: <td>UCSPI_SSL_USER</td>
1.271 wiz 14434: <td>UNBOUND_GROUP</td>
1.238 wiz 14435: </tr>
14436: <tr>
1.266 martin 14437: <td>UNBOUND_LOG_FACILITY</td>
1.271 wiz 14438: <td>UNBOUND_USER</td>
1.260 wiz 14439: </tr>
14440: <tr>
1.266 martin 14441: <td>UNLIMIT_RESOURCES</td>
1.271 wiz 14442: <td>UNPRIVILEGED</td>
1.260 wiz 14443: </tr>
14444: <tr>
1.266 martin 14445: <td>UNPRIVILEGED_GROUP</td>
1.271 wiz 14446: <td>UNPRIVILEGED_GROUPS</td>
1.156 leot 14447: </tr>
14448: <tr>
1.266 martin 14449: <td>UNPRIVILEGED_USER</td>
1.271 wiz 14450: <td>UNWRAP_FILES</td>
1.223 nia 14451: </tr>
14452: <tr>
1.266 martin 14453: <td>UNWRAP_PATTERNS</td>
1.271 wiz 14454: <td>UPDATE_GEMSPEC</td>
1.156 leot 14455: </tr>
14456: <tr>
1.266 martin 14457: <td>UPDATE_TARGET</td>
1.271 wiz 14458: <td>URI</td>
1.212 wiz 14459: </tr>
14460: <tr>
1.266 martin 14461: <td>USERGROUP_PHASE</td>
1.271 wiz 14462: <td>USERPPP_GROUP</td>
1.156 leot 14463: </tr>
14464: <tr>
1.266 martin 14465: <td>USER_SPECIFIC_PKGS</td>
1.271 wiz 14466: <td>USE_ABI_DEPENDS</td>
1.156 leot 14467: </tr>
14468: <tr>
1.266 martin 14469: <td>USE_ADA_FEATURES</td>
1.271 wiz 14470: <td>USE_APR</td>
1.156 leot 14471: </tr>
14472: <tr>
1.266 martin 14473: <td>USE_BSD_MAKEFILE</td>
1.271 wiz 14474: <td>USE_BUILTIN</td>
1.156 leot 14475: </tr>
14476: <tr>
1.266 martin 14477: <td>USE_CC_FEATURES</td>
1.271 wiz 14478: <td>USE_CROSS_COMPILE</td>
1.156 leot 14479: </tr>
14480: <tr>
1.266 martin 14481: <td>USE_CURSES</td>
1.271 wiz 14482: <td>USE_CWRAPPERS</td>
1.243 gutterid 14483: </tr>
14484: <tr>
1.266 martin 14485: <td>USE_CXX_FEATURES</td>
1.271 wiz 14486: <td>USE_DB185</td>
1.156 leot 14487: </tr>
14488: <tr>
1.266 martin 14489: <td>USE_FEATURES</td>
1.271 wiz 14490: <td>USE_GAMESGROUP</td>
1.156 leot 14491: </tr>
14492: <tr>
1.266 martin 14493: <td>USE_GCC_RUNTIME</td>
1.271 wiz 14494: <td>USE_IMAKE</td>
1.156 leot 14495: </tr>
14496: <tr>
1.266 martin 14497: <td>USE_INDIRECT_DEPENDS</td>
1.271 wiz 14498: <td>USE_JAVA</td>
1.205 wiz 14499: </tr>
14500: <tr>
1.266 martin 14501: <td>USE_JAVA2</td>
1.271 wiz 14502: <td>USE_LANGUAGES</td>
1.156 leot 14503: </tr>
14504: <tr>
1.266 martin 14505: <td>USE_LIBTOOL</td>
1.271 wiz 14506: <td>USE_NATIVE_GCC</td>
1.156 leot 14507: </tr>
14508: <tr>
1.266 martin 14509: <td>USE_NETBSD_REPO</td>
1.271 wiz 14510: <td>USE_PKGSRC_GCC</td>
1.156 leot 14511: </tr>
14512: <tr>
1.266 martin 14513: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.271 wiz 14514: <td>USE_PKGTASKS</td>
1.156 leot 14515: </tr>
14516: <tr>
1.266 martin 14517: <td>USE_PKG_ADMIN_DIGEST</td>
1.271 wiz 14518: <td>USE_RUBY_EXTCONF</td>
1.156 leot 14519: </tr>
14520: <tr>
1.266 martin 14521: <td>USE_RUBY_INSTALL</td>
1.271 wiz 14522: <td>USE_RUBY_SETUP</td>
1.156 leot 14523: </tr>
14524: <tr>
1.266 martin 14525: <td>USE_RUBY_SETUP_PKG</td>
1.271 wiz 14526: <td>USE_TMPFILES</td>
1.258 wiz 14527: </tr>
14528: <tr>
1.266 martin 14529: <td>USE_TOOLS</td>
1.271 wiz 14530: <td>UUCP_GROUP</td>
1.156 leot 14531: </tr>
14532: <tr>
1.266 martin 14533: <td>UUCP_USER</td>
1.271 wiz 14534: <td>VARBASE</td>
1.156 leot 14535: </tr>
14536: <tr>
1.266 martin 14537: <td>VARNAME</td>
1.271 wiz 14538: <td>VIM_EXTRA_OPTS</td>
1.156 leot 14539: </tr>
14540: <tr>
1.266 martin 14541: <td>WARNING_MSG</td>
1.271 wiz 14542: <td>WCALC_CGIDIR</td>
1.156 leot 14543: </tr>
14544: <tr>
1.266 martin 14545: <td>WCALC_CGIPATH</td>
1.271 wiz 14546: <td>WCALC_HTMLDIR</td>
1.156 leot 14547: </tr>
14548: <tr>
1.266 martin 14549: <td>WCALC_HTMLPATH</td>
1.271 wiz 14550: <td>WDM_MANAGERS</td>
1.156 leot 14551: </tr>
14552: <tr>
1.266 martin 14553: <td>WRAPPER_CC</td>
1.271 wiz 14554: <td>WRAPPER_REORDER_CMDS</td>
1.156 leot 14555: </tr>
14556: <tr>
1.266 martin 14557: <td>WRKDIR</td>
1.271 wiz 14558: <td>WRKDIR_BASENAME</td>
1.156 leot 14559: </tr>
14560: <tr>
1.266 martin 14561: <td>WRKDIR_LOCKTYPE</td>
1.271 wiz 14562: <td>WRKLOG</td>
1.156 leot 14563: </tr>
14564: <tr>
1.266 martin 14565: <td>WRKOBJDIR</td>
1.271 wiz 14566: <td>WRKSRC</td>
1.156 leot 14567: </tr>
14568: <tr>
1.266 martin 14569: <td>X10_PORT</td>
1.271 wiz 14570: <td>X11</td>
1.156 leot 14571: </tr>
14572: <tr>
1.266 martin 14573: <td>X11BASE</td>
1.271 wiz 14574: <td>X11_PKGSRCDIR</td>
1.156 leot 14575: </tr>
14576: <tr>
1.266 martin 14577: <td>X11_TYPE</td>
1.271 wiz 14578: <td>X509_CERTIFICATE</td>
1.156 leot 14579: </tr>
14580: <tr>
1.266 martin 14581: <td>X509_KEY</td>
1.271 wiz 14582: <td>XAW_TYPE</td>
1.189 bacon 14583: </tr>
14584: <tr>
1.266 martin 14585: <td>XLOCK_DEFAULT_MODE</td>
1.271 wiz 14586: <td>XMKMF</td>
1.156 leot 14587: </tr>
14588: <tr>
1.266 martin 14589: <td>XMKMF_FLAGS</td>
1.271 wiz 14590: <td>XXX</td>
1.263 wiz 14591: </tr>
14592: <tr>
1.266 martin 14593: <td>XXXX</td>
1.271 wiz 14594: <td>YES</td>
1.156 leot 14595: </tr>
14596: <tr>
1.266 martin 14597: <td>ZSH_STATIC</td>
1.271 wiz 14598: <td>__stdc__</td>
1.246 leot 14599: </tr>
14600: <tr>
1.266 martin 14601: <td>_vargroups</td>
1.271 wiz 14602: <td>accept</td>
1.233 wiz 14603: </tr>
14604: <tr>
1.266 martin 14605: <td>acquire-localbase-lock</td>
1.271 wiz 14606: <td>acquire-lock</td>
1.156 leot 14607: </tr>
14608: <tr>
1.266 martin 14609: <td>add</td>
1.271 wiz 14610: <td>added</td>
1.227 wiz 14611: </tr>
14612: <tr>
1.266 martin 14613: <td>administrator</td>
1.271 wiz 14614: <td>alloca</td>
1.156 leot 14615: </tr>
14616: <tr>
1.266 martin 14617: <td>alternatives</td>
1.271 wiz 14618: <td>aslr</td>
1.159 rillig 14619: </tr>
14620: <tr>
1.266 martin 14621: <td>asprintf</td>
1.271 wiz 14622: <td>atlas</td>
1.217 rillig 14623: </tr>
14624: <tr>
1.266 martin 14625: <td>autoconf</td>
1.271 wiz 14626: <td>automake</td>
1.156 leot 14627: </tr>
14628: <tr>
1.266 martin 14629: <td>autoreconf</td>
1.271 wiz 14630: <td>awk</td>
1.265 leot 14631: </tr>
14632: <tr>
1.266 martin 14633: <td>barrier</td>
1.271 wiz 14634: <td>bash</td>
1.201 cirnatda 14635: </tr>
14636: <tr>
1.266 martin 14637: <td>big-endian</td>
1.271 wiz 14638: <td>bin-install</td>
1.174 leot 14639: </tr>
14640: <tr>
1.266 martin 14641: <td>bind</td>
1.271 wiz 14642: <td>binpkg-list</td>
1.156 leot 14643: </tr>
14644: <tr>
1.266 martin 14645: <td>blas</td>
1.271 wiz 14646: <td>bootstrap-depends</td>
1.156 leot 14647: </tr>
14648: <tr>
1.266 martin 14649: <td>broken</td>
1.271 wiz 14650: <td>broken_on_platform</td>
1.174 leot 14651: </tr>
14652: <tr>
1.266 martin 14653: <td>bsd</td>
1.271 wiz 14654: <td>bsd.prog.mk</td>
1.156 leot 14655: </tr>
14656: <tr>
1.266 martin 14657: <td>build</td>
1.271 wiz 14658: <td>build-env</td>
1.161 leot 14659: </tr>
14660: <tr>
1.266 martin 14661: <td>buildlink-directories</td>
1.271 wiz 14662: <td>buildlink-oss-soundcard-h</td>
1.156 leot 14663: </tr>
14664: <tr>
1.266 martin 14665: <td>built-in</td>
1.271 wiz 14666: <td>builtin</td>
1.156 leot 14667: </tr>
14668: <tr>
1.266 martin 14669: <td>c</td>
1.271 wiz 14670: <td>c++</td>
1.156 leot 14671: </tr>
14672: <tr>
1.266 martin 14673: <td>ccache</td>
1.271 wiz 14674: <td>cce</td>
1.242 gutterid 14675: </tr>
14676: <tr>
1.266 martin 14677: <td>cdefs</td>
1.271 wiz 14678: <td>ceil</td>
1.177 leot 14679: </tr>
14680: <tr>
1.266 martin 14681: <td>changes</td>
1.271 wiz 14682: <td>changes-entry</td>
1.159 rillig 14683: </tr>
14684: <tr>
1.266 martin 14685: <td>changes-entry-noupdate</td>
1.271 wiz 14686: <td>check</td>
1.156 leot 14687: </tr>
14688: <tr>
1.266 martin 14689: <td>check-clean</td>
1.271 wiz 14690: <td>check-files</td>
1.174 leot 14691: </tr>
14692: <tr>
1.266 martin 14693: <td>check-files-clean</td>
1.271 wiz 14694: <td>check-hackage</td>
1.156 leot 14695: </tr>
14696: <tr>
1.266 martin 14697: <td>check-vulnerable</td>
1.271 wiz 14698: <td>checksum</td>
1.156 leot 14699: </tr>
14700: <tr>
1.266 martin 14701: <td>checksum-phase</td>
1.271 wiz 14702: <td>clean</td>
1.255 wiz 14703: </tr>
14704: <tr>
1.266 martin 14705: <td>clean-depends</td>
1.271 wiz 14706: <td>cleandir</td>
1.156 leot 14707: </tr>
14708: <tr>
1.266 martin 14709: <td>commit</td>
1.271 wiz 14710: <td>commit-changes-entry</td>
1.156 leot 14711: </tr>
14712: <tr>
1.266 martin 14713: <td>compact</td>
1.271 wiz 14714: <td>compiler</td>
1.174 leot 14715: </tr>
14716: <tr>
1.266 martin 14717: <td>conf</td>
1.271 wiz 14718: <td>config.guess</td>
1.156 leot 14719: </tr>
14720: <tr>
1.266 martin 14721: <td>config.sub</td>
1.271 wiz 14722: <td>configuration</td>
1.156 leot 14723: </tr>
14724: <tr>
1.266 martin 14725: <td>configure</td>
1.271 wiz 14726: <td>configure-env</td>
1.156 leot 14727: </tr>
14728: <tr>
1.266 martin 14729: <td>configure-help</td>
1.271 wiz 14730: <td>configure_args</td>
1.156 leot 14731: </tr>
14732: <tr>
1.266 martin 14733: <td>connect</td>
1.271 wiz 14734: <td>cos</td>
1.156 leot 14735: </tr>
14736: <tr>
1.266 martin 14737: <td>cpe</td>
1.271 wiz 14738: <td>cputime</td>
1.156 leot 14739: </tr>
14740: <tr>
1.266 martin 14741: <td>create-usergroup</td>
1.271 wiz 14742: <td>csh</td>
1.156 leot 14743: </tr>
14744: <tr>
1.266 martin 14745: <td>ctf</td>
1.271 wiz 14746: <td>cvs</td>
1.156 leot 14747: </tr>
14748: <tr>
1.266 martin 14749: <td>debug</td>
1.271 wiz 14750: <td>debug-barrier</td>
1.254 wiz 14751: </tr>
14752: <tr>
1.266 martin 14753: <td>declaration</td>
1.271 wiz 14754: <td>declare</td>
1.258 wiz 14755: </tr>
14756: <tr>
1.266 martin 14757: <td>defined</td>
1.271 wiz 14758: <td>depend</td>
1.241 rillig 14759: </tr>
14760: <tr>
1.266 martin 14761: <td>dependencies</td>
1.271 wiz 14762: <td>depends</td>
1.238 wiz 14763: </tr>
14764: <tr>
1.266 martin 14765: <td>depends-checksum</td>
1.271 wiz 14766: <td>depends-fetch</td>
1.223 nia 14767: </tr>
14768: <tr>
1.260 wiz 14769: <td>describe</td>
1.271 wiz 14770: <td>destdir</td>
1.174 leot 14771: </tr>
14772: <tr>
1.260 wiz 14773: <td>disable</td>
1.271 wiz 14774: <td>distclean</td>
1.214 leot 14775: </tr>
14776: <tr>
1.260 wiz 14777: <td>distfiles</td>
1.271 wiz 14778: <td>distinfo</td>
1.205 wiz 14779: </tr>
14780: <tr>
1.259 leot 14781: <td>dl</td>
1.271 wiz 14782: <td>dlopen</td>
1.161 leot 14783: </tr>
14784: <tr>
1.259 leot 14785: <td>do-buildlink</td>
1.271 wiz 14786: <td>do-clean</td>
1.197 leot 14787: </tr>
14788: <tr>
1.259 leot 14789: <td>do-configure</td>
1.271 wiz 14790: <td>do-configure-post-hook</td>
1.156 leot 14791: </tr>
14792: <tr>
1.259 leot 14793: <td>do-extract</td>
1.271 wiz 14794: <td>do-fetch</td>
1.156 leot 14795: </tr>
14796: <tr>
1.263 wiz 14797: <td>do-install</td>
1.271 wiz 14798: <td>download</td>
1.263 wiz 14799: </tr>
14800: <tr>
1.259 leot 14801: <td>emul</td>
1.271 wiz 14802: <td>emul-distinfo</td>
1.156 leot 14803: </tr>
14804: <tr>
1.259 leot 14805: <td>emul-fetch</td>
1.271 wiz 14806: <td>emulation</td>
1.156 leot 14807: </tr>
14808: <tr>
1.259 leot 14809: <td>emulator</td>
1.271 wiz 14810: <td>enable</td>
1.162 rillig 14811: </tr>
14812: <tr>
1.259 leot 14813: <td>endian</td>
1.271 wiz 14814: <td>endif</td>
1.156 leot 14815: </tr>
14816: <tr>
1.259 leot 14817: <td>enomem</td>
1.271 wiz 14818: <td>ensurepip</td>
1.258 wiz 14819: </tr>
14820: <tr>
1.259 leot 14821: <td>err</td>
1.271 wiz 14822: <td>errx</td>
1.233 wiz 14823: </tr>
14824: <tr>
1.259 leot 14825: <td>etc</td>
1.271 wiz 14826: <td>exp</td>
1.156 leot 14827: </tr>
14828: <tr>
1.259 leot 14829: <td>extract-rpm</td>
1.271 wiz 14830: <td>fabs</td>
1.227 wiz 14831: </tr>
14832: <tr>
1.259 leot 14833: <td>feature</td>
1.271 wiz 14834: <td>features</td>
1.214 leot 14835: </tr>
14836: <tr>
1.259 leot 14837: <td>fetch</td>
1.271 wiz 14838: <td>fetch-list</td>
1.156 leot 14839: </tr>
14840: <tr>
1.259 leot 14841: <td>follows</td>
1.271 wiz 14842: <td>forbids</td>
1.205 wiz 14843: </tr>
14844: <tr>
1.259 leot 14845: <td>form</td>
1.271 wiz 14846: <td>format</td>
1.197 leot 14847: </tr>
14848: <tr>
1.259 leot 14849: <td>fortify</td>
1.271 wiz 14850: <td>fortify_source</td>
1.238 wiz 14851: </tr>
14852: <tr>
1.263 wiz 14853: <td>fossil</td>
1.271 wiz 14854: <td>friend</td>
1.263 wiz 14855: </tr>
14856: <tr>
1.259 leot 14857: <td>fts</td>
1.271 wiz 14858: <td>fts_close</td>
1.254 wiz 14859: </tr>
14860: <tr>
1.259 leot 14861: <td>fts_open</td>
1.271 wiz 14862: <td>fts_read</td>
1.241 rillig 14863: </tr>
14864: <tr>
1.259 leot 14865: <td>fts_set</td>
1.271 wiz 14866: <td>gcc</td>
1.217 rillig 14867: </tr>
14868: <tr>
1.259 leot 14869: <td>gethostbyaddr</td>
1.271 wiz 14870: <td>gethostbyname</td>
1.223 nia 14871: </tr>
14872: <tr>
1.259 leot 14873: <td>gethostbyname2</td>
1.271 wiz 14874: <td>getopt_long</td>
1.156 leot 14875: </tr>
14876: <tr>
1.259 leot 14877: <td>getprogname</td>
1.271 wiz 14878: <td>getservbyname</td>
1.156 leot 14879: </tr>
14880: <tr>
1.259 leot 14881: <td>getservbyport</td>
1.271 wiz 14882: <td>getservent</td>
1.156 leot 14883: </tr>
14884: <tr>
1.259 leot 14885: <td>gettext</td>
1.271 wiz 14886: <td>git</td>
1.156 leot 14887: </tr>
14888: <tr>
1.259 leot 14889: <td>github</td>
1.271 wiz 14890: <td>gitlab</td>
1.258 wiz 14891: </tr>
14892: <tr>
1.259 leot 14893: <td>glob</td>
1.271 wiz 14894: <td>gnu</td>
1.233 wiz 14895: </tr>
14896: <tr>
1.259 leot 14897: <td>gnu_configure_strict</td>
1.271 wiz 14898: <td>go</td>
1.227 wiz 14899: </tr>
14900: <tr>
1.266 martin 14901: <td>golang</td>
1.271 wiz 14902: <td>guess-license</td>
1.223 nia 14903: </tr>
14904: <tr>
1.266 martin 14905: <td>hashbang</td>
1.271 wiz 14906: <td>heimdal</td>
1.238 wiz 14907: </tr>
14908: <tr>
1.266 martin 14909: <td>help</td>
1.271 wiz 14910: <td>hg</td>
1.263 wiz 14911: </tr>
14912: <tr>
1.266 martin 14913: <td>imake</td>
1.271 wiz 14914: <td>in-tree</td>
1.254 wiz 14915: </tr>
14916: <tr>
1.266 martin 14917: <td>increment</td>
1.271 wiz 14918: <td>indirect</td>
1.241 rillig 14919: </tr>
14920: <tr>
1.266 martin 14921: <td>inet_aton</td>
1.271 wiz 14922: <td>install</td>
1.260 wiz 14923: </tr>
14924: <tr>
1.266 martin 14925: <td>install-env</td>
1.271 wiz 14926: <td>interp</td>
1.156 leot 14927: </tr>
14928: <tr>
1.266 martin 14929: <td>interpreter</td>
1.271 wiz 14930: <td>intl</td>
1.214 leot 14931: </tr>
14932: <tr>
1.266 martin 14933: <td>ip4</td>
1.271 wiz 14934: <td>ip6</td>
1.156 leot 14935: </tr>
14936: <tr>
1.266 martin 14937: <td>ipv4</td>
1.271 wiz 14938: <td>ipv6</td>
1.205 wiz 14939: </tr>
14940: <tr>
1.266 martin 14941: <td>iso</td>
1.271 wiz 14942: <td>kerberos</td>
1.197 leot 14943: </tr>
14944: <tr>
1.266 martin 14945: <td>krb</td>
1.271 wiz 14946: <td>krb5</td>
1.161 leot 14947: </tr>
14948: <tr>
1.266 martin 14949: <td>ksh</td>
1.271 wiz 14950: <td>lapack</td>
1.156 leot 14951: </tr>
14952: <tr>
1.266 martin 14953: <td>latex</td>
1.271 wiz 14954: <td>libiconv</td>
1.156 leot 14955: </tr>
14956: <tr>
1.266 martin 14957: <td>libintl_bindtextdomain</td>
1.271 wiz 14958: <td>libintl_gettext</td>
1.156 leot 14959: </tr>
14960: <tr>
1.266 martin 14961: <td>libintl_textdomain</td>
1.271 wiz 14962: <td>libnbcompat</td>
1.189 bacon 14963: </tr>
14964: <tr>
1.266 martin 14965: <td>libs</td>
1.271 wiz 14966: <td>libtool</td>
1.189 bacon 14967: </tr>
14968: <tr>
1.266 martin 14969: <td>licence</td>
1.271 wiz 14970: <td>license</td>
1.156 leot 14971: </tr>
14972: <tr>
1.266 martin 14973: <td>lintl</td>
1.271 wiz 14974: <td>little-endian</td>
1.177 leot 14975: </tr>
14976: <tr>
1.266 martin 14977: <td>lock</td>
1.271 wiz 14978: <td>locking</td>
1.156 leot 14979: </tr>
14980: <tr>
1.266 martin 14981: <td>lua</td>
1.271 wiz 14982: <td>lvalue</td>
1.174 leot 14983: </tr>
14984: <tr>
1.266 martin 14985: <td>machine_endian</td>
1.271 wiz 14986: <td>make</td>
1.159 rillig 14987: </tr>
14988: <tr>
1.266 martin 14989: <td>makedistinfo</td>
1.271 wiz 14990: <td>makepatchsum</td>
1.259 leot 14991: </tr>
14992: <tr>
1.266 martin 14993: <td>makesum</td>
1.271 wiz 14994: <td>mdi</td>
1.246 leot 14995: </tr>
14996: <tr>
1.266 martin 14997: <td>memory</td>
1.271 wiz 14998: <td>mercurial</td>
1.258 wiz 14999: </tr>
15000: <tr>
1.266 martin 15001: <td>meta</td>
1.271 wiz 15002: <td>meta-package</td>
1.156 leot 15003: </tr>
15004: <tr>
1.266 martin 15005: <td>meta_package</td>
1.271 wiz 15006: <td>mit-krb5</td>
1.233 wiz 15007: </tr>
15008: <tr>
1.266 martin 15009: <td>mk.conf</td>
1.271 wiz 15010: <td>mkl</td>
1.227 wiz 15011: </tr>
15012: <tr>
1.266 martin 15013: <td>mount</td>
1.271 wiz 15014: <td>move</td>
1.156 leot 15015: </tr>
15016: <tr>
1.266 martin 15017: <td>moved</td>
1.271 wiz 15018: <td>mprotect</td>
1.259 leot 15019: </tr>
15020: <tr>
1.266 martin 15021: <td>mps</td>
1.271 wiz 15022: <td>mremap</td>
1.156 leot 15023: </tr>
15024: <tr>
1.266 martin 15025: <td>native</td>
1.271 wiz 15026: <td>nb</td>
1.177 leot 15027: </tr>
15028: <tr>
1.266 martin 15029: <td>nbcompat</td>
1.271 wiz 15030: <td>netlib</td>
1.159 rillig 15031: </tr>
15032: <tr>
1.266 martin 15033: <td>network</td>
1.271 wiz 15034: <td>node</td>
1.255 wiz 15035: </tr>
15036: <tr>
1.266 martin 15037: <td>node.js</td>
1.271 wiz 15038: <td>nodejs</td>
1.226 gutterid 15039: </tr>
15040: <tr>
1.266 martin 15041: <td>obstack</td>
1.271 wiz 15042: <td>obstack_ptr_grow</td>
1.156 leot 15043: </tr>
15044: <tr>
1.266 martin 15045: <td>occurs</td>
1.271 wiz 15046: <td>only</td>
1.156 leot 15047: </tr>
15048: <tr>
1.266 martin 15049: <td>openblas</td>
1.271 wiz 15050: <td>options</td>
1.218 nia 15051: </tr>
15052: <tr>
1.266 martin 15053: <td>options.mk</td>
1.271 wiz 15054: <td>order</td>
1.218 nia 15055: </tr>
15056: <tr>
1.266 martin 15057: <td>override</td>
1.271 wiz 15058: <td>override-intltool</td>
1.205 wiz 15059: </tr>
15060: <tr>
1.266 martin 15061: <td>override-message-intltool</td>
1.271 wiz 15062: <td>package</td>
1.156 leot 15063: </tr>
15064: <tr>
1.266 martin 15065: <td>parallel</td>
1.271 wiz 15066: <td>path</td>
1.161 leot 15067: </tr>
15068: <tr>
1.266 martin 15069: <td>pax</td>
1.271 wiz 15070: <td>paxctl</td>
1.156 leot 15071: </tr>
15072: <tr>
1.266 martin 15073: <td>pbulk-index</td>
1.271 wiz 15074: <td>pc</td>
1.156 leot 15075: </tr>
15076: <tr>
1.266 martin 15077: <td>perl</td>
1.271 wiz 15078: <td>perl5</td>
1.156 leot 15079: </tr>
15080: <tr>
1.266 martin 15081: <td>perms</td>
1.271 wiz 15082: <td>php</td>
1.156 leot 15083: </tr>
15084: <tr>
1.266 martin 15085: <td>pkg-build-options</td>
1.271 wiz 15086: <td>pkg-config</td>
1.156 leot 15087: </tr>
15088: <tr>
1.266 martin 15089: <td>pkg_build_options</td>
1.271 wiz 15090: <td>pkgsrc</td>
1.156 leot 15091: </tr>
15092: <tr>
1.266 martin 15093: <td>platform</td>
1.271 wiz 15094: <td>plist</td>
1.156 leot 15095: </tr>
15096: <tr>
1.266 martin 15097: <td>post-extract</td>
1.271 wiz 15098: <td>post-fetch</td>
1.156 leot 15099: </tr>
15100: <tr>
1.266 martin 15101: <td>post-wrapper</td>
1.271 wiz 15102: <td>pre-build-checks-hook</td>
1.156 leot 15103: </tr>
15104: <tr>
1.266 martin 15105: <td>pre-configure-checks-hook</td>
1.271 wiz 15106: <td>pre-extract</td>
1.156 leot 15107: </tr>
15108: <tr>
1.266 martin 15109: <td>pre-fetch</td>
1.271 wiz 15110: <td>print-plist</td>
1.156 leot 15111: </tr>
15112: <tr>
1.258 wiz 15113: <td>print-summary-data</td>
1.271 wiz 15114: <td>privileged-install-hook</td>
1.156 leot 15115: </tr>
15116: <tr>
1.258 wiz 15117: <td>pypi</td>
1.271 wiz 15118: <td>python</td>
1.156 leot 15119: </tr>
15120: <tr>
1.258 wiz 15121: <td>r</td>
1.271 wiz 15122: <td>readme-all</td>
1.174 leot 15123: </tr>
15124: <tr>
1.258 wiz 15125: <td>recursive</td>
1.271 wiz 15126: <td>recv</td>
1.156 leot 15127: </tr>
15128: <tr>
1.258 wiz 15129: <td>recvfrom</td>
1.271 wiz 15130: <td>regcomp</td>
1.156 leot 15131: </tr>
15132: <tr>
1.258 wiz 15133: <td>release-localbase-lock</td>
1.271 wiz 15134: <td>release-lock</td>
1.156 leot 15135: </tr>
15136: <tr>
1.258 wiz 15137: <td>relro</td>
1.271 wiz 15138: <td>remove</td>
1.156 leot 15139: </tr>
15140: <tr>
1.258 wiz 15141: <td>removed</td>
1.271 wiz 15142: <td>rename</td>
1.156 leot 15143: </tr>
15144: <tr>
1.258 wiz 15145: <td>renamed</td>
1.271 wiz 15146: <td>reorder</td>
1.174 leot 15147: </tr>
15148: <tr>
1.258 wiz 15149: <td>replace</td>
1.271 wiz 15150: <td>replace_interpreter</td>
1.174 leot 15151: </tr>
15152: <tr>
1.258 wiz 15153: <td>reproducible</td>
1.271 wiz 15154: <td>resolv</td>
1.156 leot 15155: </tr>
15156: <tr>
1.258 wiz 15157: <td>root</td>
1.271 wiz 15158: <td>ruby</td>
1.226 gutterid 15159: </tr>
15160: <tr>
1.258 wiz 15161: <td>send</td>
1.271 wiz 15162: <td>sendfile</td>
1.226 gutterid 15163: </tr>
15164: <tr>
1.258 wiz 15165: <td>sendto</td>
1.271 wiz 15166: <td>setenv</td>
1.156 leot 15167: </tr>
15168: <tr>
1.258 wiz 15169: <td>setgid</td>
1.271 wiz 15170: <td>setprogname</td>
1.156 leot 15171: </tr>
15172: <tr>
1.258 wiz 15173: <td>setuid</td>
1.271 wiz 15174: <td>sh</td>
1.156 leot 15175: </tr>
15176: <tr>
1.258 wiz 15177: <td>shebang</td>
1.271 wiz 15178: <td>show</td>
1.174 leot 15179: </tr>
15180: <tr>
1.258 wiz 15181: <td>show-all</td>
1.271 wiz 15182: <td>show-build-defs</td>
1.156 leot 15183: </tr>
15184: <tr>
1.258 wiz 15185: <td>show-depends</td>
1.271 wiz 15186: <td>show-depends-dirs</td>
1.156 leot 15187: </tr>
15188: <tr>
1.258 wiz 15189: <td>show-depends-pkgpaths</td>
1.271 wiz 15190: <td>show-depends-recursive</td>
1.156 leot 15191: </tr>
15192: <tr>
1.258 wiz 15193: <td>show-deps</td>
1.271 wiz 15194: <td>show-distfiles</td>
1.156 leot 15195: </tr>
15196: <tr>
1.258 wiz 15197: <td>show-downlevel</td>
1.271 wiz 15198: <td>show-subdir-var</td>
1.181 rillig 15199: </tr>
15200: <tr>
1.258 wiz 15201: <td>show-tools</td>
1.271 wiz 15202: <td>show-var</td>
1.156 leot 15203: </tr>
15204: <tr>
1.258 wiz 15205: <td>show-vars</td>
1.271 wiz 15206: <td>snprintf</td>
1.222 gutterid 15207: </tr>
15208: <tr>
1.258 wiz 15209: <td>socket</td>
1.271 wiz 15210: <td>ssp</td>
1.223 nia 15211: </tr>
15212: <tr>
1.258 wiz 15213: <td>st_mode</td>
1.271 wiz 15214: <td>stage-install</td>
1.156 leot 15215: </tr>
15216: <tr>
1.258 wiz 15217: <td>strcasestr</td>
1.271 wiz 15218: <td>strict</td>
1.156 leot 15219: </tr>
15220: <tr>
1.258 wiz 15221: <td>strip</td>
1.271 wiz 15222: <td>strndup</td>
1.156 leot 15223: </tr>
15224: <tr>
1.258 wiz 15225: <td>strnlen</td>
1.271 wiz 15226: <td>strsep</td>
1.156 leot 15227: </tr>
15228: <tr>
1.258 wiz 15229: <td>subst</td>
1.271 wiz 15230: <td>substitutions</td>
1.254 wiz 15231: </tr>
15232: <tr>
1.263 wiz 15233: <td>subversion</td>
1.271 wiz 15234: <td>sun</td>
1.263 wiz 15235: </tr>
15236: <tr>
1.254 wiz 15237: <td>sunpro</td>
1.271 wiz 15238: <td>sunwspro</td>
1.241 rillig 15239: </tr>
15240: <tr>
1.263 wiz 15241: <td>svn</td>
1.271 wiz 15242: <td>symlink</td>
1.214 leot 15243: </tr>
15244: <tr>
1.242 gutterid 15245: <td>test</td>
1.271 wiz 15246: <td>test-env</td>
1.212 wiz 15247: </tr>
15248: <tr>
1.242 gutterid 15249: <td>tex</td>
1.271 wiz 15250: <td>texlive</td>
1.227 wiz 15251: </tr>
15252: <tr>
1.242 gutterid 15253: <td>tmp</td>
1.271 wiz 15254: <td>todo</td>
1.223 nia 15255: </tr>
15256: <tr>
1.242 gutterid 15257: <td>tool</td>
1.271 wiz 15258: <td>tools</td>
1.161 leot 15259: </tr>
15260: <tr>
1.242 gutterid 15261: <td>tools-libtool-m4-override</td>
1.271 wiz 15262: <td>transitive</td>
1.156 leot 15263: </tr>
15264: <tr>
1.242 gutterid 15265: <td>type</td>
1.271 wiz 15266: <td>ulimit</td>
1.156 leot 15267: </tr>
15268: <tr>
1.242 gutterid 15269: <td>undefined</td>
1.271 wiz 15270: <td>undo-replace</td>
1.156 leot 15271: </tr>
15272: <tr>
1.242 gutterid 15273: <td>unlimit</td>
1.271 wiz 15274: <td>unprivileged</td>
1.156 leot 15275: </tr>
15276: <tr>
1.242 gutterid 15277: <td>unprivileged-install-hook</td>
1.271 wiz 15278: <td>unstripped</td>
1.156 leot 15279: </tr>
15280: <tr>
1.242 gutterid 15281: <td>update</td>
1.271 wiz 15282: <td>updated</td>
1.156 leot 15283: </tr>
15284: <tr>
1.242 gutterid 15285: <td>upload</td>
1.271 wiz 15286: <td>upload-distfiles</td>
1.156 leot 15287: </tr>
15288: <tr>
1.242 gutterid 15289: <td>use_tools</td>
1.271 wiz 15290: <td>user</td>
1.156 leot 15291: </tr>
15292: <tr>
1.242 gutterid 15293: <td>utimes</td>
1.271 wiz 15294: <td>vasprintf</td>
1.156 leot 15295: </tr>
15296: <tr>
1.242 gutterid 15297: <td>verbose</td>
1.271 wiz 15298: <td>vsnprintf</td>
1.156 leot 15299: </tr>
15300: <tr>
1.242 gutterid 15301: <td>warn</td>
1.271 wiz 15302: <td>warning</td>
1.156 leot 15303: </tr>
15304: <tr>
1.242 gutterid 15305: <td>warnings</td>
1.271 wiz 15306: <td>warnx</td>
1.156 leot 15307: </tr>
15308: <tr>
1.242 gutterid 15309: <td>wattr_off</td>
1.271 wiz 15310: <td>wattr_on</td>
1.156 leot 15311: </tr>
15312: <tr>
1.242 gutterid 15313: <td>work</td>
1.271 wiz 15314: <td>wrapper</td>
1.156 leot 15315: </tr>
15316: <tr>
1.174 leot 15317: <td>wrkdir</td>
1.271 wiz 15318: <td> </td>
1.156 leot 15319: </tr>
15320: </table>
1.154 rillig 15321: </div>
15322: <div class="appendix">
15323: <div class="titlepage"><div><div><h1 class="title">
1.266 martin 15324: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 15325: <div class="toc">
15326: <p><b>Table of Contents</b></p>
1.100 leot 15327: <dl class="toc">
1.207 leot 15328: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
15329: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 15330: </dl>
15331: </div>
15332: <p>This section contains information on editing the pkgsrc
15333: guide itself.</p>
1.41 asau 15334: <div class="sect1">
1.1 dsieger 15335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 15336: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.1 dsieger 15337: <p>The pkgsrc guide's source code is stored in
15338: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
15339: are created from it:</p>
1.41 asau 15340: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 15341: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
15342: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.174 leot 15343: <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>
15344: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1 dsieger 15345: The PDF version of the pkgsrc guide.</p></li>
1.174 leot 15346: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1 dsieger 15347: PostScript version of the pkgsrc guide.</p></li>
15348: </ul></div>
15349: </div>
1.41 asau 15350: <div class="sect1">
1.1 dsieger 15351: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.266 martin 15352: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.1 dsieger 15353: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 15354: <div class="procedure"><ol class="procedure" type="1">
1.190 bacon 15355: <li class="step"><p>Make sure you have checked out the htdocs repository
15356: into a sibling directory of your pkgsrc directory. You will need
15357: the ability to commit from both pkgsrc and htdocs.</p></li>
1.41 asau 15358: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 15359: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 15360: documentation) installed. These are automatically installed when
1.207 leot 15361: 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.41 asau 15362: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 15363: right directory. All further steps will take place
15364: here.</p></li>
1.41 asau 15365: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 15366: <code class="filename">files/</code>.</p></li>
1.41 asau 15367: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 15368: guide for valid XML and to build the final output files. If you
15369: get any errors at this stage, you can just edit the files, as
15370: there are only symbolic links in the working directory, pointing
15371: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 15372: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 15373: commit)</strong></span></p></li>
1.41 asau 15374: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 15375: regenerate the output files with the proper RCS
15376: Ids.</p></li>
1.41 asau 15377: <li class="step">
1.10 hubertf 15378: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 15379: commit the files in both <code class="filename">pkgsrc/doc</code> and
15380: <code class="filename">htdocs</code>.</p>
1.41 asau 15381: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 15382: <h3 class="title">Note</h3>
15383: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 15384: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
15385: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 15386: directory.</p>
15387: </div>
15388: </li>
15389: </ol></div>
15390: </div>
15391: </div>
15392: </div></body>
15393: </html>
CVSweb <webmaster@jp.NetBSD.org>