Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.173
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.25 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
9: </head>
1.41 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1 dsieger 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.10 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.10 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.166 leot 33: <div><p class="copyright">Copyright © 1994-2020 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.36 2020/01/03 15:55:24 leot Exp $</p></div>
1.41 asau 35: <div><div class="abstract">
1.1 dsieger 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.100 leot 48: <dl class="toc">
1.1 dsieger 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
1.154 rillig 63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1 dsieger 65: <dd><dl>
1.154 rillig 66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 67: <dd><dl>
1.154 rillig 68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 70: </dl></dd>
1.154 rillig 71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 72: <dd><dl>
1.154 rillig 73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 75: </dl></dd>
76: </dl></dd>
1.154 rillig 77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 78: <dd><dl>
1.154 rillig 79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 81: </dl></dd>
1.154 rillig 82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 83: <dd><dl>
1.154 rillig 84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 85: <dd><dl>
1.154 rillig 86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
88: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
89: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
90: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
91: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
92: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.1 dsieger 93: </dl></dd>
1.154 rillig 94: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 95: <dd><dl>
1.154 rillig 96: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
97: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
98: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 99: </dl></dd>
100: </dl></dd>
1.154 rillig 101: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 102: <dd><dl>
1.154 rillig 103: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
104: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
105: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
106: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 107: <dd><dl>
1.154 rillig 108: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
109: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
110: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 111: </dl></dd>
1.154 rillig 112: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
113: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 114: </dl></dd>
1.154 rillig 115: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 116: <dd><dl>
1.154 rillig 117: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
118: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 119: </dl></dd>
1.154 rillig 120: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 121: builds)</a></span></dt>
1.1 dsieger 122: <dd><dl>
1.154 rillig 123: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
124: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
125: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
126: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
127: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
128: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
129: </dl></dd>
130: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
131: <dd><dl>
132: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
133: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
134: </dl></dd>
135: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
136: <dd><dl>
137: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
138: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
139: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
140: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
141: <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>
142: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
143: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
144: <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>
145: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
146: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 147: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 148: <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>
149: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
150: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
151: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
152: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
153: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
154: <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 155: </dl></dd>
156: </dl></dd>
157: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
158: <dd><dl>
1.154 rillig 159: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
160: <dt><span class="chapter"><a href="#creating">12. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 161: <dd><dl>
1.154 rillig 162: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1 dsieger 163: <dd><dl>
1.154 rillig 164: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
165: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160 brook 166: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
167: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1 dsieger 168: </dl></dd>
1.154 rillig 169: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
170: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6 rillig 171: </dl></dd>
1.154 rillig 172: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.6 rillig 173: <dd><dl>
1.154 rillig 174: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
175: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
176: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 177: <dd><dl>
1.154 rillig 178: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
179: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
180: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
181: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
182: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
1.6 rillig 183: </dl></dd>
1.154 rillig 184: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
185: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
1.6 rillig 186: <dd><dl>
1.154 rillig 187: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
188: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
189: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.6 rillig 190: </dl></dd>
1.154 rillig 191: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
192: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 193: </dl></dd>
1.154 rillig 194: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 195: <dd><dl>
1.154 rillig 196: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
197: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
198: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
199: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
1.6 rillig 200: <dd><dl>
1.154 rillig 201: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
202: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
203: <dt><span class="sect2"><a href="#cflags-gnu-configure">14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
204: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 205: </dl></dd>
206: </dl></dd>
1.154 rillig 207: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.6 rillig 208: <dd><dl>
1.154 rillig 209: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
210: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
211: <dt><span class="sect1"><a href="#print-PLIST">15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
212: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
213: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
214: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
215: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
216: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
217: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.6 rillig 218: </dl></dd>
1.154 rillig 219: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.6 rillig 220: <dd><dl>
1.154 rillig 221: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
222: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 223: <dd><dl>
1.154 rillig 224: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
225: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26 wiz 226: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
227: and
228: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
229: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 230: </dl></dd>
1.154 rillig 231: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 232: <dd><dl>
1.154 rillig 233: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
234: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.6 rillig 235: </dl></dd>
236: </dl></dd>
1.154 rillig 237: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.6 rillig 238: <dd><dl>
1.154 rillig 239: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
240: <dd><dl>
241: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
242: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
243: </dl></dd>
244: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
245: <dd><dl>
246: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
247: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
248: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
249: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
250: </dl></dd>
251: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
252: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">17.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
253: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
254: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
255: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
256: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
257: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">17.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
258: </dl></dd>
259: <dt><span class="chapter"><a href="#options">18. Options handling</a></span></dt>
260: <dd><dl>
261: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
262: <dt><span class="sect1"><a href="#converting-to-options">18.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
263: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
264: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
265: </dl></dd>
266: <dt><span class="chapter"><a href="#build">19. The build process</a></span></dt>
267: <dd><dl>
268: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
269: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
270: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
271: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
272: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
273: <dd><dl>
274: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
275: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
276: </dl></dd>
277: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
278: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
279: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
280: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
281: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
282: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
283: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
284: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
285: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
286: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
287: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
288: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
289: </dl></dd>
290: <dt><span class="chapter"><a href="#tools">20. Tools needed for building or running</a></span></dt>
291: <dd><dl>
292: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
293: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
294: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
295: </dl></dd>
296: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
297: <dd><dl>
298: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
299: <dd><dl>
300: <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>
301: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
302: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
303: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
304: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
305: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
306: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
307: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
308: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
309: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
310: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
311: </dl></dd>
312: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
313: <dd><dl>
314: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
315: <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>
316: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
317: </dl></dd>
318: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
319: <dd><dl>
320: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
321: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
322: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
323: </dl></dd>
324: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
325: <dd><dl>
326: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
327: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
328: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
329: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
330: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
331: </dl></dd>
332: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
333: <dd><dl>
334: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
335: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 336: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
337: <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>
338: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 339: </dl></dd>
340: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
341: <dd><dl>
342: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
343: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
344: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
345: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
346: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
347: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
348: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
349: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
350: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
351: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
352: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
353: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
354: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
355: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
356: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
357: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
358: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
359: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 360: emulation</a></span></dt>
1.154 rillig 361: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
362: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 363: </dl></dd>
1.154 rillig 364: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 365: </dl></dd>
1.154 rillig 366: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
367: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 368: <dd><dl>
1.154 rillig 369: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
370: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
371: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
372: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
373: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
374: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
375: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
376: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
377: </dl></dd>
378: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
379: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
380: <dd><dl>
381: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
382: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
383: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
384: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1 dsieger 385: </dl></dd>
386: </dl></dd>
387: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
388: <dd><dl>
1.154 rillig 389: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 390: <dd><dl>
1.154 rillig 391: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
392: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
393: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 394: <dd><dl>
1.154 rillig 395: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
396: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 397: </dl></dd>
1.154 rillig 398: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
399: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 400: <dd><dl>
1.154 rillig 401: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
402: <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 403: </dl></dd>
1.154 rillig 404: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 405: <dd><dl>
1.154 rillig 406: <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>
407: <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 408: </dl></dd>
409: </dl></dd>
1.154 rillig 410: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1 dsieger 411: <dd><dl>
1.154 rillig 412: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
413: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 414: <dd><dl>
1.154 rillig 415: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
416: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 417: </dl></dd>
418: </dl></dd>
1.154 rillig 419: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
420: <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 421: </dl></dd>
422: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
423: <dd><dl>
424: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
425: <dd><dl>
426: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
427: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
428: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 429: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 430: </dl></dd>
431: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
432: </dl></dd>
433: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
434: <dd><dl>
435: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
436: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
437: </dl></dd>
438: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
439: <dd><dl>
1.23 wiz 440: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
441: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
442: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
443: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
444: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148 leot 445: <code class="filename">stable</code>,
1.23 wiz 446: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 447: source packages</a></span></dt>
448: </dl></dd>
1.154 rillig 449: <dt><span class="appendix"><a href="#help-topics">D. Help topics</a></span></dt>
450: <dt><span class="appendix"><a href="#editing">E. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1 dsieger 451: <dd><dl>
1.154 rillig 452: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
453: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1 dsieger 454: </dl></dd>
455: </dl>
456: </div>
457: <div class="list-of-tables">
458: <p><b>List of Tables</b></p>
459: <dl>
460: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
461: </dt>
1.154 rillig 462: <dt>13.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 463: </dt>
1.154 rillig 464: <dt>25.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 465: </dt>
466: </dl>
467: </div>
1.41 asau 468: <div class="chapter">
469: <div class="titlepage"><div><div><h1 class="title">
470: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 471: <div class="toc">
472: <p><b>Table of Contents</b></p>
1.100 leot 473: <dl class="toc">
1.1 dsieger 474: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
475: <dd><dl>
476: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
477: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
478: </dl></dd>
479: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
480: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
481: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
482: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
483: </dl>
484: </div>
1.41 asau 485: <div class="sect1">
1.1 dsieger 486: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
487: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
488: <p>There is a lot of software freely available for Unix-based
489: systems, which is usually available in form of the source code. Before
490: such software can be used, it needs to be configured to the local
491: system, compiled and installed, and this is exactly what The NetBSD
492: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
493: to handle binary packages, so that not every user has to build the
494: packages for himself, which is a time-costly task.</p>
495: <p>pkgsrc currently contains several thousand packages,
496: including:</p>
1.41 asau 497: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 498: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.1 dsieger 499: web server</p></li>
1.137 leot 500: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1 dsieger 501: web browser</p></li>
1.137 leot 502: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1 dsieger 503: Desktop Environment</p></li>
1.137 leot 504: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.1 dsieger 505: Desktop Environment</p></li>
506: </ul></div>
1.108 rillig 507: <p>… just to name a few.</p>
1.1 dsieger 508: <p>pkgsrc has built-in support for handling varying dependencies,
509: such as pthreads and X11, and extended features such as IPv6 support on
510: a range of platforms.</p>
1.41 asau 511: <div class="sect2">
1.1 dsieger 512: <div class="titlepage"><div><div><h3 class="title">
513: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
514: <p>
515: pkgsrc provides the following key features:
516: </p>
1.41 asau 517: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 518: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 519: and installation of binary packages. The source and latest
520: patches are retrieved from a master or mirror download site, checksum
521: verified, then built on your system. Support for binary-only
522: distributions is available for both native platforms and NetBSD
523: emulated platforms.</p></li>
1.23 wiz 524: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 525: including binaries, libraries, man pages and other
526: documentation.</p></li>
1.104 sevan 527: <li class="listitem"><p>Tracking of package dependencies automatically, including when
528: performing updates, to ensure required packages are installed. The
529: configuration files of various packages are handled automatically during
530: updates, so local changes are preserved.</p></li>
1.23 wiz 531: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 532: consists of highly portable code. This allows the greatest speed of
1.25 spz 533: development when porting to a new platform. This portability also
1.1 dsieger 534: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
535: platforms</em></span>.</p></li>
1.23 wiz 536: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 537: international encryption requirements and build-time options for a
538: large number of packages are all set in a simple, central
539: configuration file.</p></li>
1.23 wiz 540: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 541: freely available under a BSD license, so you may extend and adapt
542: pkgsrc to your needs. Support for local packages and patches is
543: available right out of the box, so you can configure it specifically
544: for your environment.</p></li>
545: </ul></div>
546: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 547: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 548: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 549: — That means, if a package contains bugs, it's better to find
1.1 dsieger 550: them and to complain about them rather than to just install the package
551: and hope that it works. There are numerous checks in pkgsrc that try to
1.137 leot 552: find such bugs: Static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.1 dsieger 553: of shell scripts), and post-installation checks (installed files,
554: references to shared libraries, script interpreters).</p></li>
1.23 wiz 555: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 556: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 557: pkgsrc has been ported to many operating systems. Care is taken that
558: packages behave the same on all platforms.</p></li>
559: </ul></div>
560: </div>
1.41 asau 561: <div class="sect2">
1.1 dsieger 562: <div class="titlepage"><div><div><h3 class="title">
563: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
564: <p>pkgsrc consists of both a source distribution and a binary
565: distribution for these operating systems. After retrieving the required
566: source or binaries, you can be up and running with pkgsrc in just
567: minutes!</p>
568: <p>pkgsrc was derived from FreeBSD's ports system, and
569: initially developed for NetBSD only. Since then, pkgsrc has
570: grown a lot, and now supports the following platforms:</p>
571: <div class="table">
572: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 573: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 574: <colgroup>
575: <col>
576: <col>
1.92 sevan 577: <col>
1.1 dsieger 578: </colgroup>
579: <thead><tr>
580: <th>Platform</th>
581: <th>Date Support Added</th>
1.92 sevan 582: <th>Notes</th>
1.1 dsieger 583: </tr></thead>
584: <tbody>
585: <tr>
1.10 hubertf 586: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 587: <td align="center">Aug 1997</td>
1.92 sevan 588: <td class="auto-generated"> </td>
1.1 dsieger 589: </tr>
590: <tr>
1.10 hubertf 591: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 592: <td align="center">Mar 1999</td>
1.151 sevan 593: <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 594: </tr>
595: <tr>
1.10 hubertf 596: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 597: <td align="center">Jun 1999</td>
1.151 sevan 598: <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 599: </tr>
600: <tr>
601: <td>
1.118 sevan 602: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 603: </td>
604: <td align="center">Oct 2001</td>
1.151 sevan 605: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.1 dsieger 606: </tr>
607: <tr>
1.10 hubertf 608: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 609: <td align="center">Nov 2002</td>
1.151 sevan 610: <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 611: </tr>
612: <tr>
1.10 hubertf 613: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 614: <td align="center">Nov 2002</td>
1.151 sevan 615: <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 616: </tr>
617: <tr>
1.10 hubertf 618: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 619: <td align="center">Dec 2002</td>
1.92 sevan 620: <td>
1.151 sevan 621: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
622: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.92 sevan 623: </td>
1.1 dsieger 624: </tr>
625: <tr>
626: <td>BSD/OS</td>
627: <td align="center">Dec 2003</td>
1.92 sevan 628: <td class="auto-generated"> </td>
1.1 dsieger 629: </tr>
630: <tr>
1.10 hubertf 631: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 632: <td align="center">Dec 2003</td>
1.151 sevan 633: <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 634: </tr>
635: <tr>
636: <td>
1.10 hubertf 637: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 638: (Microsoft Windows Services for Unix)
639: </td>
640: <td align="center">Mar 2004</td>
1.151 sevan 641: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1 dsieger 642: </tr>
643: <tr>
1.10 hubertf 644: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 645: <td align="center">Oct 2004</td>
1.92 sevan 646: <td class="auto-generated"> </td>
1.1 dsieger 647: </tr>
648: <tr>
1.10 hubertf 649: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 650: <td align="center">Nov 2004</td>
1.151 sevan 651: <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 652: </tr>
653: <tr>
1.10 hubertf 654: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 655: <td align="center">Apr 2007</td>
1.151 sevan 656: <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 657: </tr>
1.23 wiz 658: <tr>
659: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
660: <td align="center">Sep 2010</td>
1.151 sevan 661: <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 662: </tr>
1.45 obache 663: <tr>
664: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 665: <td align="center">Jan 2011</td>
1.92 sevan 666: <td class="auto-generated"> </td>
1.45 obache 667: </tr>
668: <tr>
669: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
670: <td align="center">Nov 2011</td>
1.151 sevan 671: <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 672: </tr>
673: <tr>
674: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
675: <td align="center">Mar 2013</td>
1.151 sevan 676: <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 677: </tr>
1.58 ryoon 678: <tr>
679: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
680: <td align="center">Jul 2013</td>
1.151 sevan 681: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.58 ryoon 682: </tr>
1.104 sevan 683: <tr>
684: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
685: <td align="center">Jun 2014</td>
1.151 sevan 686: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
1.104 sevan 687: </tr>
1.1 dsieger 688: </tbody>
689: </table></div>
690: </div>
691: <br class="table-break">
692: </div>
693: </div>
1.41 asau 694: <div class="sect1">
1.1 dsieger 695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
696: <a name="overview"></a>1.2. Overview</h2></div></div></div>
697: <p>This document is divided into three parts. The first,
1.10 hubertf 698: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 699: describes how one can use one of the packages in the Package
700: Collection, either by installing a precompiled binary package,
701: or by building one's own copy using the NetBSD package system.
1.10 hubertf 702: 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 703: package so it can be easily built by other NetBSD users without
704: knowing about the package's building details. The third part,
1.10 hubertf 705: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 706: is intended for those who want to understand how pkgsrc is
707: implemented.</p>
708: <p>This document is available in various formats:
1.10 hubertf 709: <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 710: </div>
1.41 asau 711: <div class="sect1">
1.1 dsieger 712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
713: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 714: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
715: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 716: terminology used within this document.</p>
1.41 asau 717: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 718: <dt><span class="term">Package</span></dt>
719: <dd><p>A set of files and building instructions
720: that describe what's necessary
721: to build a certain piece of software using
722: pkgsrc. Packages are traditionally stored under
1.123 wiz 723: <code class="filename">/usr/pkgsrc</code>,
724: but may be stored in any location,
725: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1 dsieger 726: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 727: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 728: is part of the NetBSD operating system and can be bootstrapped
729: to run on non-NetBSD operating systems as well. It handles
730: building (compiling), installing, and removing of
731: packages.</p></dd>
732: <dt><span class="term">Distfile</span></dt>
733: <dd><p>This term describes the file or files that are
734: provided by the author of the piece of software to
735: distribute his work. All the changes necessary to build on
736: NetBSD are reflected in the corresponding package. Usually
737: the distfile is in the form of a compressed tar-archive,
738: but other types are possible, too. Distfiles are usually
739: stored below
740: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
741: <dt><span class="term">Port</span></dt>
742: <dd><p>This is the term used by FreeBSD and OpenBSD people
743: for what we call a package.
1.23 wiz 744: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 745: architecture.</p></dd>
746: <dt><span class="term">Precompiled/binary package</span></dt>
747: <dd>
748: <p>A set of binaries built with pkgsrc from a distfile
749: and stuffed together in a single <code class="filename">.tgz</code>
750: file so it can be installed on machines of the same
751: machine architecture without the need to
752: recompile. Packages are usually generated in
753: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 754: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 755: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 756: especially in the context of precompiled packages.</p>
757: </dd>
758: <dt><span class="term">Program</span></dt>
759: <dd><p>The piece of software to be installed which will be
760: constructed from all the files in the distfile by the
761: actions defined in the corresponding package.</p></dd>
762: </dl></div>
1.41 asau 763: <div class="sect2">
1.1 dsieger 764: <div class="titlepage"><div><div><h3 class="title">
765: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 766: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 767: <dt><span class="term">pkgsrc users</span></dt>
768: <dd>
769: <p>The
770: pkgsrc users are people who use the packages provided by pkgsrc.
771: Typically they are system administrators. The people using the
1.23 wiz 772: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
773: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 774: <p>There are two kinds of pkgsrc users: Some only want to
775: install pre-built binary packages. Others build the pkgsrc
776: packages from source, either for installing them directly or for
1.10 hubertf 777: 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 778: documentation.</p>
779: </dd>
780: <dt><span class="term">package maintainers</span></dt>
781: <dd><p>A
1.10 hubertf 782: 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 783: <dt><span class="term">infrastructure developers</span></dt>
784: <dd><p>These people are involved in all those files
785: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 786: 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 787: too.</p></dd>
788: </dl></div>
789: </div>
790: </div>
1.41 asau 791: <div class="sect1">
1.1 dsieger 792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
793: <a name="typography"></a>1.4. Typography</h2></div></div></div>
794: <p>When giving examples for commands, shell prompts are used to
795: show if the command should/can be issued as root, or if
1.23 wiz 796: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 797: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
798: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
799: bourne shell and derivatives.</p>
1.1 dsieger 800: </div>
801: </div>
1.41 asau 802: <div class="part">
1.1 dsieger 803: <div class="titlepage"><div><div><h1 class="title">
804: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
805: <div class="toc">
806: <p><b>Table of Contents</b></p>
1.100 leot 807: <dl class="toc">
1.154 rillig 808: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
809: <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 810: <dd><dl>
1.154 rillig 811: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 812: <dd><dl>
1.154 rillig 813: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
814: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 815: </dl></dd>
1.154 rillig 816: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 817: <dd><dl>
1.154 rillig 818: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
819: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 820: </dl></dd>
821: </dl></dd>
1.154 rillig 822: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 823: <dd><dl>
1.154 rillig 824: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
825: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 826: </dl></dd>
1.154 rillig 827: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 828: <dd><dl>
1.154 rillig 829: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 830: <dd><dl>
1.154 rillig 831: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
832: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
833: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
834: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
835: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
836: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
837: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.1 dsieger 838: </dl></dd>
1.154 rillig 839: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 840: <dd><dl>
1.154 rillig 841: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
842: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
843: <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 844: </dl></dd>
845: </dl></dd>
1.154 rillig 846: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 847: <dd><dl>
1.154 rillig 848: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
849: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
850: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
851: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 852: <dd><dl>
1.154 rillig 853: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
854: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
855: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 856: </dl></dd>
1.154 rillig 857: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
858: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 859: </dl></dd>
1.154 rillig 860: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 861: <dd><dl>
1.154 rillig 862: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
863: <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 864: </dl></dd>
1.154 rillig 865: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 866: builds)</a></span></dt>
1.1 dsieger 867: <dd><dl>
1.154 rillig 868: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
869: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
870: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
871: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
872: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
873: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
874: </dl></dd>
875: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
876: <dd><dl>
877: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
878: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
879: </dl></dd>
880: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
881: <dd><dl>
882: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
883: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
884: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
885: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
886: <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>
887: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
888: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
889: <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>
890: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
891: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 892: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 893: <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>
894: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
895: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
896: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
897: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
898: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
899: <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 900: </dl></dd>
901: </dl>
902: </div>
1.41 asau 903: <div class="chapter">
1.1 dsieger 904: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 905: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
906: <p>
907: To get help when using pkgsrc, the definitive source is this
908: document, the pkgsrc guide. If you don't find anything here,
909: there are alternatives:
910: </p>
911: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
912: <li class="listitem">
913: <p>
914: The built-in pkgsrc help, which is available after bootstrapping
915: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
916: help for any topic, such as a variable name like
917: <code class="varname">BUILD_DEFS</code>, a make target like
918: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
919: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
920: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix D. Help topics">Appendix D, <i>Help topics</i></a>.</p>
921: </li>
922: <li class="listitem"><p>
1.163 rillig 923: To see the value of a single variable, run <span class="command"><strong>bmake
924: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
925: </p></li>
926: <li class="listitem"><p>
927: To see the values of the most common variables, run
928: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
929: topic. To see the variables for a single topic, run
930: <span class="command"><strong>bmake
931: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
932: <span class="command"><strong>bmake show-all-fetch</strong></span>.
933: </p></li>
934: <li class="listitem"><p>
1.154 rillig 935: The pkgsrc-users mailing list, to which
936: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
937: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
938: questions</a>.</p></li>
939: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
940: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
941: or by using a specialized chat program such as
942: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
943: Pick any user name and join the channel #pkgsrc.</p></li>
944: </ul></div>
945: </div>
946: <div class="chapter">
947: <div class="titlepage"><div><div><h2 class="title">
948: <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 949: <div class="toc">
950: <p><b>Table of Contents</b></p>
1.100 leot 951: <dl class="toc">
1.154 rillig 952: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 953: <dd><dl>
1.154 rillig 954: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
955: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 956: </dl></dd>
1.154 rillig 957: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 958: <dd><dl>
1.154 rillig 959: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
960: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 961: </dl></dd>
962: </dl>
963: </div>
964: <p>Before you download and extract the files, you need to decide
965: where you want to extract them. When using pkgsrc as root user, pkgsrc
966: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
967: free to install the sources and binary packages wherever you want in
968: your filesystem, provided that the pathname does not contain white-space
969: or other characters that are interpreted specially by the shell and some
970: other programs. A safe bet is to use only letters, digits, underscores
971: and dashes.</p>
1.41 asau 972: <div class="sect1">
1.1 dsieger 973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 974: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 975: <p>Before you download any pkgsrc files, you should decide
976: whether you want the <span class="emphasis"><em>current</em></span> branch or the
977: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
978: quarterly basis from the current branch and only gets modified
979: for security updates. The names of the stable branches are built
980: from the year and the quarter, for example
1.167 leot 981: <code class="literal">2019Q4</code>.</p>
1.1 dsieger 982: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 983: want to download pkgsrc. You can get it as a tar file or via CVS.
984: Both ways are described here.</p>
1.51 asau 985: <p>Note that tar archive contains CVS working copy.
986: Thus you can switch to using CVS at any later time.</p>
1.41 asau 987: <div class="sect2">
1.1 dsieger 988: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 989: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 990: <p>The primary download location for all pkgsrc files is
1.151 sevan 991: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 992: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
993: (it points to the same location).
994: There are a number of subdirectories for different purposes,
995: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
996: <p>The tar archive for the current branch is in the directory
1.151 sevan 997: <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 998: It is autogenerated weekly.</p>
1.51 asau 999: <p>To save download time we provide bzip2- and
1000: xz-compressed archives which are published at
1.151 sevan 1001: <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 1002: and
1.151 sevan 1003: <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 1004: respectively.
1005: </p>
1006: <p>You can fetch the same files using FTP.</p>
1.167 leot 1007: <p>The tar file for the stable branch 2019Q4 is in the
1008: directory <code class="filename">pkgsrc-2019Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136 leot 1009: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 1010: <pre class="screen">
1.167 leot 1011: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q4/pkgsrc.tar.gz</code></strong></pre>
1.78 snj 1012: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1013: or your web browser.</p>
1.12 weinem 1014: <p>Then, extract it with:</p>
1.78 snj 1015: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1016: <p>This will create the directory <code class="filename">pkgsrc/</code>
1017: in <code class="filename">/usr/</code> and all the package source will be
1018: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1019: <p>To download pkgsrc-current, run:</p>
1020: <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 1021: </div>
1.41 asau 1022: <div class="sect2">
1.1 dsieger 1023: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1024: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1025: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.167 leot 1026: <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-2019Q4 -P pkgsrc</code></strong>
1.23 wiz 1027: </pre>
1028: <p>This will create the directory <code class="filename">pkgsrc/</code>
1029: in your <code class="filename">/usr/</code> directory and all the package source
1030: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1031: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1032: <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 1033: </pre>
1.78 snj 1034: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23 wiz 1035: <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 1036: <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 1037: </pre>
1038: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1039: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1040: or better globally in <code class="filename">/etc/profile</code>:</p>
1041: <pre class="programlisting">
1042: # set CVS remote shell command
1043: CVS_RSH=ssh
1044: export CVS_RSH
1045: </pre>
1046: <p>By default, CVS doesn't do things like most people would expect it to do.
1047: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1048: in your home directory and saving the following lines to it.
1049: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1050: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1051: <pre class="programlisting">
1052: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1053: cvs -q
1.2 rillig 1054: checkout -P
1.4 rillig 1055: update -dP
1056: diff -upN
1.2 rillig 1057: rdiff -u
1.23 wiz 1058: release -d
1.2 rillig 1059: </pre>
1.1 dsieger 1060: </div>
1061: </div>
1.41 asau 1062: <div class="sect1">
1.1 dsieger 1063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1064: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1065: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1066: (which also works if you have first installed it via a tar
1067: file). It saves bandwidth and hard disk activity, compared to
1068: downloading the tar file again.</p>
1.41 asau 1069: <div class="sect2">
1.1 dsieger 1070: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1071: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1072: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1073: <h3 class="title">Warning</h3>
1074: <p>When updating from a tar file, you first need to
1075: completely remove the old pkgsrc directory. Otherwise those
1076: files that have been removed from pkgsrc in the mean time will
1077: not be removed on your local disk, resulting in inconsistencies.
1078: When removing the old files, any changes that you have done to
1079: the pkgsrc files will be lost after updating. Therefore updating
1080: via CVS is strongly recommended.</p>
1081: </div>
1082: <p>Note that by default the distfiles and the binary packages
1083: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1084: before updating. You can also configure pkgsrc to store distfiles
1085: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1086: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154 rillig 1087: 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 1088: <p>To update pkgsrc from a tar file, download the tar file as
1089: explained above. Then, make sure that you have not made any
1090: changes to the files in the pkgsrc directory. Remove the pkgsrc
1091: directory and extract the new tar file. Done.</p>
1092: </div>
1.41 asau 1093: <div class="sect2">
1.1 dsieger 1094: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1095: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1096: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1097: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1098: </pre>
1099: <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>
1100: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1101: </pre>
1.41 asau 1102: <div class="sect3">
1.1 dsieger 1103: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1104: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1105: <p>When updating pkgsrc, the CVS program keeps track of the
1106: branch you selected. But if you, for whatever reason, want to
1107: switch from the stable branch to the current one, you can do it
1.23 wiz 1108: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1109: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1110: back to the stable branch, add the
1.167 leot 1111: <span class="quote">“<span class="quote">-rpkgsrc-2019Q4</span>”</span> option.</p>
1.1 dsieger 1112: </div>
1.41 asau 1113: <div class="sect3">
1.1 dsieger 1114: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1115: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1116: <p>When you update pkgsrc, the CVS program will only touch
1117: those files that are registered in the CVS repository. That
1118: means that any packages that you created on your own will stay
1119: unmodified. If you change files that are managed by CVS, later
1120: updates will try to merge your changes with those that have been
1121: done by others. See the CVS manual, chapter
1.23 wiz 1122: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1123: </div>
1124: </div>
1125: </div>
1126: </div>
1.41 asau 1127: <div class="chapter">
1.1 dsieger 1128: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1129: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1130: <div class="toc">
1131: <p><b>Table of Contents</b></p>
1.100 leot 1132: <dl class="toc">
1.154 rillig 1133: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1134: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1135: </dl>
1136: </div>
1.41 asau 1137: <div class="sect1">
1.1 dsieger 1138: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1139: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1140: <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 1141: </div>
1.41 asau 1142: <div class="sect1">
1.1 dsieger 1143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1144: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1145: <p>pkgsrc can be bootstrapped for use in two different modes:
1146: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1147: to privileged one all programs are installed under one particular user
1.43 asau 1148: and cannot utilise privileged operations (packages don't create
1149: special users and all special file permissions like setuid are ignored).
1150: </p>
1.1 dsieger 1151: <p>Installing the bootstrap kit from source should be as simple as:</p>
1152: <pre class="screen">
1.60 asau 1153: <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 1154: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1155: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1156: </pre>
1.43 asau 1157: <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>
1158: <p>By default, in privileged mode pkgsrc uses
1159: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1160: where programs will be installed in,
1.118 sevan 1161: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1162: directory where pkgsrc will do its internal bookkeeping,
1163: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1164: where packages install their persistent data.
1165: In unprivileged mode pkgsrc uses
1166: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1167: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1168: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1169: </p>
1170: <p>You can change default layout using command-line arguments.
1171: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1172: </p>
1.41 asau 1173: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1174: <h3 class="title">Note</h3>
1.10 hubertf 1175: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1176: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1177: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1178: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1179: </div>
1.43 asau 1180: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1181: <h3 class="title">Note</h3>
1182: <p>It is possible to bootstrap multiple instances of pkgsrc
1183: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1184: corresponding to the installation you're working with to build
1185: and install packages.
1186: </p>
1187: </div>
1.1 dsieger 1188: </div>
1189: </div>
1.41 asau 1190: <div class="chapter">
1.1 dsieger 1191: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1192: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1193: <div class="toc">
1194: <p><b>Table of Contents</b></p>
1.100 leot 1195: <dl class="toc">
1.154 rillig 1196: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1197: <dd><dl>
1.154 rillig 1198: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1199: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1200: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
1201: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
1202: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1203: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
1204: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1205: </dl></dd>
1206: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1207: <dd><dl>
1208: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1209: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1210: <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 1211: </dl></dd>
1212: </dl>
1213: </div>
1214: <p>Basically, there are two ways of using pkgsrc. The first
1215: is to only install the package tools and to use binary packages
1.23 wiz 1216: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1217: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1218: of pkgsrc, too. Then you are able to build your own packages,
1219: and you can still use binary packages from someone else.</p>
1.41 asau 1220: <div class="sect1">
1.1 dsieger 1221: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1222: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.151 sevan 1223: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1224: site and mirrors, there are collections of binary packages,
1.9 rillig 1225: ready to be installed. These binary packages have been built using the
1226: default settings for the directories, that is:</p>
1.41 asau 1227: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1228: <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>
1229: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1230: <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 1231: </ul></div>
1232: <p>If you cannot use these directories for whatever reasons (maybe
1233: because you're not root), you cannot use these binary packages, but
1.154 rillig 1234: 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 1235: <div class="sect2">
1.1 dsieger 1236: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1237: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1238: <p>To install binary packages, you first need to know from where
1239: to get them. The first place where you should look is on the main
1.151 sevan 1240: pkgsrc FTP server 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 1241: <p>This directory contains binary packages for multiple
1242: platforms. First, select your operating system. (Ignore the
1243: directories with version numbers attached to it, they just exist for
1244: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1245: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1246: <p>In this directory, you often find a file called
1247: <code class="filename">bootstrap.tar.gz</code> which contains the package
1248: management tools. If the file is missing, it is likely that your
1249: operating system already provides those tools. Download the file and
1250: extract it in the <code class="filename">/</code> directory. It will create
1251: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1252: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1253: </div>
1.41 asau 1254: <div class="sect2">
1.1 dsieger 1255: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1256: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1257: <p>In the directory from the last section, there is a
1.85 wiz 1258: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1259: binary packages that are available for the platform, excluding those
1260: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1261: medium you are using).</p>
1.9 rillig 1262: <p>To install packages directly from an FTP or HTTP server, run
1263: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1264: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1265: <pre class="screen">
1266: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.169 rillig 1267: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1268: <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 1269: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1270: </pre>
1271: <p>Instead of URLs, you can also use local paths, for example if
1272: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1273: repository. If you want to install packages from multiple sources,
1274: you can separate them by a semicolon in
1275: <code class="varname">PKG_PATH</code>.</p>
1276: <p>After these preparations, installing a package is very
1277: easy:</p>
1278: <pre class="screen">
1.118 sevan 1279: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
1280: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.9 rillig 1281: </pre>
1.1 dsieger 1282: <p>Note that any prerequisite packages needed to run the
1283: package in question will be installed, too, assuming they are
1284: present where you install from.</p>
1.23 wiz 1285: <p>Adding packages might install vulnerable packages.
1286: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1287: regularly, especially after installing new packages, and verify
1288: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1289: <p>After you've installed packages, be sure to have
1290: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1291: <code class="varname">PATH</code> so you can actually start the just
1292: installed program.</p>
1293: </div>
1.41 asau 1294: <div class="sect2">
1.1 dsieger 1295: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1296: <a name="using.pkg_delete"></a>5.1.3. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1297: <p>To deinstall a package, it does not matter whether it was
1298: installed from source code or from a binary package. The
1.10 hubertf 1299: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1300: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1301: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1302: name can be given with or without version number. Wildcards can
1303: also be used to deinstall a set of packages, for example
1304: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1305: so that the shell does not expand them before
1306: <code class="literal">pkg_delete</code> sees them.</p>
1307: <p>The <code class="option">-r</code> option is very powerful: it
1308: removes all the packages that require the package in question
1309: and then removes the package itself. For example:
1310:
1311: </p>
1312: <pre class="screen">
1313: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1314: </pre>
1315: <p>
1316:
1317: will remove jpeg and all the packages that used it; this allows
1318: upgrading the jpeg package.</p>
1319: </div>
1.41 asau 1320: <div class="sect2">
1.1 dsieger 1321: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1322: <a name="using.pkg_info"></a>5.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1323: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1324: installed packages or binary package files.</p>
1325: </div>
1.41 asau 1326: <div class="sect2">
1.1 dsieger 1327: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1328: <a name="vulnerabilities"></a>5.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1329: <p>
1.164 leot 1330: The pkgsrc Security Team and Packages Groups maintain a list of
1.1 dsieger 1331: known security vulnerabilities to packages which are (or have been)
1332: included in pkgsrc. The list is available from the NetBSD
1.165 leot 1333: FTP site at <a class="ulink" href="http://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">http://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
1.1 dsieger 1334: </p>
1335: <p>
1.22 jakllsch 1336: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1337: this list can be downloaded
1338: automatically, and a security audit of all packages installed on a system
1339: can take place.
1340: </p>
1341: <p>
1.22 jakllsch 1342: There are two components to auditing. The first
1343: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1344: is for downloading
1.1 dsieger 1345: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1346: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1347: installed packages are vulnerable. If a package is vulnerable, you
1348: will see output similar to the following:
1349: </p>
1350: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1351: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1352: <p>
1.22 jakllsch 1353: You may wish to have the
1.151 sevan 1354: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1355: file downloaded daily so that
1356: it remains current. This may be done by adding an appropriate entry
1.167 leot 1357: to the root users <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1358: </p>
1359: <pre class="screen">
1.121 sevan 1360: # Download vulnerabilities file
1.118 sevan 1361: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1362: # Audit the installed packages and email results to root
1363: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1364: root >/dev/null 2>&1
1.22 jakllsch 1365: </pre>
1366: <p>
1.118 sevan 1367: will update the vulnerability list every day at 3AM, followed by an audit
1368: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1369:
1.118 sevan 1370: On NetBSD this may be accomplished instead by adding the following
1371: line to <code class="filename">/etc/daily.conf</code>:
1372: </p>
1373: <pre class="screen">
1374: fetch_pkg_vulnerabilities=YES
1375: </pre>
1376: <p>
1377: to fetch the vulnerability list from the daily security script. The system
1378: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1379: desired (not required), by adding the following line to
1.118 sevan 1380: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1381: </p>
1382: <pre class="screen">
1.118 sevan 1383: check_pkg_vulnerabilities=YES
1.22 jakllsch 1384: </pre>
1385: <p>
1.167 leot 1386: see <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?security.conf+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.1 dsieger 1387: </p>
1388: </div>
1.41 asau 1389: <div class="sect2">
1.1 dsieger 1390: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1391: <a name="pkg_versions"></a>5.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.1 dsieger 1392: <p>
1.137 leot 1393: Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23 wiz 1394: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1395: argument to check if your packages are up-to-date, e.g.
1396: </p>
1397: <pre class="screen">
1398: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1399: ...
1400: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1401: </pre>
1.10 hubertf 1402: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1403: package on your system and rebuild any dependencies.
1404: </p>
1405: </div>
1.41 asau 1406: <div class="sect2">
1.1 dsieger 1407: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1408: <a name="using.pkg_admin"></a>5.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1409: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1410: administrative functions on the package system.</p>
1411: </div>
1412: </div>
1.41 asau 1413: <div class="sect1">
1.1 dsieger 1414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1415: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1 dsieger 1416: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1417: directory now contains a set of packages, organized into
1418: categories. You can browse the online index of packages, or run
1.10 hubertf 1419: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1420: directory to build local <code class="filename">README.html</code> files for
1.137 leot 1421: all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.1 dsieger 1422: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1423: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1424: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1425: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1426: different <code class="varname">LOCALBASE</code> definitions on the same
1427: system (inside a chroot is an exception). </p>
1428: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1429: 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 1430: instructions how to create your own packages.</p>
1.41 asau 1431: <div class="sect2">
1.1 dsieger 1432: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1433: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1 dsieger 1434: <p>To build packages from source, you need a working C
1435: compiler. On NetBSD, you need to install the
1.23 wiz 1436: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1437: sets. If you want to build X11-related packages, the
1.23 wiz 1438: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1439: sets are required, too.</p>
1440: </div>
1.41 asau 1441: <div class="sect2">
1.1 dsieger 1442: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1443: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1 dsieger 1444: <p>The first step for building a package is downloading the
1445: distfiles (i.e. the unmodified source). If they have not yet been
1446: downloaded, pkgsrc will fetch them automatically.</p>
1447: <p>If you have all files that you need in the
1448: <code class="filename">distfiles</code> directory,
1449: you don't need to connect. If the distfiles are on CD-ROM, you can
1450: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1451: </p>
1452: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1453: <p>
1.10 hubertf 1454: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1455: <p>By default a list of distribution sites will be randomly
1456: intermixed to prevent huge load on servers which holding popular
1457: packages (for example, SourceForge.net mirrors). Thus, every
1458: time when you need to fetch yet another distfile all the mirrors
1459: will be tried in new (random) order. You can turn this feature
1460: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1461: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1462: <p>You can overwrite some of the major distribution sites to
1463: fit to sites that are close to your own. By setting one or two
1464: variables you can modify the order in which the master sites are
1465: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1466: delimited list of domain suffixes.
1467: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1468: contains a whitespace delimited list of regular expressions. It
1469: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1470: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1471: some examples. This may save some of your bandwidth and
1472: time.</p>
1473: <p>You can change these settings either in your shell's environment, or,
1474: if you want to keep the settings, by editing the
1.10 hubertf 1475: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1476: and adding the definitions there.</p>
1477: <p>
1478: If a package depends on many other packages (such as
1.137 leot 1479: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.1 dsieger 1480: alternate between periods of
1481: downloading source, and compiling. To ensure you have all the source
1482: downloaded initially you can run the command:
1483: </p>
1484: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1485: <p>
1486: which will output and run a set of shell commands to fetch the
1487: necessary files into the <code class="filename">distfiles</code> directory. You can
1488: also choose to download the files manually.
1489: </p>
1490: </div>
1.41 asau 1491: <div class="sect2">
1.1 dsieger 1492: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1493: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1 dsieger 1494: <p>
1495: Once the software has downloaded, any patches will be applied, then it
1496: will be compiled for you. This may take some time depending on your
1497: computer, and how many other packages the software depends on and their
1498: compile time.
1499: </p>
1.41 asau 1500: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1501: <h3 class="title">Note</h3>
1502: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1503: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1504: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1505: </div>
1506: <p>For example, type</p>
1507: <pre class="screen">
1508: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1509: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1510: </pre>
1511: <p>at the shell prompt to build the various components of the
1512: package.</p>
1513: <p>The next stage is to actually install the newly compiled
1514: program onto your system. Do this by entering:
1515:
1516: </p>
1517: <pre class="screen">
1518: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1519: </pre>
1520: <p>
1521:
1522: while you are still in the directory for whatever package you
1523: are installing.</p>
1524: <p>Installing the package on your system may require you to
1525: be root. However, pkgsrc has a
1526: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1527: to only become root for the actual installation step.</p>
1528: <p>That's it, the software should now be installed and setup for use.
1529: You can now enter:
1530:
1531: </p>
1532: <pre class="screen">
1533: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1534: </pre>
1535: <p>
1536:
1537: to remove the compiled files in the work directory, as you shouldn't need
1538: them any more. If other packages were also added to your system
1539: (dependencies) to allow your program to compile, you can tidy these up
1540: also with the command:</p>
1541: <pre class="screen">
1542: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1543: </pre>
1544: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 1545: system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1 dsieger 1546: <p>The program is installed under the default root of the
1547: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1548: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1549: variable in your environment, and it will use that value as the
1550: root of your packages tree. So, to use
1551: <code class="filename">/usr/local</code>, set
1552: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1553: Please note that you should use a directory which is dedicated to
1554: packages and not shared with other programs (i.e., do not try and
1555: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1556: to add any of your own files or directories (such as
1557: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1558: <code class="filename">pkgsrc/</code>) below the
1559: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1560: conflicts between programs and other files installed by the
1561: package system and whatever else may have been installed
1562: there.</p>
1.10 hubertf 1563: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1564: alter some configuration options at build time. Have a look at
1565: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1566: of what will be set there by default. Environment variables such
1567: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1568: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1569: set them each time you want to use pkgsrc.</p>
1.23 wiz 1570: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1571: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1572: or being installed. This may be for debugging purposes, or out of
1573: simple curiosity. A number of utility values have been added to
1574: help with this.</p>
1.23 wiz 1575: <div class="orderedlist"><ol class="orderedlist" type="1">
1576: <li class="listitem">
1.167 leot 1577: <p>If you invoke the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 1578: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1579: information will be displayed. For example,</p>
1580: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1581: <p>will show all the commands that are invoked, up to and
1.23 wiz 1582: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1583: </li>
1.23 wiz 1584: <li class="listitem">
1.167 leot 1585: <p>If you want to know the value of a certain <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1586: definition, then the <code class="varname">VARNAME</code> definition
1587: should be used, in conjunction with the show-var
1.167 leot 1588: target. e.g. to show the expansion of the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1589: variable <code class="varname">LOCALBASE</code>:</p>
1590: <pre class="screen">
1591: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1592: /usr/pkg
1593: <code class="prompt">%</code>
1594: </pre>
1595: </li>
1596: </ol></div>
1597: <p>If you want to install a binary package that you've either
1598: created yourself (see next section), that you put into
1599: pkgsrc/packages manually or that is located on a remote FTP
1600: server, you can use the "bin-install" target. This target will
1.167 leot 1601: install a binary package - if available - via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 1602: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1603: sites searched is kept in the variable
1604: <code class="varname">BINPKG_SITES</code>, which defaults to
1.167 leot 1605: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 1606: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1607: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1608: details.</p>
1609: <p>A final word of warning: If you set up a system that has a
1610: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1611: set that before any packages are installed, as you cannot use
1612: several directories for the same purpose. Doing so will result in
1613: pkgsrc not being able to properly detect your installed packages,
1614: and fail miserably. Note also that precompiled binary packages are
1615: usually built with the default <code class="varname">LOCALBASE</code> of
1616: <code class="filename">/usr/pkg</code>, and that you should
1617: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1618: <code class="varname">LOCALBASE</code>.</p>
1619: </div>
1620: </div>
1621: </div>
1.41 asau 1622: <div class="chapter">
1.1 dsieger 1623: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1624: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1 dsieger 1625: <div class="toc">
1626: <p><b>Table of Contents</b></p>
1.100 leot 1627: <dl class="toc">
1.154 rillig 1628: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1629: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1630: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
1631: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1632: <dd><dl>
1633: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
1634: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1635: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 1636: </dl></dd>
1.154 rillig 1637: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
1638: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 1639: </dl>
1640: </div>
1.4 rillig 1641: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1642: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1643: that file depends on the installation. On NetBSD, when you use
1.167 leot 1644: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 1645: <code class="filename">/etc/</code>. In all other cases the default location is
1646: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1647: bootstrap program to install the binary packages.</p>
1648: <p>The format of the configuration file is that of the usual
1649: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1650: is done by setting variables in this file. Note that you can define all
1651: kinds of variables, and no special error checking (for example for
1.112 rillig 1652: spelling mistakes) takes place.</p>
1.41 asau 1653: <div class="sect1">
1.1 dsieger 1654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1655: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112 rillig 1656: <p>The following variables apply to all
1.1 dsieger 1657: pkgsrc packages. A complete list of the variables that can be
1658: configured by the user is available in
1659: <code class="filename">mk/defaults/mk.conf</code>, together with some
1660: comments that describe each variable's intent.</p>
1.41 asau 1661: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1662: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1663: packages will be installed. The default is
1664: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1665: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1666: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1667: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1668: installed. The default is
1669: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1670: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1671: X11 is installed on the system. The default is
1.84 wiz 1672: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1673: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1674: downloaded copies of the original source distributions used
1675: for building pkgsrc packages. The default is
1676: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1677: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1678: database about installed packages is stored. The default is
1.118 sevan 1679: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1680: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1681: If set, override the packages'
1682: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1683: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1684: Backup location(s) for distribution files and patch files
1685: if not found locally or in
1686: <code class="filename">${MASTER_SITES}</code> or
1687: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1688: The defaults is
1689: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1690: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1691: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1692: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1693: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1694: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1695: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1696: List of acceptable licenses. License names are case-sensitive.
1697: Whenever you try to build a package whose license is not in this
1698: list, you will get an error message. If the license condition is
1699: simple enough, the error message will include specific
1700: instructions on how to change this variable.</p></li>
1.1 dsieger 1701: </ul></div>
1702: </div>
1.41 asau 1703: <div class="sect1">
1.1 dsieger 1704: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1705: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1706: <p>
1.1 dsieger 1707: </p>
1.41 asau 1708: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1709: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1710: directory for the binary packages. The default is
1711: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1712: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1713: The top level directory where, if defined, the separate
1714: working directories will get created, and symbolically
1715: linked to from <code class="filename">${WRKDIR}</code> (see below).
1716: This is useful for building packages on several
1717: architectures, then <code class="filename">${PKGSRCDIR}</code>
1718: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1719: is local to every architecture. (It should be noted that
1720: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1721: — it is an internal definition which refers to the
1.1 dsieger 1722: root of the pkgsrc tree. It is possible to have many
1723: pkgsrc tree instances.)</p></li>
1.23 wiz 1724: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1725: Directory for local patches that aren't part of pkgsrc.
1.154 rillig 1726: See <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, “<code class="filename">patches/*</code>”</a> for more
1.1 dsieger 1727: information.</p></li>
1.23 wiz 1728: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1729: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1730: BSD-style Makefile. If this is not set,
1731: <code class="varname">MAKECONF</code> is set to
1732: <code class="filename">/dev/null</code> to avoid picking up
1733: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1734: </ul></div>
1735: </div>
1.41 asau 1736: <div class="sect1">
1.1 dsieger 1737: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1738: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.143 maya 1739: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
1740: By default, binary packages of built packages are
1.150 leot 1741: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143 maya 1742: this variable to "no" prevents this.</p></li></ul></div>
1.107 jnemeth 1743: <p>Packages have to support installation into a
1.4 rillig 1744: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1745: to be built, before the actual filesystem is touched. DESTDIR
1746: support exists in two variations:</p>
1.41 asau 1747: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1748: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1749: installation and packaging is still run as root.</p></li>
1750: <li class="listitem"><p>Full DESTDIR support can run the complete
1751: build, installation and packaging as normal user. Root
1752: privileges are only needed to add packages.</p></li>
1753: </ul></div>
1.4 rillig 1754: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1755: clean</code></strong> needs to be run as root.</p>
1.17 imil 1756: <p>Considering the <code class="filename">foo/bar</code> package,
1757: DESTDIR full support can be tested using the following commands
1758:
1759: </p>
1760: <pre class="programlisting">
1761: <code class="prompt">$</code> id
1762: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1763: <code class="prompt">$</code> mkdir $HOME/packages
1764: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1765: </pre>
1766: <p>
1767:
1768: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1769: should be needed
1770:
1771: </p>
1772: <pre class="programlisting">
1.66 asau 1773: <code class="prompt">$</code> make stage-install
1.17 imil 1774: </pre>
1775: <p>
1776:
1777: Create a package without root privileges
1778:
1779: </p>
1780: <pre class="programlisting">
1.66 asau 1781: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1782: </pre>
1783: <p>
1784:
1785: For the following command, you must be able to gain root
1.167 leot 1786: privileges using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 1787:
1788: </p>
1789: <pre class="programlisting">
1.66 asau 1790: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1791: </pre>
1792: <p>
1793:
1794: Then, as a simple user
1795:
1796: </p>
1797: <pre class="programlisting">
1798: <code class="prompt">$</code> make clean
1799: </pre>
1800: <p>
1801:
1802: </p>
1.4 rillig 1803: </div>
1.41 asau 1804: <div class="sect1">
1.4 rillig 1805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1806: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1807: <div class="sect2">
1.1 dsieger 1808: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1809: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1810: <p>By default, pkgsrc will use GCC to build packages. This may be
1811: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1812: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1813: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1814: <dd>
1815: <p>This is a list of values specifying the chain of
1816: compilers to invoke when building packages. Valid values
1817: are:</p>
1.41 asau 1818: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1819: <li class="listitem"><p><code class="varname">ccc</code>:
1820: Compaq C Compilers (Tru64)</p></li>
1821: <li class="listitem"><p><code class="varname">ccache</code>:
1822: compiler cache (chainable)</p></li>
1823: <li class="listitem"><p><code class="varname">clang</code>:
1824: Clang C and Objective-C compiler</p></li>
1.23 wiz 1825: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1826: distributed C/C++ (chainable)</p></li>
1.66 asau 1827: <li class="listitem"><p><code class="varname">f2c</code>:
1828: Fortran 77 to C compiler (chainable)</p></li>
1829: <li class="listitem"><p><code class="varname">icc</code>:
1830: Intel C++ Compiler (Linux)</p></li>
1831: <li class="listitem"><p><code class="varname">ido</code>:
1832: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1833: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1834: GNU C/C++ Compiler</p></li>
1.66 asau 1835: <li class="listitem"><p><code class="varname">hp</code>:
1836: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1837: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1838: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1839: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1840: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1841: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1842: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1843: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1844: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1845: </ul></div>
1846: <p>The default is
1.23 wiz 1847: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1848: <code class="varname">ccache</code> and/or
1849: <code class="varname">distcc</code> with an appropriate
1850: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1851: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1852: variable should always be terminated with a value for
1853: a real compiler. Note that only one real compiler
1.23 wiz 1854: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1855: is not allowed).</p>
1856: </dd>
1857: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1858: <dd><p>This specifies the minimum version of GCC to use
1859: when building packages. If the system GCC doesn't
1860: satisfy this requirement, then pkgsrc will build and
1861: install one of the GCC packages to use instead.</p></dd>
1.153 leot 1862: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114 maya 1863: <dd><p>Specifies which version of python to use when several
1864: options are available.</p></dd>
1865: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1866: <dd><p>Specifies the fortran compiler to use.
1867: The default is <code class="varname">g95</code>, and
1868: <code class="varname">gfortran</code> is an alternative.</p></dd>
1869: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1870: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1871: <code class="varname">gfortran</code> is used, this option specifies which
1872: version to use.</p></dd>
1.1 dsieger 1873: </dl></div>
1874: </div>
1.41 asau 1875: <div class="sect2">
1.1 dsieger 1876: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1877: <a name="conf.cflags"></a>6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 1878: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1879: please make sure to use the <code class="literal">+=</code> operator
1880: instead of the <code class="literal">=</code> operator:</p>
1881: <pre class="programlisting">
1882: CFLAGS+= -your -flags
1883: </pre>
1884: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1885: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1886: need to add their own flags. You may want to take a look
1.137 leot 1887: at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23 wiz 1888: package if you're interested in optimization specifically
1889: for the current CPU. </p>
1.1 dsieger 1890: </div>
1.41 asau 1891: <div class="sect2">
1.1 dsieger 1892: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1893: <a name="conf.ldflags"></a>6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 1894: <p>If you want to pass flags to the linker, both in the configure
1895: step and the build step, you can do this in two ways. Either set
1896: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1897: between the two is that <code class="varname">LIBS</code> will be appended to
1898: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1899: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1900: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1901: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1902: <code class="varname">CFLAGS</code>, if you do not wish to override these
1903: settings, use the <code class="literal">+=</code> operator:</p>
1904: <pre class="programlisting">
1905: LDFLAGS+= -your -linkerflags
1906: </pre>
1907: </div>
1908: </div>
1.41 asau 1909: <div class="sect1">
1.1 dsieger 1910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1911: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1912: <p>
1.1 dsieger 1913: </p>
1.41 asau 1914: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1915: <li class="listitem">
1.1 dsieger 1916: <p><code class="varname">PKG_DEVELOPER</code>:
1917: Run some sanity checks that package developers want:
1918: </p>
1.41 asau 1919: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1920: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 1921: fuzz</p></li>
1.23 wiz 1922: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 1923: binaries will find their shared libs.</p></li>
1924: </ul></div>
1925: <p>
1926: </p>
1927: </li>
1.23 wiz 1928: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 1929: of debugging output which is displayed whilst making and
1930: installing the package. The default value for this is 0,
1931: which will not display the commands as they are executed
1932: (normal, default, quiet operation); the value 1 will display
1933: all shell commands before their invocation, and the value 2
1934: will display both the shell commands before their invocation,
1.112 rillig 1935: as well as their actual execution progress with <span class="command"><strong>set
1936: -x</strong></span>.</p></li>
1.1 dsieger 1937: </ul></div>
1938: <p>
1939: </p>
1940: </div>
1.41 asau 1941: <div class="sect1">
1.1 dsieger 1942: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1943: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1944: <p>Some packages have build time options, usually to select
1945: between different dependencies, enable optional support for big
1946: dependencies or enable experimental features.</p>
1947: <p>To see which options, if any, a package supports, and which
1.10 hubertf 1948: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 1949: show-options</strong></span>, for example:</p>
1950: <pre class="programlisting">
1951: The following options are supported by this package:
1952: ssl Enable SSL support.
1953: Exactly one of the following gecko options is required:
1954: firefox Use firefox as gecko rendering engine.
1955: mozilla Use mozilla as gecko rendering engine.
1956: At most one of the following database options may be selected:
1957: mysql Enable support for MySQL database.
1958: pgsql Enable support for PostgreSQL database.
1959:
1960: These options are enabled by default: firefox
1961: These options are currently enabled: mozilla ssl
1962: </pre>
1963: <p>The following variables can be defined in
1.10 hubertf 1964: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 1965: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1966: which can be used to select or disable options for all packages
1967: that support them, and
1968: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1969: which can be used to select or disable options specifically for
1970: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 1971: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 1972: are disabled. A few examples:</p>
1973: <pre class="screen">
1.10 hubertf 1974: <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 1975: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1976: PKG_OPTIONS.kdebase= debug -sasl
1977: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 1978: <p>It is important to note that options that were specifically
1.18 snj 1979: suggested by the package maintainer must be explicitly removed if
1.11 rillig 1980: you do not wish to include the option. If you are unsure you can view
1981: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 1982: <p>The following settings are consulted in the order given, and
1983: the last setting that selects or disables an option is
1984: used:</p>
1.23 wiz 1985: <div class="orderedlist"><ol class="orderedlist" type="1">
1986: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 1987: maintainer</p></li>
1.23 wiz 1988: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 1989: variables (see below)</p></li>
1.23 wiz 1990: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
1991: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 1992: </ol></div>
1993: <p>For groups of mutually exclusive options, the last option
1994: selected is used, all others are automatically disabled. If an
1995: option of the group is explicitly disabled, the previously
1996: selected option, if any, is used. It is an error if no option
1997: from a required group of options is selected, and building the
1998: package will fail.</p>
1999: <p>Before the options framework was introduced, build options
2000: were selected by setting a variable (often named
2001: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2002: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2003: transition to the options framework for the user, these legacy
2004: variables are converted to the appropriate options setting
2005: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2006: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2007: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2008: directly. Support for the legacy variables will be removed
2009: eventually.</p>
2010: </div>
2011: </div>
1.41 asau 2012: <div class="chapter">
1.1 dsieger 2013: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2014: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1 dsieger 2015: <div class="toc">
2016: <p><b>Table of Contents</b></p>
1.100 leot 2017: <dl class="toc">
1.154 rillig 2018: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2019: <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 2020: </dl>
2021: </div>
1.41 asau 2022: <div class="sect1">
1.1 dsieger 2023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2024: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1 dsieger 2025: <p>Once you have built and installed a package, you can create
2026: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.167 leot 2027: another system with <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 2028: the same package on a group of hosts and wasting CPU time. It also
2029: provides a simple means for others to install your package, should
2030: you distribute it.</p>
2031: <p>To create a binary package, change into the appropriate
1.10 hubertf 2032: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2033: package</strong></span>:</p>
2034: <pre class="screen">
1.112 rillig 2035: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2036: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2037: </pre>
1.1 dsieger 2038: <p>This will build and install your package (if not already done),
2039: and then build a binary package from what was installed. You can
1.10 hubertf 2040: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2041: it. Binary packages are created by default in
2042: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2043: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.137 leot 2044: continuation of the above <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.154 rillig 2045: <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 2046: such a binary package.</p>
2047: </div>
1.41 asau 2048: <div class="sect1">
1.1 dsieger 2049: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2050: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
2051: <p>See <a class="xref" href="#build.helpful-targets" title="19.17. Other helpful targets">Section 19.17, “Other helpful targets”</a>.</p>
1.6 rillig 2052: </div>
2053: </div>
1.41 asau 2054: <div class="chapter">
1.6 rillig 2055: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2056: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 2057: builds)</h2></div></div></div>
2058: <div class="toc">
2059: <p><b>Table of Contents</b></p>
1.100 leot 2060: <dl class="toc">
1.154 rillig 2061: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
2062: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
2063: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2064: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
2065: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2066: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2067: </dl>
2068: </div>
1.71 wiz 2069: <p>For a number of reasons you may want to build binary packages
2070: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2071: For instance, when you have multiple machines that should run the same software,
2072: it is wasted time if they all build their packages themselves from source.
2073: Or you may want to build a list of packages you want and check them before
2074: deploying onto production system.
2075: There is a way of getting a set of binary packages:
1.112 rillig 2076: The bulk build system, or pbulk ("p" stands for "parallel").
2077: This chapter describes how to set it up.</p>
1.41 asau 2078: <div class="sect1">
1.6 rillig 2079: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2080: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71 wiz 2081: <p>First of all, you have to decide whether you build all packages
2082: or a limited set of them. Full bulk builds usually consume a lot more resources,
2083: both space and time, than builds for some practical sets of packages.
2084: There exists a number of particularly heavy packages that are not actually
2085: interesting to a wide audience.
2086:
2087: For a limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2088: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2089: </p>
2090: <p>During bulk builds various packages are installed and deinstalled
2091: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2092: so make sure that you don't need any package during the builds.
1.112 rillig 2093: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2094: or something even more restrictive, depending on what the operating system provides,
2095: or dedicate the whole physical machine.
2096: As a useful side effect this makes sure that bulk builds cannot
2097: break anything in your system. There have been numerous cases where
1.6 rillig 2098: certain packages tried to install files outside the
2099: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2100: <code class="filename">/etc</code>.
2101: </p>
1.6 rillig 2102: </div>
1.41 asau 2103: <div class="sect1">
1.6 rillig 2104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2105: <a name="bulk.pbulk"></a>8.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2106: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2107: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2108: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2109: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2110: </ul></div>
1.41 asau 2111: <div class="sect2">
1.15 rillig 2112: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2113: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112 rillig 2114: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2115: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2116: Configure network access to fetch distribution files.
1.112 rillig 2117: Create a user with name "pbulk".</p>
1.68 asau 2118: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2119: <pre class="screen">
1.151 sevan 2120: <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>
2121: <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 2122: <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 2123: </pre>
2124: <p>Or any other way that fits (e.g., curl, wget).</p>
2125: <p>Deploy and configure pbulk tools, e.g.:</p>
2126: <pre class="screen">
1.118 sevan 2127: <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 2128: <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>
2129: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2130: </pre>
2131: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2132: <h3 class="title">Note</h3>
2133: <p><code class="filename">mk.conf.frag</code> is a fragment of
2134: <code class="filename">mk.conf</code> that contains settings you want to
2135: apply to packages you build. For instance,</p>
2136: <pre class="programlisting">
1.112 rillig 2137: PKG_DEVELOPER= yes # perform more checks
2138: X11_TYPE= modular # use pkgsrc X11
2139: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2140: # when building all packages)
1.68 asau 2141: </pre>
2142: </div>
2143: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2144: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2145: <pre class="programlisting">
2146: www/firefox
2147: mail/thunderbird
2148: misc/libreoffice4
2149: </pre>
1.69 asau 2150: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2151: and make final amendments, if wanted.</p>
1.68 asau 2152: <p>Start it:</p>
2153: <pre class="screen">
2154: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2155: </pre>
2156: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2157: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2158: </p>
2159: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2160: <h3 class="title">Note</h3>
2161: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2162: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2163: The script is kept small enough for better understanding.</p>
2164: </div>
2165: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2166: <h3 class="title">Note</h3>
2167: <p>The <code class="filename">pbulk.sh</code> script supports running
2168: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2169: </div>
1.6 rillig 2170: </div>
2171: </div>
1.41 asau 2172: <div class="sect1">
1.6 rillig 2173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2174: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71 wiz 2175: <p>A complete bulk build requires lots of disk space. Some of the
2176: disk space can be read-only, some other must be writable. Some can be on
2177: remote filesystems (such as NFS) and some should be local. Some can be
2178: temporary filesystems, others must survive a sudden reboot.</p>
2179: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2180: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2181: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2182: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2183: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2184: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2185: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2186: </ul></div>
2187: </div>
2188: <div class="sect1">
2189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2190: <a name="creating-cdroms"></a>8.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2191: <p>After your pkgsrc bulk-build has completed, you may wish to
2192: create a CD-ROM set of the resulting binary packages to assist
2193: in installing packages on other machines. The
1.137 leot 2194: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.1 dsieger 2195: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2196: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2197: way that keeps all the dependencies for a given package on the same
2198: CD as that package.</p>
1.41 asau 2199: <div class="sect2">
1.1 dsieger 2200: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2201: <a name="cdpack-example"></a>8.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2202: <p>Complete documentation for cdpack is found in the cdpack(1)
2203: man page. The following short example assumes that the binary
2204: packages are left in
2205: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2206: sufficient disk space exists in <code class="filename">/u2</code> to
2207: hold the ISO 9660 images.</p>
2208: <pre class="screen">
2209: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2210: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2211: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2212: </pre>
2213: <p>If you wish to include a common set of files
2214: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2215: etc.) on each CD in the collection, then you need to create a
2216: directory which contains these files. e.g.</p>
2217: <pre class="screen">
2218: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2219: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2220: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2221: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2222: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2223: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2224: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2225: </pre>
2226: <p>Now create the images:</p>
2227: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2228: <p>Each image will contain <code class="filename">README</code>,
2229: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2230: in their root directories.</p>
2231: </div>
2232: </div>
2233: </div>
1.41 asau 2234: <div class="chapter">
1.1 dsieger 2235: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2236: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2237: <div class="toc">
2238: <p><b>Table of Contents</b></p>
1.100 leot 2239: <dl class="toc">
1.154 rillig 2240: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2241: <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 2242: </dl>
2243: </div>
2244: <p>The files that are installed by pkgsrc are organized in a way that
2245: is similar to what you find in the <code class="filename">/usr</code> directory
2246: of the base system. But some details are different. This is because
2247: pkgsrc initially came from FreeBSD and had adopted its file system
2248: hierarchy. Later it was largely influenced by NetBSD. But no matter
2249: which operating system you are using pkgsrc with, you can expect the
2250: same layout for pkgsrc.</p>
2251: <p>There are mainly four root directories for pkgsrc, which are all
2252: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2253: When pkgsrc has been installed as root, the default locations
2254: are:</p>
2255: <pre class="programlisting">
2256: LOCALBASE= /usr/pkg
2257: PKG_SYSCONFBASE= /usr/pkg/etc
2258: VARBASE= /var
1.119 sevan 2259: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2260: </pre>
2261: <p>In unprivileged mode (when pkgsrc has been installed as any other
2262: user), the default locations are:</p>
2263: <pre class="programlisting">
2264: LOCALBASE= ${HOME}/pkg
2265: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2266: VARBASE= ${HOME}/pkg/var
1.119 sevan 2267: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2268: </pre>
2269: <p>What these four directories are for, and what they look like is
2270: explained below.</p>
1.41 asau 2271: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2272: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2273: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2274: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2275: the well-known subdirectories like <code class="filename">bin</code>,
2276: <code class="filename">include</code>, <code class="filename">lib</code>,
2277: <code class="filename">share</code> and
2278: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2279: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2280: <code class="filename">/var</code> in the base system. Some programs (especially
2281: games, network daemons) need write access to it during normal
2282: operation.</p></li>
1.23 wiz 2283: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2284: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2285: 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 2286: itself.</p></li>
2287: </ul></div>
1.41 asau 2288: <div class="sect1">
1.1 dsieger 2289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2290: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2291: </h2></div></div></div>
2292: <p>The following directories exist in a typical pkgsrc installation
2293: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2294: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2295: <dt><span class="term"><code class="filename">bin</code></span></dt>
2296: <dd><p>Contains executable programs that are intended to be
2297: directly used by the end user.</p></dd>
2298: <dt><span class="term"><code class="filename">emul</code></span></dt>
2299: <dd><p>Contains files for the emulation layers of various other
2300: operating systems, especially for
2301: NetBSD.</p></dd>
2302: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2303: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2304: <dd><p>Contains
2305: the configuration files.</p></dd>
2306: <dt><span class="term"><code class="filename">include</code></span></dt>
2307: <dd><p>Contains headers for the C and C++ programming
2308: languages.</p></dd>
2309: <dt><span class="term"><code class="filename">info</code></span></dt>
2310: <dd><p>Contains GNU info files of various
2311: packages.</p></dd>
2312: <dt><span class="term"><code class="filename">lib</code></span></dt>
2313: <dd><p>Contains shared and static
2314: libraries.</p></dd>
2315: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2316: <dd><p>Contains data files that don't change after
2317: installation. Other data files belong into
2318: <code class="filename">${VARBASE}</code>.</p></dd>
2319: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2320: <dd><p>Contains programs that are not intended to be used by
2321: end users, such as helper programs or network
2322: daemons.</p></dd>
2323: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2324: <dd><p>Contains programs that are intended to be executed as
2325: CGI scripts by a web server.</p></dd>
2326: <dt><span class="term"><code class="filename">man</code> (the usual value of
2327: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2328: <dd><p>Contains brief
2329: documentation in form of manual pages.</p></dd>
2330: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2331: <dd><p>Contains programs that are intended to be used only by
2332: the super-user.</p></dd>
2333: <dt><span class="term"><code class="filename">share</code></span></dt>
2334: <dd><p>Contains platform-independent data files that don't
2335: change after installation.</p></dd>
2336: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2337: <dd><p>Contains documentation files provided by the
2338: packages.</p></dd>
2339: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2340: <dd><p>Contains example files provided by the packages. Among
2341: others, the original configuration files are saved here and copied to
2342: <code class="filename">${PKG_SYSCONFDIR}</code> during
2343: installation.</p></dd>
2344: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2345: <dd><p>Contains the original files for rc.d
2346: scripts.</p></dd>
2347: <dt><span class="term"><code class="filename">var</code> (the usual location of
2348: <code class="filename">${VARBASE}</code>)</span></dt>
2349: <dd><p>Contains files
2350: that may be modified after
2351: installation.</p></dd>
2352: </dl></div>
2353: </div>
1.41 asau 2354: <div class="sect1">
1.1 dsieger 2355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2356: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2357: </h2></div></div></div>
1.41 asau 2358: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2359: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2360: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2361: <dd><p>Contains
2362: information about the currently installed
2363: packages.</p></dd>
2364: <dt><span class="term"><code class="filename">games</code></span></dt>
2365: <dd><p>Contains highscore
2366: files.</p></dd>
2367: <dt><span class="term"><code class="filename">log</code></span></dt>
2368: <dd><p>Contains log files.</p></dd>
2369: <dt><span class="term"><code class="filename">run</code></span></dt>
2370: <dd><p>Contains informational files about daemons that are
2371: currently running.</p></dd>
2372: </dl></div>
2373: </div>
2374: </div>
1.41 asau 2375: <div class="chapter">
1.1 dsieger 2376: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2377: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2378: <div class="toc">
2379: <p><b>Table of Contents</b></p>
1.100 leot 2380: <dl class="toc">
1.154 rillig 2381: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2382: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2383: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2384: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2385: <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>
2386: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2387: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2388: <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>
2389: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2390: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 2391: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 2392: <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>
2393: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
2394: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2395: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2396: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2397: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2398: <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 2399: </dl>
2400: </div>
2401: <p>This section contains hints, tips & tricks on special things in
2402: pkgsrc that we didn't find a better place for in the previous chapters, and
2403: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2404: <div class="sect1">
1.1 dsieger 2405: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2406: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2407: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2408: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2409: <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 2410: This is a general purpose list for most issues regarding
2411: pkgsrc, regardless of platform, e.g. soliciting user help
2412: for pkgsrc configuration, unexpected build failures, using
2413: particular packages, upgrading pkgsrc installations,
2414: questions regarding the pkgsrc release branches, etc. General announcements or
2415: proposals for changes that impact the pkgsrc user community,
2416: e.g. major infrastructure changes, new features, package
2417: removals, etc., may also be posted.</p></li>
1.23 wiz 2418: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 2419: A list where the results of pkgsrc bulk builds are sent and
2420: discussed.</p></li>
1.23 wiz 2421: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 2422: This list is for those who are interested in getting a
2423: commit message for every change committed to pkgsrc. It is
2424: also available in digest form, meaning one daily message
2425: containing all commit messages for changes to the package
2426: source tree in that 24 hour period.</p></li>
2427: </ul></div>
2428: <p>To subscribe, do:</p>
2429: <pre class="programlisting">
2430: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2431: </pre>
2432: <p>Archives for all these mailing lists are available from
1.10 hubertf 2433: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2434: </div>
1.41 asau 2435: <div class="sect1">
1.1 dsieger 2436: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2437: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2438: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2439: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2440: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2441: they might be useful, and not to duplicate the documentation that comes
2442: with each package.</p>
2443: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.137 leot 2444: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1 dsieger 2445: Symlinks for use by buildlink.</p></li></ul></div>
2446: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2447: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2448: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.121 sevan 2449: Calculates various kinds of checksums (including SHA3).</p></li>
1.137 leot 2450: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.1 dsieger 2451: Compatibility library for pkgsrc tools.</p></li>
1.137 leot 2452: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.1 dsieger 2453: non-BSD systems due to lack of native mtree.</p></li>
1.137 leot 2454: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.1 dsieger 2455: Up-to-date replacement for
2456: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2457: systems where pkg_install is not present.</p></li>
2458: </ul></div>
2459: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2460: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2461: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1 dsieger 2462: Create a binary package from an
1.10 hubertf 2463: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2464: save the old package.</p></li>
1.137 leot 2465: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.1 dsieger 2466: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2467: from multiple locations. It currently supports the following
2468: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.137 leot 2469: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.16 jnemeth 2470: the best compiler flags to optimise code for your current
1.23 wiz 2471: CPU and compiler. </p></li>
1.1 dsieger 2472: </ul></div>
2473: <p>Utilities for keeping track of installed packages, being up to date,
2474: etc:</p>
1.41 asau 2475: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2476: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.65 wiz 2477: update tool similar to apt(1). Download, install, and upgrade
2478: binary packages easily.</p></li>
1.137 leot 2479: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.1 dsieger 2480: packages whose installed versions do not match the latest pkgsrc
2481: entries.</p></li>
1.137 leot 2482: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.1 dsieger 2483: dependency graphs of packages, to aid in choosing a strategy for
2484: updating.</p></li>
1.137 leot 2485: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
2486: graphs from the output of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
2487: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12 weinem 2488: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.137 leot 2489: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1 dsieger 2490: does various checks on the complete pkgsrc system.</p></li>
1.137 leot 2491: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.1 dsieger 2492: packages you have installed.</p></li>
2493: </ul></div>
2494: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2495: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2496: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.1 dsieger 2497: making and maintaining patches for a package (includes pkgdiff,
2498: pkgvi, mkpatches, etc.).</p></li>
1.137 leot 2499: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.1 dsieger 2500: converting to pkgsrc.</p></li>
2501: </ul></div>
2502: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2503: utilities)</p>
1.41 asau 2504: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2505: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.1 dsieger 2506: packages in a chrooted area.</p></li>
1.137 leot 2507: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.1 dsieger 2508: kernel version for chrooted cross builds.</p></li>
2509: </ul></div>
2510: </div>
1.41 asau 2511: <div class="sect1">
1.1 dsieger 2512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2513: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2514: <p>To install packages from source as a non-root user, download
1.154 rillig 2515: 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 2516: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2517: --unprivileged</strong></span>.</p>
2518: <p>This will install the binary part of pkgsrc to
2519: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2520: into <code class="filename">~/pkg/etc</code>.</p>
2521: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2522: </div>
1.41 asau 2523: <div class="sect1">
1.1 dsieger 2524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2525: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2526: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2527: enable this feature by adding the option
2528: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2529: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2530: distfile is found, pkgsrc will try to resume it.</p>
2531: <p>You can also
1.61 wiz 2532: use a different program than the platform default program by changing the
1.16 jnemeth 2533: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2534: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2535: by using the value manual. A value of custom disables the system defaults
2536: and dependency tracking for the fetch program. In that case you have to
2537: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2538: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2539: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2540: <p>For example, if you want to use
1.16 jnemeth 2541: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2542: like:</p>
2543: <pre class="programlisting">
1.112 rillig 2544: FETCH_USING= wget
1.1 dsieger 2545: </pre>
2546: </div>
1.41 asau 2547: <div class="sect1">
1.1 dsieger 2548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2549: <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 2550: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2551: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2552: you will have to add the following line into
1.10 hubertf 2553: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2554: <pre class="programlisting">
1.4 rillig 2555: X11_TYPE=modular
1.1 dsieger 2556: </pre>
2557: </div>
1.41 asau 2558: <div class="sect1">
1.1 dsieger 2559: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2560: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2561: <p>If you are sitting behind a firewall which does not allow direct
2562: connections to Internet hosts (i.e. non-NAT), you may specify the
2563: relevant proxy hosts. This is done using an environment variable in the
2564: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2565: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2566: port 80 as the proxy port number. So the proxy environment variables
2567: are:</p>
2568: <pre class="programlisting">
2569: ftp_proxy=ftp://orpheus.amdahl.com:80/
2570: http_proxy=http://orpheus.amdahl.com:80/
2571: </pre>
2572: </div>
1.41 asau 2573: <div class="sect1">
1.1 dsieger 2574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2575: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2576: <p>Some fetch tools are not prepared to support HTTPS by default
2577: (for example, the one in NetBSD 6.0), or the one installed by the
2578: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2579: dependency graph).</p>
2580: <p>Usually you won't notice, because distribution files are
2581: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2582: be often enough if you are following pkgsrc-current. In that case, set
2583: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2584: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2585: with HTTPS support by default. Of course, these tools need to be
2586: installed before you can use them this way.</p>
2587: </div>
2588: <div class="sect1">
2589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2590: <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 2591: <p>This depends on which utility is used to retrieve distfiles. From
2592: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2593: the first available command from the following list:</p>
1.41 asau 2594: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2595: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2596: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2597: </ul></div>
2598: <p>On a default NetBSD installation, this will be
2599: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2600: connections first, and falls back to active connections if the server
2601: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2602: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2603: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2604: <p>Having that option present will prevent
2605: <code class="filename">/usr/bin/ftp</code> from falling back to active
2606: transfers.</p>
2607: </div>
1.41 asau 2608: <div class="sect1">
1.1 dsieger 2609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2610: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2611: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2612: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2613: 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 2614: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2615: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2616: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2617: resulting list to your machine at work/school and use it there. If you
1.167 leot 2618: don't have a NetBSD-compatible <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1 dsieger 2619: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2620: URL:</p>
2621: <p>At home:</p>
2622: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2623: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2624: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2625: <p>At work:</p>
2626: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2627: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2628: home.</p>
2629: <p>If you have a machine running NetBSD, and you want to get
2630: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2631: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2632: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2633: directly by running:</p>
2634: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2635: <p>If you even decide to ignore
2636: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2637: by running:</p>
2638: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2639: </div>
1.41 asau 2640: <div class="sect1">
1.1 dsieger 2641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2642: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 2643: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.137 leot 2644: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.1 dsieger 2645: package, you get the error from make that it doesn't know how to make
2646: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2647: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2648: the NetBSD base distribution on your machine. It is recommended to do
2649: that to format man pages.</p>
1.137 leot 2650: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.1 dsieger 2651: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2652: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2653: </div>
1.41 asau 2654: <div class="sect1">
1.1 dsieger 2655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2656: <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 2657: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2658: when you installed your NetBSD machine. Please get and install it, by
2659: extracting it in <code class="filename">/</code>:</p>
2660: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2661: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2662: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2663: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2664: -r</strong></span>).</p>
2665: </div>
1.41 asau 2666: <div class="sect1">
1.1 dsieger 2667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2668: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 2669: <p>When installing packages as non-root user and using the just-in-time
1.167 leot 2670: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-8.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 2671: password for each required package installed. To avoid this, the sudo
2672: package can be used, which does password caching over a limited time. To
2673: use it, install sudo (either as binary package or from
1.137 leot 2674: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.10 hubertf 2675: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2676: <span class="emphasis"><em>after</em></span> the definition of the
2677: <code class="varname">LOCALBASE</code> variable:</p>
2678: <pre class="programlisting">
2679: .if exists(${LOCALBASE}/bin/sudo)
2680: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2681: .endif
2682: </pre>
2683: </div>
1.41 asau 2684: <div class="sect1">
1.1 dsieger 2685: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2686: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 2687: <p>As the system administrator, you can choose where configuration files
2688: are installed. The default settings make all these files go into
2689: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
2690: be suboptimal depending on your expectations (e.g., a read-only,
2691: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2692: configuration of the provided packages).</p>
2693: <p>In order to change the defaults, you can modify the
2694: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 2695: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 2696: directory; some common examples include <code class="filename">/etc</code> or
2697: <code class="filename">/etc/pkg</code>.</p>
2698: <p>Furthermore, you can change this value on a per-package basis by
2699: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2700: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2701: package you would like to modify, that is, the contents of
2702: <code class="varname">PKGBASE</code>.</p>
2703: <p>Note that after changing these settings, you must rebuild and
2704: reinstall any affected packages.</p>
2705: </div>
1.41 asau 2706: <div class="sect1">
1.1 dsieger 2707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2708: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1 dsieger 2709: <p>Please be aware that there can often be bugs in third-party software,
2710: and some of these bugs can leave a machine vulnerable to exploitation by
2711: attackers. In an effort to lessen the exposure, the NetBSD packages team
2712: maintains a database of known-exploits to packages which have at one time
2713: been included in pkgsrc. The database can be downloaded automatically, and
2714: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 2715: do this, refer to the following two tools (installed as part of the
1.137 leot 2716: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.23 wiz 2717: <div class="orderedlist"><ol class="orderedlist" type="1">
2718: <li class="listitem">
1.20 snj 2719: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 2720: download a list of the security vulnerabilities information. This list
1.25 spz 2721: is kept up to date by the pkgsrc security team, and is distributed
2722: from the NetBSD ftp server:</p>
2723: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.1 dsieger 2724: </li>
1.23 wiz 2725: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
2726: current machine, checking each known vulnerability. If a
1.1 dsieger 2727: vulnerable package is installed, it will be shown by output to stdout,
2728: including a description of the type of vulnerability, and a URL
2729: containing more information.</p></li>
2730: </ol></div>
1.121 sevan 2731: <p>Use of these tools is strongly recommended!
1.154 rillig 2732: See <a class="xref" href="#vulnerabilities" title="5.1.5. Checking for security vulnerabilities in installed packages">Section 5.1.5, “Checking for security vulnerabilities in installed packages”</a> for instructions on how to automate checking and
1.121 sevan 2733: reporting.</p>
2734: <p>If this database is installed, pkgsrc builds will use it to
2735: perform a security check before building any package.</p>
1.1 dsieger 2736: </div>
1.41 asau 2737: <div class="sect1">
1.1 dsieger 2738: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2739: <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 2740: <p>When you add your own preferences to the
2741: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 2742: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 2743: environment variables to the <code class="filename">./configure</code>
1.167 leot 2744: scripts and to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1 dsieger 2745: <code class="varname">CFLAGS</code> from the environment variable by
2746: overriding them in the <code class="filename">Makefile</code>s of their
2747: package.</p>
2748: <p>Currently there is no solution to this problem. If you
2749: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 2750: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 2751: directory and then inspect any <code class="filename">Makefile</code> and
2752: <code class="filename">Makefile.in</code> for whether they define
2753: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 2754: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 2755: programmers write so bad code that it only works for the
2756: specific combination of <code class="varname">CFLAGS</code> they have
2757: chosen.</p>
1.172 rillig 2758: <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>
2759: <pre class="programlisting">
2760: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
2761: CFLAGS+= -Dpkgsrc___CFLAGS
2762: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
2763: </pre>
2764: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
2765: to see whether the above flags are passed to the actual build
2766: commands in general.</p>
2767: <p>To find out whether the flags are passed to individual compiler
2768: commands, have a look at the file <code class="filename">work/.work.log</code>. In
2769: most cases, the flags from the original command lines (the lines starting
2770: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
2771: (the lines starting with <code class="literal"><.></code>). If the flag is
2772: missing from the actual compiler command, it must have been removed by
2773: the <a class="link" href="#build.wrapper" title="19.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.1 dsieger 2774: </div>
1.41 asau 2775: <div class="sect1">
1.1 dsieger 2776: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2777: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 2778: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 2779: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 2780: case that occurs often is that people only update pkgsrc in
2781: parts, because of performance reasons. Since pkgsrc is one large
2782: system, not a collection of many small systems, there are
2783: sometimes changes that only work when the whole pkgsrc tree is
2784: updated.</p></li>
1.41 asau 2785: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 2786: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
2787: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 2788: files.</p></li>
1.41 asau 2789: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 2790: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 2791: verify this.</p></li>
1.108 rillig 2792: <li class="step"><p>If you are a package developer who wants to invest
1.154 rillig 2793: 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 2794: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 2795: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2796: </ol></div>
2797: </div>
1.41 asau 2798: <div class="sect1">
1.1 dsieger 2799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2800: <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 2801: <p>You have modified a file from pkgsrc, and someone else has
2802: modified that same file afterwards in the CVS repository. Both changes
2803: are in the same region of the file, so when you updated pkgsrc, the
2804: <code class="literal">cvs</code> command marked the conflicting changes in the
2805: file. Because of these markers, the file is no longer a valid
2806: <code class="filename">Makefile</code>.</p>
2807: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 2808: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 2809: -dP</strong></span> in that directory to download the current version.</p>
2810: </div>
2811: </div>
2812: </div>
1.41 asau 2813: <div class="part">
1.1 dsieger 2814: <div class="titlepage"><div><div><h1 class="title">
2815: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 2816: <div class="partintro">
1.1 dsieger 2817: <div></div>
2818: <p>This part of the book deals with creating and
1.23 wiz 2819: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 2820: guide on creating a new package. The remaining chapters are more
2821: like a reference manual for pkgsrc.</p>
2822: <div class="toc">
2823: <p><b>Table of Contents</b></p>
1.100 leot 2824: <dl class="toc">
1.154 rillig 2825: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
2826: <dt><span class="chapter"><a href="#creating">12. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 2827: <dd><dl>
1.154 rillig 2828: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1 dsieger 2829: <dd><dl>
1.154 rillig 2830: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
2831: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160 brook 2832: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
2833: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1 dsieger 2834: </dl></dd>
1.154 rillig 2835: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
2836: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6 rillig 2837: </dl></dd>
1.154 rillig 2838: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.6 rillig 2839: <dd><dl>
1.154 rillig 2840: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
2841: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
2842: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 2843: <dd><dl>
1.154 rillig 2844: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
2845: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
2846: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
2847: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
2848: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
1.6 rillig 2849: </dl></dd>
1.154 rillig 2850: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
2851: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
1.6 rillig 2852: <dd><dl>
1.154 rillig 2853: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
2854: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
2855: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.6 rillig 2856: </dl></dd>
1.154 rillig 2857: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
2858: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 2859: </dl></dd>
1.154 rillig 2860: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 2861: <dd><dl>
1.154 rillig 2862: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
2863: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
2864: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
2865: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
1.6 rillig 2866: <dd><dl>
1.154 rillig 2867: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
2868: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
2869: <dt><span class="sect2"><a href="#cflags-gnu-configure">14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
2870: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 2871: </dl></dd>
2872: </dl></dd>
1.154 rillig 2873: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.6 rillig 2874: <dd><dl>
1.154 rillig 2875: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
2876: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
2877: <dt><span class="sect1"><a href="#print-PLIST">15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
2878: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
2879: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
2880: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
2881: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
2882: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
2883: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.6 rillig 2884: </dl></dd>
1.154 rillig 2885: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.6 rillig 2886: <dd><dl>
1.154 rillig 2887: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
2888: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 2889: <dd><dl>
1.154 rillig 2890: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
2891: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26 wiz 2892: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2893: and
2894: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2895: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 2896: </dl></dd>
1.154 rillig 2897: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 2898: <dd><dl>
1.154 rillig 2899: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
2900: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.6 rillig 2901: </dl></dd>
2902: </dl></dd>
1.154 rillig 2903: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.6 rillig 2904: <dd><dl>
1.154 rillig 2905: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
2906: <dd><dl>
2907: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
2908: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
2909: </dl></dd>
2910: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
2911: <dd><dl>
2912: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
2913: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
2914: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
2915: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
2916: </dl></dd>
2917: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
2918: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">17.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
2919: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
2920: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
2921: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
2922: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
2923: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">17.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
2924: </dl></dd>
2925: <dt><span class="chapter"><a href="#options">18. Options handling</a></span></dt>
2926: <dd><dl>
2927: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
2928: <dt><span class="sect1"><a href="#converting-to-options">18.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
2929: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
2930: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
2931: </dl></dd>
2932: <dt><span class="chapter"><a href="#build">19. The build process</a></span></dt>
2933: <dd><dl>
2934: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
2935: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
2936: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
2937: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
2938: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
2939: <dd><dl>
2940: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
2941: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
2942: </dl></dd>
2943: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
2944: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
2945: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
2946: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
2947: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
2948: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2949: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2950: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
2951: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
2952: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
2953: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
2954: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
2955: </dl></dd>
2956: <dt><span class="chapter"><a href="#tools">20. Tools needed for building or running</a></span></dt>
2957: <dd><dl>
2958: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
2959: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
2960: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
2961: </dl></dd>
2962: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
2963: <dd><dl>
2964: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
2965: <dd><dl>
2966: <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>
2967: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
2968: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
2969: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
2970: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
2971: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
2972: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
2973: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
2974: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
2975: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
2976: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
2977: </dl></dd>
2978: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
2979: <dd><dl>
2980: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
2981: <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>
2982: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
2983: </dl></dd>
2984: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2985: <dd><dl>
2986: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
2987: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
2988: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
2989: </dl></dd>
2990: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
2991: <dd><dl>
2992: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
2993: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
2994: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
2995: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
2996: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
2997: </dl></dd>
2998: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2999: <dd><dl>
3000: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3001: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 3002: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3003: <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>
3004: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 3005: </dl></dd>
3006: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3007: <dd><dl>
3008: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3009: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3010: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3011: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3012: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3013: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
3014: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
3015: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
3016: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
3017: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
3018: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
3019: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
3020: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
3021: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
3022: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
3023: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
3024: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
3025: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 3026: emulation</a></span></dt>
1.154 rillig 3027: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
3028: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3029: </dl></dd>
1.154 rillig 3030: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3031: </dl></dd>
1.154 rillig 3032: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
3033: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3034: <dd><dl>
1.154 rillig 3035: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3036: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3037: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3038: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3039: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3040: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3041: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3042: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3043: </dl></dd>
3044: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
3045: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
3046: <dd><dl>
3047: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
3048: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
3049: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
3050: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1 dsieger 3051: </dl></dd>
3052: </dl>
3053: </div>
3054: </div>
1.41 asau 3055: <div class="chapter">
1.1 dsieger 3056: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3057: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3058: <p>
3059: To get help when developing pkgsrc, the definitive source is this
3060: document, the pkgsrc guide. If you don't find anything here,
3061: there are alternatives:
3062: </p>
3063: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3064: <li class="listitem">
3065: <p>
3066: The built-in pkgsrc help, which is available after bootstrapping
3067: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3068: help for any topic, such as a variable name like
3069: <code class="varname">BUILD_DEFS</code>, a make target like
3070: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3071: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
3072: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix D. Help topics">Appendix D, <i>Help topics</i></a>.</p>
3073: </li>
3074: <li class="listitem"><p>
1.163 rillig 3075: To see the value of a single variable, run <span class="command"><strong>bmake
3076: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3077: </p></li>
3078: <li class="listitem"><p>
3079: To see the values of the most common variables, run
3080: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3081: topic. To see the variables for a single topic, run
3082: <span class="command"><strong>bmake
3083: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3084: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3085: </p></li>
3086: <li class="listitem"><p>
1.154 rillig 3087: The tech-pkg mailing list, to which
3088: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3089: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3090: questions</a>.</p></li>
3091: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3092: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3093: or by using a specialized chat program such as
3094: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3095: Pick any user name and join the channel #pkgsrc.</p></li>
3096: </ul></div>
3097: </div>
3098: <div class="chapter">
3099: <div class="titlepage"><div><div><h2 class="title">
3100: <a name="creating"></a>Chapter 12. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3101: <div class="toc">
3102: <p><b>Table of Contents</b></p>
1.100 leot 3103: <dl class="toc">
1.154 rillig 3104: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1 dsieger 3105: <dd><dl>
1.154 rillig 3106: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
3107: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160 brook 3108: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
3109: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1 dsieger 3110: </dl></dd>
1.154 rillig 3111: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
3112: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.1 dsieger 3113: </dl>
3114: </div>
3115: <p>When you find a package that is not yet in pkgsrc, you
3116: most likely have a URL from where you can download the source
3117: code. Starting with this URL, creating a package involves only a
3118: few steps.</p>
1.23 wiz 3119: <div class="procedure"><ol class="procedure" type="1">
1.137 leot 3120: <li class="step"><p>First, install the packages <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.41 asau 3121: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3122: category in which you want to place your package. You can also create a
3123: directory of your own (maybe called <code class="filename">local</code>). In that
3124: category directory, create another directory for your package and change
3125: into it.</p></li>
1.41 asau 3126: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3127: you for a URL. Enter the URL of the distribution file (in most cases a
3128: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3129: of your package are created automatically. The distribution file is
3130: extracted automatically to fill in some details in the
3131: <code class="filename">Makefile</code> that would otherwise have to be done
3132: manually.</p></li>
1.41 asau 3133: <li class="step">
1.1 dsieger 3134: <p>Examine the extracted files to determine the dependencies of
3135: your package. Ideally, this is mentioned in some
3136: <code class="filename">README</code> file, but things may differ. For each of
3137: these dependencies, look where it exists in pkgsrc, and if there is a
3138: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3139: line to your package <code class="filename">Makefile</code> which includes that
3140: file just before the last line. If the
1.25 spz 3141: <code class="filename">buildlink3.mk</code> file does not exist, it must be
1.161 leot 3142: created first. The <code class="filename">buildlink3.mk</code> file makes sure
3143: that the package's include files and libraries are provided.</p>
1.25 spz 3144: <p>If you just need binaries from a package, add a
1.1 dsieger 3145: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3146: version of the dependency and where it can be found in pkgsrc. This line
3147: should be placed in the third paragraph. If the dependency is only
3148: needed for building the package, but not when using it, use
1.156 leot 3149: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
3150: instead of <code class="varname">DEPENDS</code>.
3151: The difference between <code class="varname">TOOL_DEPENDS</code> and
3152: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
3153: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
3154: packages, i.e. packages for the architecture where the package
3155: is built;
3156: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
3157: packages, i.e. packages for the architecture for which the package
3158: is built.
1.1 dsieger 3159: Your package may then look like this:</p>
3160: <pre class="programlisting">
3161: [...]
3162:
1.156 leot 3163: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3164: DEPENDS+= screen-[0-9]*:../../misc/screen
3165: DEPENDS+= screen>=4.0:../../misc/screen
3166:
3167: [...]
3168:
3169: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3170: .include "../../devel/glib2/buildlink3.mk"
3171: .include "../../mk/bsd.pkg.mk"
3172: </pre>
3173: </li>
1.41 asau 3174: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3175: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.10 hubertf 3176: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3177: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3178: -e</strong></span>, which outputs additional
3179: explanations.</p></li>
1.41 asau 3180: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.154 rillig 3181: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="12.1. Common types of packages">Section 12.1, “Common types of packages”</a>. After you have followed the instructions
1.1 dsieger 3182: over there, you can hopefully continue here.</p></li>
1.41 asau 3183: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3184: directory from the extracted files. Besides these files, a lot of cache
3185: files and other system information has been saved in the working
3186: directory, which may become wrong after you edited the
3187: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3188: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.154 rillig 3189: 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></li>
1.41 asau 3190: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3191: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3192: everything works.</p></li>
1.41 asau 3193: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3194: contains a list of the files that are installed by the package, is
1.10 hubertf 3195: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3196: >PLIST</strong></span> to generate a probably correct list. Check
3197: the file using your preferred text editor to see if the list of
3198: files looks plausible.</p></li>
1.41 asau 3199: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3200: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3201: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3202: has been registered in the database of installed files, but with an
1.10 hubertf 3203: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3204: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3205: registered with the list of files from
3206: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3207: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3208: package from the set of installed files.</p></li>
3209: </ol></div>
1.41 asau 3210: <div class="sect1">
1.1 dsieger 3211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3212: <a name="creating.common"></a>12.1. Common types of packages</h2></div></div></div>
1.41 asau 3213: <div class="sect2">
1.1 dsieger 3214: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3215: <a name="creating.perl-module"></a>12.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3216: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3217: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3218: </div>
1.41 asau 3219: <div class="sect2">
1.1 dsieger 3220: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3221: <a name="creating.python-module"></a>12.1.2. Python modules and programs</h3></div></div></div>
1.17 imil 3222: <p>Python modules and programs packages are easily created using a
3223: set of predefined variables.</p>
3224: <p>
1.63 wiz 3225: If some Python versions are not supported by the software, set the
3226: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3227: that are not supported, e.g.
1.17 imil 3228: </p>
3229: <pre class="programlisting">
1.93 sevan 3230: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3231: </pre>
3232: <p>
1.103 wiz 3233: If the packaged software is a Python module, include one of
3234: <code class="filename">../../lang/python/egg.mk</code>,
3235: <code class="filename">../../lang/python/distutils.mk</code>, or
3236: <code class="filename">../../lang/python/extension.mk</code>.</p>
3237: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3238: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3239: if the packaged software is using setuptools, you only need
3240: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3241: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3242: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3243: so pkgsrc will use this framework.
3244: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3245: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3246: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3247: to the name of the script.</p>
3248: <p>Either way, the package directory should be called
1.23 wiz 3249: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3250: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3251: </p>
3252: <pre class="programlisting">
3253: DISTNAME= foopymodule-1.2.10
3254: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3255: </pre>
1.63 wiz 3256: <p>If it is an application, include
3257: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3258: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3259: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3260: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3261: For example:
1.17 imil 3262: </p>
3263: <pre class="programlisting">
1.35 wiz 3264: REPLACE_PYTHON= *.py
1.17 imil 3265: </pre>
1.63 wiz 3266: <p>Some Python modules have separate distributions for Python-2.x
3267: and Python-3.x support. In pkgsrc this is handled by the
3268: <code class="filename">versioned_dependencies.mk</code> file. Set
3269: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3270: packages that should be depended upon and include
3271: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3272: then the pkgsrc infrastructure will depend on the appropriate package
3273: version. For example:
3274: </p>
3275: <pre class="programlisting">
1.135 wiz 3276: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.63 wiz 3277: </pre>
3278: <p>
3279: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3280: of supported packages.</p>
1.17 imil 3281: </div>
1.160 brook 3282: <div class="sect2">
3283: <div class="titlepage"><div><div><h3 class="title">
3284: <a name="creating.R-package"></a>12.1.3. R packages</h3></div></div></div>
3285: <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>
3286: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
3287: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/README.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
3288: Individual packages (and optionally their dependencies) may be created
3289: and updated. R packages generally follow the same form, and most of
3290: the relevant information needed is contained in a
3291: <code class="filename">DESCRIPTION</code> file as part of each R package on
3292: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
3293: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
3294: creates or updates a package in the canonical form. The resulting
3295: package should be reviewed for correctness.</p>
3296: </div>
3297: <div class="sect2">
3298: <div class="titlepage"><div><div><h3 class="title">
3299: <a name="creating.TeX-package"></a>12.1.4. TeXlive packages</h3></div></div></div>
3300: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
3301: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/README.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
3302: <p>If the TeXlive package name is not known, it may be useful to
3303: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
3304: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
3305: 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
3306: archive</a>.</p>
3307: <p>If the TeXlive package name is known, download the files from
3308: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
3309: archive</a>. For package <code class="filename">foo</code>, you will need
3310: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
3311: also have associated documentation packages, so download
3312: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
3313: should be placed in the appropriate category directory, which is often
3314: but not always <code class="filename">print</code>. Then run the following
3315: command in the category directory.</p>
3316: <pre class="programlisting">
3317: texlive2pkg foo.tar.xz foo.doc.tar.xz
3318: </pre>
3319: <p>This will create two packages, <code class="filename">tex-foo</code> and
3320: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
3321: are correct.</p>
3322: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
3323: currently does not include version information in package filenames
3324: and changes their contents periodically when updates occur.
3325: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
3326: pkgsrc archives. For each new or updated TeXlive package, e.g., the
3327: main one and the corresponding documentation, upload the distfiles
3328: with the following command in each package directory.</p>
3329: <pre class="programlisting">
3330: make upload-distfiles
3331: </pre>
3332: </div>
1.1 dsieger 3333: </div>
1.41 asau 3334: <div class="sect1">
1.1 dsieger 3335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3336: <a name="creating.examples"></a>12.2. Examples</h2></div></div></div>
1.41 asau 3337: <div class="sect2">
1.1 dsieger 3338: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3339: <a name="creating.nvu"></a>12.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3340: <div class="sect3">
1.1 dsieger 3341: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 3342: <a name="creating.nvu.init"></a>12.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3343: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3344: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3345: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3346: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3347: <pre class="programlisting">
3348: <code class="prompt">$</code> mkdir www/nvu
3349: <code class="prompt">$</code> cd www/nvu
3350: </pre>
3351: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3352: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3353: <pre class="programlisting">
3354: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3355: </pre>
3356: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3357: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3358: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3359: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3360: <code class="varname">COMMENT</code> fields. Then the package
3361: <code class="filename">Makefile</code> looked like that:</p>
3362: <pre class="programlisting">
1.121 sevan 3363: # $NetBSD $
1.1 dsieger 3364: #
3365:
3366: DISTNAME= nvu-1.0-sources
3367: PKGNAME= nvu-1.0
3368: CATEGORIES= www
3369: MASTER_SITES= http://cvs.nvu.com/download/
3370: EXTRACT_SUFX= .tar.bz2
3371:
3372: MAINTAINER= rillig@NetBSD.org
3373: HOMEPAGE= http://cvs.nvu.com/
3374: COMMENT= Web Authoring System
3375:
3376: # url2pkg-marker (please do not remove this line.)
3377: .include "../../mk/bsd.pkg.mk"
3378: </pre>
1.124 wiz 3379: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.121 sevan 3380: this is a workaround to prevent CVS expanding to the filename of the
3381: guide.</p>
1.1 dsieger 3382: <p>Then, I quit the editor and watched pkgsrc downloading a large
3383: source archive:</p>
3384: <pre class="programlisting">
3385: url2pkg> Running "make makesum" ...
3386: => Required installed package digest>=20010302: digest-20060826 found
3387: => Fetching nvu-1.0-sources.tar.bz2
3388: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3389: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3390: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3391: url2pkg> Running "make extract" ...
3392: => Required installed package digest>=20010302: digest-20060826 found
3393: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3394: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3395: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3396: ===> Installing dependencies for nvu-1.0
3397: ===> Overriding tools for nvu-1.0
3398: ===> Extracting for nvu-1.0
3399: url2pkg> Adjusting the Makefile.
3400:
3401: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3402:
3403: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3404: </pre>
3405: </div>
1.41 asau 3406: <div class="sect3">
1.1 dsieger 3407: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 3408: <a name="creating.nvu.problems"></a>12.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.1 dsieger 3409: <p>Now that the package has been extracted, let's see what's inside
3410: it. The package has a <code class="filename">README.txt</code>, but that only
3411: says something about mozilla, so it's probably useless for seeing what
3412: dependencies this package has. But since there is a GNU configure script
3413: in the package, let's hope that it will complain about everything it
3414: needs.</p>
3415: <pre class="programlisting">
3416: <code class="prompt">$</code> bmake
3417: => Required installed package digest>=20010302: digest-20060826 found
3418: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3419: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3420: ===> Patching for nvu-1.0
3421: ===> Creating toolchain wrappers for nvu-1.0
3422: ===> Configuring for nvu-1.0
3423: [...]
3424: configure: error: Perl 5.004 or higher is required.
3425: [...]
3426: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3427: [...]
3428: </pre>
3429: <p>That worked quite well. So I opened the package Makefile in my
3430: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3431: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3432: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3433: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3434: from scratch.</p>
3435: <pre class="programlisting">
3436: <code class="prompt">$</code> bmake clean
3437: ===> Cleaning for nvu-1.0
3438: <code class="prompt">$</code> bmake
3439: [...]
3440: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3441: GNU Make. You will not be able to build Mozilla without GNU Make.
3442: [...]
3443: </pre>
1.23 wiz 3444: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3445: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3446: <pre class="programlisting">
3447: [...]
3448: checking for GTK - version >= 1.2.0... no
3449: *** Could not run GTK test program, checking why...
3450: [...]
3451: </pre>
3452: <p>Now to the other dependencies. The first question is: Where is the
3453: GTK package hidden in pkgsrc?</p>
3454: <pre class="programlisting">
3455: <code class="prompt">$</code> echo ../../*/gtk*
3456: [many packages ...]
3457: <code class="prompt">$</code> echo ../../*/gtk
3458: ../../x11/gtk
3459: <code class="prompt">$</code> echo ../../*/gtk2
3460: ../../x11/gtk2
3461: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3462: ../../x11/gtk2/buildlink3.mk
3463: </pre>
3464: <p>The first try was definitely too broad. The second one had exactly
3465: one result, which is very good. But there is one pitfall with GNOME
3466: packages. Before GNOME 2 had been released, there were already many
3467: GNOME 1 packages in pkgsrc. To be able to continue to use these
3468: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3469: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3470: whether this was the case here, and indeed it was.</p>
3471: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3472: file, adding the dependency is very easy. I just inserted an
3473: <code class="literal">.include</code> line before the last line of the package
3474: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3475: <pre class="programlisting">
3476: [...]
3477: .include "../../x11/gtk2/buildlink3.mk"
3478: .include "../../mk/bsd.pkg.mk
3479: </pre>
1.10 hubertf 3480: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3481: was:</p>
3482: <pre class="programlisting">
3483: [...]
3484: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3485: checking for GTK - version >= 1.2.0... no
3486: *** Could not run GTK test program, checking why...
3487: *** The test program failed to compile or link. See the file config.log for the
3488: *** exact error that occured. This usually means GTK was incorrectly installed
3489: *** or that you have moved GTK since it was installed. In the latter case, you
3490: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3491: configure: error: Test for GTK failed.
3492: [...]
3493: </pre>
1.23 wiz 3494: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3495: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3496: told me that this package really wanted to have the GNOME 1 version of
3497: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3498: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3499: So I changed the <code class="literal">x11/gtk2</code> to
3500: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3501: and tried again.</p>
3502: <pre class="programlisting">
3503: [...]
1.59 jnemeth 3504: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3505: In file included from xpidl.c:42:
3506: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3507: In file included from xpidl.c:42:
3508: xpidl.h:132: error: parse error before "IDL_ns"
3509: [...]
3510: </pre>
3511: <p>The package still does not find all of its dependencies. Now the
3512: question is: Which package provides the
3513: <code class="filename">libIDL/IDL.h</code> header file?</p>
3514: <pre class="programlisting">
3515: <code class="prompt">$</code> echo ../../*/*idl*
3516: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3517: <code class="prompt">$</code> echo ../../*/*IDL*
3518: ../../net/libIDL
3519: </pre>
3520: <p>Let's take the one from the second try. So I included the
3521: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3522: again. But the error didn't change. After digging through some of the
3523: code, I concluded that the build process of the package was broken and
3524: couldn't have ever worked, but since the Mozilla source tree is quite
3525: large, I didn't want to fix it. So I added the following to the package
3526: <code class="filename">Makefile</code> and tried again:</p>
3527: <pre class="programlisting">
3528: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.139 leot 3529: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.1 dsieger 3530: </pre>
3531: <p>The latter line is needed because the package expects the library
3532: <code class="filename">libIDL.so</code>, but only
3533: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3534: wrapper to rewrite that on the fly.</p>
3535: <p>The next problem was related to a recent change of the FreeType
1.137 leot 3536: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.1 dsieger 3537: which patch files were relevant for this issue and copied them to the
3538: <code class="filename">patches</code> directory. Then I retried, fixed the
3539: patches so that they applied cleanly and retried again. This time,
3540: everything worked.</p>
3541: </div>
1.41 asau 3542: <div class="sect3">
1.1 dsieger 3543: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 3544: <a name="creating.nvu.inst"></a>12.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3545: <pre class="programlisting">
3546: <code class="prompt">$</code> bmake CHECK_FILES=no install
3547: [...]
3548: <code class="prompt">$</code> bmake print-PLIST >PLIST
3549: <code class="prompt">$</code> bmake deinstall
3550: <code class="prompt">$</code> bmake install
3551: </pre>
3552: </div>
3553: </div>
3554: </div>
3555: </div>
1.41 asau 3556: <div class="chapter">
1.1 dsieger 3557: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3558: <a name="components"></a>Chapter 13. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3559: <div class="toc">
3560: <p><b>Table of Contents</b></p>
1.100 leot 3561: <dl class="toc">
1.154 rillig 3562: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
3563: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
3564: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
3565: <dd><dl>
3566: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
3567: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
3568: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
3569: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
3570: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
3571: </dl></dd>
3572: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
3573: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
3574: <dd><dl>
3575: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
3576: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
3577: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3578: </dl></dd>
1.154 rillig 3579: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
3580: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3581: </dl>
3582: </div>
3583: <p>Whenever you're preparing a package, there are a number of
3584: files involved which are described in the following
3585: sections.</p>
1.41 asau 3586: <div class="sect1">
1.1 dsieger 3587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3588: <a name="components.Makefile"></a>13.1. <code class="filename">Makefile</code>
1.1 dsieger 3589: </h2></div></div></div>
3590: <p>Building, installation and creation of a binary package are all
3591: controlled by the package's <code class="filename">Makefile</code>.
3592: The <code class="filename">Makefile</code> describes various things about
3593: a package, for example from where to get it, how to configure,
3594: build, and install it.</p>
3595: <p>A package <code class="filename">Makefile</code> contains several
3596: sections that describe the package.</p>
3597: <p>In the first section there are the following variables, which
3598: should appear exactly in the order given here. The order and
3599: grouping of the variables is mostly historical and has no further
3600: meaning.</p>
1.41 asau 3601: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3602: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3603: distribution file to be downloaded from the package's
3604: website.</p></li>
1.23 wiz 3605: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 3606: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3607: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 3608: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3609: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3610: directory name together with the version number. It must match the
3611: regular expression
3612: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3613: starts with a letter or digit, and contains only letters, digits,
3614: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3615: <li class="listitem">
1.1 dsieger 3616: <p><code class="varname">CATEGORIES</code> is a list of categories
3617: which the package fits in. You can choose any of the top-level
3618: directories of pkgsrc for it.</p>
3619: <p>Currently the following values are available for
3620: <code class="varname">CATEGORIES</code>. If more than
3621: one is used, they need to be separated by spaces:</p>
3622: <pre class="programlisting">
3623: archivers cross geography meta-pkgs security
3624: audio databases graphics misc shells
3625: benchmarks devel ham multimedia sysutils
3626: biology editors inputmethod net textproc
3627: cad emulators lang news time
3628: chat finance mail parallel wm
3629: comms fonts math pkgtools www
3630: converters games mbone print x11
3631: </pre>
3632: </li>
1.23 wiz 3633: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 3634: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3635: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3636: and <code class="varname">DISTFILES</code> are discussed in detail in
1.154 rillig 3637: <a class="xref" href="#build.fetch" title="19.5. The fetch phase">Section 19.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.1 dsieger 3638: </ul></div>
3639: <p>The second section contains information about separately
3640: downloaded patches, if any.
3641: </p>
1.41 asau 3642: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 3643: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 3644: Name(s) of additional files that contain distribution patches.
3645: There is no default. pkgsrc will look for them at
3646: <code class="varname">PATCH_SITES</code>.
3647: They will automatically be uncompressed before patching if
3648: the names end with <code class="filename">.gz</code> or
3649: <code class="filename">.Z</code>.</p></li>
1.23 wiz 3650: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 3651: Primary location(s) for distribution patch files (see
1.80 wiz 3652: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3653: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.167 leot 3654: an argument to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.80 wiz 3655: help find the correct files to patch. It defaults to
3656: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 3657: </ul></div>
3658: <p>The third section contains the following variables.
3659: </p>
1.41 asau 3660: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3661: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 3662: address of the person who feels responsible for this package,
3663: and who is most likely to look at problems or questions regarding
1.167 leot 3664: this package which have been reported with <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.14 jmcneill 3665: Other developers may contact the <code class="varname">MAINTAINER</code>
3666: before making changes to the package, but are not required to
3667: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3668: to yourself. If you really can't maintain the package for future
3669: updates, set it to
1.10 hubertf 3670: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 3671: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 3672: of <code class="varname">MAINTAINER</code> when you do not want other
3673: developers to update or change the package without contacting
3674: you first. A package Makefile should contain one of
3675: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3676: not both. </p></li>
1.23 wiz 3677: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 3678: find more information about the package.</p></li>
1.23 wiz 3679: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 3680: description of the package (should not include the package
3681: name).</p></li>
1.122 leot 3682: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.154 rillig 3683: 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.1 dsieger 3684: </ul></div>
3685: <p>Other variables that affect the build:
3686: </p>
1.41 asau 3687: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 3688: <p><code class="varname">WRKSRC</code>: The directory where the
3689: interesting distribution files of the package are found. The
3690: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3691: works for most packages.</p>
3692: <p>If a package doesn't create a subdirectory for itself
3693: (most GNU software does, for instance), but extracts itself in
3694: the current directory, you should set
3695: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3696: <p>If a package doesn't create a subdirectory with the
3697: name of <code class="varname">DISTNAME</code> but some different name,
3698: set <code class="varname">WRKSRC</code> to point to the proper name in
3699: <code class="filename">${WRKDIR}</code>, for example
3700: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.137 leot 3701: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.1 dsieger 3702: <p>The name of the working directory created by pkgsrc is
3703: taken from the <code class="varname">WRKDIR_BASENAME</code>
3704: variable. By default, its value is
3705: <code class="filename">work</code>. If you want to use the same
3706: pkgsrc tree for building different kinds of binary packages,
3707: you can change the variable according to your needs. Two
3708: other variables handle common cases of setting
3709: <code class="varname">WRKDIR_BASENAME</code> individually. If
3710: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 3711: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 3712: the host's name is attached to the directory name. If
3713: <code class="varname">OBJMACHINE</code> is defined, the platform name
3714: is attached, which might look like
3715: <code class="filename">work.i386</code> or
3716: <code class="filename">work.sparc</code>.</p>
3717: </li></ul></div>
3718: <p>Please pay attention to the following gotchas:</p>
1.41 asau 3719: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3720: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 3721: installed in compressed form by the package. For packages using
3722: BSD-style makefiles which honor MANZ, there is
3723: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 3724: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3725: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 3726: below).</p></li>
1.154 rillig 3727: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.7. Packages installing info files">Section 21.6.7, “Packages installing info files”</a>.</p></li>
1.1 dsieger 3728: </ul></div>
3729: </div>
1.41 asau 3730: <div class="sect1">
1.1 dsieger 3731: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3732: <a name="components.distinfo"></a>13.2. <code class="filename">distinfo</code>
1.1 dsieger 3733: </h2></div></div></div>
3734: <p>The <code class="filename">distinfo</code> file contains the message
3735: digest, or checksum, of each distfile needed for the package. This
3736: ensures that the distfiles retrieved from the Internet have not been
3737: corrupted during transfer or altered by a malign force to introduce
1.108 rillig 3738: a security hole. To provide maximum security, all distfiles are
3739: protected using three different message digest algorithms (SHA1,
3740: RMD160, SHA512), as well as the file size.</p>
1.1 dsieger 3741: <p>The <code class="filename">distinfo</code> file also contains the
3742: checksums for all the patches found in the
1.154 rillig 3743: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, “<code class="filename">patches/*</code>”</a>). These checksums ensure that patches
1.145 leot 3744: are only applied intentionally and that they don't accidentally change,
3745: e.g. when merging different changes together. They also make sure that
3746: new patches are actually added to CVS and old ones are removed.
3747: Too see whether the patches and the <code class="filename">distinfo</code> file
3748: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
1.1 dsieger 3749: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108 rillig 3750: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1 dsieger 3751: <p>Some packages have different sets of distfiles depending on
1.137 leot 3752: the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.1 dsieger 3753: <code class="filename">distinfo</code> file and care should be taken when
3754: upgrading such a package to ensure distfile information is not
3755: lost.</p>
3756: </div>
1.41 asau 3757: <div class="sect1">
1.1 dsieger 3758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3759: <a name="components.patches"></a>13.3. <code class="filename">patches/*</code>
1.108 rillig 3760: </h2></div></div></div>
3761: <p>Some packages don't work out-of-the box on the various
3762: platforms that are supported by pkgsrc. These packages need
3763: to be patched to make them work. The patch files can be
1.1 dsieger 3764: found in the <code class="filename">patches/</code> directory.</p>
3765: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3766: applied to the files in <code class="varname">WRKSRC</code> directory after
1.108 rillig 3767: extracting them, in alphabetic order.</p>
1.41 asau 3768: <div class="sect2">
1.1 dsieger 3769: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3770: <a name="components.patch.structure"></a>13.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 3771: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 3772: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 3773: problems. (To force patches to apply with fuzz you can set
3774: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3775: should contain only changes for a single file, and no file should be
3776: patched by more than one patch file. This helps to keep future
3777: modifications simple.</p>
3778: <p>Each patch file is structured as follows: In the first line,
3779: there is the RCS Id of the patch itself. The second line should be
3780: empty for aesthetic reasons. After that, there should be a comment for
3781: each change that the patch does. There are a number of standard
3782: cases:</p>
1.41 asau 3783: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3784: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 3785: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 3786: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 3787: platform and other environment (for example, the compiler) that the
3788: patch is needed for.</p></li>
3789: </ul></div>
1.108 rillig 3790: <p>The patch should be commented so that any
1.1 dsieger 3791: developer who knows the code of the application can make some use of
3792: the patch. Special care should be taken for the upstream developers,
3793: since we generally want that they accept our patches, so we have less
3794: work in the future.</p>
3795: </div>
1.41 asau 3796: <div class="sect2">
1.1 dsieger 3797: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3798: <a name="components.patches.caveats"></a>13.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 3799: <p>One important thing to mention is to pay attention that no RCS
3800: IDs get stored in the patch files, as these will cause problems when
3801: later checked into the NetBSD CVS tree. Use the
1.137 leot 3802: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.1 dsieger 3803: problems.</p>
3804: <p>For even more automation, we recommend using
1.10 hubertf 3805: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 3806: whole set of patches. You just have to backup files before you
3807: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 3808: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3809: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 3810: you upgrade a package this way, you can easily compare the new
3811: set of patches with the previously existing one with
1.24 wiz 3812: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3813: are replaced by new files, so carefully check if you want to take all
3814: the changes.</p>
1.1 dsieger 3815: <p>When you have finished a package, remember to generate
1.10 hubertf 3816: the checksums for the patch files by using the <span class="command"><strong>make
1.154 rillig 3817: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="13.2. distinfo">Section 13.2, “<code class="filename">distinfo</code>”</a>.</p>
1.1 dsieger 3818: <p>When adding a patch that corrects a problem in the
3819: distfile (rather than e.g. enforcing pkgsrc's view of where
3820: man pages should go), send the patch as a bug report to the
3821: maintainer. This benefits non-pkgsrc users of the package,
3822: and usually makes it possible to remove the patch in future
3823: version.</p>
1.2 rillig 3824: <p>The file names of the patch files are usually of the form
1.24 wiz 3825: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3826: Many packages still use the previous convention
3827: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3828: but new patches should be of the form containing the filename.
1.137 leot 3829: <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.24 wiz 3830: automatically.</p>
1.1 dsieger 3831: </div>
1.41 asau 3832: <div class="sect2">
1.1 dsieger 3833: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3834: <a name="components.patches.sources"></a>13.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 3835: <p>If you want to share patches between multiple packages
3836: in pkgsrc, e.g. because they use the same distfiles, set
3837: <code class="varname">PATCHDIR</code> to the path where the patch files
3838: can be found, e.g.:</p>
3839: <pre class="programlisting">
1.159 rillig 3840: PATCHDIR= ../../editors/xemacs/patches
1.1 dsieger 3841: </pre>
3842: <p>Patch files that are distributed by the author or other
3843: maintainers can be listed in
3844: <code class="varname">PATCHFILES</code>.</p>
3845: <p>If it is desired to store any patches that should not be
3846: committed into pkgsrc, they can be kept outside the pkgsrc
3847: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3848: directory tree there is expected to have the same
1.23 wiz 3849: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 3850: patches are expected to be stored inside these dirs (also
3851: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3852: example, if you want to keep a private patch for
3853: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3854: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3855: files in the named directory are expected to be patch files,
3856: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3857: applied</em></span>.</p>
3858: </div>
1.41 asau 3859: <div class="sect2">
1.1 dsieger 3860: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3861: <a name="components.patches.guidelines"></a>13.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 3862: <p>When fixing a portability issue in the code do not use
3863: preprocessor magic to check for the current operating system nor
3864: platform. Doing so hurts portability to other platforms because
3865: the OS-specific details are not abstracted appropriately.</p>
3866: <p>The general rule to follow is: instead of checking for the
3867: operating system the application is being built on, check for the
3868: specific <span class="emphasis"><em>features</em></span> you need. For example,
3869: instead of assuming that kqueue is available under NetBSD and
3870: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 3871: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 3872: yes, this generally involves patching the
1.10 hubertf 3873: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 3874: that prevents some OSes from adopting interfaces from other OSes
3875: (e.g. Linux implementing kqueue), something that the above checks
3876: cannot take into account.</p>
3877: <p>Of course, checking for features generally involves more
3878: work on the developer's side, but the resulting changes are
3879: cleaner and there are chances they will work on many other
3880: platforms. Not to mention that there are higher chances of being
3881: later integrated into the mainstream sources. Remember:
3882: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3883: <p>Some typical examples:</p>
3884: <div class="table">
1.154 rillig 3885: <a name="patch-examples"></a><p class="title"><b>Table 13.1. Patching examples</b></p>
1.106 tnn 3886: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1 dsieger 3887: <colgroup>
3888: <col>
3889: <col>
3890: <col>
3891: </colgroup>
3892: <thead><tr>
3893: <th>Where</th>
3894: <th>Incorrect</th>
3895: <th>Correct</th>
3896: </tr></thead>
3897: <tbody>
3898: <tr>
3899: <td>configure script</td>
3900: <td>
3901: <pre class="programlisting">
3902: case ${target_os} in
3903: netbsd*) have_kvm=yes ;;
3904: *) have_kvm=no ;;
3905: esac
3906: </pre>
3907: </td>
3908: <td>
3909: <pre class="programlisting">
3910: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
3911: </pre>
3912: </td>
3913: </tr>
3914: <tr>
3915: <td>C source file</td>
3916: <td>
3917: <pre class="programlisting">
3918: #if defined(__NetBSD__)
3919: # include <sys/event.h>
3920: #endif
3921: </pre>
3922: </td>
3923: <td>
3924: <pre class="programlisting">
3925: #if defined(HAVE_SYS_EVENT_H)
3926: # include <sys/event.h>
3927: #endif
3928: </pre>
3929: </td>
3930: </tr>
3931: <tr>
3932: <td>C source file</td>
3933: <td>
3934: <pre class="programlisting">
3935: int
3936: monitor_file(...)
3937: {
3938: #if defined(__NetBSD__)
3939: int fd = kqueue();
3940: ...
3941: #else
3942: ...
3943: #endif
3944: }
3945: </pre>
3946: </td>
3947: <td>
3948: <pre class="programlisting">
3949: int
3950: monitor_file(...)
3951: {
3952: #if defined(HAVE_KQUEUE)
3953: int fd = kqueue();
3954: ...
3955: #else
1.112 rillig 3956: ...
1.1 dsieger 3957: #endif
3958: }
3959: </pre>
3960: </td>
3961: </tr>
3962: </tbody>
3963: </table></div>
3964: </div>
1.141 maya 3965: <br class="table-break">
1.1 dsieger 3966: </div>
1.41 asau 3967: <div class="sect2">
1.1 dsieger 3968: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3969: <a name="components.patches.feedback"></a>13.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 3970: <p>Always, always, <span class="strong"><strong>always</strong></span>
3971: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3972: improvements you do to a package to the mainstream developers.
3973: This is the only way to get their attention on portability issues
3974: and to ensure that future versions can be built out-of-the box on
3975: NetBSD. Furthermore, any user that gets newer distfiles will get
3976: the fixes straight from the packaged code.</p>
3977: <p>This generally involves cleaning up the patches
3978: (because sometimes the patches that are
1.40 wiz 3979: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 3980: appropriate trackers for the projects and working with the
3981: mainstream authors to accept your changes. It is
3982: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3983: the packages in pkgsrc are kept simple and thus further changes
3984: can be done without much hassle.</p>
1.24 wiz 3985: <p>When you have done this, please add a URL to the upstream
3986: bug report to the patch comment.</p>
1.1 dsieger 3987: <p>Support the idea of free software!</p>
3988: </div>
3989: </div>
1.41 asau 3990: <div class="sect1">
1.1 dsieger 3991: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3992: <a name="other-mandatory-files"></a>13.4. Other mandatory files</h2></div></div></div>
1.41 asau 3993: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3994: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3995: <dd><p>A multi-line description of the piece of software. This should include
3996: any credits where they are due. Please bear in mind that others do not
3997: share your sense of humour (or spelling idiosyncrasies), and that others
3998: will read everything that you write here.</p></dd>
3999: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4000: <dd><p>This file governs the files that are installed on your
4001: system: all the binaries, manual pages, etc. There are other
4002: directives which may be entered in this file, to control the
4003: creation and deletion of directories, and the location of
1.154 rillig 4004: inserted files. See <a class="xref" href="#plist" title="Chapter 15. PLIST issues">Chapter 15, <i>PLIST issues</i></a> for more
1.1 dsieger 4005: information.</p></dd>
4006: </dl></div>
4007: </div>
1.41 asau 4008: <div class="sect1">
1.1 dsieger 4009: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4010: <a name="components.optional"></a>13.5. Optional files</h2></div></div></div>
1.41 asau 4011: <div class="sect2">
1.1 dsieger 4012: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4013: <a name="components.optional.bin"></a>13.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 4014: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4015: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 4016: <dd>
1.167 leot 4017: <p>This shell script is invoked twice by <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1 dsieger 4018: First time after package extraction and before files are
4019: moved in place, the second time after the files to install
4020: are moved in place. This can be used to do any custom
4021: procedures not possible with @exec commands in
1.167 leot 4022: <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
4023: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.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="17.1. Files and directories outside the installation prefix">Section 17.1, “Files and directories outside the installation prefix”</a>.
1.28 wiz 4024: Please note that you can modify variables in it easily by using
4025: <code class="varname">FILES_SUBST</code> in the package's
4026: <code class="filename">Makefile</code>:</p>
4027: <pre class="programlisting">
4028: FILES_SUBST+= SOMEVAR="somevalue"
4029: </pre>
4030: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4031: <code class="filename">INSTALL</code>. By default, substitution is
4032: performed for <code class="varname">PREFIX</code>,
4033: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4034: <code class="varname">VARBASE</code>, and a few others, type
4035: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4036: complete list.</p>
4037: </dd>
1.1 dsieger 4038: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4039: <dd><p>This script is executed before and after any files are removed. It is
4040: this script's responsibility to clean up any additional messy details
4041: around the package's installation, since all pkg_delete knows is how to
4042: delete the files created in the original distribution.
1.167 leot 4043: See <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4044: and <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.28 wiz 4045: The same methods to replace variables can be used as for
4046: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 4047: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4048: <dd>
4049: <p>This file is displayed after installation of the package.
4050: Useful for things like legal notices on almost-free
4051: software and hints for updating config files after
4052: installing modules for apache, PHP etc.
4053: Please note that you can modify variables in it easily by using
4054: <code class="varname">MESSAGE_SUBST</code> in the package's
4055: <code class="filename">Makefile</code>:</p>
4056: <pre class="programlisting">
4057: MESSAGE_SUBST+= SOMEVAR="somevalue"
4058: </pre>
1.23 wiz 4059: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 4060: <code class="filename">MESSAGE</code>. By default, substitution is
4061: performed for <code class="varname">PKGNAME</code>,
4062: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99 sevan 4063: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 4064: <code class="varname">PKG_SYSCONFDIR</code>,
4065: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 4066: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 4067: <p>You can display a different or additional files by
4068: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4069: default is <code class="filename">MESSAGE</code>, if the file
4070: exists.</p>
4071: </dd>
4072: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 4073: <dd>
4074: <p>This file is used by the alternatives framework.
4075: It creates, configures, and destroys generic wrappers used to
4076: run programs with similar interfaces.
4077: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4078: for more information.</p>
4079: <p>Each line of the file contains two filenames, first
4080: the wrapper and then the alternative provided by the package.
4081: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4082: </dd>
1.1 dsieger 4083: </dl></div>
4084: </div>
1.41 asau 4085: <div class="sect2">
1.1 dsieger 4086: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4087: <a name="components.optional.build"></a>13.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 4088: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4089: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4090: <dd><p>This file contains arbitrary things that could
4091: also go into a <code class="filename">Makefile</code>, but its purpose is
4092: to be used by more than one package. This file should only be
4093: used when the packages that will use the file are known in
4094: advance. For other purposes it is often better to write a
4095: <code class="filename">*.mk</code> file and give it a good name that
4096: describes what it does.</p></dd>
4097: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4098: <dd><p>This file contains the dependency information
1.154 rillig 4099: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p></dd>
1.1 dsieger 4100: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4101: <dd><p>This file contains workarounds for compiler bugs
4102: and similar things. It is included automatically by the pkgsrc
4103: infrastructure, so you don't need an extra
4104: <code class="literal">.include</code> line for
4105: it.</p></dd>
4106: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4107: <dd><p>This file contains the code for the
1.154 rillig 4108: package-specific options (see <a class="xref" href="#options" title="Chapter 18. Options handling">Chapter 18, <i>Options handling</i></a>) that can be
1.1 dsieger 4109: selected by the user. If a package has only one or two options,
4110: it is equally acceptable to put the code directly into the
4111: <code class="filename">Makefile</code>.</p></dd>
4112: </dl></div>
4113: </div>
1.41 asau 4114: <div class="sect2">
1.1 dsieger 4115: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4116: <a name="components.optional.none"></a>13.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 4117: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4118: <dt><span class="term"><code class="filename">README*</code></span></dt>
4119: <dd><p>These files do not take place in the creation of
4120: a package and thus are purely informative to the package
4121: developer.</p></dd>
4122: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4123: <dd><p>This file contains things that need to be done
4124: to make the package even
4125: better.</p></dd>
4126: </dl></div>
4127: </div>
4128: </div>
1.41 asau 4129: <div class="sect1">
1.1 dsieger 4130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4131: <a name="work-dir"></a>13.6. <code class="filename">work*</code>
1.1 dsieger 4132: </h2></div></div></div>
1.10 hubertf 4133: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 4134: unpacked into the directory denoted by
4135: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 4136: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 4137: directory is also used to keep various timestamp files.
4138: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4139: The default is <code class="filename">${.CURDIR}/work</code>
4140: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4141: if <code class="varname">OBJMACHINE</code> is set.</p>
4142: </div>
1.41 asau 4143: <div class="sect1">
1.1 dsieger 4144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4145: <a name="files-dir"></a>13.7. <code class="filename">files/*</code>
1.1 dsieger 4146: </h2></div></div></div>
1.172 rillig 4147: <p>If you have any files that you wish to be placed in the package
4148: prior to configuration or building, you can place these files here
4149: and use a <span class="command"><strong>${CP}</strong></span> command in the
4150: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
1.1 dsieger 4151: <p>If you want to share files in this way with other
4152: packages, set the <code class="varname">FILESDIR</code> variable to point
4153: to the other package's <code class="filename">files</code> directory,
4154: e.g.:</p>
4155: <pre class="programlisting">
1.159 rillig 4156: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 4157: </pre>
4158: </div>
4159: </div>
1.41 asau 4160: <div class="chapter">
1.1 dsieger 4161: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 4162: <a name="makefile"></a>Chapter 14. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4163: <div class="toc">
4164: <p><b>Table of Contents</b></p>
1.100 leot 4165: <dl class="toc">
1.154 rillig 4166: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
4167: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
4168: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
4169: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
4170: <dd><dl>
4171: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
4172: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
4173: <dt><span class="sect2"><a href="#cflags-gnu-configure">14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
4174: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 4175: </dl></dd>
4176: </dl>
4177: </div>
4178: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4179: each of which forms a well-defined part of the pkgsrc system. Using
1.167 leot 4180: the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.1 dsieger 4181: like pkgsrc requires some discipline to keep the code correct and
4182: understandable.</p>
4183: <p>The basic ingredients for <code class="filename">Makefile</code>
1.154 rillig 4184: programming are variables and shell
1.1 dsieger 4185: commands. Among these shell commands may even be more complex ones
1.167 leot 4186: like <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.1 dsieger 4187: as intended it is necessary to quote all variables correctly when they
4188: are used.</p>
1.154 rillig 4189: <p>This chapter describes some patterns that appear quite often in
1.1 dsieger 4190: <code class="filename">Makefile</code>s, including the pitfalls that come along
4191: with them.</p>
1.41 asau 4192: <div class="sect1">
1.1 dsieger 4193: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4194: <a name="makefile.style"></a>14.1. Caveats</h2></div></div></div>
1.41 asau 4195: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4196: <p>When you are creating a file as a
4197: target of a rule, always write the data to a temporary file first
4198: and finally rename that file. Otherwise there might occur an error
4199: in the middle of generating the file, and when the user runs
1.167 leot 4200: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.1 dsieger 4201: regenerated properly. Example:</p>
4202: <pre class="programlisting">
4203: wrong:
4204: @echo "line 1" > ${.TARGET}
4205: @echo "line 2" >> ${.TARGET}
4206: @false
4207:
4208: correct:
4209: @echo "line 1" > ${.TARGET}.tmp
4210: @echo "line 2" >> ${.TARGET}.tmp
4211: @false
4212: @mv ${.TARGET}.tmp ${.TARGET}
4213: </pre>
1.10 hubertf 4214: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4215: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4216: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4217: correct</strong></span> gives an error message twice, as expected.</p>
1.167 leot 4218: <p>You might remember that <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.1 dsieger 4219: <code class="literal">${.TARGET}</code> in case of error, but this only
4220: happens when it is interrupted, for example by pressing
1.154 rillig 4221: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.167 leot 4222: when one of the commands fails (like <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.1 dsieger 4223: </li></ul></div>
4224: </div>
1.41 asau 4225: <div class="sect1">
1.1 dsieger 4226: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4227: <a name="makefile.variables"></a>14.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4228: <p><code class="filename">Makefile</code> variables contain strings that
1.154 rillig 4229: can be processed using the five operators <code class="code">=</code>,
4230: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.167 leot 4231: <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.1 dsieger 4232: page.</p>
4233: <p>When a variable's value is parsed from a
1.154 rillig 4234: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
4235: the backslash character <code class="code">\</code> are handled specially. If a
4236: backslash is the last character in a line, that backslash is removed
4237: from the line and the line continues with the next line of the file.</p>
4238: <p>The <code class="code">#</code> character starts a comment that reaches
4239: until the end of the line. To get an actual <code class="code">#</code> character,
4240: such as in a URL, write <code class="code">\#</code> instead.</p>
1.108 rillig 4241: <p>The evaluation of variables either happens immediately or lazy.
1.154 rillig 4242: It happens immediately when the variable occurs on the right-hand
4243: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
1.108 rillig 4244: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4245: In the other cases, it is evaluated lazily.</p>
1.1 dsieger 4246: <p>Some of the modifiers split the string into words and then
1.154 rillig 4247: operate on the words, others operate on the string as a whole. When a
4248: string is split into words, double quotes and single quotes are
1.167 leot 4249: interpreted as delimiters, just like in <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?sh+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.41 asau 4250: <div class="sect2">
1.1 dsieger 4251: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4252: <a name="makefile.variables.names"></a>14.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4253: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4254: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4255: are reserved for use by the pkgsrc infrastructure. They shall
1.154 rillig 4256: not be used by packages.</p></li>
1.23 wiz 4257: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4258: lowercase variable names for the iteration
4259: variables.</p></li>
1.154 rillig 4260: <li class="listitem"><p>All list variables should have a plural name,
4261: such as <code class="varname">PKG_OPTIONS</code> or
1.1 dsieger 4262: <code class="varname">DISTFILES</code>.</p></li>
4263: </ul></div>
4264: </div>
4265: </div>
1.41 asau 4266: <div class="sect1">
1.1 dsieger 4267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4268: <a name="makefile.code"></a>14.3. Code snippets</h2></div></div></div>
1.41 asau 4269: <div class="sect2">
1.1 dsieger 4270: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4271: <a name="adding-to-list"></a>14.3.1. Adding things to a list</h3></div></div></div>
1.108 rillig 4272: <p>When adding a string that possibly contains whitespace or quotes to
4273: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4274: modifier.</p>
4275: <p>When adding another list to a list (example 2), it must not be
4276: quoted, since its elements are already quoted.</p>
1.1 dsieger 4277: <pre class="programlisting">
1.108 rillig 4278: STRING= foo * bar `date`
4279: LIST= # empty
4280: ANOTHER_LIST= a=b c=d
4281:
4282: LIST+= ${STRING:Q} # 1
4283: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4284: </pre>
4285: </div>
1.41 asau 4286: <div class="sect2">
1.1 dsieger 4287: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4288: <a name="echo-literal"></a>14.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.108 rillig 4289: <p>Echoing a string containing special characters needs special
4290: work.</p>
1.1 dsieger 4291: <pre class="programlisting">
4292: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 4293: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4294:
4295: all:
4296: echo ${STRING} # 1
1.108 rillig 4297: echo ${STRING:Q} # 2
4298: printf '%s\n' ${STRING:Q}'' # 3
4299: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
4300: </pre>
4301: <p>Example 1 leads to a syntax error in the shell, as the characters
4302: are just copied.</p>
4303: <p>Example 2 quotes the string so that the shell interprets it
4304: correctly. But the echo command may additionally interpret strings with a
4305: leading dash or those containing backslashes.</p>
1.167 leot 4306: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.139 leot 4307: interprets the format string, but not the next argument. The trailing
4308: single quotes handle the case when the string is empty. In that case, the
4309: :Q modifier would result in an empty string too, which would then be
1.167 leot 4310: skipped by the shell. For <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.139 leot 4311: but other programs may care.</p>
1.108 rillig 4312: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4313: need to be quoted because the quoting has already been done
4314: when adding elements to the list.</p>
1.1 dsieger 4315: </div>
1.41 asau 4316: <div class="sect2">
1.1 dsieger 4317: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4318: <a name="cflags-gnu-configure"></a>14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
1.108 rillig 4319: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4320: GNU-style configure script (especially those that call other configure
4321: scripts), it must not have leading or trailing whitespace, since
4322: otherwise the configure script gets confused. To trim leading and
4323: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4324: following example:</p>
1.1 dsieger 4325: <pre class="programlisting">
4326: CPPFLAGS= # empty
1.108 rillig 4327: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.1 dsieger 4328: CPPFLAGS+= ${MY_CPPFLAGS}
4329:
4330: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4331:
4332: all:
4333: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.108 rillig 4334: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4335: </pre>
1.108 rillig 4336: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4337: trailing whitespace because the <code class="code">+=</code> operator always adds a
4338: space.</p>
4339: </div>
4340: <div class="sect2">
4341: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4342: <a name="empty-variables"></a>14.3.4. Handling possibly empty variables</h3></div></div></div>
1.108 rillig 4343: <p>When a possibly empty variable is used in a shell program, it may
4344: lead to a syntax error.</p>
4345: <pre class="programlisting">
4346: EGFILES= # empty
4347:
4348: install-examples: # produces a syntax error in the shell
4349: for egfile in ${EGFILES}; do \
4350: echo "Installing $$egfile"; \
4351: done
4352: </pre>
4353: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.167 leot 4354: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.108 rillig 4355: To fix this syntax error, use one of the snippets below.</p>
4356: <pre class="programlisting">
4357: EMPTY= # empty
4358:
4359: install-examples:
4360: for egfile in ${EGFILES} ""; do \
4361: [ -n "$$egfile" ] || continue; \
4362: echo "Installing $$egfile"; \
1.1 dsieger 4363: done
1.108 rillig 4364: </pre>
4365: <p>In this case, an empty string is appended to the iteration list (to
4366: prevent the syntax error) and filtered out later.</p>
4367: <pre class="programlisting">
4368: EGFILES= # empty
1.1 dsieger 4369:
1.108 rillig 4370: install-examples:
4371: .for egfile in ${EGFILES}
4372: echo "Installing ${egfile}"
1.1 dsieger 4373: .endfor
4374: </pre>
1.154 rillig 4375: <p>If one of the filenames contains special characters, it should be
4376: enclosed in single or double quotes.</p>
1.108 rillig 4377: <p>To have a shell command test whether a make variable is empty, use
4378: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1 dsieger 4379: </div>
4380: </div>
4381: </div>
1.41 asau 4382: <div class="chapter">
1.1 dsieger 4383: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 4384: <a name="plist"></a>Chapter 15. PLIST issues</h2></div></div></div>
1.1 dsieger 4385: <div class="toc">
4386: <p><b>Table of Contents</b></p>
1.100 leot 4387: <dl class="toc">
1.154 rillig 4388: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
4389: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4390: <dt><span class="sect1"><a href="#print-PLIST">15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
4391: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
4392: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
4393: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
4394: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
4395: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
4396: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4397: </dl>
4398: </div>
4399: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4400: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4401: the package (relative to the <code class="filename">${PREFIX}</code>
4402: directory it's been installed in) plus some additional statements
1.167 leot 4403: - see the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1 dsieger 4404: This chapter addresses some issues that need attention when
4405: dealing with the <code class="filename">PLIST</code> file (or files, see
4406: below!).</p>
1.41 asau 4407: <div class="sect1">
1.1 dsieger 4408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4409: <a name="rcs-id"></a>15.1. RCS ID</h2></div></div></div>
1.1 dsieger 4410: <p>Be sure to add a RCS ID line as the first thing in any
4411: <code class="filename">PLIST</code> file you write:</p>
4412: <pre class="programlisting">
1.121 sevan 4413: @comment $NetBSD $
1.111 sevan 4414: </pre>
1.123 wiz 4415: <p>An artificial space has been added between NetBSD and $, this is a
1.121 sevan 4416: workaround here to prevent CVS expanding to the filename of the guide. When
1.125 leot 4417: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 4418: </div>
1.41 asau 4419: <div class="sect1">
1.1 dsieger 4420: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4421: <a name="automatic-plist-generation"></a>15.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4422: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4423: to output a PLIST that matches any new files since the package
1.154 rillig 4424: was extracted. See <a class="xref" href="#build.helpful-targets" title="19.17. Other helpful targets">Section 19.17, “Other helpful targets”</a> for
1.1 dsieger 4425: more information on this target.</p>
4426: </div>
1.41 asau 4427: <div class="sect1">
1.1 dsieger 4428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4429: <a name="print-PLIST"></a>15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4430: </h2></div></div></div>
4431: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4432: of AWK patterns and actions that are used to filter the output of
4433: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4434: scripting you like to it, but be careful with quoting.</p>
4435: <p>For example, to get all files inside the
4436: <code class="filename">libdata/foo</code> directory removed from the
4437: resulting PLIST:</p>
4438: <pre class="programlisting">
4439: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.111 sevan 4440: </pre>
1.1 dsieger 4441: </div>
1.41 asau 4442: <div class="sect1">
1.1 dsieger 4443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4444: <a name="plist.misc"></a>15.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4445: <p>A number of variables are substituted automatically in
4446: PLISTs when a package is installed on a system. This includes the
4447: following variables:</p>
1.41 asau 4448: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4449: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4450: <dd>
4451: <p>Some packages like emacs and perl embed information
4452: about which architecture they were built on into the
4453: pathnames where they install their files. To handle this
4454: case, PLIST will be preprocessed before actually used, and
4455: the symbol
1.23 wiz 4456: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4457: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4458: same is done if the string
4459: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4460: PLIST somewhere - use this on packages that have GNU
4461: autoconf-created configure scripts.</p>
1.41 asau 4462: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4463: <h3 class="title">Legacy note</h3>
4464: <p>There used to be a symbol
1.23 wiz 4465: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4466: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4467: -m</strong></span>, but that's no longer supported and has
4468: been removed.</p>
4469: </div>
4470: </dd>
4471: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4472: <dd>
4473: <p>Some packages want to embed the OS name and version
4474: into some paths. To do this, use these variables in the
4475: <code class="filename">PLIST</code>:
4476: </p>
1.41 asau 4477: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4478: <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>
4479: <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>
4480: <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.1 dsieger 4481: </ul></div>
4482: </dd>
4483: </dl></div>
1.88 tnn 4484: <p>For a list of values which are replaced by
4485: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4486: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4487: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4488: <p>If you want to change other variables not listed above, you
4489: can add variables and their expansions to this variable in the
1.154 rillig 4490: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="13.5. Optional files">Section 13.5, “Optional files”</a>):</p>
1.1 dsieger 4491: <pre class="programlisting">
4492: PLIST_SUBST+= SOMEVAR="somevalue"
1.111 sevan 4493: </pre>
1.23 wiz 4494: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4495: in the <code class="filename">PLIST</code> with
1.23 wiz 4496: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4497: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4498: the common case of conditionally including some
4499: <code class="filename">PLIST</code> entries. It can be done by adding
4500: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4501: setting the corresponding <code class="varname">PLIST.foo</code> variable
4502: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4503: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4504: in the <code class="filename">PLIST</code> with either
1.23 wiz 4505: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4506: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 4507: For example, in <code class="filename">Makefile</code>:</p>
4508: <pre class="programlisting">
1.112 rillig 4509: PLIST_VARS+= foo
1.18 snj 4510: .if <em class="replaceable"><code>condition</code></em>
1.112 rillig 4511: PLIST.foo= yes
1.18 snj 4512: .else
1.111 sevan 4513: </pre>
1.18 snj 4514: <p>And then in <code class="filename">PLIST</code>:</p>
4515: <pre class="programlisting">
1.121 sevan 4516: @comment $NetBSD $
1.18 snj 4517: bin/bar
4518: man/man1/bar.1
4519: ${PLIST.foo}bin/foo
4520: ${PLIST.foo}man/man1/foo.1
4521: ${PLIST.foo}share/bar/foo.data
1.111 sevan 4522: </pre>
1.123 wiz 4523: <p>An artificial space has been added between NetBSD and $, this is a
1.121 sevan 4524: workaround here to prevent CVS expanding to the filename of the guide. When
4525: adding the RCS ID the space should be ommited.</p>
1.1 dsieger 4526: </div>
1.41 asau 4527: <div class="sect1">
1.1 dsieger 4528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4529: <a name="manpage-compression"></a>15.5. Man page compression</h2></div></div></div>
1.1 dsieger 4530: <p>Man pages should be installed in compressed form if
4531: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4532: and uncompressed otherwise. To handle this in the
1.23 wiz 4533: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 4534: appended/removed automatically for man pages according to
4535: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4536: or not, see above for details. This modification of the
4537: <code class="filename">PLIST</code> file is done on a copy of it, not
4538: <code class="filename">PLIST</code> itself.</p>
4539: </div>
1.41 asau 4540: <div class="sect1">
1.1 dsieger 4541: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4542: <a name="using-PLIST_SRC"></a>15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 4543: </h2></div></div></div>
4544: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
4545: in generating the binary package, set the variable
4546: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.167 leot 4547: The files are later concatenated using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.1 dsieger 4548: important. The default for <code class="varname">PLIST_SRC</code> is
4549: <code class="filename">${PKGDIR}/PLIST</code>.</p>
4550: </div>
1.41 asau 4551: <div class="sect1">
1.1 dsieger 4552: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4553: <a name="platform-specific-plist"></a>15.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 4554: <p>Some packages decide to install a different set of files based on
4555: the operating system being used. These differences can be
4556: automatically handled by using the following files:</p>
1.41 asau 4557: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4558: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4559: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4560: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4561: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4562: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 4563: </ul></div>
4564: </div>
1.41 asau 4565: <div class="sect1">
1.1 dsieger 4566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4567: <a name="build-plist"></a>15.8. Build-specific PLISTs</h2></div></div></div>
1.86 wiz 4568: <p>Some packages decide to generate hard-to-guess file names
4569: during installation that are hard to wire down.</p>
4570: <p>In such cases, you can set the
4571: <code class="varname">GENERATE_PLIST</code> variable to shell code
4572: terminated (with a semicolon) that will output PLIST entries which
4573: will be appended to the PLIST</p>
4574: <p>You can find one example in editors/xemacs:</p>
4575: <pre class="programlisting">
1.111 sevan 4576: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4577: </pre>
1.86 wiz 4578: <p>which will append something like
4579: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4580: <code class="filename">PLIST</code>.
4581: </p>
4582: </div>
4583: <div class="sect1">
4584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4585: <a name="faq.common-dirs"></a>15.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 4586: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 4587: multiple (and unrelated) packages install files. These
1.22 jakllsch 4588: directories were problematic because you had to add special
4589: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 4590: centralized package handle them.</p>
1.22 jakllsch 4591: <p>In pkgsrc, it is now easy: Each package should create
4592: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4593: will remove any directories left empty after uninstalling a
4594: package.</p>
4595: <p>If a package needs an empty directory to work, create
4596: the directory during installation as usual, and also add an
4597: entry to the PLIST:
1.111 sevan 4598:
4599: </p>
1.1 dsieger 4600: <pre class="programlisting">
1.22 jakllsch 4601: @pkgdir path/to/empty/directory
1.111 sevan 4602: </pre>
1.22 jakllsch 4603: <p>
1.111 sevan 4604:
1.86 wiz 4605: or take a look at <code class="varname">MAKE_DIRS</code> and
4606: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 4607: </p>
1.1 dsieger 4608: </div>
4609: </div>
1.41 asau 4610: <div class="chapter">
1.1 dsieger 4611: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 4612: <a name="buildlink"></a>Chapter 16. Buildlink methodology</h2></div></div></div>
1.1 dsieger 4613: <div class="toc">
4614: <p><b>Table of Contents</b></p>
1.100 leot 4615: <dl class="toc">
1.154 rillig 4616: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
4617: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4618: <dd><dl>
1.154 rillig 4619: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
4620: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26 wiz 4621: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4622: and
4623: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4624: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4625: </dl></dd>
1.154 rillig 4626: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.1 dsieger 4627: <dd><dl>
1.154 rillig 4628: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
4629: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1 dsieger 4630: </dl></dd>
4631: </dl>
4632: </div>
4633: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
4634: are seen by a package's configure and build processes. This is implemented
4635: in a two step process:</p>
1.23 wiz 4636: <div class="orderedlist"><ol class="orderedlist" type="1">
4637: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 4638: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4639: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 4640: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 4641: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4642: <code class="option">-L${LOCALBASE}/lib</code> into references to
4643: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4644: native compiler on some operating systems look like GCC, so that
4645: packages that expect GCC won't require modifications to build with
4646: those native compilers.</p></li>
4647: </ol></div>
4648: <p>This normalizes the environment in which a package is built so that the
4649: package may be built consistently despite what other software may be
4650: installed. Please note that the normal system header and library paths,
4651: e.g. <code class="filename">/usr/include</code>,
4652: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4653: designed to insulate the package build from non-system-supplied
4654: software.</p>
1.41 asau 4655: <div class="sect1">
1.1 dsieger 4656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4657: <a name="converting-to-buildlink3"></a>16.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 4658: <p>The process of converting packages to use the buildlink3
1.23 wiz 4659: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 4660: The things to keep in mind are:</p>
1.23 wiz 4661: <div class="orderedlist"><ol class="orderedlist" type="1">
4662: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 4663: instead of the actual toolchain. Some packages are tricky,
4664: and the only way to know for sure is the check
4665: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4666: wrappers are being invoked.</p></li>
1.23 wiz 4667: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 4668: the package Makefile, e.g. Java VMs, standalone shells,
4669: etc., because the code to symlink files into
4670: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 4671: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 4672: </p></li>
1.23 wiz 4673: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 4674: <code class="filename">buildlink3.mk</code> files that you list in a
4675: package's Makefile are added as dependencies for that package.
4676: </p></li>
4677: </ol></div>
4678: <p>If a dependency on a particular package is required for its libraries and
4679: headers, then we replace:</p>
4680: <pre class="programlisting">
4681: DEPENDS+= foo>=1.1.0:../../category/foo
4682: </pre>
4683: <p>with</p>
4684: <pre class="programlisting">
4685: .include "../../category/foo/buildlink3.mk"
4686: </pre>
4687: <p>The buildlink3.mk files usually define the required dependencies.
4688: If you need a newer version of the dependency when using buildlink3.mk
4689: files, then you can define it in your Makefile; for example:</p>
4690: <pre class="programlisting">
4691: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4692: .include "../../category/foo/buildlink3.mk"
4693: </pre>
4694: <p>There are several <code class="filename">buildlink3.mk</code>
4695: files in <code class="filename">pkgsrc/mk</code>
4696: that handle special package issues:</p>
1.41 asau 4697: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4698: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 4699: the native or a pkgsrc Berkeley DB implementation based on
4700: the values of <code class="varname">BDB_ACCEPTED</code> and
4701: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 4702: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 4703: comes with neither Curses nor NCurses, this will take care
1.137 leot 4704: to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.23 wiz 4705: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 4706: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4707: adding a dependency on Heimdal or MIT-krb5 for packages that
4708: require a Kerberos 5 implementation.</p></li>
1.23 wiz 4709: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 4710: system-provided Motif installation or adds a dependency on
1.137 leot 4711: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.23 wiz 4712: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.126 leot 4713: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
4714: to choose which Motif version will be used.</p></li>
1.55 ryoon 4715: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 4716: system-provided GNU readline or editline (libedit) installation,
1.137 leot 4717: or adds a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
4718: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.55 ryoon 4719: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4720: If your package really needs GNU readline library, its Makefile
4721: should include <code class="filename">devel/readline/buildlink3.mk</code>
4722: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 4723: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 4724: variables that may be used by packages that use the
4725: Open Sound System (OSS) API.</p></li>
1.23 wiz 4726: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 4727: any of the Postgres versions in the variable
4728: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4729: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 4730: the file for more information.</p></li>
1.23 wiz 4731: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 4732: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.137 leot 4733: a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.23 wiz 4734: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 4735: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4736: library.</p></li>
4737: </ul></div>
4738: <p>The comments in those <code class="filename">buildlink3.mk</code>
4739: files provide a more complete
4740: description of how to use them properly.</p>
4741: </div>
1.41 asau 4742: <div class="sect1">
1.1 dsieger 4743: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4744: <a name="creating-buildlink3.mk"></a>16.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 4745: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 4746: included by Makefiles to indicate the need to compile and link
4747: against header files and libraries provided by the package. A
4748: <code class="filename">buildlink3.mk</code> file should always provide
4749: enough information to add the correct type of dependency
4750: relationship and include any other
4751: <code class="filename">buildlink3.mk</code> files that it needs to find
4752: headers and libraries that it needs in turn.</p>
4753: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.137 leot 4754: file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.1 dsieger 4755: package is highly recommended. For most packages, the following
4756: command will generate a good starting point for
4757: <code class="filename">buildlink3.mk</code> files:</p>
4758: <pre class="screen">
4759: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4760: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4761: </pre>
1.41 asau 4762: <div class="sect2">
1.1 dsieger 4763: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4764: <a name="anatomy-of-bl3"></a>16.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 4765: <p>The following real-life example
4766: <code class="filename">buildlink3.mk</code> is taken
4767: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
4768: <pre class="programlisting">
1.18 snj 4769: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 4770:
1.112 rillig 4771: BUILDLINK_TREE+= tiff
1.1 dsieger 4772:
1.18 snj 4773: .if !defined(TIFF_BUILDLINK3_MK)
4774: TIFF_BUILDLINK3_MK:=
1.1 dsieger 4775:
1.112 rillig 4776: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4777: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
4778: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 4779:
4780: .include "../../devel/zlib/buildlink3.mk"
4781: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 4782: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 4783:
1.112 rillig 4784: BUILDLINK_TREE+= -tiff
1.1 dsieger 4785: </pre>
4786: <p>The header and footer manipulate
1.18 snj 4787: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 4788: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 4789: the dependency tree.</p>
4790: <p>The main section is protected from multiple inclusion
1.1 dsieger 4791: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4792: added. Several important variables are set in the section:</p>
1.41 asau 4793: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4794: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4795: is the actual dependency recorded in the installed
4796: package; this should always be set using
1.10 hubertf 4797: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 4798: we're appending to any pre-existing list of values. This
4799: variable should be set to the first version of the
1.26 wiz 4800: package that had an backwards-incompatible API change.
1.1 dsieger 4801: </p></li>
1.23 wiz 4802: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4803: is the location of the <em class="replaceable"><code>pkg</code></em>
4804: pkgsrc directory.</p></li>
1.23 wiz 4805: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4806: (not shown above) controls whether we use
4807: <code class="varname">BUILD_DEPENDS</code> or
4808: <code class="varname">DEPENDS</code> to add the dependency on
4809: <em class="replaceable"><code>pkg</code></em>. The build dependency is
4810: selected by setting
4811: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4812: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 4813: used.</p></li>
1.23 wiz 4814: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4815: and
4816: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
4817: (not shown above) are lists of subdirectories of
4818: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4819: to add to the header and library search paths. These
1.23 wiz 4820: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 4821: respectively.</p></li>
1.23 wiz 4822: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4823: (not shown above) is the list of preprocessor flags to add
4824: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 4825: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 4826: should be avoided and instead be handled using
4827: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
4828: above.</p></li>
4829: </ul></div>
4830: <p>The following variables are all optionally defined within
4831: this second section (protected against multiple inclusion) and
4832: control which package files are symlinked into
4833: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
4834: transformed during the symlinking:</p>
1.41 asau 4835: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4836: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4837: (not shown above) is a shell glob pattern relative to
4838: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4839: to be symlinked into
4840: <code class="filename">${BUILDLINK_DIR}</code>,
4841: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 4842: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4843: (not shown above) is a shell pipeline that
4844: outputs to stdout a list of files relative to
4845: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
4846: The resulting files are to be symlinked
4847: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
4848: this takes the <code class="filename">+CONTENTS</code> of a
4849: <em class="replaceable"><code>pkg</code></em> and filters it through
4850: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 4851: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4852: (not shown above) is a filter command that filters
4853: <code class="filename">+CONTENTS</code> input into a list of files
4854: relative to
4855: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 4856: on stdout. By default,
1.1 dsieger 4857: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
4858: outputs the contents of the <code class="filename">include</code>
4859: and <code class="filename">lib</code> directories in the package
1.84 wiz 4860: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 4861: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4862: (not shown above) is a list of sed arguments used to
4863: transform the name of the source filename into a
1.10 hubertf 4864: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 4865: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
4866: </ul></div>
1.18 snj 4867: <p>This section can additionally include any
1.1 dsieger 4868: <code class="filename">buildlink3.mk</code> needed for
4869: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
4870: Including these <code class="filename">buildlink3.mk</code> files
4871: means that the headers and libraries for these
4872: dependencies are also symlinked into
4873: <code class="filename">${BUILDLINK_DIR}</code>
4874: whenever the <em class="replaceable"><code>pkg</code></em>
4875: <code class="filename">buildlink3.mk</code>
1.18 snj 4876: file is included. Dependencies are only added for directly
4877: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 4878: <p>When providing a <code class="filename">buildlink3.mk</code> and
4879: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 4880: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 4881: header files are automatically exposed when the package is
4882: use.</p>
4883: <p>In particular, if only an executable
4884: (<code class="filename">bin/foo</code>) is linked against a library, that
4885: library does not need to be propagated in the
4886: <code class="filename">buildlink3.mk</code> file.</p>
4887: <p>The following steps should help you decide if a
4888: <code class="filename">buildlink3.mk</code> file needs to be included:
4889: </p>
4890: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4891: <li class="listitem"><p>Look at the installed header files: What
4892: headers do they include? The packages providing these files
4893: must be buildlinked.</p></li>
1.49 wiz 4894: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
4895: libraries and look against what other libraries they link.
4896: Some of the packages providing these probably need to be
4897: buildlinked; however, it's not automatic, since e.g. GTK on
4898: some systems pulls in the X libraries, so they will show up in
4899: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 4900: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 4901: used as a hint.</p></li>
1.47 wiz 4902: </ul></div>
4903: <p>
4904: </p>
1.1 dsieger 4905: </div>
1.41 asau 4906: <div class="sect2">
1.1 dsieger 4907: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4908: <a name="updating-buildlink-depends"></a>16.2.2. Updating
1.1 dsieger 4909: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4910: and
4911: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4912: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
4913: <p>These two variables differ in that one describes source
4914: compatibility (API) and the other binary compatibility (ABI).
4915: The difference is that a change in the API breaks compilation of
4916: programs while changes in the ABI stop compiled programs from
4917: running.</p>
4918: <p>Changes to the
1.27 wiz 4919: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4920: variable in a <code class="filename">buildlink3.mk</code> file happen
4921: very rarely. One possible reason is that all packages depending
4922: on this already need a newer version. In case it is bumped see
4923: the description below.</p>
4924: <p>The most common example of an ABI change is that the major
4925: version of a shared library is increased. In this case,
4926: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4927: should be adjusted to require at least the new package version.
4928: Then the packages that depend on this package need their
4929: <code class="varname">PKGREVISION</code>s increased and, if they have
4930: <code class="filename">buildlink3.mk</code> files, their
4931: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4932: adjusted, too. This is needed so pkgsrc will require the correct
4933: package dependency and not settle for an older one when building
4934: the source.</p>
1.154 rillig 4935: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for
1.26 wiz 4936: more information about dependencies on other packages,
4937: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 4938: <code class="varname">ABI_DEPENDS</code> definitions.</p>
4939: <p>Please take careful consideration before adjusting
4940: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4941: or
4942: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4943: as we don't want to cause unneeded package deletions and
4944: rebuilds. In many cases, new versions of packages work just
4945: fine with older dependencies.</p>
4946: <p>Also it is not needed to set
1.26 wiz 4947: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4948: when it is identical to
1.1 dsieger 4949: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
4950: </div>
4951: </div>
1.41 asau 4952: <div class="sect1">
1.1 dsieger 4953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4954: <a name="writing-builtin.mk"></a>16.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 4955: <p>Some packages in pkgsrc install headers and libraries that
4956: coincide with headers and libraries present in the base system.
4957: Aside from a <code class="filename">buildlink3.mk</code> file, these
4958: packages should also include a <code class="filename">builtin.mk</code>
4959: file that includes the necessary checks to decide whether using
4960: the built-in software or the pkgsrc software is
4961: appropriate.</p>
4962: <p>The only requirements of a builtin.mk file for
4963: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 4964: <div class="orderedlist"><ol class="orderedlist" type="1">
4965: <li class="listitem"><p>It should set
1.1 dsieger 4966: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4967: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 4968: after it is included.</p></li>
1.23 wiz 4969: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 4970: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4971: which is already set before the
4972: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 4973: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 4974: is <span class="emphasis"><em>very</em></span> important and takes careful
4975: attention to <code class="filename">Makefile</code> coding.</p></li>
4976: </ol></div>
1.41 asau 4977: <div class="sect2">
1.1 dsieger 4978: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4979: <a name="anatomy-of-builtin.mk"></a>16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.1 dsieger 4980: <p>The following is the recommended template for builtin.mk
4981: files:</p>
4982: <pre class="programlisting">
4983: .if !defined(IS_BUILTIN.foo)
4984: #
4985: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4986: # genuinely exists in the system or not.
4987: #
4988: IS_BUILTIN.foo?= no
4989:
4990: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4991: # version can be determined.
4992: #
4993: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4994: BUILTIN_PKG.foo?= foo-1.0
4995: . endif
4996: .endif # IS_BUILTIN.foo
4997:
4998: .if !defined(USE_BUILTIN.foo)
4999: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5000: . if defined(BUILTIN_PKG.foo)
5001: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5002: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5003: USE_BUILTIN.foo!= \
5004: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5005: && ${ECHO} "yes" || ${ECHO} "no"
5006: . endif
5007: . endfor
5008: . endif
5009: .endif # USE_BUILTIN.foo
5010:
5011: CHECK_BUILTIN.foo?= no
5012: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5013: #
5014: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5015: # "yes" or "no".
5016: #
5017: .endif # CHECK_BUILTIN.foo
5018: </pre>
5019: <p>The first section sets
5020: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5021: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5022: in the base system. This should not be a base system software
5023: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 5024: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 5025: included as part of the base system. This variable is only
5026: used internally within the <code class="filename">builtin.mk</code>
5027: file.</p>
5028: <p>The second section sets
5029: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5030: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5031: system if it exists (if
5032: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5033: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 5034: within the <code class="filename">builtin.mk</code> file.</p>
5035: <p>The third section sets
5036: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5037: and is <span class="emphasis"><em>required</em></span> in all
5038: <code class="filename">builtin.mk</code> files. The code in this
5039: section must make the determination whether the built-in
5040: software is adequate to satisfy the dependencies listed in
5041: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5042: This is typically done by comparing
5043: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5044: against each of the dependencies in
5045: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5046: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5047: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5048: end of the <code class="filename">builtin.mk</code> file. Note that
5049: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5050: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 5051: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5052: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 5053: that the built-in version of the software is similar enough to
5054: be used as a replacement.</p>
5055: <p>The last section is guarded by
5056: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5057: and includes code that uses the value of
5058: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5059: set in the previous section. This typically includes, e.g.,
5060: adding additional dependency restrictions and listing additional
5061: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5062: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5063: </div>
1.41 asau 5064: <div class="sect2">
1.1 dsieger 5065: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5066: <a name="native-or-pkgsrc-preference"></a>16.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5067: <p>When building packages, it's possible to choose whether to set
5068: a global preference for using either the built-in (native)
5069: version or the pkgsrc version of software to satisfy a
5070: dependency. This is controlled by setting
5071: <code class="varname">PREFER_PKGSRC</code> and
5072: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 5073: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
1.1 dsieger 5074: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5075: use the pkgsrc versions of software, while
5076: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5077: built-in versions. Preferences are determined by the most
5078: specific instance of the package in either
5079: <code class="varname">PREFER_PKGSRC</code> or
5080: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5081: in neither or in both variables, then
5082: <code class="varname">PREFER_PKGSRC</code> has precedence over
5083: <code class="varname">PREFER_NATIVE</code>. For example, to require
5084: using pkgsrc versions of software for all but the most basic
5085: bits on a NetBSD system, you can set:</p>
5086: <pre class="programlisting">
5087: PREFER_PKGSRC= yes
5088: PREFER_NATIVE= getopt skey tcp_wrappers
5089: </pre>
5090: <p>A package <span class="emphasis"><em>must</em></span> have a
5091: <code class="filename">builtin.mk</code>
5092: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5093: otherwise it is simply ignored in that list.</p>
1.117 sevan 5094: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
5095: straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
5096: bootstrap.
5097: Switching between settings globally at a later date can introduce
5098: complications with dependency resolution. This is caused by packages
5099: built with the opposite preference being installed alongside each other.</p>
5100: <pre class="screen">
5101: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
5102: </pre>
1.1 dsieger 5103: </div>
5104: </div>
5105: </div>
1.41 asau 5106: <div class="chapter">
1.1 dsieger 5107: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 5108: <a name="pkginstall"></a>Chapter 17. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5109: <div class="toc">
5110: <p><b>Table of Contents</b></p>
1.100 leot 5111: <dl class="toc">
1.154 rillig 5112: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
1.1 dsieger 5113: <dd><dl>
1.154 rillig 5114: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
5115: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
1.1 dsieger 5116: </dl></dd>
1.154 rillig 5117: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
1.1 dsieger 5118: <dd><dl>
1.154 rillig 5119: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5120: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
5121: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
5122: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
5123: </dl></dd>
5124: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
5125: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">17.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
5126: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
5127: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
5128: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
5129: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
5130: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">17.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.1 dsieger 5131: </dl>
5132: </div>
5133: <p>This chapter describes the framework known as
5134: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5135: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5136: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5137: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5138: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5139: provided that packages are correctly designed.</p></li>
1.23 wiz 5140: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5141: <li class="listitem"><p>Registration of system users and groups.</p></li>
5142: <li class="listitem"><p>Registration of system shells.</p></li>
5143: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5144: </ul></div>
5145: <p>The following sections inspect each of the above points in detail.</p>
5146: <p>You may be thinking that many of the things described here could be
5147: easily done with simple code in the package's post-installation target
5148: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5149: as the code in them is only executed when building from source. Machines
5150: using binary packages could not benefit from it at all (as the code itself
5151: could be unavailable). Therefore, the only way to achieve any of the items
5152: described above is by means of the installation scripts, which are
5153: automatically generated by pkginstall.</p>
1.41 asau 5154: <div class="sect1">
1.1 dsieger 5155: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5156: <a name="files-and-dirs-outside-prefix"></a>17.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5157: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5158: of files and directories that belong to a package. The names used in it
5159: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5160: which means that it cannot register files outside this directory (absolute
5161: path names are not allowed). Despite this restriction, some packages need
5162: to install files outside this location; e.g., under
5163: <code class="filename">${VARBASE}</code> or
5164: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5165: is to create such files during installation time by using
5166: installation scripts.</p>
5167: <p>The generic installation scripts are shell scripts that can
5168: contain arbitrary code. The list of scripts to execute is taken from
5169: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5170: <code class="filename">INSTALL</code>. A similar variable exists for package
5171: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5172: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5173: commands, so they have the potential to create and manage files
5174: anywhere in the file system.</p>
5175: <p>Using these general installation files is not recommended, but
5176: may be needed in some special cases. One reason for avoiding them is
5177: that the user has to trust the packager that there is no unwanted or
5178: simply erroneous code included in the installation script. Also,
5179: previously there were many similar scripts for the same functionality,
5180: and fixing a common error involved finding and changing all of
5181: them.</p>
5182: <p>The pkginstall framework offers another, standardized way. It
5183: provides generic scripts to abstract the manipulation of such files
5184: and directories based on variables set in the package's
5185: <code class="filename">Makefile</code>. The rest of this section describes
5186: these variables.</p>
1.41 asau 5187: <div class="sect2">
1.1 dsieger 5188: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5189: <a name="dirs-outside-prefix"></a>17.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5190: <p>The following variables can be set to request the creation of
5191: directories anywhere in the file system:</p>
1.41 asau 5192: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108 rillig 5193: <li class="listitem">
5194: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5195: contain a list of directories that should be created and should attempt
5196: to be destroyed by the installation scripts. The difference between
5197: the two is that the latter prompts the administrator to remove any
5198: directories that may be left after deinstallation (because they were
1.108 rillig 5199: not empty), while the former does not. Example:</p>
5200: <pre class="programlisting">
5201: MAKE_DIRS+= ${VARBASE}/foo/private
5202: </pre>
5203: </li>
1.23 wiz 5204: <li class="listitem">
1.1 dsieger 5205: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5206: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5207: which directories should be created and should attempt to be destroyed
5208: by the installation scripts. Each tuple holds the following values,
5209: separated by spaces: the directory name, its owner, its group and its
5210: numerical mode. For example:</p>
5211: <pre class="programlisting">
1.108 rillig 5212: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5213: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5214: </pre>
5215: <p>The difference between the two is exactly the same as their
5216: non-<code class="varname">PERMS</code> counterparts.</p>
5217: </li>
5218: </ul></div>
5219: </div>
1.41 asau 5220: <div class="sect2">
1.1 dsieger 5221: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5222: <a name="files-outside-prefix"></a>17.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5223: <p>Creating non-empty files outside the installation prefix is tricky
5224: because the <code class="filename">PLIST</code> forces all files to be inside it.
5225: To overcome this problem, the only solution is to extract the file in the
5226: known place (i.e., inside the installation prefix) and copy it to the
5227: appropriate location during installation (done by the installation scripts
5228: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5229: file</em></span> in the following paragraphs, which describe the variables
5230: that can be used to automatically and consistently handle files outside the
5231: installation prefix:</p>
1.41 asau 5232: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5233: <li class="listitem">
1.1 dsieger 5234: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5235: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5236: During installation time, the master file is copied to the target one
5237: if and only if the latter does not exist. Upon deinstallation, the
5238: target file is removed provided that it was not modified by the
5239: installation.</p>
5240: <p>The difference between the two is that the latter prompts the
5241: administrator to remove any files that may be left after
5242: deinstallation (because they were not empty), while the former does
5243: not.</p>
5244: </li>
1.23 wiz 5245: <li class="listitem">
1.1 dsieger 5246: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5247: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5248: files as well as their target locations. For each of them, it also
5249: specifies their owner, their group and their numeric permissions, in
5250: this order. For example:</p>
5251: <pre class="programlisting">
1.108 rillig 5252: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5253: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5254: </pre>
5255: <p>The difference between the two is exactly the same as their
5256: non-<code class="varname">PERMS</code> counterparts.</p>
5257: </li>
5258: </ul></div>
5259: </div>
5260: </div>
1.41 asau 5261: <div class="sect1">
1.1 dsieger 5262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5263: <a name="conf-files"></a>17.2. Configuration files</h2></div></div></div>
1.1 dsieger 5264: <p>Configuration files are special in the sense that they are installed
5265: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5266: need special treatment during installation (most of which is automated by
5267: pkginstall). The main concept you must bear in mind is that files marked
5268: as configuration files are automatically copied to the right place (somewhere
5269: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5270: and only if</em></span> they didn't exist before. Similarly, they will not
5271: be removed if they have local modifications. This ensures that
5272: administrators never lose any custom changes they may have made.</p>
1.41 asau 5273: <div class="sect2">
1.1 dsieger 5274: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5275: <a name="conf-files-sysconfdir"></a>17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1 dsieger 5276: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5277: specifies where configuration files shall be installed. Its contents are
5278: set based upon the following variables:</p>
1.41 asau 5279: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5280: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5281: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5282: be overridden by the user to point to his preferred location (e.g.,
5283: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5284: Packages must not use it directly.</p></li>
1.23 wiz 5285: <li class="listitem">
1.1 dsieger 5286: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5287: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5288: for the package being built shall be installed. The definition of this
5289: variable only makes sense in the package's
5290: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5291: <p>As an example, consider the Apache package,
1.137 leot 5292: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.1 dsieger 5293: configuration files under the
5294: <code class="filename">httpd/</code> subdirectory of
5295: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5296: Makefile.</p>
5297: </li>
1.23 wiz 5298: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5299: variable that holds this package's configuration directory (if
5300: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5301: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5302: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5303: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5304: directory where the configuration files for the package identified by
5305: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5306: </ul></div>
5307: <p>Based on the above variables, pkginstall determines the value of
5308: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5309: variable that can be used within a package to refer to its configuration
5310: directory. The algorithm used to set its value is basically the
5311: following:</p>
1.23 wiz 5312: <div class="orderedlist"><ol class="orderedlist" type="1">
5313: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5314: its value is used.</p></li>
1.23 wiz 5315: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5316: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5317: <code class="filename">Makefile</code>, the resulting value is
5318: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5319: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5320: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5321: </ol></div>
5322: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.154 rillig 5323: automatically added to <code class="filename">OWN_DIRS</code>. See <a class="xref" href="#dirs-outside-prefix" title="17.1.1. Directory manipulation">Section 17.1.1, “Directory manipulation”</a> what this means. This does not apply to
1.16 jnemeth 5324: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5325: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5326: </div>
1.41 asau 5327: <div class="sect2">
1.1 dsieger 5328: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5329: <a name="conf-files-configure"></a>17.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5330: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5331: known place, you need to teach each package where it shall install its
5332: files. In some cases you will have to patch the package Makefiles to
5333: achieve it. If you are lucky, though, it may be as easy as passing an
5334: extra flag to the configuration script; this is the case of GNU Autoconf-
5335: generated files:</p>
5336: <pre class="programlisting">
5337: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5338: </pre>
5339: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5340: for</em></span> its configuration files, not where they will be originally
5341: installed (although the difference is never explicit,
5342: unfortunately).</p>
5343: </div>
1.41 asau 5344: <div class="sect2">
1.1 dsieger 5345: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5346: <a name="conf-files-patching"></a>17.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5347: <p>As said before, pkginstall automatically handles configuration files.
5348: This means that <span class="strong"><strong>the packages themselves must not
5349: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5350: directly</strong></span>. Bad news is that many software installation scripts
5351: will, out of the box, mess with the contents of that directory. So what is
5352: the correct procedure to fix this issue?</p>
5353: <p>You must teach the package (usually by manually patching it) to
5354: install any configuration files under the examples hierarchy,
5355: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5356: <code class="filename">PLIST</code> registers them and the administrator always
5357: has the original copies available.</p>
5358: <p>Once the required configuration files are in place (i.e., under the
5359: examples hierarchy), the pkginstall framework can use them as master copies
5360: during the package installation to update what is in
5361: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5362: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.154 rillig 5363: used. Check out <a class="xref" href="#files-outside-prefix" title="17.1.2. File manipulation">Section 17.1.2, “File manipulation”</a> for information
1.1 dsieger 5364: about their syntax and their purpose. Here is an example, taken from the
1.137 leot 5365: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.1 dsieger 5366: <pre class="programlisting">
5367: EGDIR= ${PREFIX}/share/doc/mutt/samples
5368: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5369: </pre>
5370: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5371: package and has no meaning outside it.</p>
5372: </div>
1.41 asau 5373: <div class="sect2">
1.1 dsieger 5374: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5375: <a name="conf-files-disable"></a>17.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5376: <p>The automatic copying of config files can be toggled by setting the
5377: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5378: installation.</p>
5379: </div>
5380: </div>
1.41 asau 5381: <div class="sect1">
1.1 dsieger 5382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5383: <a name="rcd-scripts"></a>17.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5384: <p>System startup scripts are special files because they must be
5385: installed in a place known by the underlying OS, usually outside the
1.154 rillig 5386: installation prefix. Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="17.1. Files and directories outside the installation prefix">Section 17.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.1 dsieger 5387: can be used. However, pkginstall provides a special mechanism to handle
5388: these files.</p>
5389: <p>In order to provide system startup scripts, the package has
5390: to:</p>
1.23 wiz 5391: <div class="orderedlist"><ol class="orderedlist" type="1">
5392: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5393: the <code class="literal">.sh</code> suffix appended. Considering the
1.137 leot 5394: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.1 dsieger 5395: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5396: <li class="listitem">
1.1 dsieger 5397: <p>Tell pkginstall to handle it, appending the name of the script,
5398: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5399: Continuing the previous example:</p>
5400: <pre class="programlisting">
5401: RCD_SCRIPTS+= cupsd
5402: </pre>
5403: </li>
5404: </ol></div>
5405: <p>Once this is done, pkginstall will do the following steps for each
5406: script in an automated fashion:</p>
1.23 wiz 5407: <div class="orderedlist"><ol class="orderedlist" type="1">
5408: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5409: substitutions described in the <code class="filename">FILES_SUBST</code>
5410: variable.</p></li>
1.23 wiz 5411: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5412: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5413: that this master file must be explicitly registered in the
5414: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5415: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5416: from the examples hierarchy into the system-wide startup scripts
5417: directory.</p></li>
5418: </ol></div>
1.41 asau 5419: <div class="sect2">
1.1 dsieger 5420: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5421: <a name="rcd-scripts-disable"></a>17.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5422: <p>The automatic copying of config files can be toggled by setting the
5423: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5424: installation. Note that the scripts will be always copied inside the
5425: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5426: matter what the value of this variable is.</p>
5427: </div>
5428: </div>
1.41 asau 5429: <div class="sect1">
1.1 dsieger 5430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5431: <a name="users-and-groups"></a>17.4. System users and groups</h2></div></div></div>
1.1 dsieger 5432: <p>If a package needs to create special users and/or groups during
5433: installation, it can do so by using the pkginstall framework.</p>
5434: <p>Users can be created by adding entries to the
5435: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5436: syntax:</p>
5437: <pre class="programlisting">
5438: user:group
5439: </pre>
5440: <p>Further specification of user details may be done by setting
5441: per-user variables.
5442: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5443: numeric UID for the user.
5444: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5445: user's description or comment.
5446: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5447: user's home directory, and defaults to
5448: <code class="filename">/nonexistent</code> if not specified.
5449: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5450: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5451: not specified.</p>
5452: <p>Similarly, groups can be created by adding entries to the
5453: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5454: <pre class="programlisting">
5455: group
5456: </pre>
5457: <p>The numeric GID of the group may be set by defining
5458: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5459: <p>If a package needs to create the users and groups at an earlier
1.116 wiz 5460: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
5461: <code class="literal">configure</code>,<code class="literal">build</code>, or
5462: <code class="literal">pre-install</code> to indicate the phase before which the
5463: users and groups are created. In this case, the numeric UIDs and GIDs
5464: of the created users and groups are automatically hardcoded into the
5465: final installation scripts.</p>
1.1 dsieger 5466: </div>
1.41 asau 5467: <div class="sect1">
1.1 dsieger 5468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5469: <a name="shells"></a>17.5. System shells</h2></div></div></div>
1.1 dsieger 5470: <p>Packages that install system shells should register them in the shell
5471: database, <code class="filename">/etc/shells</code>, to make things easier to the
5472: administrator. This must be done from the installation scripts to keep
5473: binary packages working on any system. pkginstall provides an easy way to
5474: accomplish this task.</p>
5475: <p>When a package provides a shell interpreter, it has to set the
5476: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5477: add some hooks to the installation scripts to handle it. Consider the
1.137 leot 5478: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.1 dsieger 5479: <pre class="programlisting">
5480: PKG_SHELL= ${PREFIX}/bin/zsh
5481: </pre>
1.41 asau 5482: <div class="sect2">
1.1 dsieger 5483: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5484: <a name="shells-disable"></a>17.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5485: <p>The automatic registration of shell interpreters can be disabled by
5486: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5487: environment variable to <code class="literal">NO</code>.</p>
5488: </div>
5489: </div>
1.41 asau 5490: <div class="sect1">
1.1 dsieger 5491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5492: <a name="fonts"></a>17.6. Fonts</h2></div></div></div>
1.1 dsieger 5493: <p>Packages that install X11 fonts should update the database files
5494: that index the fonts within each fonts directory. This can easily be
5495: accomplished within the pkginstall framework.</p>
5496: <p>When a package installs X11 fonts, it must list the directories in
5497: which fonts are installed in the
5498: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5499: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5500: <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.1 dsieger 5501: installation scripts to run the appropriate commands to update the fonts
5502: database files within each of those directories. For convenience, if the
5503: directory path is relative, it is taken to be relative to the package's
1.137 leot 5504: installation prefix. Consider the following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.1 dsieger 5505: <pre class="programlisting">
1.67 wiz 5506: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5507: </pre>
1.41 asau 5508: <div class="sect2">
1.1 dsieger 5509: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5510: <a name="fonts-disable"></a>17.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5511: <p>The automatic update of fonts databases can be disabled by
5512: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5513: environment variable to <code class="literal">NO</code>.</p>
5514: </div>
5515: </div>
5516: </div>
1.41 asau 5517: <div class="chapter">
1.1 dsieger 5518: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 5519: <a name="options"></a>Chapter 18. Options handling</h2></div></div></div>
1.1 dsieger 5520: <div class="toc">
5521: <p><b>Table of Contents</b></p>
1.100 leot 5522: <dl class="toc">
1.154 rillig 5523: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
5524: <dt><span class="sect1"><a href="#converting-to-options">18.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
5525: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
5526: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5527: </dl>
5528: </div>
5529: <p>Many packages have the ability to be built to support different
5530: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5531: in pkgsrc that provides generic handling of those options that
5532: determine different ways in which the packages can be built. It's
5533: possible for the user to specify exactly which sets of options will be
5534: built into a package or to allow a set of global default options
5535: apply.</p>
1.7 rillig 5536: <p>There are two broad classes of behaviors that one might want to
5537: control via options. One is whether some particular feature is
5538: enabled in a program that will be built anyway, often by including or
5539: not including a dependency on some other package. The other is
5540: whether or not an additional program will be built as part of the
5541: package. Generally, it is better to make a split package for such
5542: additional programs instead of using options, because it enables
5543: binary packages to be built which can then be added separately. For
5544: example, the foo package might have minimal dependencies (those
5545: packages without which foo doesn't make sense), and then the foo-gfoo
5546: package might include the GTK frontend program gfoo. This is better
5547: than including a gtk option to foo that adds gfoo, because either that
5548: option is default, in which case binary users can't get foo without
5549: gfoo, or not default, in which case they can't get gfoo. With split
5550: packages, they can install foo without having GTK, and later decide to
5551: install gfoo (pulling in GTK at that time). This is an advantage to
5552: source users too, avoiding the need for rebuilds.</p>
5553: <p>Plugins with widely varying dependencies should usually be split
5554: instead of options.</p>
5555: <p>It is often more work to maintain split packages, especially if
5556: the upstream package does not support this. The decision of split
5557: vs. option should be made based on the likelihood that users will want
5558: or object to the various pieces, the size of the dependencies that are
5559: included, and the amount of work.</p>
5560: <p>A further consideration is licensing. Non-free parts, or parts
5561: that depend on non-free dependencies (especially plugins) should
5562: almost always be split if feasible.</p>
1.41 asau 5563: <div class="sect1">
1.1 dsieger 5564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5565: <a name="global-default-options"></a>18.1. Global default options</h2></div></div></div>
1.1 dsieger 5566: <p>Global default options are listed in
5567: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5568: that should be built into every package if that option is supported.
1.10 hubertf 5569: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5570: </div>
1.41 asau 5571: <div class="sect1">
1.1 dsieger 5572: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5573: <a name="converting-to-options"></a>18.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 5574: </h2></div></div></div>
5575: <p>The following example shows how
5576: <code class="filename">bsd.options.mk</code> should be used
5577: by the hypothetical ``wibble'' package, either in the package
5578: <code class="filename">Makefile</code>, or in a file,
5579: e.g. <code class="filename">options.mk</code>, that is included by the
5580: main package <code class="filename">Makefile</code>.</p>
5581: <pre class="programlisting">
5582: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5583: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5584: PKG_OPTIONS_OPTIONAL_GROUPS= database
5585: PKG_OPTIONS_GROUP.database= mysql pgsql
5586: PKG_SUGGESTED_OPTIONS= wibble-foo
5587: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5588: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5589:
5590: .include "../../mk/bsd.prefs.mk"
5591:
5592: # this package was previously named wibble2
5593: .if defined(PKG_OPTIONS.wibble2)
5594: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5595: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5596: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5597: .endif
5598:
5599: .include "../../mk/bsd.options.mk"
5600:
5601: # Package-specific option-handling
5602:
5603: ###
5604: ### FOO support
5605: ###
5606: .if !empty(PKG_OPTIONS:Mwibble-foo)
5607: CONFIGURE_ARGS+= --enable-foo
5608: .endif
5609:
5610: ###
5611: ### LDAP support
5612: ###
5613: .if !empty(PKG_OPTIONS:Mldap)
5614: . include "../../databases/openldap-client/buildlink3.mk"
5615: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5616: .endif
5617:
5618: ###
5619: ### database support
5620: ###
5621: .if !empty(PKG_OPTIONS:Mmysql)
5622: . include "../../mk/mysql.buildlink3.mk"
5623: .endif
5624: .if !empty(PKG_OPTIONS:Mpgsql)
5625: . include "../../mk/pgsql.buildlink3.mk"
5626: .endif
5627: </pre>
5628: <p>The first section contains the information about which build
5629: options are supported by the package, and any default options settings
5630: if needed.</p>
1.23 wiz 5631: <div class="orderedlist"><ol class="orderedlist" type="1">
5632: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.167 leot 5633: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.1 dsieger 5634: options. It should be set to
5635: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5636: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5637: at the point where the options are processed.</p></li>
1.23 wiz 5638: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 5639: build options supported by the package.</p></li>
1.23 wiz 5640: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 5641: list of names of groups of mutually exclusive options. The options in
5642: each group are listed in
5643: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5644: The most specific setting of any option from the group takes
5645: precedence over all other options in the group. Options from the
5646: groups will be automatically added to
5647: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 5648: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 5649: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5650: packages will fail if no option from the group is
5651: selected.</p></li>
1.23 wiz 5652: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 5653: of names of sets of options. At least one option from each set must
5654: be selected. The options in each set are listed in
5655: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5656: Options from the sets will be automatically added to
5657: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5658: fail if no option from the set is selected.</p></li>
1.23 wiz 5659: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 5660: build options which are enabled by default.</p></li>
1.23 wiz 5661: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 5662: of
1.23 wiz 5663: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.10 hubertf 5664: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 5665: their option counterparts. Pairs should be added with
1.23 wiz 5666: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 5667: warning will be issued if the user uses a legacy
5668: variable.</p></li>
1.23 wiz 5669: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 5670: of
1.23 wiz 5671: <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.1 dsieger 5672: pairs that map options that have been renamed to their new
1.23 wiz 5673: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 5674: the listing of global legacy options. A warning will be issued if
5675: the user uses a legacy option.</p></li>
1.23 wiz 5676: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 5677: options implied by deprecated variables used. This can be used for
5678: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5679: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5680: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 5681: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 5682: a list of warnings about deprecated variables or options used, and
5683: what to use instead.</p></li>
5684: </ol></div>
5685: <p>A package should never modify
5686: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5687: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5688: To suggest a default set of options, use
5689: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5690: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5691: including <code class="filename">bsd.options.mk</code>. If none of
5692: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5693: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5694: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5695: happen with platform-specific options if none of them is supported on
5696: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5697: empty list and the package is otherwise treated as not using the
5698: options framework.</p>
5699: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5700: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5701: build options, properly filtered to remove unsupported and duplicate
5702: options.</p>
5703: <p>The remaining sections contain the logic that is specific to
5704: each option. The correct way to check for an option is to check
5705: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5706: <pre class="programlisting">
5707: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
5708: </pre>
5709: </div>
1.41 asau 5710: <div class="sect1">
1.1 dsieger 5711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5712: <a name="option-names"></a>18.3. Option Names</h2></div></div></div>
1.1 dsieger 5713: <p>Options that enable similar features in different packages (like
5714: optional support for a library) should use a common name in all
5715: packages that support it (like the name of the library). If another
5716: package already has an option with the same meaning, use the same
5717: name.</p>
5718: <p>Options that enable features specific to one package, where it's
5719: unlikely that another (unrelated) package has the same (or a similar)
5720: optional feature, should use a name prefixed with
5721: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5722: <p>If a group of related packages share an optional feature
5723: specific to that group, prefix it with the name of the
1.23 wiz 5724: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 5725: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5726: <p>For new options, add a line to
5727: <code class="filename">mk/defaults/options.description</code>. Lines have two
5728: fields, separated by tab. The first field is the option name, the
5729: second its description. The description should be a whole sentence
5730: (starting with an uppercase letter and ending with a period) that
1.23 wiz 5731: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5732: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 5733: </div>
1.41 asau 5734: <div class="sect1">
1.7 rillig 5735: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5736: <a name="option-build"></a>18.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 5737: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.7 rillig 5738: different dependencies based on the options with which the package was
5739: built. For querying these options, the file
5740: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5741: typical example looks like this:</p>
5742: <pre class="programlisting">
5743: pkgbase := libpurple
5744: .include "../../mk/pkg-build-options.mk"
5745:
5746: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5747: ...
5748: .endif
5749: </pre>
5750: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5751: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5752: options of the libpurple package, which can then be queried like
5753: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5754: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5755: details.</p>
5756: </div>
1.1 dsieger 5757: </div>
1.41 asau 5758: <div class="chapter">
1.1 dsieger 5759: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 5760: <a name="build"></a>Chapter 19. The build process</h2></div></div></div>
1.1 dsieger 5761: <div class="toc">
5762: <p><b>Table of Contents</b></p>
1.100 leot 5763: <dl class="toc">
1.154 rillig 5764: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
5765: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
5766: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
5767: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
5768: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
5769: <dd><dl>
5770: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
5771: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
5772: </dl></dd>
5773: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5774: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5775: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5776: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5777: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5778: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5779: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5780: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5781: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5782: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
5783: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
5784: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
1.1 dsieger 5785: </dl>
5786: </div>
1.41 asau 5787: <div class="sect1">
1.1 dsieger 5788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5789: <a name="build.intro"></a>19.1. Introduction</h2></div></div></div>
1.1 dsieger 5790: <p>This chapter gives a detailed description on how a package is
5791: built. Building a package is separated into different
5792: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5793: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 5794: described in the following sections. Each phase is split into
1.1 dsieger 5795: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
5796: containing phase, prefixed by one of <code class="varname">pre-</code>,
5797: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
5798: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
5799: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
5800: <p>Never override the regular targets (like
5801: <code class="varname">fetch</code>), if you have to, override the
5802: <code class="varname">do-*</code> ones instead.</p>
5803: <p>The basic steps for building a program are always the same. First
5804: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
5805: the local system and then extracted. After any pkgsrc-specific patches
5806: to compile properly are applied, the software can be configured, then
5807: built (usually by compiling), and finally the generated binaries, etc.
5808: can be put into place on the system.</p>
5809: <p>To get more details about what is happening at each step,
5810: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
5811: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
5812: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
5813: </div>
1.41 asau 5814: <div class="sect1">
1.1 dsieger 5815: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5816: <a name="build.prefix"></a>19.2. Program location</h2></div></div></div>
1.1 dsieger 5817: <p>Before outlining the process performed by the NetBSD package system in
5818: the next section, here's a brief discussion on where programs are
5819: installed, and which variables influence this.</p>
5820: <p>The automatic variable <code class="varname">PREFIX</code> indicates
5821: where all files of the final program shall be installed. It is
5822: usually set to <code class="varname">LOCALBASE</code>
5823: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
5824: for pkgs in the <code class="filename">cross</code> category. The value of
5825: <code class="varname">PREFIX</code> needs to be put
5826: into the various places in the program's source where paths to
1.154 rillig 5827: these files are encoded. See <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.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.1 dsieger 5828: <p>When choosing which of these variables to use,
5829: follow the following rules:</p>
1.41 asau 5830: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5831: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 5832: where the current pkg will be installed. When referring to a
5833: pkg's own installation path, use
1.23 wiz 5834: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
5835: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 5836: are installed. If you need to construct a -I or -L argument
5837: to the compiler to find includes and libraries installed by
1.23 wiz 5838: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 5839: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
5840: installed all packages in <code class="filename">/usr/local</code>. As
5841: pkgsrc leaves <code class="filename">/usr/local</code> for the system
5842: administrator, this variable is a misnomer.</p></li>
1.23 wiz 5843: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 5844: distribution (from xsrc, etc.) is installed. When looking for
5845: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 5846: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.99 sevan 5847: <li class="listitem"><p>X11-based packages using imake must set
5848: <code class="varname">USE_IMAKE</code> to be installed correctly under
5849: <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5850: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.167 leot 5851: install files according to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.1 dsieger 5852: manual pages go into <code class="filename">${PREFIX}/man</code>, not
5853: <code class="filename">${PREFIX}/share/man</code>.</p></li>
5854: </ul></div>
5855: </div>
1.41 asau 5856: <div class="sect1">
1.1 dsieger 5857: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5858: <a name="build.builddirs"></a>19.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 5859: <p>When building a package, various directories are used to store
1.1 dsieger 5860: source files, temporary files, pkgsrc-internal files, and so on. These
5861: directories are explained here.</p>
5862: <p>Some of the directory variables contain relative pathnames. There
5863: are two common base directories for these relative directories:
5864: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
5865: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
5866: inside the package itself.</p>
1.41 asau 5867: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5868: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
5869: <dd><p>This is an absolute pathname that points to the pkgsrc
5870: root directory. Generally, you don't need
5871: it.</p></dd>
5872: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
5873: <dd><p>This is an absolute pathname that points to the
5874: current package.</p></dd>
5875: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
5876: <dd><p>This is a pathname relative to
5877: <code class="varname">PKGSRCDIR</code> that points to the current
5878: package.</p></dd>
5879: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
5880: <dd><p>This is an absolute pathname pointing to the directory
5881: where all work takes place. The distfiles are extracted to this
5882: directory. It also contains temporary directories and log files used by
5883: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
5884: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
5885: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
5886: <dd><p>This is an absolute pathname pointing to the directory
5887: where the distfiles are extracted. It is usually a direct subdirectory
5888: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
5889: that isn't hidden. This variable may be changed by a package
5890: <code class="filename">Makefile</code>.</p></dd>
5891: </dl></div>
1.14 jmcneill 5892: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
5893: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 5894: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 5895: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
5896: If users would like to have their pkgsrc trees behave in a
5897: read-only manner, then the value of
5898: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
5899: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 5900: </div>
1.41 asau 5901: <div class="sect1">
1.1 dsieger 5902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5903: <a name="build.running"></a>19.4. Running a phase</h2></div></div></div>
1.10 hubertf 5904: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 5905: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
5906: phase. This will automatically run all phases that are required for this
5907: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 5908: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 5909: the package will be built, but not installed.</p>
5910: </div>
1.41 asau 5911: <div class="sect1">
1.1 dsieger 5912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5913: <a name="build.fetch"></a>19.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 5914: <p>The first step in building a package is to fetch the
5915: distribution files (distfiles) from the sites that are providing
5916: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
5917: phase.</p>
1.41 asau 5918: <div class="sect2">
1.1 dsieger 5919: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5920: <a name="build.fetch.what"></a>19.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1 dsieger 5921: <p>In simple cases, <code class="varname">MASTER_SITES</code>
5922: defines all URLs from where the distfile, whose name is
5923: derived from the <code class="varname">DISTNAME</code> variable, is
5924: fetched. The more complicated cases are described
5925: below.</p>
5926: <p>The variable <code class="varname">DISTFILES</code> specifies
5927: the list of distfiles that have to be fetched. Its value
1.66 asau 5928: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
5929: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 5930: so that most packages don't need to define it at all.
5931: <code class="varname">EXTRACT_SUFX</code> is
5932: <code class="literal">.tar.gz</code> by default, but can be changed
5933: freely. Note that if your package requires additional
5934: distfiles to the default one, you cannot just append the
5935: additional filenames using the <code class="literal">+=</code>
5936: operator, but you have write for example:</p>
5937: <pre class="programlisting">
1.66 asau 5938: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 5939: </pre>
5940: <p>Each distfile is fetched from a list of sites, usually
5941: <code class="varname">MASTER_SITES</code>. If the package has multiple
5942: <code class="varname">DISTFILES</code> or multiple
5943: <code class="varname">PATCHFILES</code> from different sites, you can
5944: set
5945: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
5946: to the list of URLs where the file
5947: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
5948: (including the suffix) can be found.</p>
5949: <pre class="programlisting">
5950: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5951: DISTFILES+= foo-file.tar.gz
5952: SITES.foo-file.tar.gz= \
5953: http://www.somewhere.com/somehow/ \
5954: http://www.somewhereelse.com/mirror/somehow/
5955: </pre>
5956: <p>When actually fetching the distfiles, each item from
5957: <code class="varname">MASTER_SITES</code> or
5958: <code class="varname">SITES.*</code> gets the name of each distfile
5959: appended to it, without an intermediate slash. Therefore,
5960: all site values have to end with a slash or other separator
5961: character. This allows for example to set
5962: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
5963: that gets the name of the distfile as a parameter. In this
5964: case, the definition would look like:</p>
5965: <pre class="programlisting">
5966: MASTER_SITES= http://www.example.com/download.cgi?file=
5967: </pre>
1.22 jakllsch 5968: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 5969: In that case the URL is taken as is, fetched and the result
5970: stored under the name of the distfile. You can use this style
5971: for the case when the download URL style does not match the
5972: above common case. For example, if permanent download URL is a
5973: redirector to the real download URL, or the download file name
5974: is offered by an HTTP Content-Disposition header. In the
5975: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
5976: created instead of the default
5977: <code class="filename">v1.0.0.tar.gz</code>.</p>
5978: <pre class="programlisting">
5979: DISTNAME= foo-1.0.0
5980: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
5981: </pre>
1.1 dsieger 5982: <p>There are some predefined values for
5983: <code class="varname">MASTER_SITES</code>, which can be used in
5984: packages. The names of the variables should speak for
5985: themselves.</p>
1.156 leot 5986: <table border="0" summary="Simple list" class="simplelist">
5987: <tr>
5988: <td>MASTER_SITE_APACHE</td>
5989: <td>MASTER_SITE_BACKUP</td>
5990: </tr>
5991: <tr>
5992: <td>MASTER_SITE_CRATESIO</td>
5993: <td>MASTER_SITE_CYGWIN</td>
5994: </tr>
5995: <tr>
5996: <td>MASTER_SITE_DEBIAN</td>
5997: <td>MASTER_SITE_FREEBSD</td>
5998: </tr>
5999: <tr>
6000: <td>MASTER_SITE_FREEBSD_LOCAL</td>
6001: <td>MASTER_SITE_GENTOO</td>
6002: </tr>
6003: <tr>
6004: <td>MASTER_SITE_GITHUB</td>
6005: <td>MASTER_SITE_GNOME</td>
6006: </tr>
6007: <tr>
6008: <td>MASTER_SITE_GNU</td>
6009: <td>MASTER_SITE_GNUSTEP</td>
6010: </tr>
6011: <tr>
6012: <td>MASTER_SITE_HASKELL_HACKAGE</td>
6013: <td>MASTER_SITE_IFARCHIVE</td>
6014: </tr>
6015: <tr>
6016: <td>MASTER_SITE_KDE</td>
6017: <td>MASTER_SITE_MOZILLA</td>
6018: </tr>
6019: <tr>
6020: <td>MASTER_SITE_MOZILLA_ALL</td>
6021: <td>MASTER_SITE_MYSQL</td>
6022: </tr>
6023: <tr>
6024: <td>MASTER_SITE_NETLIB</td>
6025: <td>MASTER_SITE_OPENBSD</td>
6026: </tr>
6027: <tr>
6028: <td>MASTER_SITE_OPENOFFICE</td>
6029: <td>MASTER_SITE_OSDN</td>
6030: </tr>
6031: <tr>
6032: <td>MASTER_SITE_PERL_CPAN</td>
6033: <td>MASTER_SITE_PGSQL</td>
6034: </tr>
6035: <tr>
6036: <td>MASTER_SITE_PYPI</td>
6037: <td>MASTER_SITE_RUBYGEMS</td>
6038: </tr>
6039: <tr>
6040: <td>MASTER_SITE_R_CRAN</td>
6041: <td>MASTER_SITE_SOURCEFORGE</td>
6042: </tr>
6043: <tr>
6044: <td>MASTER_SITE_SUNSITE</td>
6045: <td>MASTER_SITE_SUSE</td>
6046: </tr>
6047: <tr>
6048: <td>MASTER_SITE_TEX_CTAN</td>
6049: <td>MASTER_SITE_XCONTRIB</td>
6050: </tr>
6051: <tr>
6052: <td>MASTER_SITE_XEMACS</td>
6053: <td>MASTER_SITE_XORG</td>
6054: </tr>
6055: </table>
1.1 dsieger 6056: <p>Some explanations for the less self-explaining ones:
6057: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 6058: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.25 spz 6059: 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>
1.1 dsieger 6060: <p>If you choose one of these predefined sites, you may
6061: want to specify a subdirectory of that site. Since these
6062: macros may expand to more than one actual site, you
6063: <span class="emphasis"><em>must</em></span> use the following construct to
6064: specify a subdirectory:</p>
6065: <pre class="programlisting">
6066: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6067: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6068: </pre>
6069: <p>Note the trailing slash after the subdirectory
6070: name.</p>
6071: </div>
1.41 asau 6072: <div class="sect2">
1.1 dsieger 6073: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 6074: <a name="build.fetch.how"></a>19.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6075: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6076: all the distfiles exist in a local directory
6077: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6078: user). If the files do not exist, they are fetched using
6079: commands of the form</p>
6080: <pre class="programlisting">
6081: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6082: </pre>
6083: <p>where <code class="literal">${site}</code> varies through
6084: several possibilities in turn: first,
6085: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6086: sites specified in either <code class="varname">SITES.file</code> if
6087: defined, else <code class="varname">MASTER_SITES</code> or
6088: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6089: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6090: all except the first and the last can be optionally sorted
6091: by the user, via setting either
6092: <code class="varname">MASTER_SORT_RANDOM</code>, and
6093: <code class="varname">MASTER_SORT_AWK</code> or
6094: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 6095: <p> The specific command and arguments used depend on the
6096: <code class="varname">FETCH_USING</code> parameter. The example above is
6097: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 6098: <p>The distfiles mirror run by the NetBSD Foundation uses the
6099: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6100: distfiles, if they are freely distributable. Packages setting
6101: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 6102: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 6103: mirrored.</p>
6104: </div>
6105: </div>
1.41 asau 6106: <div class="sect1">
1.1 dsieger 6107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6108: <a name="build.checksum"></a>19.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6109: <p>After the distfile(s) are fetched, their checksum is
6110: generated and compared with the checksums stored in the
6111: distinfo file. If the checksums don't match, the build is
6112: aborted. This is to ensure the same distfile is used for
6113: building, and that the distfile wasn't changed, e.g. by some
6114: malign force, deliberately changed distfiles on the master
6115: distribution site or network lossage.</p>
6116: </div>
1.41 asau 6117: <div class="sect1">
1.1 dsieger 6118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6119: <a name="build.extract"></a>19.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6120: <p>When the distfiles are present on the local system, they
6121: need to be extracted, as they usually come in the form of some
6122: compressed archive format.</p>
6123: <p>By default, all <code class="varname">DISTFILES</code> are
6124: extracted. If you only need some of them, you can set the
6125: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6126: files.</p>
6127: <p>Extracting the files is usually done by a little
6128: program, <code class="filename">mk/extract/extract</code>, which
6129: already knows how to extract various archive formats, so most
6130: likely you will not need to change anything here. But if you
6131: need, the following variables may help you:</p>
1.41 asau 6132: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6133: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6134: <dd><p>Use these variables to override the default
6135: options for an extract command, which are defined in
6136: <code class="filename">mk/extract/extract</code>.</p></dd>
6137: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6138: <dd><p>This variable can be set to
1.14 jmcneill 6139: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6140: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 6141: absolute pathname pointing to the command with which tar
1.14 jmcneill 6142: archives should be extracted. It is preferred to choose bsdtar over gtar
6143: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 6144: </dl></div>
6145: <p>If the <code class="filename">extract</code> program doesn't
6146: serve your needs, you can also override the
6147: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6148: command used for extracting the files. This command is
6149: executed in the <code class="filename">${WRKSRC}</code>
6150: directory. During execution of this command, the shell
6151: variable <code class="varname">extract_file</code> holds the absolute
6152: pathname of the file that is going to be extracted.</p>
6153: <p>And if that still does not suffice, you can override the
6154: <code class="varname">do-extract</code> target in the package
6155: Makefile.</p>
6156: </div>
1.41 asau 6157: <div class="sect1">
1.1 dsieger 6158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6159: <a name="build.patch"></a>19.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6160: <p>After extraction, all the patches named by the
6161: <code class="varname">PATCHFILES</code>, those present in the patches
6162: subdirectory of the package as well as in
6163: $LOCALPATCHES/$PKGPATH (e.g.
6164: <code class="filename">/usr/local/patches/graphics/png</code>) are
6165: applied. Patchfiles ending in <code class="filename">.Z</code> or
6166: <code class="filename">.gz</code> are uncompressed before they are
6167: applied, files ending in <code class="filename">.orig</code> or
6168: <code class="filename">.rej</code> are ignored. Any special options to
1.167 leot 6169: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.154 rillig 6170: <code class="varname">PATCH_DIST_ARGS</code>. See <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, “<code class="filename">patches/*</code>”</a> for more details.</p>
1.167 leot 6171: <p>By default <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.1 dsieger 6172: it fail if the patches apply with some lines of fuzz. Please
6173: fix (regen) the patches so that they apply cleanly. The
6174: rationale behind this is that patches that don't apply cleanly
6175: may end up being applied in the wrong place, and cause severe
6176: harm there.</p>
6177: </div>
1.41 asau 6178: <div class="sect1">
1.1 dsieger 6179: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6180: <a name="build.tools"></a>19.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6181: <p>This is covered in <a class="xref" href="#tools" title="Chapter 20. Tools needed for building or running">Chapter 20, <i>Tools needed for building or running</i></a>.
1.1 dsieger 6182: </p>
6183: </div>
1.41 asau 6184: <div class="sect1">
1.1 dsieger 6185: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6186: <a name="build.wrapper"></a>19.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6187: <p>This phase creates wrapper programs for the compilers and
6188: linkers. The following variables can be used to tweak the
6189: wrappers.</p>
1.41 asau 6190: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6191: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6192: <dd><p>The command used to print progress
6193: messages. Does nothing by default. Set to
6194: <code class="literal">${ECHO}</code> to see the progress
6195: messages.</p></dd>
6196: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6197: <dd><p>This variable can be set to
6198: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6199: depending on whether you want additional information in the
6200: wrapper log file.</p></dd>
6201: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6202: <dd><p>This variable can be set to
6203: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6204: on whether the wrapper should use its cache, which will
6205: improve the speed. The default value is
6206: <code class="literal">yes</code>, but is forced to
6207: <code class="literal">no</code> if the platform does not support
6208: it.</p></dd>
6209: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6210: <dd><p>A list of reordering commands. A reordering
6211: command has the form
6212: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6213: It ensures that that
6214: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6215: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6216: </p></dd>
6217: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6218: <dd><p>A list of transformation commands. [TODO:
6219: investigate further]</p></dd>
6220: </dl></div>
6221: </div>
1.41 asau 6222: <div class="sect1">
1.1 dsieger 6223: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6224: <a name="build.configure"></a>19.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6225: <p>Most pieces of software need information on the header
6226: files, system calls, and library routines which are available
6227: on the platform they run on. The process of determining this
6228: information is known as configuration, and is usually
6229: automated. In most cases, a script is supplied with the
6230: distfiles, and its invocation results in generation of header
6231: files, Makefiles, etc.</p>
6232: <p>If the package contains a configure script, this can be
6233: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6234: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6235: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6236: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6237: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6238: <pre class="programlisting">
6239: .for d in ${CONFIGURE_DIRS}
6240: cd ${WRKSRC} \
6241: && cd ${d} \
6242: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6243: .endfor
6244: </pre>
6245: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6246: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6247: <code class="varname">WRKSRC</code>. In each of these directories, the
6248: configure script is run with the environment
6249: <code class="varname">CONFIGURE_ENV</code> and arguments
6250: <code class="varname">CONFIGURE_ARGS</code>. The variables
6251: <code class="varname">CONFIGURE_ENV</code>,
6252: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6253: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6254: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6255: package.</p>
1.37 wiz 6256: <p>If the program uses the Perl way of configuration (mainly Perl
6257: modules, but not only), i.e. a file called
6258: <code class="filename">Makefile.PL</code>, it should include
6259: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6260: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6261: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6262: <p>If the program uses an <code class="filename">Imakefile</code>
6263: for configuration, the appropriate steps can be invoked by
6264: setting <code class="varname">USE_IMAKE</code> to
1.99 sevan 6265: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6266: You can add variables to xmkmf's environment by adding them to the
1.1 dsieger 6267: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6268: <p>If the program uses <code class="filename">cmake</code>
6269: for configuration, the appropriate steps can be invoked by
1.23 wiz 6270: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6271: You can add variables to cmake's environment by adding them to the
6272: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6273: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6274: The top directory argument is given by the
6275: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6276: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6277: <p>If there is no configure step at all, set
1.23 wiz 6278: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6279: </div>
1.41 asau 6280: <div class="sect1">
1.1 dsieger 6281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6282: <a name="build.build"></a>19.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6283: <p>For building a package, a rough equivalent of the
6284: following code is executed.</p>
6285: <pre class="programlisting">
6286: .for d in ${BUILD_DIRS}
6287: cd ${WRKSRC} \
6288: && cd ${d} \
6289: && env ${MAKE_ENV} \
6290: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6291: -f ${MAKE_FILE} \
6292: ${BUILD_TARGET}
6293: .endfor
6294: </pre>
6295: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6296: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6297: <code class="varname">WRKSRC</code>. In each of these directories,
6298: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6299: <code class="varname">MAKE_ENV</code> and arguments
6300: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6301: <code class="varname">MAKE_ENV</code>,
6302: <code class="varname">BUILD_MAKE_FLAGS</code>,
6303: <code class="varname">MAKE_FILE</code> and
6304: <code class="varname">BUILD_TARGET</code> may all be changed by the
6305: package.</p>
6306: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6307: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6308: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6309: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6310: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6311: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6312: <p>If there is no build step at all, set
1.23 wiz 6313: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6314: </div>
1.41 asau 6315: <div class="sect1">
1.1 dsieger 6316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6317: <a name="build.test"></a>19.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6318: <p>[TODO]</p>
6319: </div>
1.41 asau 6320: <div class="sect1">
1.1 dsieger 6321: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6322: <a name="build.install"></a>19.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6323: <p>Once the build stage has completed, the final step is to
6324: install the software in public directories, so users can
6325: access the programs and files.</p>
6326: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6327: equivalent of the following code is executed. Additionally,
6328: before and after this code, much magic is performed to do
6329: consistency checks, registering the package, and so on.</p>
6330: <pre class="programlisting">
6331: .for d in ${INSTALL_DIRS}
6332: cd ${WRKSRC} \
6333: && cd ${d} \
6334: && env ${MAKE_ENV} \
6335: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6336: -f ${MAKE_FILE} \
6337: ${INSTALL_TARGET}
6338: .endfor
6339: </pre>
6340: <p>The variable's meanings are analogous to the ones in the
6341: <span class="emphasis"><em>build</em></span> phase.
6342: <code class="varname">INSTALL_DIRS</code> defaults to
6343: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6344: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6345: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6346: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6347: defined.</p>
6348: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6349: variables are useful. They are all variations of the
1.167 leot 6350: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.1 dsieger 6351: permissions preset. <code class="varname">INSTALL</code> is the plain
6352: install command. The specialized variants, together with their
6353: intended use, are:</p>
1.41 asau 6354: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6355: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6356: <dd><p>directories that contain
6357: binaries</p></dd>
6358: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6359: <dd><p>directories that contain
6360: scripts</p></dd>
6361: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6362: <dd><p>directories that contain shared and static
6363: libraries</p></dd>
6364: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6365: <dd><p>directories that contain data
6366: files</p></dd>
6367: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6368: <dd><p>directories that contain man
6369: pages</p></dd>
1.100 leot 6370: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6371: <dd><p>directories that contain data files for games
6372: </p></dd>
1.1 dsieger 6373: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6374: <dd><p>binaries that can be stripped from debugging
6375: symbols</p></dd>
6376: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6377: <dd><p>binaries that cannot be
6378: stripped</p></dd>
6379: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6380: <dd><p>game
6381: binaries</p></dd>
6382: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6383: <dd><p>shared and static
6384: libraries</p></dd>
6385: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6386: <dd><p>data files</p></dd>
6387: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6388: <dd><p>data files for
6389: games</p></dd>
6390: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6391: <dd><p>man pages</p></dd>
6392: </dl></div>
6393: <p>Some other variables are:</p>
1.41 asau 6394: <div class="variablelist"><dl class="variablelist">
1.106 tnn 6395: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.167 leot 6396: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?strip+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.106 tnn 6397: when installing binaries. Any debugging sections and symbols present in
6398: binaries will be preserved.
6399: </p></dd>
1.1 dsieger 6400: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6401: <dd><p>A list of directories relative to
6402: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6403: beginning of the <span class="emphasis"><em>install</em></span> phase.
6404: The package is supposed to create all needed directories itself
6405: before installing files to it and list all other directories here.
6406: </p></dd>
6407: </dl></div>
6408: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6409: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6410: mostly relevant for packages in the <code class="filename">regress</code>
6411: category.</p>
6412: </div>
1.41 asau 6413: <div class="sect1">
1.1 dsieger 6414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6415: <a name="build.package"></a>19.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6416: <p>Once the install stage has completed, a binary package of
6417: the installed files can be built. These binary packages can be
6418: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6419: the <span class="command"><strong>make bin-install</strong></span> or by using
6420: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6421: <p>By default, the binary packages are created in
6422: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6423: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6424: one for each category in the <code class="varname">CATEGORIES</code>
6425: variable. <code class="varname">PACKAGES</code> defaults to
6426: <code class="filename">pkgsrc/packages</code>.</p>
6427: </div>
1.41 asau 6428: <div class="sect1">
1.1 dsieger 6429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6430: <a name="build.clean"></a>19.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6431: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6432: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6433: to clean the work directories of all dependencies too, use
1.10 hubertf 6434: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6435: </div>
1.41 asau 6436: <div class="sect1">
1.1 dsieger 6437: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6438: <a name="build.helpful-targets"></a>19.17. Other helpful targets</h2></div></div></div>
1.41 asau 6439: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6440: <dt><span class="term">pre/post-*</span></dt>
6441: <dd><p>For any of the main targets described in the
6442: previous section, two auxiliary targets exist with
1.23 wiz 6443: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.1 dsieger 6444: prefix for the main target's name. These targets are
6445: invoked before and after the main target is called,
6446: allowing extra configuration or installation steps be
6447: performed from a package's Makefile, for example, which
6448: a program's configure script or install target
6449: omitted.</p></dd>
6450: <dt><span class="term">do-*</span></dt>
6451: <dd><p>Should one of the main targets do the wrong thing,
6452: and should there be no variable to fix this, you can
6453: redefine it with the do-* target. (Note that redefining
6454: the target itself instead of the do-* target is a bad
6455: idea, as the pre-* and post-* targets won't be called
6456: anymore, etc.) You will not usually need to do
6457: this.</p></dd>
6458: <dt><span class="term">reinstall</span></dt>
6459: <dd>
1.10 hubertf 6460: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6461: you noticed some file was not installed properly, you
6462: can repeat the installation with this target, which will
1.23 wiz 6463: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6464: <p>This is the default value of
6465: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6466: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6467: package</strong></span>, where the defaults are
1.23 wiz 6468: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6469: respectively.</p>
6470: </dd>
6471: <dt><span class="term">deinstall</span></dt>
6472: <dd>
1.167 leot 6473: <p>This target does a <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.1 dsieger 6474: current directory, effectively de-installing the
6475: package. The following variables can be used to tune the
6476: behaviour:</p>
1.41 asau 6477: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6478: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.167 leot 6479: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.1 dsieger 6480: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6481: <dd><p>Remove all packages that require (depend on)
6482: the given package. This can be used to remove any
6483: packages that may have been pulled in by a given
1.10 hubertf 6484: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6485: DEINSTALLDEPENDS=1</strong></span> is done in
6486: <code class="filename">pkgsrc/x11/kde</code>, this is
6487: likely to remove whole KDE. Works by adding
1.167 leot 6488: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.1 dsieger 6489: command line.</p></dd>
6490: </dl></div>
6491: </dd>
6492: <dt><span class="term">bin-install</span></dt>
6493: <dd><p>Install a binary package from local disk and via FTP
6494: from a list of sites (see the
6495: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6496: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6497: available anywhere. The arguments given to
1.10 hubertf 6498: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6499: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6500: operation, etc.</p></dd>
1.95 wiz 6501: <dt><span class="term">install-clean</span></dt>
6502: <dd><p>This target removes the state files for the "install" and later
6503: phases so that the "install" target may be re-invoked. This can be
6504: used after editing the PLIST to install the package without
6505: rebuilding it.</p></dd>
6506: <dt><span class="term">build-clean</span></dt>
6507: <dd><p>This target removes the state files for the "build" and later
6508: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 6509: <dt><span class="term">update</span></dt>
6510: <dd>
6511: <p>This target causes the current package to be
6512: updated to the latest version. The package and all
6513: depending packages first get de-installed, then current
6514: versions of the corresponding packages get compiled and
6515: installed. This is similar to manually noting which
6516: packages are currently installed, then performing a
1.10 hubertf 6517: series of <span class="command"><strong>make deinstall</strong></span> and
6518: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6519: <code class="varname">UPDATE_TARGET</code> is set to) for these
6520: packages.</p>
1.23 wiz 6521: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6522: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6523: update</strong></span> was interrupted for some reason.
6524: However, in this case, make sure you don't call
1.10 hubertf 6525: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6526: list of dependent packages in <code class="varname">WRKDIR</code>.
6527: Otherwise, you lose the ability to automatically update
6528: the current package along with the dependent packages
6529: you have installed.</p>
1.10 hubertf 6530: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6531: update</strong></span> will only work as long as the package
6532: tree remains unchanged. If the source code for one of
6533: the packages to be updated has been changed, resuming
1.10 hubertf 6534: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 6535: fail!</p>
6536: <p>The following variables can be used either on the
1.10 hubertf 6537: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6538: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 6539: update</strong></span>:</p>
1.41 asau 6540: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6541: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
6542: <dd><p>Install target to recursively use for the
6543: updated package and the dependent packages.
6544: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 6545: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 6546: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 6547: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6548: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6549: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 6550: endless loop!</p></dd>
6551: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
6552: <dd><p>Don't clean up after updating. Useful if
6553: you want to leave the work sources of the updated
6554: packages around for inspection or other purposes.
6555: Be sure you eventually clean up the source tree
1.23 wiz 6556: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 6557: or you may run into troubles with old source code
6558: still lying around on your next
1.10 hubertf 6559: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 6560: update</strong></span>.</p></dd>
6561: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
6562: <dd><p>Deinstall each package before installing
6563: (making <code class="varname">DEPENDS_TARGET</code>). This
6564: may be necessary if the
1.23 wiz 6565: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 6566: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 6567: update</strong></span>.</p></dd>
6568: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
6569: <dd><p>Allows you to disable recursion and hardcode
6570: the target for packages. The default is
1.23 wiz 6571: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 6572: facilitating a recursive update of prerequisite
6573: packages. Only set
6574: <code class="varname">DEPENDS_TARGET</code> if you want to
6575: disable recursive updates. Use
6576: <code class="varname">UPDATE_TARGET</code> instead to just
6577: set a specific target for each package to be
1.10 hubertf 6578: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 6579: (see above).</p></dd>
6580: </dl></div>
6581: </dd>
6582: <dt><span class="term">clean-update</span></dt>
6583: <dd>
6584: <p>Clean the source tree for all packages that would
1.10 hubertf 6585: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 6586: from the current directory. This target should not be
6587: used if the current package (or any of its depending
6588: packages) have already been de-installed (e.g., after
1.10 hubertf 6589: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 6590: some packages you intended to update. As a rule of
6591: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 6592: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 6593: and only if you have a dirty package tree (e.g., if you
6594: used <code class="varname">NOCLEAN</code>).</p>
6595: <p>If you are unsure about whether your tree is
1.10 hubertf 6596: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 6597: clean</strong></span> at the top of the tree, or use the
6598: following sequence of commands from the directory of the
6599: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 6600: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 6601: time, otherwise you lose all the packages you wanted to
6602: update!):</p>
6603: <pre class="screen">
6604: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
6605: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
6606: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6607: </pre>
6608: <p>The following variables can be used either on the
1.10 hubertf 6609: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6610: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 6611: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6612: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 6613: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 6614: reconstruct the list of directories to update for
1.10 hubertf 6615: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 6616: update</strong></span> successfully installed all
6617: packages you wanted to update. Normally, this is
1.10 hubertf 6618: done automatically on <span class="command"><strong>make
1.1 dsieger 6619: update</strong></span>, but may have been suppressed by
6620: the <code class="varname">NOCLEAN</code> variable (see
6621: above).</p></dd>
6622: </dl></div>
6623: </dd>
6624: <dt><span class="term">replace</span></dt>
6625: <dd>
6626: <p>Update the installation of the current package. This
6627: differs from update in that it does not replace dependent
1.137 leot 6628: packages. You will need to install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.1 dsieger 6629: target to work.</p>
6630: <p><span class="emphasis"><em>Be careful when using this
6631: target!</em></span> There are no guarantees that dependent
6632: packages will still work, in particular they will most
1.10 hubertf 6633: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 6634: library package whose shared library major version changed
6635: between your installed version and the new one. For this
6636: reason, this target is not officially supported and only
6637: recommended for advanced users.</p>
6638: </dd>
6639: <dt><span class="term">info</span></dt>
1.167 leot 6640: <dd><p>This target invokes <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.1 dsieger 6641: package. You can use this to check which version of a
6642: package is installed.</p></dd>
6643: <dt><span class="term">index</span></dt>
6644: <dd>
6645: <p>This is a top-level command, i.e. it should be used in
6646: the <code class="filename">pkgsrc</code> directory. It creates a
6647: database of all packages in the local pkgsrc tree, including
6648: dependencies, comment, maintainer, and some other useful
6649: information. Individual entries are created by running
1.10 hubertf 6650: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 6651: directories. This index file is saved as
6652: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 6653: verbose format by running <span class="command"><strong>make
1.1 dsieger 6654: print-index</strong></span>. You can search in it with
1.10 hubertf 6655: <span class="command"><strong>make search
1.1 dsieger 6656: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6657: extract a list of all packages that depend on a particular
1.10 hubertf 6658: one by running <span class="command"><strong>make show-deps
1.1 dsieger 6659: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6660: <p>Running this command takes a very long time, some
6661: hours even on fast machines!</p>
6662: </dd>
6663: <dt><span class="term">readme</span></dt>
6664: <dd>
6665: <p>This target generates a
6666: <code class="filename">README.html</code> file, which can be
1.137 leot 6667: viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>. The generated files
1.1 dsieger 6668: contain references to any packages which are in the
6669: <code class="varname">PACKAGES</code> directory on the local
6670: host. The generated files can be made to refer to URLs
6671: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6672: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6673: wanted to generate <code class="filename">README.html</code>
6674: files which pointed to binary packages on the local
6675: machine, in the directory
6676: <code class="filename">/usr/packages</code>, set
6677: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6678: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6679: <code class="varname">${PACKAGES}</code> directory and its
6680: subdirectories will be searched for all the binary
6681: packages.</p>
6682: <p>The target can be run at the toplevel or in category
6683: directories, in which case it descends recursively.</p>
6684: </dd>
6685: <dt><span class="term">readme-all</span></dt>
6686: <dd><p>This is a top-level command, run it in
6687: <code class="filename">pkgsrc</code>. Use this target to create a
6688: file <code class="filename">README-all.html</code> which contains a
6689: list of all packages currently available in the NetBSD
6690: Packages Collection, together with the category they belong
6691: to and a short description. This file is compiled from the
6692: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 6693: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 6694: readme</strong></span>.</p></dd>
6695: <dt><span class="term">cdrom-readme</span></dt>
6696: <dd><p>This is very much the same as the
1.23 wiz 6697: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 6698: used when generating a pkgsrc tree to be written to a
6699: CD-ROM. This target also produces
6700: <code class="filename">README.html</code> files, and can be made
6701: to refer to URLs based on
6702: <code class="varname">CDROM_PKG_URL_HOST</code> and
6703: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
6704: <dt><span class="term">show-distfiles</span></dt>
6705: <dd><p>This target shows which distfiles and patchfiles
6706: are needed to build the package
6707: (<code class="varname">ALLFILES</code>, which contains all
6708: <code class="varname">DISTFILES</code> and
6709: <code class="varname">PATCHFILES</code>, but not
6710: <code class="filename">patches/*</code>).</p></dd>
6711: <dt><span class="term">show-downlevel</span></dt>
6712: <dd><p>This target shows nothing if the package is not
6713: installed. If a version of this package is installed,
6714: but is not the version provided in this version of
6715: pkgsrc, then a warning message is displayed. This target
6716: can be used to show which of your installed packages are
6717: downlevel, and so the old versions can be deleted, and
6718: the current ones added.</p></dd>
6719: <dt><span class="term">show-pkgsrc-dir</span></dt>
6720: <dd><p>This target shows the directory in the pkgsrc
6721: hierarchy from which the package can be built and
6722: installed. This may not be the same directory as the one
6723: from which the package was installed. This target is
6724: intended to be used by people who may wish to upgrade
6725: many packages on a single host, and can be invoked from
6726: the top-level pkgsrc Makefile by using the
1.23 wiz 6727: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 6728: <dt><span class="term">show-installed-depends</span></dt>
6729: <dd><p>This target shows which installed packages match
6730: the current package's <code class="varname">DEPENDS</code>. Useful
6731: if out of date dependencies are causing build
6732: problems.</p></dd>
1.95 wiz 6733: <dt><span class="term">print-build-depends-list</span></dt>
6734: <dd><p>This target shows the list of packages that the current package
6735: depends on for building.</p></dd>
6736: <dt><span class="term">print-run-depends-list</span></dt>
6737: <dd><p>This target shows the list of packages that the current package
6738: depends on for running.</p></dd>
1.1 dsieger 6739: <dt><span class="term">check-shlibs</span></dt>
6740: <dd><p>After a package is installed, check all its
6741: binaries and (on ELF platforms) shared libraries to see
6742: if they find the shared libs they need. Run by default
1.10 hubertf 6743: 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>
1.1 dsieger 6744: <dt><span class="term">print-PLIST</span></dt>
6745: <dd>
1.23 wiz 6746: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 6747: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 6748: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 6749: -newer work/.extract_done</strong></span>. An attempt is made
6750: to care for shared libs etc., but it is
6751: <span class="emphasis"><em>strongly</em></span> recommended to review the
6752: result before putting it into
6753: <code class="filename">PLIST</code>. On upgrades, it's useful to
6754: diff the output of this command against an already
6755: existing <code class="filename">PLIST</code> file.</p>
1.167 leot 6756: <p>If the package installs files via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.1 dsieger 6757: other methods that don't update file access times, be
6758: sure to add these files manually to your
1.23 wiz 6759: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6760: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 6761: them!</p>
1.154 rillig 6762: <p>See <a class="xref" href="#print-PLIST" title="15.3. Tweaking output of make print-PLIST">Section 15.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
1.1 dsieger 6763: information on this target.</p>
6764: </dd>
6765: <dt><span class="term">bulk-package</span></dt>
6766: <dd>
6767: <p>Used to do bulk builds. If an appropriate binary
6768: package already exists, no action is taken. If not, this
6769: target will compile, install and package it (and its
6770: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.154 rillig 6771: properly. 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 6772: builds)</i></a>).
1.1 dsieger 6773: After creating the binary package, the sources, the
6774: just-installed package and its required packages are
6775: removed, preserving free disk space.</p>
6776: <p><span class="emphasis"><em>Beware that this target may deinstall
6777: all packages installed on a system!</em></span></p>
6778: </dd>
6779: <dt><span class="term">bulk-install</span></dt>
6780: <dd>
6781: <p>Used during bulk-installs to install required
6782: packages. If an up-to-date binary package is available,
1.167 leot 6783: it will be installed via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.10 hubertf 6784: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 6785: but the installed binary won't be removed.</p>
6786: <p>A binary package is considered
1.23 wiz 6787: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.167 leot 6788: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.41 asau 6789: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6790: <li class="listitem"><p>None of the package's files
1.1 dsieger 6791: (<code class="filename">Makefile</code>, ...) were modified
6792: since it was built.</p></li>
1.23 wiz 6793: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 6794: packages were modified since it was built.</p></li>
6795: </ul></div>
6796: <p><span class="emphasis"><em>Beware that this target may deinstall
6797: all packages installed on a system!</em></span></p>
6798: </dd>
6799: </dl></div>
6800: </div>
6801: </div>
1.41 asau 6802: <div class="chapter">
1.1 dsieger 6803: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 6804: <a name="tools"></a>Chapter 20. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6805: <div class="toc">
6806: <p><b>Table of Contents</b></p>
1.100 leot 6807: <dl class="toc">
1.154 rillig 6808: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
6809: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
6810: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6811: </dl>
6812: </div>
6813: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6814: by pkgsrc and also for individual packages to define what commands
1.156 leot 6815: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
1.1 dsieger 6816: or for later run-time of an installed packaged (such as
6817: <code class="varname">DEPENDS</code>).
6818: If the native system provides an adequate tool, then in many cases, a pkgsrc
6819: package will not be used.</p>
6820: <p>When building a package, the replacement tools are
6821: made available in a directory (as symlinks or wrapper scripts)
6822: that is early in the executable search path. Just like the buildlink
6823: system, this helps with consistent builds.</p>
6824: <p>A tool may be needed to help build a specific package. For example,
6825: perl, GNU make (gmake) or yacc may be needed.</p>
6826: <p>Also a tool may be needed, for example, because the native system's supplied
6827: tool may be inefficient for building a package with pkgsrc.
6828: For example, a package may need GNU awk, bison (instead of
6829: yacc) or a better sed.</p>
6830: <p>The tools used by a package can be listed by running
1.10 hubertf 6831: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6832: <div class="sect1">
1.1 dsieger 6833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6834: <a name="pkgsrc-tools"></a>20.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 6835: <p>The default set of tools used by pkgsrc is defined in
6836: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 6837: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6838: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 6839: These can be seen by running:
1.10 hubertf 6840: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 6841: <p>If a package needs a specific program to build
6842: then the <code class="varname">USE_TOOLS</code> variable can be used
6843: to define the tools needed.</p>
6844: </div>
1.41 asau 6845: <div class="sect1">
1.1 dsieger 6846: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6847: <a name="package-tools"></a>20.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 6848: <p>In the following examples, the :run means that it is needed at
6849: run-time (and becomes a DEPENDS).
1.1 dsieger 6850: The default is a build dependency which can be set with
6851: :build. (So in this example, it is the same as gmake:build
6852: and pkg-config:build.)</p>
6853: <pre class="programlisting">
6854: USE_TOOLS+= gmake perl:run pkg-config
6855: </pre>
6856: <p>When using the tools framework, a
6857: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6858: which contains the full path to the appropriate tool. For example,
1.23 wiz 6859: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 6860: on Linux systems.</p>
6861: <p>If you always need a pkgsrc version of the
6862: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6863: </p>
6864: </div>
1.41 asau 6865: <div class="sect1">
1.1 dsieger 6866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6867: <a name="platform-tools"></a>20.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 6868: <p>When improving or porting pkgsrc to a new platform, have a look
6869: at (or create) the corresponding platform specific make file fragment under
6870: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6871: the name of the common tools. For example:</p>
6872: <pre class="programlisting">
6873: .if exists(/usr/bin/bzcat)
6874: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6875: .elif exists(/usr/bin/bzip2)
6876: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6877: .endif
6878:
6879: TOOLS_PLATFORM.true?= true # shell builtin
6880: </pre>
6881: </div>
6882: </div>
1.41 asau 6883: <div class="chapter">
1.1 dsieger 6884: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 6885: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 6886: <div class="toc">
6887: <p><b>Table of Contents</b></p>
1.100 leot 6888: <dl class="toc">
1.154 rillig 6889: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 6890: <dd><dl>
1.154 rillig 6891: <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>
6892: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
6893: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
6894: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
6895: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
6896: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
6897: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
6898: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
6899: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
6900: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
6901: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
6902: </dl></dd>
6903: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6904: <dd><dl>
6905: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
6906: <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>
6907: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
6908: </dl></dd>
6909: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6910: <dd><dl>
6911: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
6912: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
6913: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
6914: </dl></dd>
6915: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
6916: <dd><dl>
6917: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
6918: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
6919: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
6920: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
6921: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
6922: </dl></dd>
6923: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6924: <dd><dl>
6925: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
6926: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 6927: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
6928: <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>
6929: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 6930: </dl></dd>
6931: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6932: <dd><dl>
6933: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
6934: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
6935: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
6936: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
6937: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
6938: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
6939: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
6940: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
6941: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
6942: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
6943: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
6944: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
6945: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
6946: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
6947: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
6948: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
6949: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
6950: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 6951: emulation</a></span></dt>
1.154 rillig 6952: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
6953: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 6954: </dl></dd>
1.154 rillig 6955: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 6956: </dl>
6957: </div>
1.41 asau 6958: <div class="sect1">
1.1 dsieger 6959: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6960: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 6961: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 6962: different platforms. As a result, it is important to ensure,
6963: where possible, that packages in pkgsrc are portable. This
6964: chapter mentions some particular details you should pay
6965: attention to while working on pkgsrc.</p>
1.41 asau 6966: <div class="sect2">
1.1 dsieger 6967: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 6968: <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 6969: </h3></div></div></div>
6970: <p>The pkgsrc user can configure pkgsrc by overriding several
6971: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 6972: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 6973: want to use those variables in the preprocessor directives of
1.167 leot 6974: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1 dsieger 6975: <code class="literal">.for</code>), you need to include the file
6976: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
6977: loads the user preferences.</p>
6978: <p>But note that some variables may not be completely defined
6979: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
6980: included, as they may contain references to variables that are
1.108 rillig 6981: not yet defined. In shell commands (the lines in
6982: <code class="filename">Makefile</code> that are indented with a tab) this
6983: is no problem, since variables are only expanded when they are
6984: used. But in the preprocessor directives mentioned above and in
6985: dependency lines (of the form <code class="literal">target:
1.1 dsieger 6986: dependencies</code>) the variables are expanded at load
6987: time.</p>
1.41 asau 6988: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 6989: <h3 class="title">Note</h3>
1.108 rillig 6990: <p>To check whether a variable can be used at load time,
6991: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 6992: </div>
6993: </div>
1.41 asau 6994: <div class="sect2">
1.1 dsieger 6995: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 6996: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 6997: <p>Occasionally, packages require interaction from the user,
6998: and this can be in a number of ways:</p>
1.41 asau 6999: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7000: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7001: interaction such as entering username/password or accepting a
7002: license on a web page.</p></li>
1.23 wiz 7003: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7004: passwords.</p></li>
1.23 wiz 7005: <li class="listitem"><p>help to configure the package before it is built</p></li>
7006: <li class="listitem"><p>help during the build process</p></li>
7007: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7008: </ul></div>
1.108 rillig 7009: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7010: variable to define which stages need interaction. This should be
7011: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 7012: <pre class="programlisting">
7013: INTERACTIVE_STAGE= configure install
1.111 sevan 7014: </pre>
1.1 dsieger 7015: <p>The user can then decide to skip this package by setting the
1.108 rillig 7016: <code class="varname">BATCH</code> variable. Packages that require interaction
7017: are also excluded from bulk builds.</p>
1.1 dsieger 7018: </div>
1.41 asau 7019: <div class="sect2">
1.1 dsieger 7020: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7021: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 7022: <p>Authors of software can choose the licence under which software
7023: can be copied. The Free Software Foundation has declared some
7024: licenses "Free", and the Open Source Initiative has a definition of
7025: "Open Source".</p>
7026: <p>By default, pkgsrc allows packages with Free or Open Source
7027: licenses to be built. To allow packages with other licenses to be
7028: built as well, the pkgsrc user needs to add these licenses to the
7029: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7030: that this variable only affects which packages may be
7031: <span class="emphasis"><em>built</em></span>, while the license terms often also
7032: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 7033: <p>One might want to only install packages with a BSD license,
1.108 rillig 7034: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 7035: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 7036: user can override the default by setting the
7037: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 7038: of "+=". The licenses accepted by default are defined in the
7039: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7040: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7041: <p>The license tag mechanism is intended to address
7042: copyright-related issues surrounding building, installing and
7043: using a package, and not to address redistribution issues (see
7044: <code class="varname">RESTRICTED</code> and
1.111 sevan 7045: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7046: Packages with redistribution restrictions should set these
7047: tags.</p>
1.1 dsieger 7048: <p>Denoting that a package may be copied according to a
7049: particular license is done by placing the license in
7050: <code class="filename">pkgsrc/licenses</code> and setting the
7051: <code class="varname">LICENSE</code> variable to a string identifying the
1.137 leot 7052: license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.1 dsieger 7053: <pre class="programlisting">
7054: LICENSE= xv-license
1.111 sevan 7055: </pre>
1.1 dsieger 7056: <p>When trying to build, the user will get a notice that the
7057: package is covered by a license which has not been placed in the
7058: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7059: <pre class="programlisting">
7060: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7061: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7062: ===> To view the license, enter "/usr/bin/make show-license".
7063: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7064: ===> ACCEPTABLE_LICENSES+=xv-license
7065: *** Error code 1
1.111 sevan 7066: </pre>
1.10 hubertf 7067: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7068: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7069: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7070: convey to pkgsrc that it should not in the future fail because of
7071: that license:</p>
7072: <pre class="programlisting">
7073: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7074: </pre>
7075: <p>The use of <code class="varname">LICENSE=shareware</code>,
7076: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7077: is deprecated because it does not crisply refer to a particular
7078: license text. Another problem with such usage is that it does not
7079: enable a user to tell pkgsrc to proceed for a single package
7080: without also telling pkgsrc to proceed for all packages with that
7081: tag.</p>
7082: <div class="sect3">
7083: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7084: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7085: <p>When adding a package with a new license, the following steps
7086: are required:</p>
7087: <div class="orderedlist"><ol class="orderedlist" type="1">
7088: <li class="listitem">
1.169 rillig 7089: <p>Check whether the license qualifies as Free or Open Source by
7090: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7091: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111 sevan 7092: Open Source Initiative</a>. If this is the case, the filename in
7093: <code class="filename">pkgsrc/licenses/</code> does not need the
7094: <code class="filename">-license</code> suffix, and the license name should be
7095: added to:</p>
1.48 rodent 7096: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7097: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7098: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7099: <li class="listitem"><p>default_acceptable_licenses in
7100: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48 rodent 7101: </ul></div>
7102: </li>
1.169 rillig 7103: <li class="listitem"><p>The license text should be added to
7104: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7105: licenses can be seen in this directory.</p></li>
1.48 rodent 7106: </ol></div>
1.111 sevan 7107: </div>
7108: <div class="sect3">
7109: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7110: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7111: <p>When the license changes (in a way other than formatting),
1.111 sevan 7112: make sure that the new license has a different name (e.g.,
1.1 dsieger 7113: append the version number if it exists, or the date). Just
7114: because a user told pkgsrc to build programs under a previous
7115: version of a license does not mean that pkgsrc should build
7116: programs under the new licenses. The higher-level point is that
7117: pkgsrc does not evaluate licenses for reasonableness; the only
7118: test is a mechanistic test of whether a particular text has been
1.111 sevan 7119: approved by either of two bodies (FSF or OSI).</p>
7120: </div>
1.1 dsieger 7121: </div>
1.41 asau 7122: <div class="sect2">
1.1 dsieger 7123: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7124: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7125: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7126: By declaring the restrictions, package tools can
1.1 dsieger 7127: automatically refrain from e.g. placing binary packages on FTP
7128: sites.</p>
1.111 sevan 7129: <p>There are four possible restrictions, which are
1.1 dsieger 7130: the cross product of sources (distfiles) and binaries not being
7131: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7132: language in any license, and because non-Free licenses tend to be
7133: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7134: CD-ROM.
7135:
7136: "FTP" means making the source or binary file available over the
7137: Internet at no charge.
7138:
7139: "CD-ROM" means making the source or binary available on some kind of
7140: media, together with other source and binary packages, which is sold
7141: for a distribution charge.
1.1 dsieger 7142: </p>
7143: <p>In order to encode these restrictions, the package system
7144: defines five make variables that can be set to note these
7145: restrictions:</p>
1.41 asau 7146: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7147: <li class="listitem">
1.1 dsieger 7148: <p><code class="varname">RESTRICTED</code></p>
7149: <p>This variable should be set whenever a restriction
7150: exists (regardless of its kind). Set this variable to a
7151: string containing the reason for the restriction. It should
7152: be understood that those wanting to understand the restriction
7153: will have to read the license, and perhaps seek advice of
7154: counsel.</p>
7155: </li>
1.23 wiz 7156: <li class="listitem">
1.1 dsieger 7157: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7158: <p>Binaries may not be placed on CD-ROM containing other
7159: binary packages, for which a distribution charge may be made.
7160: In this case, set this variable to
7161: <code class="varname">${RESTRICTED}</code>.</p>
7162: </li>
1.23 wiz 7163: <li class="listitem">
1.1 dsieger 7164: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7165: <p>Binaries may not made available on the Internet without
7166: charge. In this case, set this variable to
7167: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7168: binary packages will not be included on ftp.NetBSD.org.</p>
7169: </li>
1.23 wiz 7170: <li class="listitem">
1.1 dsieger 7171: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7172: <p>Distfiles may not be placed on CD-ROM, together with
7173: other distfiles, for which a fee may be charged. In this
7174: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7175: </p>
7176: </li>
1.23 wiz 7177: <li class="listitem">
1.1 dsieger 7178: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7179: <p>Distfiles may not made available via FTP at no charge.
7180: In this case, set this variable to
7181: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7182: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7183: </li>
7184: </ul></div>
1.111 sevan 7185: <p>Please note that packages will be removed from pkgsrc when the
7186: distfiles are not distributable and cannot be obtained for a period
7187: of one full quarter branch. Packages with manual/interactive fetch
7188: must have a maintainer and it is his/her responsibility to ensure
7189: this.</p>
1.1 dsieger 7190: </div>
1.41 asau 7191: <div class="sect2">
1.1 dsieger 7192: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7193: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.1 dsieger 7194: <p>Your package may depend on some other package being present
7195: - and there are various ways of expressing this dependency.
7196: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
1.156 leot 7197: <code class="varname">DEPENDS</code> and
7198: <code class="varname">TOOL_DEPENDS</code> definitions, the
1.1 dsieger 7199: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7200: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7201: to handle dependencies, and which uses the variables named above.
1.154 rillig 7202: See <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a> for more information.</p>
1.1 dsieger 7203: <p>The basic difference between the two variables is as
7204: follows: The <code class="varname">DEPENDS</code> definition registers
7205: that pre-requisite in the binary package so it will be pulled in
7206: when the binary package is later installed, whilst the
1.156 leot 7207: <code class="varname">BUILD_DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
7208: definitions does not, marking a dependency that is only needed for
7209: building the package.</p>
1.1 dsieger 7210: <p>This means that if you only need a package present whilst
7211: you are building, it should be noted as a
1.156 leot 7212: <code class="varname">TOOL_DEPENDS</code> or
7213: <code class="varname">BUILD_DEPENDS</code>. When cross-compiling,
7214: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7215: packages, i.e. packages for the architecture where the package
7216: is built;
7217: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
7218: packages, i.e. packages for the architecture for which the package
7219: is built.</p>
7220: <p>The format for <code class="varname">BUILD_DEPENDS</code>,
7221: <code class="varname">DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
7222: definition is:</p>
1.1 dsieger 7223: <pre class="programlisting">
7224: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7225: </pre>
1.23 wiz 7226: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7227: may include any of the wildcard version numbers recognized by
1.167 leot 7228: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23 wiz 7229: <div class="orderedlist"><ol class="orderedlist" type="1">
7230: <li class="listitem">
1.1 dsieger 7231: <p>If your package needs another package's binaries or
1.54 wiz 7232: libraries to build and run, and if that package has a
1.1 dsieger 7233: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7234: <pre class="programlisting">
7235: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7236: </pre>
1.1 dsieger 7237: </li>
1.23 wiz 7238: <li class="listitem">
1.54 wiz 7239: <p>If your package needs another package's binaries or
7240: libraries only for building, and if that package has a
7241: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7242: <pre class="programlisting">
7243: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7244: </pre>
1.54 wiz 7245: <p>but set
7246: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7247: to make it a build dependency only. This case is rather
7248: rare.</p>
7249: </li>
7250: <li class="listitem">
1.25 spz 7251: <p>If your package needs binaries from another package to build,
1.156 leot 7252: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7253: <pre class="programlisting">
1.156 leot 7254: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7255: </pre>
1.1 dsieger 7256: </li>
1.156 leot 7257: <li class="listitem"><p>If your package needs static libraries to link against, header
7258: files to include, etc. from another package to build,
7259: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7260: <li class="listitem"><p>If your package needs a library with which to link and
7261: there is no <code class="filename">buildlink3.mk</code> file
7262: available, create one. Using
7263: <code class="varname">DEPENDS</code> won't be sufficient because the
7264: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7265: <li class="listitem">
1.25 spz 7266: <p>If your package needs some executable to be able to run
7267: correctly and if there's no
7268: <code class="filename">buildlink3.mk</code> file, this is specified
7269: using the <code class="varname">DEPENDS</code> variable. The
1.137 leot 7270: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.129 wiz 7271: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7272: when it runs, and that is specified:</p>
1.1 dsieger 7273: <pre class="programlisting">
1.129 wiz 7274: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7275: </pre>
1.25 spz 7276: </li>
7277: <li class="listitem">
7278: <p>You can use wildcards in package dependencies. Note that
7279: such wildcard dependencies are retained when creating binary
7280: packages. The dependency is checked when installing the binary
7281: package and any package which matches the pattern will be
7282: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7283: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7284: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7285: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7286: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7287: <p>Wildcards can also be used to specify that a package
7288: will only build against a certain minimum version of a
7289: pre-requisite:</p>
7290: <pre class="programlisting">
1.25 spz 7291: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7292: </pre>
1.25 spz 7293: <p>This means that the package will build using version 6.0
7294: of ImageMagick or newer. Such a dependency may be warranted
7295: if, for example, the command line options of an executable
7296: have changed.</p>
7297: <p>If you need to depend on minimum versions of libraries,
7298: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7299: <p>For security fixes, please update the package
1.154 rillig 7300: 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 7301: information.</p>
7302: </li>
7303: </ol></div>
7304: <p>If your package needs files from another package to build,
7305: add the relevant distribution files to
7306: <code class="varname">DISTFILES</code>, so they will be extracted
1.137 leot 7307: automatically. See the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.1 dsieger 7308: (It relies on the jpeg sources being present in source form
7309: during the build.)</p>
7310: </div>
1.41 asau 7311: <div class="sect2">
1.1 dsieger 7312: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7313: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7314: <p>Your package may conflict with other packages a user might
7315: already have installed on his system, e.g. if your package
7316: installs the same set of files as another package in the pkgsrc
1.80 wiz 7317: tree or has the same <code class="varname">PKGNAME</code>.</p>
1.142 leot 7318: <p>For example, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/libXaw3d/README.html" target="_top"><code class="filename">x11/libXaw3d</code></a>
7319: and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
7320: install the same shared library, thus you set in
7321: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7322: <pre class="programlisting">
7323: CONFLICTS= Xaw-Xpm-[0-9]*
7324: </pre>
7325: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7326: <pre class="programlisting">
7327: CONFLICTS= libXaw3d-[0-9]*
7328: </pre>
1.167 leot 7329: <p><a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.142 leot 7330: that conflict with existing packages and abort. However, in many
7331: situations this is too late in the process. Binary package managers
7332: will not know about the conflict until they attempt to install the
7333: package after already downloading it and all its dependencies.
7334: Users may also waste time building a package and its dependencies
7335: only to find out at the end that it conflicts with another package
7336: they have installed.</p>
7337: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7338: should be added in all cases where it is known that packages conflict
7339: with each other. These <code class="varname">CONFLICTS</code> entries are
1.167 leot 7340: exported in <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.142 leot 7341: managers to inform users that packages cannot be installed onto
7342: the target system.</p>
1.1 dsieger 7343: </div>
1.41 asau 7344: <div class="sect2">
1.1 dsieger 7345: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7346: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7347: <p>There are several reasons why a package might be
7348: instructed to not build under certain circumstances. If the
7349: package builds and runs on most platforms, the exceptions
1.83 dholland 7350: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7351: the package builds and runs on a small handful of platforms,
7352: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7353: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7354: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7355: (OS-version-platform) that can use glob-style
7356: wildcards.</p>
7357: <p>If a package is not appropriate for some platforms (as
1.114 maya 7358: opposed to merely broken), a different set of variables should be
1.83 dholland 7359: used as this affects failure reporting and statistics.
7360: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7361: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7362: the package is appropriate for only a small handful of platforms
7363: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7364: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7365: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7366: (OS-version-platform) that can use glob-style
7367: wildcards.</p>
7368: <p>Some packages are tightly bound to a specific version of an
1.137 leot 7369: operating system, e.g. LKMs or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
1.1 dsieger 7370: backwards compatible with other versions of the OS, and should be
7371: uploaded to a version specific directory on the FTP server. Mark
7372: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7373: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7374: the package system internals, but may be used in the
7375: future.</p>
7376: <p>If the package should be skipped (for example, because it
7377: provides functionality already provided by the system), set
7378: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7379: the package should fail because some preconditions are not met,
7380: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7381: message.</p>
7382: </div>
1.41 asau 7383: <div class="sect2">
1.1 dsieger 7384: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7385: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7386: <p>To ensure that a package may not be deleted, once it has been
7387: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7388: be set in the package Makefile. This will be carried into any
7389: binary package that is made from this pkgsrc entry. A
1.23 wiz 7390: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.167 leot 7391: not be deleted using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23 wiz 7392: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7393: </div>
1.41 asau 7394: <div class="sect2">
1.1 dsieger 7395: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7396: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7397: <p>When a vulnerability is found, this should be noted in
7398: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7399: and after committing that file, ask pkgsrc-security@NetBSD.org to
7400: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7401: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7402: <code class="varname">PKGREVISION</code> should be increased (this is of
7403: course not necessary if the problem is fixed by using a newer
7404: release of the software), and the pattern in the
7405: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7406: <p>Also, if the fix should be applied to the stable pkgsrc
7407: branch, be sure to submit a pullup request!</p>
7408: <p>Binary packages already on ftp.NetBSD.org will be handled
7409: semi-automatically by a weekly cron job.</p>
7410: </div>
1.41 asau 7411: <div class="sect2">
1.1 dsieger 7412: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7413: <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 7414: <p>When making fixes to an existing package it can be useful
7415: to change the version number in <code class="varname">PKGNAME</code>. To
7416: avoid conflicting with future versions by the original author, a
1.23 wiz 7417: <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 7418: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7419: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7420: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7421: <pre class="programlisting">
7422: DISTNAME= foo-17.42
7423: PKGREVISION= 9
1.111 sevan 7424: </pre>
1.1 dsieger 7425: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7426: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7427: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7428: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7429: <code class="varname">PKGNAME_NOREV</code>.</p>
7430: <p>When a new release of the package is released, the
7431: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7432: minor release of the above package, things should be like:</p>
7433: <pre class="programlisting">
7434: DISTNAME= foo-17.43
1.111 sevan 7435: </pre>
1.1 dsieger 7436: <p><code class="varname">PKGREVISION</code> should be incremented for any
7437: non-trivial change in the resulting binary package. Without a
7438: <code class="varname">PKGREVISION</code> bump, someone with the previous
7439: version installed has no way of knowing that their package is out
7440: of date. Thus, changes without increasing
7441: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7442: trivial that no reasonable person would want to upgrade", and this
7443: is the rough test for when increasing
7444: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7445: changes that do not merit increasing
7446: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7447: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7448: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169 rillig 7449: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7450: comments in Makefile.</p></li>
7451: <li class="listitem"><p>Changing build variables if the resulting binary
7452: package is the same.</p></li>
7453: <li class="listitem"><p>Changing
7454: <code class="filename">DESCR</code>.</p></li>
7455: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7456: default options don't change.</p></li>
1.1 dsieger 7457: </ul></div>
7458: <p>Examples of changes that do merit an increase to
7459: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7460: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7461: <li class="listitem"><p>Security fixes</p></li>
7462: <li class="listitem"><p>Changes or additions to a patch
7463: file</p></li>
7464: <li class="listitem"><p>Changes to the
7465: <code class="filename">PLIST</code></p></li>
7466: <li class="listitem"><p>A dependency is changed or
7467: renamed.</p></li>
1.1 dsieger 7468: </ul></div>
7469: <p>PKGREVISION must also be incremented when dependencies have ABI
7470: changes.</p>
7471: </div>
1.41 asau 7472: <div class="sect2">
1.1 dsieger 7473: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7474: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.1 dsieger 7475: <p>When you want to replace the same text in multiple files
7476: or when the replacement text varies, patches alone cannot help.
7477: This is where the SUBST framework comes in. It provides an
7478: easy-to-use interface for replacing text in files.
1.172 rillig 7479: It just needs the following information:</p>
7480: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7481: <li class="listitem"><p><span class="emphasis"><em>When</em></span> should the replacement
7482: happen?</p></li>
7483: <li class="listitem"><p><span class="emphasis"><em>Where</em></span> should the replacement happen,
7484: i.e. in which files?</p></li>
7485: <li class="listitem"><p><span class="emphasis"><em>Which</em></span> text should be
7486: replaced with what?</p></li>
7487: </ul></div>
7488: <p>This information is encoded in a block of <code class="varname">SUBST</code>
7489: variables, like in this example:</p>
1.1 dsieger 7490: <pre class="programlisting">
7491: SUBST_CLASSES+= fix-paths
7492: SUBST_STAGE.fix-paths= pre-configure
7493: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7494: SUBST_FILES.fix-paths= src/*.c
7495: SUBST_FILES.fix-paths+= scripts/*.sh
7496: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7497: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.111 sevan 7498: </pre>
1.1 dsieger 7499: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
7500: that are used to identify the different SUBST blocks that are
7501: defined. The SUBST framework is heavily used by pkgsrc, so it is
7502: important to always use the <code class="literal">+=</code> operator with
1.172 rillig 7503: this variable. Otherwise some substitutions may be skipped.</p>
1.1 dsieger 7504: <p>The remaining variables of each SUBST block are
7505: parameterized with the identifier from the first line
7506: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7507: parameters to a function call.</p>
7508: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
7509: which the replacement will take place. All combinations of
7510: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7511: <code class="literal">post-</code> together with a phase name are
7512: possible, though only few are actually used. Most commonly used
7513: are <code class="literal">post-patch</code> and
7514: <code class="literal">pre-configure</code>. Of these two,
7515: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 7516: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 7517: have the state after applying the patches but before making any
7518: other changes. This is especially useful when you are debugging
7519: a package in order to create new patches for it. Similarly,
7520: <code class="literal">post-build</code> is preferred over
7521: <code class="literal">pre-install</code>, because the install phase should
7522: generally be kept as simple as possible. When you use
7523: <code class="literal">post-build</code>, you have the same files in the
7524: working directory that will be installed later, so you can check
7525: if the substitution has succeeded.</p>
7526: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
7527: that is printed just before the substitution is done.</p>
7528: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
7529: globbing patterns that specifies the files in which the
7530: substitution will take place. The patterns are interpreted
7531: relatively to the <code class="varname">WRKSRC</code> directory.</p>
7532: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.167 leot 7533: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.1 dsieger 7534: command should be prefixed with <code class="literal">-e</code>, so that
7535: all SUBST blocks look uniform.</p>
1.172 rillig 7536: <p><code class="varname">SUBST_VARS.*</code> is a list of variable names.
7537: For each of these variables, the text <code class="literal">@VAR@</code> is
7538: replaced with the value of the variable
7539: <code class="varname">VAR</code>.</p>
1.1 dsieger 7540: <p>There are some more variables, but they are so seldomly
7541: used that they are only documented in the
7542: <code class="filename">mk/subst.mk</code> file.</p>
7543: </div>
7544: </div>
1.41 asau 7545: <div class="sect1">
1.1 dsieger 7546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7547: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 7548: <div class="sect2">
1.1 dsieger 7549: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7550: <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 7551: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 7552: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 7553: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7554: with the name of each file to download as an argument, expecting
7555: it to output the URL of the directory from which to download
1.137 leot 7556: it. <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.1 dsieger 7557: example of this usage.</p>
7558: <p>If the download can't be automated, because the user must
7559: submit personal information to apply for a password, or must pay
7560: for the source, or whatever, you can set
7561: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7562: displayed to the user before aborting the build. Example:</p>
7563: <pre class="programlisting">
7564: FETCH_MESSAGE= "Please download the files"
7565: FETCH_MESSAGE+= " "${DISTFILES:Q}
7566: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 7567: </pre>
1.1 dsieger 7568: </div>
1.41 asau 7569: <div class="sect2">
1.1 dsieger 7570: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7571: <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 7572: <p>Sometimes authors of a software package make some
7573: modifications after the software was released, and they put up a
7574: new distfile without changing the package's version number. If a
7575: package is already in pkgsrc at that time, the checksum will
7576: no longer match. The contents of the new distfile should be
7577: compared against the old one before changing anything, to make
7578: sure the distfile was really updated on purpose, and that
7579: no trojan horse or so crept in.
7580: Please mention that the distfiles were compared and what was found
1.53 rodent 7581: in your commit message.</p>
1.109 wiz 7582: <p>Then, the correct way to work around this is to set
7583: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7584: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7585: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7586: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 7587: <code class="varname">PATCHFILES</code> for this package will be put in that
1.154 rillig 7588: 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 7589: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 7590: including the <code class="filename">nbX</code> suffix) or a date stamp can
7591: be appended, like
7592: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169 rillig 7593: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
7594: name does not contain a version and the distfile is apt to change. In
7595: cases where the likelihood of this is very small,
7596: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
7597: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
7598: distfile name changes, even if a package is being moved or
7599: renamed.</p>
1.53 rodent 7600: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 7601: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7602: path in the filenames.
1.53 rodent 7603: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 7604: Furthermore, a mail to the package's authors seems appropriate
7605: telling them that changing distfiles after releases without
7606: changing the file names is not good practice.</p>
7607: </div>
1.88 tnn 7608: <div class="sect2">
7609: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7610: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169 rillig 7611: <p>Helper methods exist for packages hosted on github.com which
7612: will often have distfile names that clash with other packages, for
7613: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
7614: from below:</p>
1.88 tnn 7615: <div class="sect3">
7616: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7617: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169 rillig 7618: <p>If your distfile URL looks similar to
7619: <code class="literal">http://github.com/username/exampleproject/archive/v1.0.zip</code>,
7620: then you are packaging a tagged release.</p>
1.88 tnn 7621: <pre class="programlisting">
7622: DISTNAME= exampleproject-1.0
1.90 tnn 7623: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7624: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7625: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 7626: EXTRACT_SUFX= .zip
7627: </pre>
7628: </div>
7629: <div class="sect3">
7630: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7631: <a name="build.fetch.github.commit"></a>21.2.3.2. Fetch based on a specific commit</h4></div></div></div>
1.169 rillig 7632: <p>If your distfile URL looks similar to
7633: <code class="literal">http://github.com​/example​/example​/archive​/988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz</code>,
7634: then you are packaging a specific commit not tied to a
7635: release.</p>
1.88 tnn 7636: <pre class="programlisting">
7637: DISTNAME= example-1.0
1.107 jnemeth 7638: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 7639: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7640: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 7641: </pre>
1.88 tnn 7642: </div>
7643: <div class="sect3">
7644: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7645: <a name="build.fetch.github.release"></a>21.2.3.3. Fetch based on release</h4></div></div></div>
1.169 rillig 7646: <p>If your distfile URL looks similar to
7647: <code class="literal">http://github.com​/username/exampleproject​/releases​/download​/rel-1.6​/offensive-1.6.zip</code>,
7648: then you are packaging a release.</p>
1.88 tnn 7649: <pre class="programlisting">
7650: DISTNAME= offensive-1.6
1.90 tnn 7651: PKGNAME= ${DISTNAME:S/offensive/proper/}
7652: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7653: GITHUB_PROJECT= exampleproject
7654: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
7655: EXTRACT_SUFX= .zip
1.111 sevan 7656: </pre>
1.88 tnn 7657: </div>
7658: </div>
1.1 dsieger 7659: </div>
1.41 asau 7660: <div class="sect1">
1.1 dsieger 7661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7662: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 7663: <div class="sect2">
1.1 dsieger 7664: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7665: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 7666: <p>pkgsrc supports many different machines, with different
7667: object formats like a.out and ELF, and varying abilities to do
7668: shared library and dynamic loading at all. To accompany this,
7669: varying commands and options have to be passed to the
7670: compiler, linker, etc. to get the Right Thing, which can be
7671: pretty annoying especially if you don't have all the machines
7672: at your hand to test things. The
1.137 leot 7673: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.23 wiz 7674: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 7675: both static and dynamic libraries from a set of source files,
7676: thus being platform-independent.</p>
7677: <p>Here's how to use libtool in a package in seven simple
7678: steps:</p>
1.23 wiz 7679: <div class="orderedlist"><ol class="orderedlist" type="1">
7680: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 7681: Makefile.</p></li>
1.23 wiz 7682: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
7683: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 7684: add it to the definition of <code class="varname">CC</code>, if only
7685: libraries are being built in a given Makefile. This one command
7686: will build both PIC and non-PIC library objects, so you need not
7687: have separate shared and non-shared library rules.</p></li>
1.23 wiz 7688: <li class="listitem">
1.1 dsieger 7689: <p>For the linking of the library, remove any
1.23 wiz 7690: <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
7691: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 7692: <pre class="programlisting">
7693: ${LIBTOOL} --mode=link \
7694: ${CC} -o ${.TARGET:.a=.la} \
7695: ${OBJS:.o=.lo} \
7696: -rpath ${PREFIX}/lib \
7697: -version-info major:minor
1.111 sevan 7698: </pre>
1.1 dsieger 7699: <p>Note that the library is changed to have a
7700: <code class="filename">.la</code> extension, and the objects are
7701: changed to have a <code class="filename">.lo</code>
7702: extension. Change <code class="varname">OBJS</code> as
7703: necessary. This automatically creates all of the
7704: <code class="filename">.a</code>,
7705: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
7706: necessary) in the build directory. Be sure to include
1.23 wiz 7707: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 7708: minor are zero, as libtool will otherwise strip off the
7709: shared library version.</p>
7710: <p>From the libtool manual:</p>
7711: <pre class="programlisting">
7712: So, libtool library versions are described by three integers:
7713:
7714: CURRENT
7715: The most recent interface number that this library implements.
7716:
7717: REVISION
7718: The implementation number of the CURRENT interface.
7719:
7720: AGE
7721: The difference between the newest and oldest interfaces that
7722: this library implements. In other words, the library implements
7723: all the interface numbers in the range from number `CURRENT -
7724: AGE' to `CURRENT'.
7725:
7726: If two libraries have identical CURRENT and AGE numbers, then the
7727: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 7728: </pre>
1.23 wiz 7729: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 7730: different results for a.out and ELF (excluding symlinks)
7731: in only one case. An ELF library of the form
1.23 wiz 7732: <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 7733: will have a symlink of
1.23 wiz 7734: <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 7735: on an a.out platform. This is handled
7736: automatically.</p>
1.23 wiz 7737: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 7738: directory of the library being built.</p>
7739: <p>In the <code class="filename">PLIST</code>, include only the
7740: <code class="filename">.la</code> file, the other files will be
7741: added automatically.</p>
7742: </li>
1.23 wiz 7743: <li class="listitem">
1.1 dsieger 7744: <p>When linking shared object (<code class="filename">.so</code>)
1.167 leot 7745: files, i.e. files that are loaded via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23 wiz 7746: shared libraries, use <span class="quote">“<span class="quote">-module
7747: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 7748: tacked on.</p>
7749: <p>The <code class="filename">PLIST</code> file gets the
7750: <code class="filename">foo.so</code> entry.</p>
7751: </li>
1.23 wiz 7752: <li class="listitem">
1.1 dsieger 7753: <p>When linking programs that depend on these libraries
7754: <span class="emphasis"><em>before</em></span> they are installed, preface
1.167 leot 7755: the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ld+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 7756: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 7757: libraries (static or shared), but please be aware that
7758: libtool will not allow you to specify a relative path in
1.23 wiz 7759: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 7760: expects you to change that argument to be the
7761: <code class="filename">.la</code> file. e.g.</p>
7762: <pre class="programlisting">
7763: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 7764: </pre>
1.1 dsieger 7765: <p>should be changed to:</p>
7766: <pre class="programlisting">
7767: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 7768: </pre>
1.1 dsieger 7769: <p>and it will do the right thing with the libraries.</p>
7770: </li>
1.23 wiz 7771: <li class="listitem">
1.167 leot 7772: <p>When installing libraries, preface the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
7773: or <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 7774: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 7775: <code class="filename">.la</code>. e.g.</p>
7776: <pre class="programlisting">
1.22 jakllsch 7777: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 7778: </pre>
1.1 dsieger 7779: <p>This will install the static <code class="filename">.a</code>,
7780: shared library, any needed symlinks, and run
1.167 leot 7781: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 7782: </li>
1.23 wiz 7783: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 7784: the <code class="filename">.la</code>
7785: file (this is a change from previous behaviour).</p></li>
7786: </ol></div>
7787: </div>
1.41 asau 7788: <div class="sect2">
1.1 dsieger 7789: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7790: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 7791: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
7792: package Makefile. This will override the package's own libtool
7793: in most cases. For older libtool using packages, libtool is
7794: made by ltconfig script during the do-configure step; you can
1.10 hubertf 7795: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 7796: configure; find work*/ -name libtool</strong></span>.</p>
7797: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
7798: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 7799: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
7800: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 7801: package's libtool script(s), set it as appropriate.</p>
7802: <p>If you do not need <code class="filename">*.a</code> static
7803: libraries built and installed, then use
7804: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
7805: <p>If your package makes use of the platform-independent library
7806: for loading dynamic shared objects, that comes with libtool
7807: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
7808: <p>Some packages use libtool incorrectly so that the package
7809: may not work or build in some circumstances. Some of the more
7810: common errors are:</p>
1.41 asau 7811: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7812: <li class="listitem">
1.1 dsieger 7813: <p>The inclusion of a shared object (-module) as a dependent library in an
7814: executable or library. This in itself isn't a problem if one of two things
7815: has been done:</p>
1.23 wiz 7816: <div class="orderedlist"><ol class="orderedlist" type="1">
7817: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 7818: <code class="filename">libfoo.la</code>, not
7819: <code class="filename">foo.la</code></p></li>
1.23 wiz 7820: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 7821: </ol></div>
7822: </li>
1.23 wiz 7823: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 7824: The function lt_dlinit() should be called and the macro
7825: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
7826: executables.</p></li>
7827: </ul></div>
7828: </div>
1.41 asau 7829: <div class="sect2">
1.1 dsieger 7830: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7831: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 7832: <p>If a package needs GNU autoconf or automake to be executed
7833: to regenerate the configure script and Makefile.in makefile
7834: templates, then they should be executed in a pre-configure
7835: target.</p>
7836: <p>For packages that need only autoconf:</p>
7837: <pre class="programlisting">
7838: AUTOCONF_REQD= 2.50 # if default version is not good enough
7839: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
7840: ...
7841:
7842: pre-configure:
7843: cd ${WRKSRC} && autoconf
7844:
7845: ...
1.111 sevan 7846: </pre>
1.1 dsieger 7847: <p>and for packages that need automake and autoconf:</p>
7848: <pre class="programlisting">
7849: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
7850: USE_TOOLS+= automake # use "automake14" for automake-1.4
7851: ...
7852:
7853: pre-configure:
7854: set -e; cd ${WRKSRC}; \
7855: aclocal; autoheader; automake -a --foreign -i; autoconf
7856:
7857: ...
1.111 sevan 7858: </pre>
1.1 dsieger 7859: <p>Packages which use GNU Automake will almost certainly
7860: require GNU Make.</p>
7861: <p>There are times when the configure process makes
7862: additional changes to the generated files, which then causes
7863: the build process to try to re-execute the automake sequence.
7864: This is prevented by touching various files in the configure
7865: stage. If this causes problems with your package you can set
7866: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
7867: Makefile.</p>
7868: </div>
7869: </div>
1.41 asau 7870: <div class="sect1">
1.1 dsieger 7871: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7872: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41 asau 7873: <div class="sect2">
1.1 dsieger 7874: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7875: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 7876: <p>Compilers for the C, C++, and Fortran languages comes with
7877: the NetBSD base system. By default, pkgsrc assumes that a package
7878: is written in C and will hide all other compilers (via the wrapper
1.154 rillig 7879: framework, see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 7880: <p>To declare which language's compiler a package needs, set
7881: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 7882: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
7883: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
7884: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 7885: written in C++, usually need a C compiler for the configure
7886: phase.</p>
7887: </div>
1.41 asau 7888: <div class="sect2">
1.1 dsieger 7889: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7890: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 7891: <p>If a program is written in Java, use the Java framework in
7892: pkgsrc. The package must include
7893: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
7894: provides the following variables:</p>
1.41 asau 7895: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7896: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 7897: dependency on the JDK is added. If
1.23 wiz 7898: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 7899: there is only a runtime dependency on the JDK. The default is
1.23 wiz 7900: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 7901: JDK.</p></li>
1.23 wiz 7902: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 7903: a package needs a Java2 implementation. The supported values
1.23 wiz 7904: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
7905: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
7906: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
7907: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 7908: above. This variable is not set by default.</p></li>
1.24 wiz 7909: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
7910: automatically set to the runtime location of the used Java
7911: implementation dependency. It may be used to set
7912: <code class="varname">JAVA_HOME</code> to a good value if the program
7913: needs this variable to be defined.
7914: </p></li>
1.1 dsieger 7915: </ul></div>
7916: </div>
1.41 asau 7917: <div class="sect2">
1.1 dsieger 7918: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7919: <a name="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 7920: <p>If your package contains interpreted perl scripts, add
1.23 wiz 7921: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 7922: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
7923: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
7924: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 7925: that you want adjusted. Every occurrence of
7926: <code class="filename">*/bin/perl</code> in a she-bang line will be
7927: replaced with the full path to the perl executable.</p>
1.1 dsieger 7928: <p>If a particular version of perl is needed, set the
7929: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 7930: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.154 rillig 7931: <p>See <a class="xref" href="#perl-modules" title="21.6.6. Packages installing perl modules">Section 21.6.6, “Packages installing perl modules”</a> for information
1.1 dsieger 7932: about handling perl modules.</p>
7933: </div>
1.41 asau 7934: <div class="sect2">
1.1 dsieger 7935: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7936: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 7937: <p><code class="varname">REPLACE_SH</code>,
7938: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
7939: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
7940: hash bangs in files. Please use the appropriate one, prefering
7941: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 7942: Each should contain a list of scripts, relative to
7943: <code class="varname">WRKSRC</code>, that you want adjusted. Every
7944: occurrence of the matching shell in a she-bang line will be
7945: replaced with the full path to the shell executable.
1.40 wiz 7946: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
7947: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
7948: </div>
1.41 asau 7949: <div class="sect2">
1.40 wiz 7950: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7951: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 7952: <p>Currently, there is no special handling for other languages
7953: in pkgsrc. If a compiler package provides a
7954: <code class="filename">buildlink3.mk</code> file, include that, otherwise
7955: just add a (build) dependency on the appropriate compiler
7956: package.</p>
7957: </div>
7958: </div>
1.41 asau 7959: <div class="sect1">
1.1 dsieger 7960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7961: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7962: <p>The most common failures when building a package are that
7963: some platforms do not provide certain header files, functions or
7964: libraries, or they provide the functions in a library that the
7965: original package author didn't know. To work around this, you
7966: can rewrite the source code in most cases so that it does not
7967: use the missing functions or provides a replacement function.</p>
1.41 asau 7968: <div class="sect2">
1.1 dsieger 7969: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7970: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 7971: <p>If a package already comes with a GNU configure script, the
7972: preferred way to fix the build failure is to change the
7973: configure script, not the code. In the other cases, you can
7974: utilize the C preprocessor, which defines certain macros
7975: depending on the operating system and hardware architecture it
7976: compiles for. These macros can be queried using for example
7977: <code class="varname">#if defined(__i386)</code>. Almost every operating
7978: system, hardware architecture and compiler has its own macro.
7979: For example, if the macros <code class="varname">__GNUC__</code>,
7980: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
7981: are all defined, you know that you are using NetBSD on an i386
7982: compatible CPU, and your compiler is GCC.</p>
7983: <p>The list of the following macros for hardware and
7984: operating system depends on the compiler that is used. For
7985: example, if you want to conditionally compile code on Solaris,
7986: don't use <code class="varname">__sun__</code>, as the SunPro compiler
7987: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 7988: <div class="sect3">
1.1 dsieger 7989: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7990: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1 dsieger 7991: <p>To distinguish between 4.4 BSD-derived systems and the
7992: rest of the world, you should use the following code.</p>
7993: <pre class="programlisting">
7994: #include <sys/param.h>
7995: #if (defined(BSD) && BSD >= 199306)
7996: /* BSD-specific code goes here */
7997: #else
7998: /* non-BSD-specific code goes here */
7999: #endif
8000: </pre>
8001: <p>If this distinction is not fine enough, you can also test
8002: for the following macros.</p>
8003: <pre class="programlisting">
1.45 obache 8004: Cygwin __CYGWIN__
8005: DragonFly __DragonFly__
1.1 dsieger 8006: FreeBSD __FreeBSD__
1.45 obache 8007: Haiku __HAIKU__
1.1 dsieger 8008: Interix __INTERIX
8009: IRIX __sgi (TODO: get a definite source for this)
8010: Linux linux, __linux, __linux__
1.83 dholland 8011: Mac OS X __APPLE__
1.45 obache 8012: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8013: Minix3 __minix
1.1 dsieger 8014: NetBSD __NetBSD__
8015: OpenBSD __OpenBSD__
8016: Solaris sun, __sun
8017: </pre>
8018: </div>
1.41 asau 8019: <div class="sect3">
1.1 dsieger 8020: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8021: <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 8022: <pre class="programlisting">
8023: i386 i386, __i386, __i386__
8024: MIPS __mips
8025: SPARC sparc, __sparc
8026: </pre>
8027: </div>
1.41 asau 8028: <div class="sect3">
1.1 dsieger 8029: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8030: <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 8031: <pre class="programlisting">
8032: GCC __GNUC__ (major version), __GNUC_MINOR__
8033: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8034: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8035: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8036: </pre>
8037: </div>
8038: </div>
1.41 asau 8039: <div class="sect2">
1.1 dsieger 8040: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8041: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8042: <p>Some source files trigger bugs in the compiler, based on
8043: combinations of compiler version and architecture and almost
8044: always relation to optimisation being enabled. Common symptoms
8045: are gcc internal errors or never finishing compiling a
8046: file.</p>
8047: <p>Typically, a workaround involves testing the
8048: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8049: optimisation for that combination of file,
1.87 tnn 8050: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8051: <p>This used to be a big problem in the past, but is rarely
8052: needed now as compiler technology has matured. If you still need
8053: to add a compiler specific workaround, please do so in the file
8054: <code class="filename">hacks.mk</code> and describe the symptom and
8055: compiler version as detailed as possible.</p>
1.1 dsieger 8056: </div>
1.41 asau 8057: <div class="sect2">
1.1 dsieger 8058: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8059: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8060: <p>Compilation sometimes fails with an error message like this:</p>
8061: <pre class="programlisting">
8062: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8063: fatal error: pango/pango.h: No such file or directory
8064: </pre>
8065: <p>The proper way to fix this problem depends on the type of the
8066: header, which is described in the following sections.</p>
8067: <div class="sect3">
8068: <div class="titlepage"><div><div><h4 class="title">
8069: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8070: <p>If the header name looks like it comes from a different package,
8071: that other package should be included via the buildlink3
8072: framework.</p>
8073: <p>First, look whether the header is somewhere in the buildlink3
8074: directory below <code class="varname">WRKDIR</code>. In the above case of
8075: the missing Pango header:</p>
8076: <pre class="programlisting">
8077: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8078: </pre>
8079: <p>In the case of Pango, the output is:</p>
8080: <pre class="programlisting">
8081: work/.buildlink/include/pango-1.0/pango/pango.h
8082: </pre>
8083: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8084: in the <code class="filename">.buildlink</code> directory, it would have been
8085: found automatically. There is an extra <code class="filename">pango-1.0</code>
8086: path component though, which means that the compiler command line must
8087: contain an option of the form
8088: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8089: most cases this option is generated by the configure script, which can be examined using:</p>
8090: <pre class="programlisting">
8091: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8092: -I/usr/pkg/include/pango-1.0
8093: -I/usr/pkg/include/pango-1.0
8094: -I/usr/pkg/include/pango-1.0
8095: -I/usr/pkg/include/pango-1.0
8096: -I/usr/pkg/include/pango-1.0
8097: </pre>
8098: <p>This looks good. These options are transformed by the buildlink
8099: wrapper to refer to the correct path inside
8100: <code class="filename">work/.buildlink</code>.</p>
8101: <p>Since the compilation fails though, examine the compiler command
8102: lines in <code class="filename">work/.work.log</code> to see whether the
8103: <code class="literal">-I</code> option is included in the particular command
8104: line.</p>
8105: <p>To further analyze the situation, run <span class="command"><strong>bmake
8106: build-env</strong></span>, which sets up an interactive, realistic environment
8107: including all the pkgsrc wrapper commands and environment variables. From
8108: there, try to compile some simple example programs that use the
8109: header.</p>
8110: </div>
8111: <div class="sect3">
8112: <div class="titlepage"><div><div><h4 class="title">
8113: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8114: <p>If the name of the header seems to come from the package itself,
8115: and if the build is run with parallel jobs, the package may have some
8116: undeclared dependencies between the <code class="filename">.c</code> and the
8117: <code class="filename">.h</code> files, and a C file is compiled before its
8118: required header is generated.</p>
8119: <p>To see whether the build runs with parallel jobs, run
8120: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8121: like this:</p>
8122: <pre class="programlisting">
8123: usr MAKE_JOBS= 7
8124: pkg MAKE_JOBS_SAFE # undefined
8125: def _MAKE_JOBS_N= 7
8126: </pre>
8127: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8128: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8129: package could have disabled parallel builds by setting
8130: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8131: in this case it hasn't.</p>
8132: <p>To see whether the build failure is caused by parallel builds,
8133: first save the exact error message and a bit of context, maybe you need
8134: it later for reporting a bug. Next, run:</p>
8135: <pre class="programlisting">
8136: MAKE_JOBS_SAFE=no bmake clean build
8137: </pre>
8138: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8139: report</a> against the pkgsrc package, including the exact error
8140: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8141: </div>
1.173 ! rillig 8142: <div class="sect3">
! 8143: <div class="titlepage"><div><div><h4 class="title">
! 8144: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
! 8145: <p>Pkgsrc does not work reliably if any of
! 8146: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
! 8147: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
! 8148: bootstrap program prevents installing pkgsrc in symlink-based
! 8149: directories. Existing pkgsrc installations are not checked for symlinks
! 8150: though.</p>
! 8151: <p>The "No such file or directory" error messages are a typical
! 8152: symptom of symlinks, and it's quite difficult to find out that this is
! 8153: the actual cause.</p>
! 8154: </div>
! 8155: <div class="sect3">
! 8156: <div class="titlepage"><div><div><h4 class="title">
! 8157: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
! 8158: <p>When building a hierarchy of packages, it may happen that one
! 8159: package is built and then pkgsrc is updated. This situation can provoke
! 8160: various hard to diagnose build errors. To clean up the situation:</p>
! 8161: <pre class="programlisting">
! 8162: <code class="prompt">$</code> (cd ../../ && test -f mk/bsd.pkg.mk && rm -rf */*/work)
! 8163: </pre>
! 8164: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
! 8165: this command in the wrong directory.)</p>
! 8166: <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
! 8167: that directory as well.</p>
! 8168: </div>
! 8169: <div class="sect3">
! 8170: <div class="titlepage"><div><div><h4 class="title">
! 8171: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
! 8172: <p>On platforms other than BSD, third-party packages are installed in
! 8173: <code class="filename">/usr/include</code>, together with the base system. This
! 8174: means that pkgsrc cannot distinguish between headers provided by the base
! 8175: system (which it needs) and headers from third-party packages (which are
! 8176: often included in pkgsrc as well). This can lead to subtle version
! 8177: mismatches.</p>
! 8178: <p>In pkgsrc installations that have been active for several years, it
! 8179: may happen that some files are manually deleted. To exclude this unlikely
! 8180: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
! 8181: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
! 8182: check/fix dependencies.</p>
! 8183: <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>
! 8184: for contact information. Be prepared to describe what you have tried so
! 8185: far and what any error messages were.</p>
! 8186: </div>
1.172 rillig 8187: </div>
8188: <div class="sect2">
8189: <div class="titlepage"><div><div><h3 class="title">
8190: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 8191: </h3></div></div></div>
1.1 dsieger 8192: <p>This error message often means that a package did not
8193: link to a shared library it needs. The following functions are
8194: known to cause this error message over and over.</p>
8195: <div class="informaltable">
1.106 tnn 8196: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 8197: <colgroup>
8198: <col>
8199: <col>
8200: <col>
8201: </colgroup>
8202: <thead><tr>
8203: <th>Function</th>
8204: <th>Library</th>
8205: <th>Affected platforms</th>
8206: </tr></thead>
8207: <tbody>
8208: <tr>
8209: <td>accept, bind, connect</td>
8210: <td>-lsocket</td>
8211: <td>Solaris</td>
8212: </tr>
8213: <tr>
8214: <td>crypt</td>
8215: <td>-lcrypt</td>
8216: <td>DragonFly, NetBSD</td>
8217: </tr>
8218: <tr>
8219: <td>dlopen, dlsym</td>
8220: <td>-ldl</td>
8221: <td>Linux</td>
8222: </tr>
8223: <tr>
8224: <td>gethost*</td>
8225: <td>-lnsl</td>
8226: <td>Solaris</td>
8227: </tr>
8228: <tr>
8229: <td>inet_aton</td>
8230: <td>-lresolv</td>
8231: <td>Solaris</td>
8232: </tr>
8233: <tr>
8234: <td>nanosleep, sem_*, timer_*</td>
8235: <td>-lrt</td>
8236: <td>Solaris</td>
8237: </tr>
8238: <tr>
8239: <td>openpty</td>
8240: <td>-lutil</td>
8241: <td>Linux</td>
8242: </tr>
8243: </tbody>
8244: </table>
8245: </div>
8246: <p>To fix these linker errors, it is often sufficient to say
8247: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8248: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8249: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8250: bmake</strong></span>.</p>
1.41 asau 8251: <div class="sect3">
1.1 dsieger 8252: <div class="titlepage"><div><div><h4 class="title">
1.172 rillig 8253: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8254: <p>When you are using the SunPro compiler, there is another
8255: possibility. That compiler cannot handle the following code:</p>
8256: <pre class="programlisting">
8257: extern int extern_func(int);
8258:
8259: static inline int
8260: inline_func(int x)
8261: {
8262: return extern_func(x);
8263: }
8264:
8265: int main(void)
8266: {
8267: return 0;
8268: }
8269: </pre>
8270: <p>It generates the code for <code class="function">inline_func</code> even if
8271: that function is never used. This code then refers to
8272: <code class="function">extern_func</code>, which can usually not be resolved. To
8273: solve this problem you can try to tell the package to disable inlining
8274: of functions.</p>
8275: </div>
8276: </div>
1.41 asau 8277: <div class="sect2">
1.1 dsieger 8278: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8279: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1 dsieger 8280: <p>Sometimes packages fail to build because the compiler runs
8281: into an operating system specific soft limit. With the
8282: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 8283: to unlimit the resources. Currently, the allowed values are any combination of
8284: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8285: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 8286: Setting this variable is similar to running the shell builtin
1.10 hubertf 8287: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8288: segment size or maximum stack size of a process, respectively, to
8289: their hard limits.</p>
8290: </div>
8291: </div>
1.41 asau 8292: <div class="sect1">
1.1 dsieger 8293: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8294: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 8295: <div class="sect2">
1.1 dsieger 8296: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8297: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8298: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8299: with some operating systems cannot create more than one
8300: directory at a time. As such, you should call
8301: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8302: <pre class="programlisting">
8303: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8304: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 8305: </pre>
1.23 wiz 8306: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8307: dir2</code></span>”</span> to the
1.1 dsieger 8308: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8309: automatically do the right thing.</p>
8310: </div>
1.41 asau 8311: <div class="sect2">
1.1 dsieger 8312: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8313: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8314: <p>In general, documentation should be installed into
8315: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8316: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8317: includes the version number of the package).</p>
8318: <p>Many modern packages using GNU autoconf allow to set the
8319: directory where HTML documentation is installed with the
1.23 wiz 8320: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8321: is needed because otherwise the documentation ends up in
8322: <code class="filename">${PREFIX}/share/doc/html</code> or other
8323: places.</p>
8324: <p>An exception to the above is that library API documentation
1.137 leot 8325: generated with the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.1 dsieger 8326: browsers (devhelp) should be left at their default location, which
8327: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8328: documentation can be recognized from files ending in
8329: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8330: (It is also acceptable to install such files in
8331: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8332: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8333: <code class="filename">.devhelp*</code> file must be directly in that
8334: directory then, no additional subdirectory level is allowed in
8335: this case. This is usually achieved by using
1.23 wiz 8336: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8337: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8338: though.)</p>
8339: </div>
1.41 asau 8340: <div class="sect2">
1.1 dsieger 8341: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8342: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8343: <p>Certain packages, most of them in the games category, install
8344: a score file that allows all users on the system to record their
8345: highscores. In order for this to work, the binaries need to be
8346: installed setgid and the score files owned by the appropriate
1.35 wiz 8347: group and/or owner (traditionally the "games" user/group). Set
8348: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8349: following variables, documented in more detail in
8350: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8351: behaviour: <code class="varname">GAMEDATAMODE</code>,
8352: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8353: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8354: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8355: <code class="varname">GAMEDATA_PERMS</code> and
8356: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8357: <p>An example that illustrates some of the variables described above is
8358: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8359: used to properly set directory permissions of the directory where the
8360: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8361: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8362: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8363: binary:</p>
8364: <pre class="programlisting">
1.112 rillig 8365: USE_GAMESGROUP= yes
1.100 leot 8366:
1.112 rillig 8367: BUILD_DEFS+= VARBASE
1.100 leot 8368:
1.112 rillig 8369: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8370: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8371: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 8372: </pre>
1.100 leot 8373: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8374: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8375: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8376: needed to be accessed by setgid games and
8377: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8378: <p>A package should therefore never hard code file ownership or
1.100 leot 8379: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8380: or alternatively on <code class="varname">INSTALL_GAME</code>,
8381: <code class="varname">INSTALL_GAME_DATA</code> and
8382: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8383: </div>
1.41 asau 8384: <div class="sect2">
1.1 dsieger 8385: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8386: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8387: <p><code class="varname">DESTDIR</code> support means that a package
8388: installs into a staging directory, not the final location of the
8389: files. Then a binary package is created which can be used for
8390: installation as usual. There are two ways: Either the package must
1.23 wiz 8391: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8392: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8393: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8394: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 8395: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8396: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 8397: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8398: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8399: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8400: the inclusion.</p></li>
1.23 wiz 8401: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8402: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8403: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8404: automatically. Many manual rules and pre/post-install often are
8405: incorrect; fix them.</p></li>
1.23 wiz 8406: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8407: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8408: <li class="listitem"><p>In general, packages should support
1.4 rillig 8409: <code class="varname">UNPRIVILEGED</code> to be able to use
8410: DESTDIR.</p></li>
8411: </ul></div>
8412: </div>
1.41 asau 8413: <div class="sect2">
1.4 rillig 8414: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8415: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8416: <p>Your package may also contain scripts with hardcoded paths to
8417: other interpreters besides (or as well as) perl. To correct the
8418: full pathname to the script interpreter, you need to set the
8419: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8420: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8421: <pre class="programlisting">
8422: REPLACE_INTERPRETER+= tcl
8423: REPLACE.tcl.old= .*/bin/tclsh
8424: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8425: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8426: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 8427: </pre>
1.41 asau 8428: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8429: <h3 class="title">Note</h3>
8430: <p>Before March 2006, these variables were called
8431: <code class="varname">_REPLACE.*</code> and
8432: <code class="varname">_REPLACE_FILES.*</code>.</p>
8433: </div>
8434: </div>
1.41 asau 8435: <div class="sect2">
1.1 dsieger 8436: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8437: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8438: <p>Makefiles of packages providing perl5 modules should include
8439: the Makefile fragment
8440: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8441: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8442: configuration for such modules as well as various hooks to tune
8443: this configuration. See comments in this file for
8444: details.</p>
8445: <p>Perl5 modules will install into different places depending
8446: on the version of perl used during the build process. To
8447: address this, pkgsrc will append lines to the
8448: <code class="filename">PLIST</code> corresponding to the files listed in
8449: the installed <code class="filename">.packlist</code> file generated by
8450: most perl5 modules. This is invoked by defining
8451: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8452: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8453: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8454: e.g.:</p>
1.1 dsieger 8455: <pre class="programlisting">
1.47 wiz 8456: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 8457: </pre>
1.47 wiz 8458: <p>The perl5 config variables
8459: <code class="varname">installarchlib</code>,
8460: <code class="varname">installscript</code>,
8461: <code class="varname">installvendorbin</code>,
8462: <code class="varname">installvendorscript</code>,
8463: <code class="varname">installvendorarch</code>,
8464: <code class="varname">installvendorlib</code>,
8465: <code class="varname">installvendorman1dir</code>, and
8466: <code class="varname">installvendorman3dir</code> represent those
8467: locations in which components of perl5 modules may be installed,
8468: provided as variable with uppercase and prefixed with
8469: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8470: and may be used by perl5 packages that don't have a packlist.
8471: These variables are also substituted for in the
8472: <code class="filename">PLIST</code> as uppercase prefixed with
8473: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8474: </div>
1.41 asau 8475: <div class="sect2">
1.1 dsieger 8476: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8477: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8478: <p>Some packages install info files or use the
1.23 wiz 8479: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8480: commands. <code class="varname">INFO_FILES</code> should be defined in
8481: the package Makefile so that <code class="filename">INSTALL</code> and
8482: <code class="filename">DEINSTALL</code> scripts will be generated to
8483: handle registration of the info files in the Info directory
1.23 wiz 8484: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8485: files registration is either provided by the system, or by a
8486: special purpose package automatically added as dependency if
8487: needed.</p>
8488: <p><code class="varname">PKGINFODIR</code> is the directory under
8489: <code class="filename">${PREFIX}</code> where info files are primarily
8490: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8491: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8492: <p>The info files for the package should be listed in the
8493: package <code class="filename">PLIST</code>; however any split info files
8494: need not be listed.</p>
1.23 wiz 8495: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8496: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8497: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8498: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8499: should be noted with the <code class="varname">TEXINFO_REQD</code>
8500: variable in the package <code class="filename">Makefile</code>. By
8501: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8502: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8503: does not match the required minimum, a build dependency on the
1.137 leot 8504: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.1 dsieger 8505: be added automatically.</p>
8506: <p>The build and installation process of the software provided
8507: by the package should not use the
1.10 hubertf 8508: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8509: info files is the task of the package
8510: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8511: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8512: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8513: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8514: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8515: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8516: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8517: no effect except the logging of a message. The script overriding
1.10 hubertf 8518: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8519: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8520: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8521: </div>
1.41 asau 8522: <div class="sect2">
1.1 dsieger 8523: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8524: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8525: <p>All packages that install manual pages should install them
8526: into the same directory, so that there is one common place to look
8527: for them. In pkgsrc, this place is
8528: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8529: should be used in packages. The default for
8530: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8531: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8532: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8533: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8534: <h3 class="title">Note</h3>
8535: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8536: is far from complete.</p>
8537: </div>
8538: <p>The <code class="filename">PLIST</code> files can just use
8539: <code class="filename">man/</code> as the top level directory for the man
8540: page file entries, and the pkgsrc framework will convert as
8541: needed. In all other places, the correct
8542: <code class="varname">PKGMANDIR</code> must be used.</p>
8543: <p>Packages that are
8544: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8545: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8546: <code class="filename">./configure</code>
8547: --mandir switch to set where the man pages should be installed.
8548: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8549: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8550: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8551: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8552: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8553: Or if the <code class="filename">./configure</code> script uses
8554: a non-standard use of --mandir, you can set
8555: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.154 rillig 8556: <p>See <a class="xref" href="#manpage-compression" title="15.5. Man page compression">Section 15.5, “Man page compression”</a> for
1.1 dsieger 8557: information on installation of compressed manual pages.</p>
8558: </div>
1.41 asau 8559: <div class="sect2">
1.1 dsieger 8560: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8561: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8562: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8563: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8564: you need to take some extra steps to make sure they get registered
8565: in the database:</p>
1.23 wiz 8566: <div class="orderedlist"><ol class="orderedlist" type="1">
8567: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8568: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8569: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8570: deinstallation time, and tells the package where to install
1.7 rillig 8571: GConf data files using some standard configure arguments. It
1.1 dsieger 8572: also disallows any access to the database directly from the
8573: package.</p></li>
1.23 wiz 8574: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8575: <code class="filename">.schemas</code> files under
8576: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8577: installed under <code class="filename">${PREFIX}/etc</code>, you will
8578: need to manually patch the package.</p></li>
1.23 wiz 8579: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8580: directory, as they will be handled automatically. See
1.154 rillig 8581: <a class="xref" href="#faq.conf" title="10.13. How do I change the location of configuration files?">Section 10.13, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.23 wiz 8582: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8583: your <code class="filename">Makefile</code> with a list of all
8584: <code class="filename">.schemas</code> files installed by the package, if
8585: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8586: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8587: your <code class="filename">Makefile</code> with a
8588: list of all <code class="filename">.entries</code> files installed by the
8589: package, if any. Names must not contain any directories in
8590: them.</p></li>
8591: </ol></div>
8592: </div>
1.41 asau 8593: <div class="sect2">
1.1 dsieger 8594: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8595: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8596: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8597: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8598: get registered in the database:</p>
1.23 wiz 8599: <div class="orderedlist"><ol class="orderedlist" type="1">
8600: <li class="listitem"><p>Include
1.18 snj 8601: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8602: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8603: takes care of rebuilding the scrollkeeper database at
8604: installation and deinstallation time, and disallows any access
8605: to it directly from the package.</p></li>
1.23 wiz 8606: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8607: <code class="filename">libdata/scrollkeeper</code> directory, as they
8608: will be handled automatically.</p></li>
1.23 wiz 8609: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8610: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8611: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8612: </ol></div>
8613: </div>
1.41 asau 8614: <div class="sect2">
1.1 dsieger 8615: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8616: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8617: <p>If a package installs font files, you will need to rebuild
8618: the fonts database in the directory where they get installed at
8619: installation and deinstallation time. This can be automatically
8620: done by using the pkginstall framework.</p>
8621: <p>You can list the directories where fonts are installed in the
8622: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8623: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8624: <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 8625: Also make sure that the database file
8626: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8627: <p>Note that you should not create new directories for fonts;
8628: instead use the standard ones to avoid that the user needs to
8629: manually configure his X server to find them.</p>
8630: </div>
1.41 asau 8631: <div class="sect2">
1.1 dsieger 8632: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8633: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8634: <p>If a package installs GTK2 immodules or loaders, you need to
8635: take some extra steps to get them registered in the GTK2 database
8636: properly:</p>
1.23 wiz 8637: <div class="orderedlist"><ol class="orderedlist" type="1">
8638: <li class="listitem"><p>Include
1.1 dsieger 8639: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8640: <code class="filename">buildlink3.mk</code> file. This takes care of
8641: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8642: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8643: your package installs GTK2 immodules.</p></li>
1.23 wiz 8644: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8645: GTK2 loaders.</p></li>
1.23 wiz 8646: <li class="listitem">
1.1 dsieger 8647: <p>Patch the package to not touch any of the GTK2
8648: databases directly. These are:</p>
1.41 asau 8649: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8650: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8651: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 8652: </ul></div>
8653: </li>
1.23 wiz 8654: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 8655: any entries under the <code class="filename">libdata/gtk-2.0</code>
8656: directory, as they will be handled automatically.</p></li>
8657: </ol></div>
8658: </div>
1.41 asau 8659: <div class="sect2">
1.1 dsieger 8660: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8661: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8662: <p>If a package installs SGML or XML data files that need to be
8663: registered in system-wide catalogs (like DTDs, sub-catalogs,
8664: etc.), you need to take some extra steps:</p>
1.23 wiz 8665: <div class="orderedlist"><ol class="orderedlist" type="1">
8666: <li class="listitem"><p>Include
1.1 dsieger 8667: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8668: your <code class="filename">Makefile</code>, which takes care of
8669: registering those files in system-wide catalogs at
8670: installation and deinstallation time.</p></li>
1.23 wiz 8671: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 8672: any SGML catalogs installed by the package.</p></li>
1.23 wiz 8673: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 8674: any XML catalogs installed by the package.</p></li>
1.23 wiz 8675: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 8676: to be added to the SGML catalog. These come in groups of
8677: three strings; see xmlcatmgr(1) for more information
8678: (specifically, arguments recognized by the 'add' action).
8679: Note that you will normally not use this variable.</p></li>
1.23 wiz 8680: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 8681: to be added to the XML catalog. These come in groups of three
8682: strings; see xmlcatmgr(1) for more information (specifically,
8683: arguments recognized by the 'add' action). Note that you will
8684: normally not use this variable.</p></li>
8685: </ol></div>
8686: </div>
1.41 asau 8687: <div class="sect2">
1.1 dsieger 8688: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8689: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 8690: <p>If a package provides extensions to the MIME database by
8691: installing <code class="filename">.xml</code> files inside
8692: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8693: need to take some extra steps to ensure that the database is kept
8694: consistent with respect to these new files:</p>
1.23 wiz 8695: <div class="orderedlist"><ol class="orderedlist" type="1">
8696: <li class="listitem"><p>Include
1.1 dsieger 8697: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8698: (avoid using the <code class="filename">buildlink3.mk</code> file from
8699: this same directory, which is reserved for inclusion from
8700: other <code class="filename">buildlink3.mk</code> files). It takes
8701: care of rebuilding the MIME database at installation and
8702: deinstallation time, and disallows any access to it directly
8703: from the package.</p></li>
1.23 wiz 8704: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8705: <code class="filename">share/mime</code> directory,
8706: <span class="emphasis"><em>except</em></span> for files saved under
8707: <code class="filename">share/mime/packages</code>. The former are
8708: handled automatically by
8709: the update-mime-database program, but the latter are
8710: package-dependent and must be removed by the package that
8711: installed them in the first place.</p></li>
1.23 wiz 8712: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 8713: from the PLIST. They will be handled by the shared-mime-info
8714: package.</p></li>
8715: </ol></div>
8716: </div>
1.41 asau 8717: <div class="sect2">
1.1 dsieger 8718: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8719: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 8720: <p>If a package uses intltool during its build, add
8721: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
8722: which forces it to use the intltool package provided by pkgsrc,
8723: instead of the one bundled with the distribution file.</p>
8724: <p>This tracks intltool's build-time dependencies and uses the
8725: latest available version; this way, the package benefits of any
8726: bug fixes that may have appeared since it was released.</p>
8727: </div>
1.41 asau 8728: <div class="sect2">
1.1 dsieger 8729: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8730: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 8731: <p>If a package contains a rc.d script, it won't be copied into
8732: the startup directory by default, but you can enable it, by adding
8733: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 8734: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 8735: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8736: it will automatically remove the scripts when the package is
8737: deinstalled.</p>
8738: </div>
1.41 asau 8739: <div class="sect2">
1.1 dsieger 8740: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8741: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 8742: <p>If a package installs TeX packages into the texmf tree,
8743: the <code class="filename">ls-R</code> database of the tree needs to be
8744: updated.</p>
1.41 asau 8745: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8746: <h3 class="title">Note</h3>
1.22 jakllsch 8747: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 8748: packages should install files
1.22 jakllsch 8749: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
8750: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 8751: </div>
1.23 wiz 8752: <div class="orderedlist"><ol class="orderedlist" type="1">
8753: <li class="listitem"><p>Include
1.22 jakllsch 8754: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 8755: takes care of rebuilding the <code class="filename">ls-R</code>
8756: database at installation and deinstallation time.</p></li>
1.23 wiz 8757: <li class="listitem">
1.1 dsieger 8758: <p>If your package installs files into a texmf
8759: tree other than the one
1.22 jakllsch 8760: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
8761: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 8762: trees that need database update.</p>
8763: <p>If your package also installs font map files that need
1.10 hubertf 8764: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 8765: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 8766: set <code class="varname">TEX_MAP_FILES</code> and/or
8767: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 8768: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 8769: be run automatically at installation/deinstallation to
8770: enable/disable font map files for TeX output
8771: drivers.</p>
8772: </li>
1.23 wiz 8773: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 8774: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 8775: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 8776: </ol></div>
8777: </div>
1.41 asau 8778: <div class="sect2">
1.1 dsieger 8779: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8780: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.1 dsieger 8781: emulation</h3></div></div></div>
8782: <p>There are some packages that provide libraries and
8783: executables for running binaries from a one operating system
8784: on a different one (if the latter supports it). One example
8785: is running Linux binaries on NetBSD.</p>
1.137 leot 8786: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.1 dsieger 8787: helps in extracting and packaging Linux rpm packages.</p>
8788: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 8789: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 8790: if all libraries for each installed executable can be found by
8791: the dynamic linker. Since the standard dynamic linker is run,
8792: this fails for emulation packages, because the libraries used
8793: by the emulation are not in the standard directories.</p>
8794: </div>
1.41 asau 8795: <div class="sect2">
1.1 dsieger 8796: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8797: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 8798: <p>If a package installs images under the
8799: <code class="filename">share/icons/hicolor</code> and/or updates the
8800: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8801: database, you need to take some extra steps to make sure that the
8802: shared theme directory is handled appropriately and that the cache
8803: database is rebuilt:</p>
1.23 wiz 8804: <div class="orderedlist"><ol class="orderedlist" type="1">
8805: <li class="listitem"><p>Include
1.1 dsieger 8806: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 8807: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 8808: entry that refers to the theme cache.</p></li>
1.23 wiz 8809: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 8810: directories from the <code class="filename">share/icons/hicolor</code>
8811: hierarchy because they will be handled automatically.</p></li>
8812: </ol></div>
8813: <p>The best way to verify that the PLIST is correct with
8814: respect to the last two points is to regenerate it using
1.10 hubertf 8815: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 8816: </div>
1.41 asau 8817: <div class="sect2">
1.1 dsieger 8818: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8819: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 8820: <p>If a package installs <code class="filename">.desktop</code> files
8821: under <code class="filename">share/applications</code> and these include
1.53 rodent 8822: MIME information (MimeType key), you need to take extra steps to
8823: ensure that they are registered into the MIME database:</p>
1.23 wiz 8824: <div class="orderedlist"><ol class="orderedlist" type="1">
8825: <li class="listitem"><p>Include
1.1 dsieger 8826: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 8827: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 8828: <code class="filename">share/applications/mimeinfo.cache</code> file.
8829: It will be handled automatically.</p></li>
8830: </ol></div>
8831: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 8832: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 8833: print-PLIST</strong></span>.</p>
8834: </div>
8835: </div>
1.41 asau 8836: <div class="sect1">
1.1 dsieger 8837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8838: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 8839: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 8840: immediately. In this case, one can plainly mark a package as broken. For
8841: this, one just sets the variable <code class="varname">BROKEN</code> to the
8842: reason why the package is broken (similar to the
1.162 rillig 8843: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
1.22 jakllsch 8844: the package will immediately be shown this message, and the build
8845: will not be even tried.</p>
8846: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 8847: intervals.</p>
8848: </div>
8849: </div>
1.41 asau 8850: <div class="chapter">
1.1 dsieger 8851: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 8852: <a name="debug"></a>Chapter 22. Debugging</h2></div></div></div>
1.1 dsieger 8853: <p>To check out all the gotchas when building a package, here are
8854: the steps that I do in order to get a package working. Please note
8855: this is basically the same as what was explained in the previous
8856: sections, only with some debugging aids.</p>
1.41 asau 8857: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8858: <li class="listitem"><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
8859: <li class="listitem">
1.137 leot 8860: <p>Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.1 dsieger 8861: create a directory for a new package, change into it, then run
1.10 hubertf 8862: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 8863: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>mkdir /usr/pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>examplepkg</code></em></code></strong>
8864: <code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>examplepkg</code></em></code></strong>
8865: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
8866: </li>
1.23 wiz 8867: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
8868: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
8869: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
8870: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 8871: configure step to the package's
8872: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 8873: <li class="listitem">
1.1 dsieger 8874: <p>Make the package compile, doing multiple rounds of</p>
8875: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8876: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
8877: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
8878: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
8879: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
8880: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
8881: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
8882: <p>Doing this step as non-root user will ensure that no files
8883: are modified that shouldn't be, especially during the build
1.10 hubertf 8884: phase. <span class="command"><strong>mkpatches</strong></span>,
8885: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.137 leot 8886: from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.1 dsieger 8887: package.</p>
8888: </li>
1.23 wiz 8889: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
1.154 rillig 8890: necessary; see <a class="xref" href="#components.Makefile" title="13.1. Makefile">Section 13.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.23 wiz 8891: <li class="listitem">
1.1 dsieger 8892: <p>Generate a <code class="filename">PLIST</code>:</p>
8893: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8894: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
8895: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
8896: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8897: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
8898: <p>You usually need to be <code class="username">root</code> to do
8899: this. Look if there are any files left:</p>
8900: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8901: <p>If this reveals any files that are missing in
8902: <code class="filename">PLIST</code>, add them.</p>
8903: </li>
1.23 wiz 8904: <li class="listitem">
1.1 dsieger 8905: <p>Now that the <code class="filename">PLIST</code> is OK, install the
8906: package again and make a binary package:</p>
8907: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
8908: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
8909: </li>
1.23 wiz 8910: <li class="listitem">
1.1 dsieger 8911: <p>Delete the installed package:</p>
8912: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
8913: </li>
1.23 wiz 8914: <li class="listitem">
1.10 hubertf 8915: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 8916: command, which shouldn't find anything now:</p>
8917: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8918: </li>
1.23 wiz 8919: <li class="listitem">
1.1 dsieger 8920: <p>Reinstall the binary package:</p>
8921: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
8922: </li>
1.23 wiz 8923: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
8924: <li class="listitem">
1.137 leot 8925: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.1 dsieger 8926: reports:</p>
8927: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
8928: </li>
1.154 rillig 8929: <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a>.</p></li>
1.1 dsieger 8930: </ul></div>
8931: </div>
1.41 asau 8932: <div class="chapter">
1.1 dsieger 8933: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 8934: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 8935: <div class="toc">
8936: <p><b>Table of Contents</b></p>
1.100 leot 8937: <dl class="toc">
1.154 rillig 8938: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
8939: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
8940: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
8941: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
8942: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
8943: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
8944: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
8945: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 8946: </dl>
8947: </div>
1.41 asau 8948: <div class="sect1">
1.1 dsieger 8949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8950: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 8951: <p>Our policy is that we accept binaries only from pkgsrc
8952: developers to guarantee that the packages don't contain any
8953: trojan horses etc. This is not to annoy anyone but rather to
8954: protect our users! You're still free to put up your home-made
8955: binary packages and tell the world where to get them. NetBSD
8956: developers doing bulk builds and wanting to upload them please
1.154 rillig 8957: 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 8958: builds)</i></a>.</p>
1.1 dsieger 8959: </div>
1.41 asau 8960: <div class="sect1">
1.1 dsieger 8961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8962: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 8963: <p>First, check that your package is complete, compiles and
1.154 rillig 8964: runs well; see <a class="xref" href="#debug" title="Chapter 22. Debugging">Chapter 22, <i>Debugging</i></a> and the rest of this
1.167 leot 8965: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1 dsieger 8966: archive that contains all files that make up the package.
8967: Finally, send this package to the pkgsrc bug tracking system,
1.167 leot 8968: either with the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1 dsieger 8969: that, go to the web page
1.10 hubertf 8970: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.21 snj 8971: which contains some instructions and a link to a form where you
8972: can submit packages. The
1.137 leot 8973: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.21 snj 8974: also available as a substitute for either of the above two tools.
8975: </p>
1.1 dsieger 8976: <p>In the form of the problem report, the category should be
1.23 wiz 8977: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 8978: and version number, and the description field should contain a
8979: short description of your package (contents of the COMMENT
8980: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 8981: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 8982: <p>If you want to submit several packages, please send a
8983: separate PR for each one, it's easier for us to track things
8984: that way.</p>
8985: <p>Alternatively, you can also import new packages into
1.23 wiz 8986: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.105 wiz 8987: homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1 dsieger 8988: for details.</p>
8989: </div>
1.41 asau 8990: <div class="sect1">
1.1 dsieger 8991: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8992: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 8993: <p>Please note all package additions, updates, moves, and
8994: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
8995: important to keep this file up to date and conforming to the
8996: existing format, because it will be used by scripts to
1.10 hubertf 8997: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 8998: sites. Additionally, check the
8999: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9000: for the package you updated or removed, in case it was mentioned
9001: there.</p>
9002: <p>When the <code class="varname">PKGREVISION</code> of a package is
9003: bumped, the change should appear in
9004: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9005: related or otherwise relevant. Mass bumps that result from a
9006: dependency being updated should not be mentioned. In all other
9007: cases it's the developer's decision.</p>
9008: <p>There is a make target that helps in creating proper
1.10 hubertf 9009: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9010: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9011: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9012: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9013: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9014: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9015: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9016: For new packages, or package moves or removals, set the
9017: <code class="varname">CTYPE</code> variable on the command line to "Added",
9018: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9019: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9020: not the same as your NetBSD login name. The target also automatically
9021: removes possibly existing entries for the package in the
9022: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 9023: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 9024: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9025: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9026: makes the cvs commands use the main repository.
9027: </p>
1.1 dsieger 9028: </div>
1.41 asau 9029: <div class="sect1">
1.1 dsieger 9030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9031: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 9032: <p>For several years, there have been mirrors of pkgsrc in
9033: fossil, git, and hg. Standard practise when using these tools is to
9034: make the first line of a commit message function as a summary that
9035: can be read without the rest, such as is commonly done with "git log
9036: --oneline". For this reason, we have the following guidelines for
9037: pkgsrc commit messages:</p>
9038: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9039: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 9040: big picture in 65 characters or less. When a commit is for one
1.130 wiz 9041: package, include the name of the package. For updates, include the
9042: version to which it is updated.</p></li>
9043: <li class="listitem"><p>Leave the next line empty.</p></li>
9044: <li class="listitem"><p>Then come the details for the commit (changes in that
9045: package, reason for a change) and any relevant PRs. Wrap this
9046: section.</p></li>
9047: </ul></div>
9048: <p>Here is an example:
9049: </p>
9050: <pre class="programlisting">
9051: libxslt: update to 1.0.30
9052:
9053: Changes since 1.0.29:
9054: ...
9055: </pre>
9056: <p>
9057: </p>
9058: <p>Here is another example:
9059: </p>
9060: <pre class="programlisting">
9061: mk/bsd.pkg.mk: enable SSP by default on NetBSD
9062:
9063: (rationale)
9064: </pre>
9065: <p>
9066: </p>
9067: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
9068: allowed on the pkgsrc repository to change commit messages.</p>
9069: </div>
9070: <div class="sect1">
9071: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9072: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 9073: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 9074: access to the pkgsrc repository.</p>
9075: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9076: Start by adding the directory and then files in the directory. Don't
9077: forget to add the new package to the category's
9078: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9079: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9080: <pre class="programlisting">
9081: <code class="prompt">$</code> cd .../pkgsrc/category
9082: <code class="prompt">$</code> cvs add pkgname
9083: <code class="prompt">$</code> cd pkgname
9084: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9085: <code class="prompt">$</code> cvs add patches/p*
9086: <code class="prompt">$</code> cvs status | less
1.34 wiz 9087: <code class="prompt">$</code> cvs commit
1.33 wiz 9088: <code class="prompt">$</code> cd ..
9089: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 9090: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 9091: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 9092: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 9093: </pre>
1.1 dsieger 9094: <p>The commit message of the initial import should include part of the
9095: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9096: what the package is/does.</p>
1.33 wiz 9097: <p>Also mention the new package in
9098: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9099: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9100: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 9101: </div>
1.41 asau 9102: <div class="sect1">
1.1 dsieger 9103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9104: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9105: <p>Please always put a concise, appropriate and relevant summary of the
9106: changes between old and new versions into the commit log when updating
9107: a package. There are various reasons for this:</p>
1.41 asau 9108: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9109: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 9110: or its information may be overwritten by newer information.</p></li>
1.23 wiz 9111: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9112: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 9113: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9114: repository is very useful for people who read the pkgsrc-changes mailing
9115: list, so that they can make tactical decisions about when to upgrade
9116: the package.</p></li>
9117: </ul></div>
9118: <p>Please also recognize that, just because a new version of a package
9119: has been released, it should not automatically be upgraded in the CVS
9120: repository. We prefer to be conservative in the packages that are
9121: included in pkgsrc - development or beta packages are not really the
9122: best thing for most places in which pkgsrc is used. Please use your
9123: judgement about what should go into pkgsrc, and bear in mind that
9124: stability is to be preferred above new and possibly untested features.</p>
9125: </div>
1.41 asau 9126: <div class="sect1">
1.1 dsieger 9127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9128: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 9129: <p>Renaming packages is not recommended.</p>
9130: <p>When renaming packages, be sure to fix any references to old name
9131: in other Makefiles, options, buildlink files, etc.</p>
1.167 leot 9132: <p>
9133: Also when renaming a package, please add
9134: the package name and version pattern(s) of the previous package
9135: to <code class="varname">SUPERSEDES</code>.
1.20 snj 9136: This may be repeated for multiple renames.
9137: The new package would be an exact replacement.
1.167 leot 9138: Example:
1.20 snj 9139: </p>
1.167 leot 9140: <pre class="programlisting">
9141: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
9142: SUPERSEDES+= optcomp-[0-9]*
9143: </pre>
1.23 wiz 9144: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 9145: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9146: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9147: not be an exact replacement but is a suggestion for the replaced
9148: functionality.</p>
9149: </div>
1.41 asau 9150: <div class="sect1">
1.20 snj 9151: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9152: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 9153: <p>It is preferred that packages are not renamed or moved, but if needed
9154: please follow these steps.
9155: </p>
1.23 wiz 9156: <div class="orderedlist"><ol class="orderedlist" type="1">
9157: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9158: <li class="listitem">
1.1 dsieger 9159: <p>Remove all CVS dirs.</p>
9160: <p>Alternatively to the first two steps you can also do:</p>
9161: <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>
9162: <p>and use that for further work.</p>
9163: </li>
1.23 wiz 9164: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9165: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9166: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9167: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 9168: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9169: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9170: for doing an update using pkgsrc building; for example, it can
1.167 leot 9171: search the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20 snj 9172: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9173: new <code class="varname">PKGPATH</code> for that moved package. Note that
9174: it may have multiple matches, so the tool should also check on the
9175: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9176: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9177: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 9178: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9179: place.</p></li>
1.23 wiz 9180: <li class="listitem">
1.1 dsieger 9181: <p>Check if any package depends on it:
9182: </p>
9183: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9184: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9185: </li>
1.23 wiz 9186: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9187: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9188: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9189: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9190: <li class="listitem">
1.1 dsieger 9191: <p>Commit the changed and removed files:</p>
9192: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9193: <p>(and any packages from step 5, of course).</p>
9194: </li>
9195: </ol></div>
9196: </div>
9197: </div>
1.41 asau 9198: <div class="chapter">
1.1 dsieger 9199: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9200: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9201: <p>This section contains the answers to questions that may
9202: arise when you are writing a package. If you don't find your
9203: question answered here, first have a look in the other chapters,
9204: and if you still don't have the answer, ask on the
9205: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9206: <div class="qandaset">
1.173 ! rillig 9207: <a name="idm79483792"></a><dl>
1.154 rillig 9208: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9209: MAKEFLAGS, .MAKEFLAGS and
9210: MAKE_FLAGS?</a>
9211: </dt>
1.154 rillig 9212: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9213: MAKE, GMAKE and
9214: MAKE_PROGRAM?</a>
9215: </dt>
1.154 rillig 9216: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9217: CC, PKG_CC and
9218: PKGSRC_COMPILER?</a>
9219: </dt>
1.154 rillig 9220: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9221: BUILDLINK_LDFLAGS,
9222: BUILDLINK_LDADD and
9223: BUILDLINK_LIBS?</a>
9224: </dt>
1.154 rillig 9225: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9226: VARNAME=BUILDLINK_PREFIX.foo
9227: say it's empty?</a>
9228: </dt>
1.154 rillig 9229: <dt>24.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9230: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9231: don't understand the := inside
9232: it.</a>
9233: </dt>
1.154 rillig 9234: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9235: developers?</a>
9236: </dt>
1.154 rillig 9237: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9238: documentation?</a>
9239: </dt>
1.154 rillig 9240: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9241: do?</a>
9242: </dt>
9243: </dl>
1.41 asau 9244: <table border="0" style="width: 100%;">
9245: <colgroup>
1.1 dsieger 9246: <col align="left" width="1%">
1.23 wiz 9247: <col>
1.41 asau 9248: </colgroup>
1.1 dsieger 9249: <tbody>
1.41 asau 9250: <tr class="question">
1.1 dsieger 9251: <td align="left" valign="top">
1.173 ! rillig 9252: <a name="devfaq.makeflags"></a><a name="idm79483408"></a><p><b>24.1.</b></p>
1.1 dsieger 9253: </td>
9254: <td align="left" valign="top"><p>What is the difference between
9255: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9256: <code class="varname">MAKE_FLAGS</code>?</p></td>
9257: </tr>
9258: <tr class="answer">
9259: <td align="left" valign="top"></td>
9260: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.167 leot 9261: to the pkgsrc-internal invocations of <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1 dsieger 9262: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9263: the <code class="varname">MAKE_PROGRAM</code> when building the
9264: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9265: </tr>
1.41 asau 9266: <tr class="question">
1.1 dsieger 9267: <td align="left" valign="top">
1.173 ! rillig 9268: <a name="devfaq.make"></a><a name="idm79479440"></a><p><b>24.2.</b></p>
1.1 dsieger 9269: </td>
9270: <td align="left" valign="top"><p>What is the difference between
9271: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9272: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9273: </tr>
9274: <tr class="answer">
9275: <td align="left" valign="top"></td>
9276: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.167 leot 9277: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1 dsieger 9278: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9279: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9280: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9281: Make program that is used for building the
9282: package.</p></td>
9283: </tr>
1.41 asau 9284: <tr class="question">
1.1 dsieger 9285: <td align="left" valign="top">
1.173 ! rillig 9286: <a name="devfaq.cc"></a><a name="idm79474960"></a><p><b>24.3.</b></p>
1.1 dsieger 9287: </td>
9288: <td align="left" valign="top"><p>What is the difference between
9289: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9290: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9291: </tr>
9292: <tr class="answer">
9293: <td align="left" valign="top"></td>
9294: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9295: compiler, which can be configured by the pkgsrc user.
9296: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9297: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9298: path to a compiler, but the type of compiler that should be
9299: used. See <code class="filename">mk/compiler.mk</code> for more
9300: information about the latter variable.</p></td>
9301: </tr>
1.41 asau 9302: <tr class="question">
1.1 dsieger 9303: <td align="left" valign="top">
1.173 ! rillig 9304: <a name="devfaq.bl3flags"></a><a name="idm79470864"></a><p><b>24.4.</b></p>
1.1 dsieger 9305: </td>
9306: <td align="left" valign="top"><p>What is the difference between
9307: <code class="varname">BUILDLINK_LDFLAGS</code>,
9308: <code class="varname">BUILDLINK_LDADD</code> and
9309: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9310: </tr>
9311: <tr class="answer">
9312: <td align="left" valign="top"></td>
9313: <td align="left" valign="top"><p>[FIXME]</p></td>
9314: </tr>
1.41 asau 9315: <tr class="question">
1.1 dsieger 9316: <td align="left" valign="top">
1.173 ! rillig 9317: <a name="devfaq.bl3prefix"></a><a name="idm79468560"></a><p><b>24.5.</b></p>
1.1 dsieger 9318: </td>
1.10 hubertf 9319: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9320: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9321: say it's empty?</p></td>
9322: </tr>
9323: <tr class="answer">
9324: <td align="left" valign="top"></td>
9325: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 9326: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9327: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 9328: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 9329: command.</p></td>
9330: </tr>
1.41 asau 9331: <tr class="question">
1.1 dsieger 9332: <td align="left" valign="top">
1.173 ! rillig 9333: <a name="devfaq.master_sites"></a><a name="idm79465488"></a><p><b>24.6.</b></p>
1.1 dsieger 9334: </td>
9335: <td align="left" valign="top"><p>What does
1.108 rillig 9336: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9337: don't understand the <code class="code">:=</code> inside
1.1 dsieger 9338: it.</p></td>
9339: </tr>
9340: <tr class="answer">
9341: <td align="left" valign="top"></td>
1.108 rillig 9342: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
9343: assignment operator, although it looks like it.
1.1 dsieger 9344: Instead, it is a degenerate form of
1.108 rillig 9345: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.167 leot 9346: which is documented in the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.108 rillig 9347: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 9348: case of <code class="varname">MASTER_SITE_*</code>,
9349: <em class="replaceable"><code>old_string</code></em> is the empty string and
9350: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 9351: <code class="code">package/</code>. That's where the
9352: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 9353: together.</p></td>
9354: </tr>
1.41 asau 9355: <tr class="question">
1.1 dsieger 9356: <td align="left" valign="top">
1.173 ! rillig 9357: <a name="devfaq.mailinglists"></a><a name="idm79458576"></a><p><b>24.7.</b></p>
1.1 dsieger 9358: </td>
9359: <td align="left" valign="top"><p>Which mailing lists are there for package
9360: developers?</p></td>
9361: </tr>
9362: <tr class="answer">
9363: <td align="left" valign="top"></td>
1.41 asau 9364: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 9365: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1 dsieger 9366: <dd><p>This is a list for technical discussions related
9367: to pkgsrc development, e.g. soliciting feedback for changes to
9368: pkgsrc infrastructure, proposed new features, questions related
9369: to porting pkgsrc to a new platform, advice for maintaining a
9370: package, patches that affect many packages, help requests moved
9371: from pkgsrc-users when an infrastructure bug is found,
9372: etc.</p></dd>
1.10 hubertf 9373: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1 dsieger 9374: <dd><p>All bug reports in category "pkg" sent with
1.167 leot 9375: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.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 9376: directly; use one of the other mailing
9377: lists.</p></dd>
9378: </dl></div></td>
9379: </tr>
1.41 asau 9380: <tr class="question">
1.1 dsieger 9381: <td align="left" valign="top">
1.173 ! rillig 9382: <a name="devfaq.documentation"></a><a name="idm79454864"></a><p><b>24.8.</b></p>
1.1 dsieger 9383: </td>
9384: <td align="left" valign="top"><p>Where is the pkgsrc
9385: documentation?</p></td>
9386: </tr>
9387: <tr class="answer">
9388: <td align="left" valign="top"></td>
9389: <td align="left" valign="top">
9390: <p>There are many places where you can find
9391: documentation about pkgsrc:</p>
1.41 asau 9392: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9393: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9394: of chapters that explain large parts of pkgsrc, but some
9395: chapters tend to be outdated. Which ones they are is hard to
9396: say.</p></li>
1.23 wiz 9397: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.1 dsieger 9398: about certain features, announcements of new parts of the pkgsrc
9399: infrastructure and sometimes even announcements that a certain
9400: feature has been marked as obsolete. The benefit here is that
9401: each message has a date appended to it.</p></li>
1.23 wiz 9402: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9403: <code class="filename">mk/</code> directory start with a comment that
9404: describes the purpose of the file and how it can be used by the
9405: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9406: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9407: help</strong></span>.</p></li>
1.23 wiz 9408: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9409: information, but they tend to be highly abbreviated, especially
9410: for actions that occur often. Some contain a detailed
9411: description of what has changed, but they are geared towards the
9412: other pkgsrc developers, not towards an average pkgsrc user.
9413: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9414: don't know what has been before, these messages may not be worth
9415: too much to you.</p></li>
1.23 wiz 9416: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9417: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9418: mind of the developer who wrote the code. To get this
1.10 hubertf 9419: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9420: to see who has written it and ask on the
9421: <code class="literal">tech-pkg</code> mailing list, so that others can
9422: find your questions later (see above). To be sure that the
9423: developer in charge reads the mail, you may CC him or
9424: her.</p></li>
9425: </ul></div>
9426: </td>
9427: </tr>
1.41 asau 9428: <tr class="question">
1.1 dsieger 9429: <td align="left" valign="top">
1.173 ! rillig 9430: <a name="devfaq.too-much-time"></a><a name="idm79448336"></a><p><b>24.9.</b></p>
1.1 dsieger 9431: </td>
9432: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9433: do?</p></td>
9434: </tr>
9435: <tr class="answer">
9436: <td align="left" valign="top"></td>
9437: <td align="left" valign="top">
9438: <p>This is not really an FAQ yet, but here's the answer
9439: anyway.</p>
1.41 asau 9440: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9441: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.137 leot 9442: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.1 dsieger 9443: will tell you about newer versions of installed packages that are
9444: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9445: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9446: — it contains a list of suggested new packages and a list of
1.1 dsieger 9447: cleanups and enhancements for pkgsrc that would be nice to
9448: have.</p></li>
1.23 wiz 9449: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9450: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9451: mailing list.</p></li>
9452: </ul></div>
9453: </td>
9454: </tr>
9455: </tbody>
9456: </table>
9457: </div>
9458: </div>
1.41 asau 9459: <div class="chapter">
1.1 dsieger 9460: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9461: <a name="gnome"></a>Chapter 25. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9462: <div class="toc">
9463: <p><b>Table of Contents</b></p>
1.100 leot 9464: <dl class="toc">
1.154 rillig 9465: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
9466: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
9467: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
9468: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1 dsieger 9469: </dl>
9470: </div>
1.10 hubertf 9471: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9472: site</a>:</p>
9473: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9474: environment, an intuitive and attractive desktop for users, and the
9475: GNOME development platform, an extensive framework for building
9476: applications that integrate into the rest of the desktop.</p></blockquote></div>
9477: <p>pkgsrc provides a seamless way to automatically build and install
9478: a complete GNOME environment <span class="emphasis"><em>under many different
9479: platforms</em></span>. We can say with confidence that pkgsrc is one of
9480: the most advanced build and packaging systems for GNOME due to its
9481: included technologies buildlink3, the wrappers and tools framework and
9482: automatic configuration file management. Lots of efforts are put into
9483: achieving a completely clean deinstallation of installed software
9484: components.</p>
1.10 hubertf 9485: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9486: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9487: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9488: pkgsrc as its preferred packaging system, contributing lots of
9489: portability fixes to make GNOME build and install under it.</p>
9490: <p>This chapter is aimed at pkgsrc developers and other people
9491: interested in helping our GNOME porting and packaging efforts. It
9492: provides instructions on how to manage the existing packages and some
9493: important information regarding their internals.</p>
1.41 asau 9494: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9495: <h3 class="title">We need your help!</h3>
9496: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9497: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9498: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9499: work</a> list! There is still a long way to go to get a
9500: fully-functional GNOME desktop under NetBSD and we need your help to
9501: achieve it!</p>
9502: </div>
1.41 asau 9503: <div class="sect1">
1.1 dsieger 9504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9505: <a name="meta-packages"></a>25.1. Meta packages</h2></div></div></div>
1.1 dsieger 9506: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9507: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 9508: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.1 dsieger 9509: the core GNOME desktop environment. It only includes the necessary
9510: bits to get it to boot correctly, although it may lack important
9511: functionality for daily operation. The idea behind this package is
9512: to let end users build their own configurations on top of this one,
9513: first installing this meta package to achieve a functional setup and
9514: then adding individual applications.</p></li>
1.137 leot 9515: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.1 dsieger 9516: complete installation of the GNOME platform and desktop as defined
9517: by the GNOME project; this is based on the components distributed in
9518: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9519: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9520: official FTP server. Developer-only tools found in those
9521: directories are not installed unless required by some other
9522: component to work properly. Similarly, packages from the bindings
9523: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9524: in unless required as a dependency for an end-user component. This
1.137 leot 9525: package "extends" <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
9526: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.1 dsieger 9527: Installs all the tools required to build a GNOME component when
9528: fetched from the CVS repository. These are required to let the
1.10 hubertf 9529: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9530: </ul></div>
9531: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9532: sorted in a way that eases updates: a package may depend on other
9533: packages listed before it but not on any listed after it. It is very
9534: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9535: change it to alphabetical sorting!</em></span></p>
9536: </div>
1.41 asau 9537: <div class="sect1">
1.1 dsieger 9538: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9539: <a name="new-package"></a>25.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9540: <p>Almost all GNOME applications are written in C and use a common
9541: set of tools as their build system. Things get different with the new
9542: bindings to other languages (such as Python), but the following will
9543: give you a general idea on the minimum required tools:</p>
1.41 asau 9544: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9545: <li class="listitem">
1.1 dsieger 9546: <p>Almost all GNOME applications use the GNU Autotools as their
9547: build system. As a general rule you will need to tell this to your
9548: package:</p>
9549: <pre class="programlisting">
9550: GNU_CONFIGURE=yes
9551: USE_LIBTOOL=yes
9552: USE_TOOLS+=gmake
9553: </pre>
9554: </li>
1.23 wiz 9555: <li class="listitem">
1.1 dsieger 9556: <p>If the package uses pkg-config to detect dependencies, add this
9557: tool to the list of required utilities:</p>
1.111 sevan 9558: <pre class="programlisting">
9559: USE_TOOLS+=pkg-config
9560: </pre>
1.137 leot 9561: <p>Also use <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.1 dsieger 9562: the end of the build process to ensure that you did not miss to
9563: specify any dependency in your package and that the version
9564: requirements are all correct.</p>
9565: </li>
1.23 wiz 9566: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9567: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9568: to handle dependencies and to force the package to use the latest
9569: available version.</p></li>
1.23 wiz 9570: <li class="listitem">
1.1 dsieger 9571: <p>If the package uses gtk-doc (a documentation generation
9572: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9573: tool is rather big and the distfile should come with pregenerated
9574: documentation anyway; if it does not, it is a bug that you ought to
9575: report. For such packages you should disable gtk-doc (unless it is
9576: the default):</p>
1.111 sevan 9577: <pre class="programlisting">
9578: CONFIGURE_ARGS+=--disable-gtk-doc
9579: </pre>
1.1 dsieger 9580: <p>The default location of installed HTML files
9581: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9582: and should not be changed unless the package insists on installing
9583: them somewhere else. Otherwise programs as
1.10 hubertf 9584: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9585: do that with an entry similar to:</p>
1.111 sevan 9586: <pre class="programlisting">
9587: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9588: </pre>
1.1 dsieger 9589: </li>
9590: </ul></div>
9591: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9592: files under the installation prefix to maintain databases. In this
9593: context, shared means that those exact same directories and files are
9594: used among several different packages, leading to conflicts in the
9595: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9596: handle the most common cases, so you have to forget about using
9597: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9598: omitting shared files from them. If you find yourself doing those,
9599: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9600: <p>The following table lists the common situations that result in
9601: using shared directories or files. For each of them, the appropriate
9602: solution is given. After applying the solution be sure to
9603: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9604: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9605: <div class="table">
1.154 rillig 9606: <a name="plist-handling"></a><p class="title"><b>Table 25.1. PLIST handling for GNOME packages</b></p>
1.106 tnn 9607: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1 dsieger 9608: <colgroup>
9609: <col>
9610: <col>
9611: </colgroup>
9612: <thead><tr>
9613: <th>If the package...</th>
9614: <th>Then...</th>
9615: </tr></thead>
9616: <tbody>
9617: <tr>
9618: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.154 rillig 9619: <td>See <a class="xref" href="#scrollkeeper-data-files" title="21.6.10. Packages installing scrollkeeper/rarian data files">Section 21.6.10, “Packages installing scrollkeeper/rarian data files”</a>.</td>
1.1 dsieger 9620: </tr>
9621: <tr>
9622: <td>Installs icons under the
9623: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9624: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.154 rillig 9625: <td>See <a class="xref" href="#hicolor-theme" title="21.6.19. Packages installing hicolor theme icons">Section 21.6.19, “Packages installing hicolor theme icons”</a>.</td>
1.1 dsieger 9626: </tr>
9627: <tr>
9628: <td>Installs files under
9629: <code class="filename">share/mime/packages</code>.</td>
1.154 rillig 9630: <td>See <a class="xref" href="#mime-database" title="21.6.14. Packages installing extensions to the MIME database">Section 21.6.14, “Packages installing extensions to the MIME database”</a>.</td>
1.1 dsieger 9631: </tr>
9632: <tr>
9633: <td>Installs <code class="filename">.desktop</code> files under
9634: <code class="filename">share/applications</code> and these include MIME
9635: information.</td>
1.154 rillig 9636: <td>See <a class="xref" href="#desktop-files" title="21.6.20. Packages installing desktop files">Section 21.6.20, “Packages installing desktop files”</a>.</td>
1.1 dsieger 9637: </tr>
9638: </tbody>
9639: </table></div>
9640: </div>
9641: <br class="table-break">
9642: </div>
1.41 asau 9643: <div class="sect1">
1.1 dsieger 9644: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9645: <a name="full-update"></a>25.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9646: <p>When seeing GNOME as a whole, there are two kinds of
9647: updates:</p>
1.41 asau 9648: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9649: <dt><span class="term">Major update</span></dt>
9650: <dd>
9651: <p>Given that there is still a very long way for GNOME 3 (if it
9652: ever appears), we consider a major update one that goes from a
9653: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9654: where <code class="literal">Y</code> is even and greater than
9655: <code class="literal">X</code>. These are hard to achieve because they
9656: introduce lots of changes in the components' code and almost all
9657: GNOME distfiles are updated to newer versions. Some of them can
9658: even break API and ABI compatibility with the previous major
9659: version series. As a result, the update needs to be done all at
9660: once to minimize breakage.</p>
9661: <p>A major update typically consists of around 80 package
9662: updates and the addition of some new ones.</p>
9663: </dd>
9664: <dt><span class="term">Minor update</span></dt>
9665: <dd>
9666: <p>We consider a minor update one that goes from a
9667: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9668: one where <code class="literal">Y</code> is greater than
9669: <code class="literal">X</code>. These are easy to achieve because they do
9670: not update all GNOME components, can be done in an incremental way
9671: and do not break API nor ABI compatibility.</p>
9672: <p>A minor update typically consists of around 50 package
9673: updates, although the numbers here may vary a lot.</p>
9674: </dd>
9675: </dl></div>
9676: <p>In order to update the GNOME components in pkgsrc to a new stable
9677: release (either major or minor), the following steps should be
9678: followed:</p>
1.23 wiz 9679: <div class="orderedlist"><ol class="orderedlist" type="1">
9680: <li class="listitem">
1.1 dsieger 9681: <p>Get a list of all the tarballs that form the new release by
9682: using the following commands. These will leave the full list of the
1.18 snj 9683: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 9684: file:</p>
9685: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9686: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9687: awk '{ print $9 }' >list.txt</code></strong>
9688: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9689: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9690: awk '{ print $9 }' >>list.txt</code></strong></pre>
9691: </li>
1.23 wiz 9692: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 9693: bump their version to the release you are updating them to. The
9694: three meta packages should be always consistent with versioning.
9695: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9696: in them.</p></li>
1.23 wiz 9697: <li class="listitem">
1.1 dsieger 9698: <p>For each meta package, update all its
9699: <code class="varname">DEPENDS</code> lines to match the latest versions as
9700: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9701: newer version (even if found in the FTP) because the meta packages
9702: are supposed to list the exact versions that form a specific GNOME
9703: release. Exceptions are permitted here if a newer version solves a
9704: serious issue in the overall desktop experience; these typically
9705: come in the form of a revision bump in pkgsrc, not in newer versions
9706: from the developers.</p>
9707: <p>Packages not listed in the <code class="filename">list.txt</code> file
9708: should be updated to the latest version available (if found in
9709: pkgsrc). This is the case, for example, of the dependencies on the
1.137 leot 9710: GNU Autotools in the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.1 dsieger 9711: </li>
1.23 wiz 9712: <li class="listitem">
1.1 dsieger 9713: <p>Generate a patch from the modified meta packages and extract the
9714: list of "new" lines. This will provide you an outline on what
9715: packages need to be updated in pkgsrc and in what order:</p>
9716: <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>
9717: </li>
1.23 wiz 9718: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 9719: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 9720: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 9721: of <code class="filename">todo.txt</code> and update the packages listed in
9722: it in order. For major desktop updates none of these should be
9723: committed until the entire set is completed because there are chances
9724: of breaking not-yet-updated packages.</p></li>
1.23 wiz 9725: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 9726: the tree one by one with appropriate log messages. At the end,
9727: commit the three meta package updates and all the corresponding
9728: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9729: <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>
9730: </ol></div>
9731: </div>
1.41 asau 9732: <div class="sect1">
1.1 dsieger 9733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9734: <a name="patching"></a>25.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9735: <p>GNOME is a very big component in pkgsrc which approaches 100
9736: packages. Please, it is very important that you always, always,
9737: <span class="strong"><strong>always</strong></span> feed back any portability
1.154 rillig 9738: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="13.3.5. Feedback to the author">Section 13.3.5, “Feedback to the author”</a>). This is the only way to get
1.1 dsieger 9739: their attention on portability issues and to ensure that future versions
9740: can be built out-of-the box on NetBSD. The less custom patches in
9741: pkgsrc, the easier further updates are. Those developers in charge of
9742: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9743: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.1 dsieger 9744: Bugzilla</a>. Not all components use these to track bugs, but most
9745: of them do. Do not be short on your reports: always provide detailed
9746: explanations of the current failure, how it can be improved to achieve
9747: maximum portability and, if at all possible, provide a patch against CVS
9748: head. The more verbose you are, the higher chances of your patch being
9749: accepted.</p>
9750: <p>Also, please avoid using preprocessor magic to fix portability
9751: issues. While the FreeBSD GNOME people are doing a great job in porting
9752: GNOME to their operating system, the official GNOME sources are now
9753: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9754: and similar macros. This hurts portability. Please see our patching
1.154 rillig 9755: guidelines (<a class="xref" href="#components.patches.guidelines" title="13.3.4. Patching guidelines">Section 13.3.4, “Patching guidelines”</a>) for more
1.1 dsieger 9756: details.</p>
9757: </div>
9758: </div>
9759: </div>
1.41 asau 9760: <div class="part">
1.1 dsieger 9761: <div class="titlepage"><div><div><h1 class="title">
9762: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 9763: <div class="partintro">
1.1 dsieger 9764: <div></div>
9765: <p>This part of the guide deals with everything
9766: from the infrastructure that is behind the interfaces described
9767: in the developer's guide. A casual package maintainer should not
9768: need anything from this part.</p>
9769: <div class="toc">
9770: <p><b>Table of Contents</b></p>
1.100 leot 9771: <dl class="toc">
1.154 rillig 9772: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 9773: <dd><dl>
1.154 rillig 9774: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
9775: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
9776: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 9777: <dd><dl>
1.154 rillig 9778: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
9779: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 9780: </dl></dd>
1.154 rillig 9781: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
9782: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9783: <dd><dl>
1.154 rillig 9784: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
9785: <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 9786: </dl></dd>
1.154 rillig 9787: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9788: <dd><dl>
1.154 rillig 9789: <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>
9790: <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 9791: </dl></dd>
9792: </dl></dd>
1.154 rillig 9793: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1 dsieger 9794: <dd><dl>
1.154 rillig 9795: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
9796: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9797: <dd><dl>
1.154 rillig 9798: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
9799: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 9800: </dl></dd>
9801: </dl></dd>
1.154 rillig 9802: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
9803: <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 9804: </dl>
9805: </div>
9806: </div>
1.41 asau 9807: <div class="chapter">
1.1 dsieger 9808: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9809: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 9810: <div class="toc">
9811: <p><b>Table of Contents</b></p>
1.100 leot 9812: <dl class="toc">
1.154 rillig 9813: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
9814: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
9815: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 9816: <dd><dl>
1.154 rillig 9817: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
9818: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 9819: </dl></dd>
1.154 rillig 9820: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
9821: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9822: <dd><dl>
1.154 rillig 9823: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
9824: <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 9825: </dl></dd>
1.154 rillig 9826: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9827: <dd><dl>
1.154 rillig 9828: <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>
9829: <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 9830: </dl></dd>
9831: </dl>
9832: </div>
9833: <p>The pkgsrc infrastructure consists of many small Makefile
9834: fragments. Each such fragment needs a properly specified
9835: interface. This chapter explains how such an interface looks
9836: like.</p>
1.41 asau 9837: <div class="sect1">
1.1 dsieger 9838: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9839: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 9840: <p>Whenever a variable is defined in the pkgsrc
9841: infrastructure, the location and the way of definition provide
9842: much information about the intended use of that variable.
9843: Additionally, more documentation may be found in a header
9844: comment or in this pkgsrc guide.</p>
9845: <p>A special file is
9846: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9847: variables that are intended to be user-defined. They are either
9848: defined using the <code class="literal">?=</code> operator or they are
9849: left undefined because defining them to anything would
1.23 wiz 9850: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 9851: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9852: file.</p>
9853: <p>Outside this file, the following conventions apply:
9854: Variables that are defined using the <code class="literal">?=</code>
9855: operator may be overridden by a package.</p>
9856: <p>Variables that are defined using the <code class="literal">=</code>
9857: operator may be used read-only at run-time.</p>
9858: <p>Variables whose name starts with an underscore must not be
9859: accessed outside the pkgsrc infrastructure at all. They may
9860: change without further notice.</p>
1.41 asau 9861: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9862: <h3 class="title">Note</h3>
9863: <p>These conventions are currently not applied
9864: consistently to the complete pkgsrc
9865: infrastructure.</p>
9866: </div>
9867: </div>
1.41 asau 9868: <div class="sect1">
1.1 dsieger 9869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9870: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 9871: <p>All variables that contain lists of things should default
9872: to being empty. Two examples that do not follow this rule are
9873: <code class="varname">USE_LANGUAGES</code> and
9874: <code class="varname">DISTFILES</code>. These variables cannot simply be
9875: modified using the <code class="literal">+=</code> operator in package
9876: <code class="filename">Makefile</code>s (or other files included by
9877: them), since there is no guarantee whether the variable is
9878: already set or not, and what its value is. In the case of
1.23 wiz 9879: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 9880: the default value and just define it as in the following
9881: example.</p>
9882: <pre class="programlisting">
9883: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
9884: </pre>
9885: <p>Because of the selection of this default value, the same
9886: value appears in many package Makefiles. Similarly for
9887: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 9888: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 9889: doesn't stand out. Nevertheless it is mentioned in many
9890: files.</p>
9891: </div>
1.41 asau 9892: <div class="sect1">
1.1 dsieger 9893: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9894: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.41 asau 9895: <div class="sect2">
1.1 dsieger 9896: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9897: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.1 dsieger 9898: <p>Variable evaluation takes place either at load time or at
9899: runtime, depending on the context in which they occur. The
9900: contexts where variables are evaluated at load time are:</p>
1.41 asau 9901: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9902: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 9903: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 9904: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 9905: <code class="literal">.for</code>,</p></li>
1.23 wiz 9906: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 9907: </ul></div>
9908: <p>A special exception are references to the iteration
9909: variables of <code class="literal">.for</code> loops, which are expanded
9910: inline, no matter in which context they appear.</p>
9911: <p>As the values of variables may change during load time,
9912: care must be taken not to evaluate them by accident. Typical
9913: examples for variables that should not be evaluated at load time
9914: are <code class="varname">DEPENDS</code> and
9915: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9916: clear, here is an example:</p>
9917: <pre class="programlisting">
9918: CONFIGURE_ARGS= # none
9919: CFLAGS= -O
9920: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
9921:
9922: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
9923:
9924: CFLAGS+= -Wall
1.111 sevan 9925: </pre>
1.1 dsieger 9926: <p>This code shows how the use of the <code class="literal">:=</code>
9927: operator can quickly lead to unexpected results. The first
9928: paragraph is fairly common code. The second paragraph evaluates
9929: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9930: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9931: <code class="literal">-Wall</code> is appended to the
9932: <code class="varname">CFLAGS</code>, but this addition will not appear in
9933: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9934: paragraphs from above typically occur in completely unrelated
9935: files.</p>
9936: </div>
1.41 asau 9937: <div class="sect2">
1.1 dsieger 9938: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9939: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.1 dsieger 9940: <p>After all the files have been loaded, the values of the
9941: variables cannot be changed anymore. Variables that are used in
9942: the shell commands are expanded at this point.</p>
9943: </div>
9944: </div>
1.41 asau 9945: <div class="sect1">
1.1 dsieger 9946: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9947: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 9948: <p>There are many ways in which the definition and use of a
1.108 rillig 9949: variable can be restricted in order to detect bugs and violations
9950: of the (mostly unwritten) policies. A package can be checked with
9951: <code class="literal">pkglint -Wall</code> to see whether it meets these
9952: rules.</p>
1.1 dsieger 9953: </div>
1.41 asau 9954: <div class="sect1">
1.1 dsieger 9955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9956: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 9957: <p>Most of the <code class="filename">.mk</code> files fall into one
9958: of the following classes. Cases where a file falls into more
9959: than one class should be avoided as it often leads to subtle
9960: bugs.</p>
1.41 asau 9961: <div class="sect2">
1.1 dsieger 9962: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9963: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 9964: <p>In a traditional imperative programming language some of
9965: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 9966: procedures. They take some input parameters and—after
9967: inclusion—provide a result in output parameters. Since all
1.1 dsieger 9968: variables in <code class="filename">Makefile</code>s have global scope
9969: care must be taken not to use parameter names that have already
9970: another meaning. For example, <code class="varname">PKGNAME</code> is a
9971: bad choice for a parameter name.</p>
9972: <p>Procedures are completely evaluated at preprocessing time.
9973: That is, when calling a procedure all input parameters must be
9974: completely resolvable. For example,
9975: <code class="varname">CONFIGURE_ARGS</code> should never be an input
9976: parameter since it is very likely that further text will be
9977: added after calling the procedure, which would effectively apply
9978: the procedure to only a part of the variable. Also, references
1.108 rillig 9979: to other variables will be modified after calling the
1.1 dsieger 9980: procedure.</p>
9981: <p>A procedure can declare its output parameters either as
9982: suitable for use in preprocessing directives or as only
9983: available at runtime. The latter alternative is for variables
9984: that contain references to other runtime variables.</p>
9985: <p>Procedures shall be written such that it is possible to
9986: call the procedure more than once. That is, the file must not
9987: contain multiple-inclusion guards.</p>
9988: <p>Examples for procedures are
9989: <code class="filename">mk/bsd.options.mk</code> and
9990: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
9991: that the parameters are evaluated at load time, they should be
9992: assigned using the <code class="literal">:=</code> operator, which should
9993: be used only for this purpose.</p>
9994: </div>
1.41 asau 9995: <div class="sect2">
1.1 dsieger 9996: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9997: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 9998: <p>Action files take some input parameters and may define
9999: runtime variables. They shall not define loadtime variables.
10000: There are action files that are included implicitly by the
10001: pkgsrc infrastructure, while other must be included
10002: explicitly.</p>
10003: <p>An example for action files is
10004: <code class="filename">mk/subst.mk</code>.</p>
10005: </div>
10006: </div>
1.41 asau 10007: <div class="sect1">
1.1 dsieger 10008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10009: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10010: <p>Package <code class="filename">Makefile</code>s usually consist of
10011: a set of variable definitions, and include the file
10012: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10013: Before that, they may also include various other
10014: <code class="filename">*.mk</code> files if they need to query the
10015: availability of certain features like the type of compiler or
10016: the X11 implementation. Due to the heavy use of preprocessor
10017: directives like <code class="literal">.if</code> and
10018: <code class="literal">.for</code>, the order in which the files are loaded
10019: matters.</p>
10020: <p>This section describes at which point the various files
10021: are loaded and gives reasons for that order.</p>
1.41 asau 10022: <div class="sect2">
1.1 dsieger 10023: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10024: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10025: </h3></div></div></div>
10026: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10027: is to define some essential variables like
10028: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10029: <code class="varname">MACHINE_ARCH</code>.</p>
10030: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10031: 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 10032: After that, those variables
1.1 dsieger 10033: that have not been overridden by the user are loaded from
10034: <code class="filename">mk/defaults/mk.conf</code>.</p>
10035: <p>After the user settings, the system settings and platform
10036: settings are loaded, which may override the user
10037: settings.</p>
10038: <p>Then, the tool definitions are loaded. The tool wrappers
10039: are not yet in effect. This only happens when building a
10040: package, so the proper variables must be used instead of the
10041: direct tool names.</p>
10042: <p>As the last steps, some essential variables from the
10043: wrapper and the package system flavor are loaded, as well as the
10044: variables that have been cached in earlier phases of a package
10045: build.</p>
10046: </div>
1.41 asau 10047: <div class="sect2">
1.1 dsieger 10048: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10049: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10050: </h3></div></div></div>
10051: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10052: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10053: loaded, which fill default values for those variables that have
10054: not been defined by the package. These variables may later
10055: be used even in unrelated files.</p>
10056: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10057: provides the target <code class="literal">error-check</code> that is added
10058: as a special dependency to all other targets that use
10059: <code class="varname">DELAYED_ERROR_MSG</code> or
10060: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10061: <p>Then, the package-specific hacks from
10062: <code class="filename">hacks.mk</code> are included.</p>
10063: <p>Then, various other files follow. Most of them don't have
10064: any dependencies on what they need to have included before or
10065: after them, though some do.</p>
10066: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10067: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10068: restricts the use of these variables to all the files that have
10069: been included before. Appearances in later files will be
10070: silently ignored.</p>
10071: <p>Then, the files for the main targets are included, in the
10072: order of later execution, though the actual order should not
10073: matter.</p>
10074: <p>At last, some more files are included that don't set any
10075: interesting variables but rather just define make targets to be
10076: executed.</p>
10077: </div>
10078: </div>
10079: </div>
1.41 asau 10080: <div class="chapter">
1.1 dsieger 10081: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 10082: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.1 dsieger 10083: <div class="toc">
10084: <p><b>Table of Contents</b></p>
1.100 leot 10085: <dl class="toc">
1.154 rillig 10086: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
10087: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10088: <dd><dl>
1.154 rillig 10089: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
10090: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 10091: </dl></dd>
10092: </dl>
10093: </div>
10094: <p>The pkgsrc infrastructure consists of a large codebase,
10095: and there are many corners where every little bit of a file is
10096: well thought out, making pkgsrc likely to fail as soon as
10097: anything is changed near those parts. To prevent most changes
10098: from breaking anything, a suite of regression tests should go
10099: along with every important part of the pkgsrc infrastructure.
10100: This chapter describes how regression tests work in pkgsrc and
10101: how you can add new tests.</p>
1.41 asau 10102: <div class="sect1">
1.1 dsieger 10103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10104: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.137 leot 10105: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.10 hubertf 10106: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10107: can simply run that command, which will run all tests in the
1.168 rillig 10108: <code class="filename">regress/</code> directory.</p>
1.1 dsieger 10109: </div>
1.41 asau 10110: <div class="sect1">
1.1 dsieger 10111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10112: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.168 rillig 10113: <p>Every directory in the <code class="filename">regress/</code>
10114: directory that contains a file called <code class="filename">spec</code>
1.1 dsieger 10115: is considered a regression test. This file is a shell program
1.10 hubertf 10116: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10117: The following functions can be overridden to suit your
10118: needs.</p>
1.41 asau 10119: <div class="sect2">
1.1 dsieger 10120: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10121: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 10122: <p>These functions do not take any parameters. Although they
10123: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.168 rillig 10124: first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108 rillig 10125: question</a> for details.</p>
1.41 asau 10126: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10127: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 10128: <dd><p>This function prepares the environment for the
10129: test. By default it does nothing.</p></dd>
1.108 rillig 10130: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10131: <dd>
10132: <p>This function runs the actual test. By default,
1.1 dsieger 10133: it calls <code class="varname">TEST_MAKE</code> with the arguments
10134: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10135: error messages into the file
1.108 rillig 10136: <code class="varname">TEST_OUTFILE</code>.</p>
10137: <p>When defining this function, make sure that all output that
10138: needs to be checked is written to the correct output file.
10139: Example:</p>
10140: <pre class="programlisting">
10141: do_test() {
1.112 rillig 10142: echo "Example output"
1.108 rillig 10143: } 1>$TEST_OUTFILE 2>&1
10144: </pre>
10145: </dd>
10146: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10147: <dd>
10148: <p>This function is run after the test and is
1.1 dsieger 10149: typically used to compare the actual output from the one that is
10150: expected. It can make use of the various helper functions from
1.108 rillig 10151: the next section. Example:</p>
10152: <pre class="programlisting">
10153: check_result() {
1.112 rillig 10154: exit_status 0
10155: output_require "Example"
10156: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10157: output_prohibit "no such file or directory"
1.168 rillig 10158: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 10159: }
10160: </pre>
10161: </dd>
10162: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 10163: <dd><p>This function cleans everything up after the
10164: test has been run. By default it does nothing.</p></dd>
10165: </dl></div>
10166: </div>
1.41 asau 10167: <div class="sect2">
1.1 dsieger 10168: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10169: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.41 asau 10170: <div class="variablelist"><dl class="variablelist">
1.168 rillig 10171: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10172: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108 rillig 10173: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 10174: <dd><p>This function compares the exitcode of the
1.108 rillig 10175: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 10176: If they differ, the test will fail.</p></dd>
1.108 rillig 10177: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10178: <dd>
10179: <p>This function checks for each of its parameters
10180: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 10181: extended regular expression. If it does not, the test will
1.108 rillig 10182: fail. Example:</p>
10183: <pre class="programlisting">
10184: output_require "looks fine"
10185: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10186: </pre>
10187: </dd>
1.1 dsieger 10188: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10189: <dd><p>This function checks for each of its parameters
1.10 hubertf 10190: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10191: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10192: If any of the regular expressions matches, the test will
10193: fail.</p></dd>
10194: </dl></div>
10195: </div>
10196: </div>
10197: </div>
1.41 asau 10198: <div class="chapter">
1.1 dsieger 10199: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 10200: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10201: <div class="toc">
10202: <p><b>Table of Contents</b></p>
1.154 rillig 10203: <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 10204: </div>
10205: <p>The pkgsrc system has already been ported to many
10206: operating systems, hardware architectures and compilers. This
10207: chapter explains the necessary steps to make pkgsrc even more
10208: portable.</p>
1.41 asau 10209: <div class="sect1">
1.1 dsieger 10210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10211: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10212: <p>To port pkgsrc to a new operating system (called
10213: <code class="literal">MyOS</code> in this example), you need to touch the
10214: following files:</p>
1.41 asau 10215: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10216: <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>
10217: <dd><p>This file contains some basic definitions, for
10218: example the name of the C
10219: compiler.</p></dd>
10220: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10221: <dd><p>Insert code that defines the variables
10222: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10223: <code class="varname">LOWER_OS_VERSION</code>,
10224: <code class="varname">LOWER_VENDOR</code>,
10225: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10226: <code class="varname">APPEND_ELF</code>, and the other variables that
10227: appear in this file.</p></dd>
10228: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10229: <dd><p>This file contains the platform-specific
10230: definitions that are used by pkgsrc. Start by copying one of the
10231: other files and edit it to your
10232: needs.</p></dd>
10233: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10234: <dd><p>This file defines the paths to all the tools
10235: that are needed by one or the other package in pkgsrc, as well
10236: as by pkgsrc itself. Find out where these tools are on your
10237: platform and add them.</p></dd>
10238: </dl></div>
10239: <p>Now, you should be able to build some basic packages, like
1.137 leot 10240: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.1 dsieger 10241: </div>
10242: </div>
10243: </div>
1.41 asau 10244: <div class="appendix">
10245: <div class="titlepage"><div><div><h1 class="title">
10246: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10247: <div class="toc">
10248: <p><b>Table of Contents</b></p>
1.100 leot 10249: <dl class="toc">
1.1 dsieger 10250: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10251: <dd><dl>
10252: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10253: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10254: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 10255: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 10256: </dl></dd>
10257: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10258: </dl>
10259: </div>
10260: <p>We checked to find a piece of software that wasn't in the packages
10261: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10262: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10263: present in the tree is beyond us, but it's useful for the purposes of
10264: this exercise.</p>
1.41 asau 10265: <div class="sect1">
1.1 dsieger 10266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10267: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10268: <div class="sect2">
1.1 dsieger 10269: <div class="titlepage"><div><div><h3 class="title">
10270: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10271: <pre class="programlisting">
10272: # $NetBSD$
10273: #
10274:
10275: DISTNAME= bison-1.25
10276: CATEGORIES= devel
1.171 rillig 10277: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 10278:
1.29 dholland 10279: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 10280: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10281: COMMENT= GNU yacc clone
10282:
10283: GNU_CONFIGURE= yes
1.46 wiz 10284: INFO_FILES= yes
1.1 dsieger 10285:
10286: .include "../../mk/bsd.pkg.mk"
10287: </pre>
10288: </div>
1.41 asau 10289: <div class="sect2">
1.1 dsieger 10290: <div class="titlepage"><div><div><h3 class="title">
10291: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10292: <pre class="programlisting">
10293: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.167 leot 10294: improvements. Why you would want this when Berkeley <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?yacc+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 10295: of the NetBSD source tree is beyond me.
10296: </pre>
10297: </div>
1.41 asau 10298: <div class="sect2">
1.1 dsieger 10299: <div class="titlepage"><div><div><h3 class="title">
10300: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10301: <pre class="programlisting">
10302: @comment $NetBSD$
10303: bin/bison
10304: man/man1/bison.1.gz
10305: share/bison.simple
10306: share/bison.hairy
10307: </pre>
10308: </div>
1.41 asau 10309: <div class="sect2">
1.1 dsieger 10310: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 10311: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1 dsieger 10312: <p>The NetBSD package system comes with
1.137 leot 10313: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1 dsieger 10314: which helps to check the contents of these
10315: files. After installation it is quite easy to use, just change to the
1.171 rillig 10316: directory of the package you wish to examine and run
1.10 hubertf 10317: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10318: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171 rillig 10319: ERROR: Makefile: Each package must define its LICENSE.
10320: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10321: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10322: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10323: 1 error, 2 warnings and 1 note found.
10324: (Run "pkglint -e" to show explanations.)
10325: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 10326: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1 dsieger 10327: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170 rillig 10328: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1 dsieger 10329: -Wall</strong></span> for a very thorough check.</p>
10330: </div>
10331: </div>
1.41 asau 10332: <div class="sect1">
1.1 dsieger 10333: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10334: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10335: <p>Create the directory where the package lives,
10336: plus any auxiliary directories:</p>
10337: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10338: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10339: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10340: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10341: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.154 rillig 10342: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 13. Package components - files, directories and contents">Chapter 13, <i>Package components - files, directories and contents</i></a>)
1.1 dsieger 10343: then continue with fetching the distfile:</p>
10344: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10345: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10346: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10347: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10348: ftp: Error retrieving file: 500 Internal error
10349:
10350: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10351: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10352: ftp: Error retrieving file: 500 Internal error
10353:
10354: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10355: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10356: Successfully retrieved file.</pre>
10357: <p>Generate the checksum of the distfile into
10358: <code class="filename">distinfo</code>:</p>
10359: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10360: <p>Now compile:</p>
10361: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10362: >> Checksum OK for bison-1.25.tar.gz.
10363: ===> Extracting for bison-1.25
10364: ===> Patching for bison-1.25
10365: ===> Ignoring empty patch directory
10366: ===> Configuring for bison-1.25
10367: creating cache ./config.cache
10368: checking for gcc... cc
10369: checking whether we are using GNU C... yes
10370: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10371: checking how to run the C preprocessor... cc -E
10372: checking for minix/config.h... no
10373: checking for POSIXized ISC... no
10374: checking whether cross-compiling... no
10375: checking for ANSI C header files... yes
10376: checking for string.h... yes
10377: checking for stdlib.h... yes
10378: checking for memory.h... yes
10379: checking for working const... yes
10380: checking for working alloca.h... no
10381: checking for alloca... yes
10382: checking for strerror... yes
10383: updating cache ./config.cache
10384: creating ./config.status
10385: creating Makefile
10386: ===> Building for bison-1.25
10387: 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
10388: 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
10389: 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
10390: 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
10391: 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
10392: 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
10393: 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
10394: 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
10395: 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
10396: 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
10397: 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
10398: 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
10399: 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
10400: 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
10401: 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
10402: 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
10403: 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
10404: 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
10405: 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
10406: 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
10407: 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
10408: 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
10409: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10410: rm -f bison.s1
10411: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10412: <p>Everything seems OK, so install the files:</p>
10413: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10414: >> Checksum OK for bison-1.25.tar.gz.
10415: ===> Installing for bison-1.25
10416: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10417: rm -f /usr/pkg/bin/bison
10418: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10419: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10420: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10421: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10422: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10423: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10424: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10425: ===> Registering installation for bison-1.25</pre>
10426: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10427: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10428: binary package, do this now:</p>
10429: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10430: >> Checksum OK for bison-1.25.tar.gz.
10431: ===> Building package for bison-1.25
10432: Creating package bison-1.25.tgz
10433: Registering depends:.
10434: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10435: <p>Now that you don't need the source and object files
10436: any more, clean up:</p>
10437: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10438: ===> Cleaning for bison-1.25</pre>
10439: </div>
10440: </div>
1.41 asau 10441: <div class="appendix">
10442: <div class="titlepage"><div><div><h1 class="title">
10443: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10444: <div class="toc">
10445: <p><b>Table of Contents</b></p>
1.100 leot 10446: <dl class="toc">
1.1 dsieger 10447: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10448: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10449: </dl>
10450: </div>
1.41 asau 10451: <div class="sect1">
1.1 dsieger 10452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10453: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10454: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10455: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10456: => figlet221.tar.gz doesn't seem to exist on this system.
10457: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10458: => [172219 bytes]
10459: Connected to ftp.plig.net.
10460: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10461: 331 Guest login ok, send your complete e-mail address as password.
10462: 230-You are user #5 of 500 simultaneous users allowed.
10463: 230-
10464: 230- ___ _ _ _
10465: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10466: 230- | _| _| . |_| . | | | . |_| . | _| . |
10467: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10468: 230- |_| |_| |___| |___|
10469: 230-
10470: 230-** Welcome to ftp.plig.org **
10471: 230-
10472: 230-Please note that all transfers from this FTP site are logged. If you
10473: 230-do not like this, please disconnect now.
10474: 230-
1.18 snj 10475: 230-This archive is available via
1.1 dsieger 10476: 230-
10477: 230-HTTP: http://ftp.plig.org/
10478: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10479: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10480: 230-
10481: 230-Please email comments, bug reports and requests for packages to be
10482: 230-mirrored to ftp-admin@plig.org.
10483: 230-
10484: 230-
10485: 230 Logged in anonymously.
10486: Remote system type is UNIX.
10487: Using binary mode to transfer files.
10488: 200 Type okay.
10489: 250 "/pub" is new cwd.
10490: 250-"/pub/figlet" is new cwd.
10491: 250-
10492: 250-Welcome to the figlet archive at ftp.figlet.org
10493: 250-
10494: 250- ftp://ftp.figlet.org/pub/figlet/
10495: 250-
10496: 250-The official FIGlet web page is:
10497: 250- http://www.figlet.org/
10498: 250-
10499: 250-If you have questions, please mailto:info@figlet.org. If you want to
10500: 250-contribute a font or something else, you can email us.
10501: 250
10502: 250 "/pub/figlet/program" is new cwd.
10503: 250 "/pub/figlet/program/unix" is new cwd.
10504: local: figlet221.tar.gz remote: figlet221.tar.gz
10505: 502 Unimplemented command.
10506: 227 Entering Passive Mode (195,40,6,41,246,104)
10507: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10508: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10509: 226 Transfer completed.
10510: 172219 bytes received in 00:02 (75.99 KB/s)
10511: 221 Goodbye.
10512: => Checksum OK for figlet221.tar.gz.
10513: ===> Extracting for figlet-2.2.1nb2
10514: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10515: ===> Patching for figlet-2.2.1nb2
10516: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10517: ===> Overriding tools for figlet-2.2.1nb2
10518: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10519: ===> Configuring for figlet-2.2.1nb2
10520: ===> Building for figlet-2.2.1nb2
10521: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10522: chmod a+x figlet
10523: gcc -O2 -o chkfont chkfont.c
10524: => Unwrapping files-to-be-installed.
10525: <code class="prompt">#</code>
10526: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10527: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10528: ===> Installing for figlet-2.2.1nb2
10529: install -d -o root -g wheel -m 755 /usr/pkg/bin
10530: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10531: mkdir -p /usr/pkg/share/figlet
10532: cp figlet /usr/pkg/bin
10533: cp chkfont /usr/pkg/bin
10534: chmod 555 figlist showfigfonts
10535: cp figlist /usr/pkg/bin
10536: cp showfigfonts /usr/pkg/bin
10537: cp fonts/*.flf /usr/pkg/share/figlet
10538: cp fonts/*.flc /usr/pkg/share/figlet
10539: cp figlet.6 /usr/pkg/man/man6
10540: ===> Registering installation for figlet-2.2.1nb2
10541: <code class="prompt">#</code></pre>
10542: </div>
1.41 asau 10543: <div class="sect1">
1.1 dsieger 10544: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10545: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10546: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10547: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10548: ===> Packaging figlet-2.2.1nb2
10549: ===> Building binary package for figlet-2.2.1nb2
10550: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10551: Using SrcDir value of /usr/pkg
10552: Registering depends:.
10553: <code class="prompt">#</code></pre>
10554: </div>
10555: </div>
1.41 asau 10556: <div class="appendix">
10557: <div class="titlepage"><div><div><h1 class="title">
10558: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10559: <div class="toc">
10560: <p><b>Table of Contents</b></p>
1.100 leot 10561: <dl class="toc">
1.23 wiz 10562: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10563: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10564: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10565: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10566: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148 leot 10567: <code class="filename">stable</code>,
1.23 wiz 10568: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10569: source packages</a></span></dt>
10570: </dl>
10571: </div>
10572: <p>As in other big projects, the directory layout of pkgsrc
10573: is quite complex for newbies. This chapter explains where you
10574: find things on the FTP server. The base directory on
1.10 hubertf 10575: <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.1 dsieger 10576: On other servers it may be different, but inside this directory,
10577: everything should look the same, no matter on which server you
10578: are. This directory contains some subdirectories, which are
10579: explained below.</p>
1.41 asau 10580: <div class="sect1">
1.1 dsieger 10581: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10582: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10583: <p>The directory <code class="filename">distfiles</code> contains lots
10584: of archive files from all pkgsrc packages, which are mirrored
10585: here. The subdirectories are called after their package names
10586: and are used when the distributed files have names that don't
10587: explicitly contain a version number or are otherwise too generic
10588: (for example <code class="filename">release.tar.gz</code>).</p>
10589: </div>
1.41 asau 10590: <div class="sect1">
1.1 dsieger 10591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10592: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10593: <p>This directory contains things that individual pkgsrc
10594: developers find worth publishing.</p>
10595: </div>
1.41 asau 10596: <div class="sect1">
1.1 dsieger 10597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10598: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10599: <p>This directory contains binary packages for the various
10600: platforms that are supported by pkgsrc.
10601: Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.41 asau 10602: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10603: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10604: operating system for which the packages have been built. The
1.10 hubertf 10605: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10606: command, so it may differ from the one you are used to
10607: hear.</p></li>
1.23 wiz 10608: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10609: architecture of the platform for which the packages have been
1.10 hubertf 10610: built. It also includes the <code class="varname">ABI</code> (Application
10611: Binary Interface) for platforms that have several of
10612: them.</p></li>
1.23 wiz 10613: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10614: the operating system. For version numbers that change often (for
10615: example NetBSD-current), the often-changing part should be
10616: replaced with an <code class="literal">x</code>, for example
10617: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10618: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10619: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10620: for a stable branch, or <code class="literal">head</code> for packages
10621: built from the HEAD branch. The latter should only be used when
10622: the packages are updated on a regular basis. Otherwise the date
10623: from checking out pkgsrc should be appended, for example
10624: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10625: </ul></div>
10626: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10627: can quickly click through the directories on the
10628: server and find the best binary packages for their machines. Since they
10629: usually know the operating system and the hardware architecture, OPSYS
10630: and ARCH are placed first. After these choices, they can select the
10631: best combination of OSVERSION and TAG together, since it is usually the
10632: case that packages stay compatible between different version of the
10633: operating system.</p>
10634: <p>In each of these directories, there is a
10635: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10636: <code class="filename">All</code> which contains all binary packages.
10637: Besides that, there are various category directories that
10638: contain symbolic links to the real binary packages.</p>
10639: </div>
1.41 asau 10640: <div class="sect1">
1.1 dsieger 10641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10642: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10643: <p>Here are the reports from bulk builds, for those who want
10644: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10645: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.8 rillig 10646: </div>
1.41 asau 10647: <div class="sect1">
1.8 rillig 10648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10649: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.148 leot 10650: <code class="filename">stable</code>,
1.22 jakllsch 10651: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10652: source packages</h2></div></div></div>
1.23 wiz 10653: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10654: that is the files that define how to create binary packages from
10655: source archives.</p>
1.149 leot 10656: <p>Each of the <code class="filename">current</code>,
10657: <code class="filename">stable</code> and
10658: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
10659: directories share the same structure. They each contain a
10660: <code class="filename">pkgsrc</code> directory and
10661: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 10662: <p>The directory <code class="filename">pkgsrc</code> contains a
10663: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 10664: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
10665: as the directory, ready to be downloaded as a whole.</p>
10666: <p>The <code class="filename">current</code> directory contains files
10667: related to the HEAD branch of the CVS repository.
10668: In this directory there is an additional file called
10669: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
10670: all pkgsrc <code class="filename">README</code>s with information about
10671: categories and packages.
10672: </p>
10673: <p>The <code class="filename">stable</code> directory is a symlink to
10674: the latest
10675: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
10676: </p>
10677: <p>The
10678: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
10679: directories contain files related to the
10680: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
10681: stable branch of the CVS repository. In these directories there is
10682: an additional file called
10683: <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 10684: which contains the state of pkgsrc when it was branched.</p>
10685: </div>
10686: </div>
1.41 asau 10687: <div class="appendix">
10688: <div class="titlepage"><div><div><h1 class="title">
1.154 rillig 10689: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
10690: <p>
10691: The following list contains all help topics that are available
10692: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
10693: </p>
1.156 leot 10694: <table border="0" summary="Simple list" class="simplelist">
10695: <tr>
10696: <td>#!</td>
10697: <td>-lintl</td>
10698: </tr>
10699: <tr>
10700: <td>64bit</td>
10701: <td>ABI</td>
10702: </tr>
10703: <tr>
10704: <td>ACCEPTABLE_LICENSES</td>
10705: <td>ACROREAD_FONTPATH</td>
10706: </tr>
10707: <tr>
10708: <td>ADDITIONAL</td>
10709: <td>AFAIK</td>
10710: </tr>
10711: <tr>
10712: <td>AIX</td>
10713: <td>ALLOW_VULNERABLE_PACKAGES</td>
10714: </tr>
10715: <tr>
10716: <td>ALL_ENV</td>
1.161 leot 10717: <td>ALSA_PC</td>
10718: </tr>
10719: <tr>
1.160 brook 10720: <td>ALTERNATIVES_SRC</td>
1.161 leot 10721: <td>AMANDA_TMP</td>
1.159 rillig 10722: </tr>
10723: <tr>
1.160 brook 10724: <td>AMANDA_USER</td>
1.161 leot 10725: <td>AMANDA_VAR</td>
1.156 leot 10726: </tr>
10727: <tr>
1.160 brook 10728: <td>APACHE_GROUP</td>
1.161 leot 10729: <td>APACHE_MODULE_NAME</td>
1.156 leot 10730: </tr>
10731: <tr>
1.160 brook 10732: <td>APACHE_MODULE_SRC</td>
1.161 leot 10733: <td>APACHE_MODULE_SRCDIR</td>
1.156 leot 10734: </tr>
10735: <tr>
1.160 brook 10736: <td>APACHE_PKG_PREFIX</td>
1.161 leot 10737: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.156 leot 10738: </tr>
10739: <tr>
1.160 brook 10740: <td>APACHE_SUEXEC_DOCROOT</td>
1.161 leot 10741: <td>APACHE_USER</td>
1.156 leot 10742: </tr>
10743: <tr>
1.160 brook 10744: <td>APPEND_ABI</td>
1.161 leot 10745: <td>APPEND_ELF</td>
1.156 leot 10746: </tr>
10747: <tr>
1.160 brook 10748: <td>ARLA_CACHE</td>
1.161 leot 10749: <td>AUDIT_PACKAGES_FLAGS</td>
1.156 leot 10750: </tr>
10751: <tr>
1.160 brook 10752: <td>AUTOCONF_REQD</td>
1.161 leot 10753: <td>AUTOMAKE_OVERRIDE</td>
1.156 leot 10754: </tr>
10755: <tr>
1.160 brook 10756: <td>AUTOMAKE_REQD</td>
1.161 leot 10757: <td>AUTO_MKDIRS</td>
1.156 leot 10758: </tr>
10759: <tr>
1.160 brook 10760: <td>BDB185_DEFAULT</td>
1.161 leot 10761: <td>BDBBASE</td>
1.156 leot 10762: </tr>
10763: <tr>
1.160 brook 10764: <td>BDB_ACCEPTED</td>
1.161 leot 10765: <td>BDB_DEFAULT</td>
1.156 leot 10766: </tr>
10767: <tr>
1.160 brook 10768: <td>BDB_LIBS</td>
1.161 leot 10769: <td>BDB_TYPE</td>
1.156 leot 10770: </tr>
10771: <tr>
1.160 brook 10772: <td>BIND_DIR</td>
1.161 leot 10773: <td>BIND_GROUP</td>
1.156 leot 10774: </tr>
10775: <tr>
1.160 brook 10776: <td>BIND_USER</td>
1.161 leot 10777: <td>BINPKG_SITES</td>
1.156 leot 10778: </tr>
10779: <tr>
1.160 brook 10780: <td>BIN_INSTALL_FLAGS</td>
1.161 leot 10781: <td>BISON_PKGDATADIR</td>
10782: </tr>
10783: <tr>
10784: <td>BLAS_ACCEPTED</td>
10785: <td>BLAS_LIBS</td>
1.156 leot 10786: </tr>
10787: <tr>
1.161 leot 10788: <td>BLAS_TYPE</td>
1.156 leot 10789: <td>BOOTSTRAP_DEPENDS</td>
10790: </tr>
10791: <tr>
10792: <td>BOOTSTRAP_SETUPTOOLS</td>
10793: <td>BROKEN</td>
10794: </tr>
10795: <tr>
10796: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
10797: <td>BROKEN_ON_PLATFORM</td>
10798: </tr>
10799: <tr>
10800: <td>BSDSRCDIR</td>
10801: <td>BSDXSRCDIR</td>
10802: </tr>
10803: <tr>
10804: <td>BSD_MAKE_ENV</td>
10805: <td>BUILDLINK_AUTO_DIRS</td>
10806: </tr>
10807: <tr>
10808: <td>BUILDLINK_AUTO_VARS</td>
10809: <td>BUILDLINK_CFLAGS</td>
10810: </tr>
10811: <tr>
10812: <td>BUILDLINK_CONTENTS_FILTER</td>
10813: <td>BUILDLINK_CPPFLAGS</td>
10814: </tr>
10815: <tr>
10816: <td>BUILDLINK_DEPMETHOD</td>
10817: <td>BUILDLINK_FILES</td>
10818: </tr>
10819: <tr>
10820: <td>BUILDLINK_FILES_CMD</td>
10821: <td>BUILDLINK_FNAME_TRANSFORM</td>
10822: </tr>
10823: <tr>
10824: <td>BUILDLINK_LDFLAGS</td>
10825: <td>BUILDLINK_LIBS</td>
10826: </tr>
10827: <tr>
10828: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
10829: <td>BUILDLINK_PKGNAME</td>
10830: </tr>
10831: <tr>
10832: <td>BUILDLINK_PREFIX</td>
10833: <td>BUILDLINK_RPATHDIRS</td>
10834: </tr>
10835: <tr>
10836: <td>BUILDLINK_TREE</td>
10837: <td>BUILD_DEFS</td>
10838: </tr>
10839: <tr>
10840: <td>BUILD_DEFS_EFFECTS</td>
10841: <td>BUILD_DEPENDS</td>
10842: </tr>
10843: <tr>
10844: <td>BUILD_DIRS</td>
10845: <td>BUILD_ENV_SHELL</td>
10846: </tr>
10847: <tr>
10848: <td>BUILD_MAKE_CMD</td>
10849: <td>BUILD_MAKE_FLAGS</td>
10850: </tr>
10851: <tr>
10852: <td>BUILD_TARGET</td>
10853: <td>BUILTIN_FIND_FILES</td>
10854: </tr>
10855: <tr>
10856: <td>BUILTIN_FIND_FILES_VAR</td>
10857: <td>BUILTIN_FIND_GREP</td>
10858: </tr>
10859: <tr>
10860: <td>BUILTIN_FIND_HEADERS</td>
10861: <td>BUILTIN_FIND_HEADERS_VAR</td>
10862: </tr>
10863: <tr>
10864: <td>BUILTIN_PKG</td>
10865: <td>BUILTIN_TEST_CURSES_DEFINES</td>
10866: </tr>
10867: <tr>
10868: <td>BUILTIN_TEST_CURSES_FUNCS</td>
10869: <td>BUILTIN_VERSION_SCRIPT</td>
10870: </tr>
10871: <tr>
10872: <td>BUILTIN_X11_TYPE</td>
10873: <td>BUILTIN_X11_VERSION</td>
10874: </tr>
10875: <tr>
10876: <td>CACTI_GROUP</td>
10877: <td>CACTI_USER</td>
10878: </tr>
10879: <tr>
10880: <td>CANNA_GROUP</td>
10881: <td>CANNA_USER</td>
10882: </tr>
10883: <tr>
10884: <td>CAT</td>
10885: <td>CCACHE_BASE</td>
10886: </tr>
10887: <tr>
10888: <td>CCACHE_DIR</td>
10889: <td>CCACHE_LOGFILE</td>
10890: </tr>
10891: <tr>
10892: <td>CC_VERSION</td>
10893: <td>CC_VERSION_STRING</td>
10894: </tr>
10895: <tr>
10896: <td>CDRECORD_CONF</td>
10897: <td>CDROM_PKG_URL_DIR</td>
10898: </tr>
10899: <tr>
10900: <td>CDROM_PKG_URL_HOST</td>
1.161 leot 10901: <td>CHECKOUT_DATE</td>
10902: </tr>
10903: <tr>
1.160 brook 10904: <td>CHECK_FAKEHOME</td>
1.161 leot 10905: <td>CHECK_FILES</td>
1.159 rillig 10906: </tr>
10907: <tr>
1.160 brook 10908: <td>CHECK_FILES_SKIP</td>
1.161 leot 10909: <td>CHECK_FILES_STRICT</td>
1.156 leot 10910: </tr>
10911: <tr>
1.160 brook 10912: <td>CHECK_HEADERS</td>
1.161 leot 10913: <td>CHECK_HEADERS_SKIP</td>
1.156 leot 10914: </tr>
10915: <tr>
1.160 brook 10916: <td>CHECK_INTERPRETER</td>
1.161 leot 10917: <td>CHECK_INTERPRETER_SKIP</td>
1.156 leot 10918: </tr>
10919: <tr>
1.160 brook 10920: <td>CHECK_PERMS</td>
1.161 leot 10921: <td>CHECK_PERMS_AUTOFIX</td>
1.156 leot 10922: </tr>
10923: <tr>
1.160 brook 10924: <td>CHECK_PERMS_SKIP</td>
1.161 leot 10925: <td>CHECK_PORTABILITY</td>
1.156 leot 10926: </tr>
10927: <tr>
1.160 brook 10928: <td>CHECK_PORTABILITY_SKIP</td>
1.161 leot 10929: <td>CHECK_RELRO</td>
1.156 leot 10930: </tr>
10931: <tr>
1.160 brook 10932: <td>CHECK_RELRO_SKIP</td>
1.161 leot 10933: <td>CHECK_RELRO_SUPPORTED</td>
1.156 leot 10934: </tr>
10935: <tr>
1.160 brook 10936: <td>CHECK_SHLIBS</td>
1.161 leot 10937: <td>CHECK_SHLIBS_BLACKLIST</td>
1.156 leot 10938: </tr>
10939: <tr>
1.160 brook 10940: <td>CHECK_SHLIBS_SKIP</td>
1.161 leot 10941: <td>CHECK_SHLIBS_SUPPORTED</td>
1.156 leot 10942: </tr>
10943: <tr>
1.160 brook 10944: <td>CHECK_SSP</td>
1.161 leot 10945: <td>CHECK_SSP_SKIP</td>
1.156 leot 10946: </tr>
10947: <tr>
1.160 brook 10948: <td>CHECK_SSP_SUPPORTED</td>
1.161 leot 10949: <td>CHECK_STRIPPED</td>
1.156 leot 10950: </tr>
10951: <tr>
1.160 brook 10952: <td>CHECK_STRIPPED_SKIP</td>
1.161 leot 10953: <td>CHECK_WRKREF</td>
1.156 leot 10954: </tr>
10955: <tr>
1.160 brook 10956: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.161 leot 10957: <td>CHECK_WRKREF_SKIP</td>
1.156 leot 10958: </tr>
10959: <tr>
1.160 brook 10960: <td>CLAMAV_DBDIR</td>
1.161 leot 10961: <td>CLAMAV_GROUP</td>
1.156 leot 10962: </tr>
10963: <tr>
1.160 brook 10964: <td>CLAMAV_USER</td>
1.161 leot 10965: <td>CLANGBASE</td>
1.156 leot 10966: </tr>
10967: <tr>
1.160 brook 10968: <td>CLEANDEPENDS</td>
1.161 leot 10969: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.156 leot 10970: </tr>
10971: <tr>
1.160 brook 10972: <td>CMAKE_INSTALL_PREFIX</td>
1.161 leot 10973: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.156 leot 10974: </tr>
10975: <tr>
1.160 brook 10976: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.161 leot 10977: <td>CMAKE_PREFIX_PATH</td>
1.156 leot 10978: </tr>
10979: <tr>
10980: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.161 leot 10981: <td>COMMON_LISP_DOCFILES</td>
10982: </tr>
10983: <tr>
10984: <td>COMMON_LISP_EXAMPLES</td>
10985: <td>COMMON_LISP_EXTRAFILES</td>
10986: </tr>
10987: <tr>
10988: <td>COMMON_LISP_PACKAGES</td>
10989: <td>COMMON_LISP_SYSTEM</td>
1.156 leot 10990: </tr>
10991: <tr>
10992: <td>COMPILER_RPATH_FLAG</td>
10993: <td>COMPILER_USE_SYMLINKS</td>
10994: </tr>
10995: <tr>
10996: <td>CONFIGURE_ARGS</td>
10997: <td>CONFIGURE_DIRS</td>
10998: </tr>
10999: <tr>
11000: <td>CONFIGURE_ENV</td>
1.172 rillig 11001: <td>CONFIGURE_ENV_SHELL</td>
1.156 leot 11002: </tr>
11003: <tr>
1.172 rillig 11004: <td>CONFIGURE_HAS_INFODIR</td>
1.156 leot 11005: <td>CONFIGURE_HAS_MANDIR</td>
11006: </tr>
11007: <tr>
1.172 rillig 11008: <td>CONFIGURE_SCRIPT</td>
1.156 leot 11009: <td>CONFIG_SHELL</td>
11010: </tr>
11011: <tr>
1.172 rillig 11012: <td>CONFIG_SHELL_FLAGS</td>
1.156 leot 11013: <td>CONF_FILES</td>
11014: </tr>
11015: <tr>
1.172 rillig 11016: <td>CONF_FILES_MODE</td>
1.156 leot 11017: <td>CONF_FILES_PERMS</td>
11018: </tr>
11019: <tr>
1.172 rillig 11020: <td>CONSERVER_DEFAULTHOST</td>
1.156 leot 11021: <td>CONSERVER_DEFAULTPORT</td>
11022: </tr>
11023: <tr>
1.172 rillig 11024: <td>CP</td>
1.156 leot 11025: <td>CPP</td>
11026: </tr>
11027: <tr>
1.172 rillig 11028: <td>CPP_PRECOMP_FLAGS</td>
1.156 leot 11029: <td>CREATE_WRKDIR_SYMLINK</td>
11030: </tr>
11031: <tr>
1.172 rillig 11032: <td>CROSSBASE</td>
1.156 leot 11033: <td>CTFCONVERT</td>
11034: </tr>
11035: <tr>
1.172 rillig 11036: <td>CTF_FILES_SKIP</td>
1.156 leot 11037: <td>CTF_SUPPORTED</td>
11038: </tr>
11039: <tr>
1.172 rillig 11040: <td>CTYPE</td>
1.156 leot 11041: <td>CUPS_GROUP</td>
11042: </tr>
11043: <tr>
1.172 rillig 11044: <td>CUPS_SYSTEM_GROUPS</td>
1.156 leot 11045: <td>CUPS_USER</td>
11046: </tr>
11047: <tr>
1.172 rillig 11048: <td>CURSES_DEFAULT</td>
1.156 leot 11049: <td>CURSES_TYPE</td>
1.161 leot 11050: </tr>
11051: <tr>
1.172 rillig 11052: <td>CVS_EXTRACTDIR</td>
1.161 leot 11053: <td>CVS_MODULE</td>
11054: </tr>
11055: <tr>
1.172 rillig 11056: <td>CVS_PROJECT</td>
1.161 leot 11057: <td>CVS_REPOSITORIES</td>
11058: </tr>
11059: <tr>
1.172 rillig 11060: <td>CVS_ROOT</td>
1.161 leot 11061: <td>CVS_ROOT_GNU</td>
11062: </tr>
11063: <tr>
1.172 rillig 11064: <td>CVS_ROOT_NONGNU</td>
1.161 leot 11065: <td>CVS_ROOT_SOURCEFORGE</td>
11066: </tr>
11067: <tr>
1.172 rillig 11068: <td>CVS_TAG</td>
1.160 brook 11069: <td>CXX</td>
1.159 rillig 11070: </tr>
11071: <tr>
1.172 rillig 11072: <td>CYRUS_GROUP</td>
1.160 brook 11073: <td>CYRUS_IDLE</td>
1.156 leot 11074: </tr>
11075: <tr>
1.172 rillig 11076: <td>CYRUS_USER</td>
1.160 brook 11077: <td>DAEMONTOOLS_GROUP</td>
1.156 leot 11078: </tr>
11079: <tr>
1.172 rillig 11080: <td>DAEMONTOOLS_LOG_USER</td>
1.160 brook 11081: <td>DBUS_GROUP</td>
1.156 leot 11082: </tr>
11083: <tr>
1.172 rillig 11084: <td>DBUS_USER</td>
1.160 brook 11085: <td>DEFANG_GROUP</td>
1.156 leot 11086: </tr>
11087: <tr>
1.172 rillig 11088: <td>DEFANG_USER</td>
1.160 brook 11089: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.156 leot 11090: </tr>
11091: <tr>
1.172 rillig 11092: <td>DEFAULT_DISTFILES</td>
1.160 brook 11093: <td>DEFAULT_IRC_SERVER</td>
1.156 leot 11094: </tr>
11095: <tr>
1.172 rillig 11096: <td>DEFAULT_SERIAL_DEVICE</td>
1.160 brook 11097: <td>DEF_UMASK</td>
1.156 leot 11098: </tr>
11099: <tr>
1.172 rillig 11100: <td>DEINSTALLDEPENDS</td>
1.160 brook 11101: <td>DEINSTALL_SRC</td>
1.156 leot 11102: </tr>
11103: <tr>
1.172 rillig 11104: <td>DEINSTALL_TEMPLATES</td>
1.160 brook 11105: <td>DELAYED_ERROR_MSG</td>
1.156 leot 11106: </tr>
11107: <tr>
1.172 rillig 11108: <td>DELAYED_WARNING_MSG</td>
1.160 brook 11109: <td>DEPENDS</td>
1.156 leot 11110: </tr>
11111: <tr>
1.172 rillig 11112: <td>DEPENDS_TARGET</td>
1.160 brook 11113: <td>DEPENDS_TYPE</td>
1.156 leot 11114: </tr>
11115: <tr>
1.172 rillig 11116: <td>DESTDIR</td>
1.160 brook 11117: <td>DESTDIR_VARNAME</td>
1.156 leot 11118: </tr>
11119: <tr>
1.172 rillig 11120: <td>DIALER_GROUP</td>
1.160 brook 11121: <td>DIGEST_REQD</td>
1.156 leot 11122: </tr>
11123: <tr>
1.172 rillig 11124: <td>DISTDIR</td>
1.160 brook 11125: <td>DISTFILES</td>
1.156 leot 11126: </tr>
11127: <tr>
1.172 rillig 11128: <td>DISTINFO_FILE</td>
1.160 brook 11129: <td>DISTNAME</td>
1.156 leot 11130: </tr>
11131: <tr>
1.172 rillig 11132: <td>DIST_PATH</td>
1.160 brook 11133: <td>DIST_SUBDIR</td>
1.156 leot 11134: </tr>
11135: <tr>
1.172 rillig 11136: <td>DJBDNS_AXFR_USER</td>
1.160 brook 11137: <td>DJBDNS_CACHE_USER</td>
1.156 leot 11138: </tr>
11139: <tr>
1.172 rillig 11140: <td>DJBDNS_DJBDNS_GROUP</td>
1.160 brook 11141: <td>DJBDNS_LOG_USER</td>
1.156 leot 11142: </tr>
11143: <tr>
1.172 rillig 11144: <td>DJBDNS_RBL_USER</td>
1.160 brook 11145: <td>DJBDNS_TINY_USER</td>
1.156 leot 11146: </tr>
11147: <tr>
1.172 rillig 11148: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.160 brook 11149: <td>DL_AUTO_VARS</td>
1.156 leot 11150: </tr>
11151: <tr>
1.172 rillig 11152: <td>DL_CFLAGS</td>
1.160 brook 11153: <td>DL_LDFLAGS</td>
1.156 leot 11154: </tr>
11155: <tr>
1.172 rillig 11156: <td>DL_LIBS</td>
1.160 brook 11157: <td>DNS</td>
1.156 leot 11158: </tr>
11159: <tr>
1.172 rillig 11160: <td>DOWNLOADED_DISTFILE</td>
1.160 brook 11161: <td>DT_LAYOUT</td>
1.156 leot 11162: </tr>
11163: <tr>
1.172 rillig 11164: <td>DYNAMIC_SITES_CMD</td>
1.160 brook 11165: <td>DYNAMIC_SITES_SCRIPT</td>
1.156 leot 11166: </tr>
11167: <tr>
1.172 rillig 11168: <td>ECHO</td>
1.160 brook 11169: <td>ECHO_N</td>
1.156 leot 11170: </tr>
11171: <tr>
1.172 rillig 11172: <td>ELK_GUI</td>
1.160 brook 11173: <td>EMACS_TYPE</td>
1.156 leot 11174: </tr>
11175: <tr>
1.172 rillig 11176: <td>EMULDIR</td>
1.160 brook 11177: <td>EMULSUBDIR</td>
1.156 leot 11178: </tr>
11179: <tr>
1.172 rillig 11180: <td>EMULSUBDIRSLASH</td>
1.160 brook 11181: <td>EMUL_ARCH</td>
1.156 leot 11182: </tr>
11183: <tr>
1.172 rillig 11184: <td>EMUL_DISTRO</td>
1.160 brook 11185: <td>EMUL_EXEC_FMT</td>
1.156 leot 11186: </tr>
11187: <tr>
1.172 rillig 11188: <td>EMUL_IS_NATIVE</td>
1.160 brook 11189: <td>EMUL_MODULES</td>
1.156 leot 11190: </tr>
11191: <tr>
1.172 rillig 11192: <td>EMUL_OPSYS</td>
1.160 brook 11193: <td>EMUL_PKG_FMT</td>
1.156 leot 11194: </tr>
11195: <tr>
1.172 rillig 11196: <td>EMUL_PLATFORM</td>
1.160 brook 11197: <td>EMUL_PLATFORMS</td>
1.156 leot 11198: </tr>
11199: <tr>
1.172 rillig 11200: <td>EMUL_PREFER</td>
1.160 brook 11201: <td>EMUL_REQD</td>
1.156 leot 11202: </tr>
11203: <tr>
1.172 rillig 11204: <td>EMUL_TYPE</td>
1.160 brook 11205: <td>ERROR_MSG</td>
1.156 leot 11206: </tr>
11207: <tr>
1.172 rillig 11208: <td>EXIM_GROUP</td>
1.160 brook 11209: <td>EXIM_USER</td>
1.156 leot 11210: </tr>
11211: <tr>
1.172 rillig 11212: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.160 brook 11213: <td>EXTRACTOR</td>
1.156 leot 11214: </tr>
11215: <tr>
1.172 rillig 11216: <td>EXTRACT_CMD</td>
1.160 brook 11217: <td>EXTRACT_CMD_DEFAULT</td>
1.156 leot 11218: </tr>
11219: <tr>
1.172 rillig 11220: <td>EXTRACT_DIR</td>
1.160 brook 11221: <td>EXTRACT_ELEMENTS</td>
1.156 leot 11222: </tr>
11223: <tr>
1.172 rillig 11224: <td>EXTRACT_ENV</td>
1.160 brook 11225: <td>EXTRACT_ONLY</td>
1.156 leot 11226: </tr>
11227: <tr>
1.172 rillig 11228: <td>EXTRACT_OPTS</td>
1.160 brook 11229: <td>EXTRACT_SUFX</td>
1.156 leot 11230: </tr>
11231: <tr>
1.172 rillig 11232: <td>EXTRACT_USING</td>
1.160 brook 11233: <td>FAILOVER_FETCH</td>
1.156 leot 11234: </tr>
11235: <tr>
1.172 rillig 11236: <td>FAIL_MSG</td>
1.160 brook 11237: <td>FAKE_NCURSES</td>
1.156 leot 11238: </tr>
11239: <tr>
1.172 rillig 11240: <td>FAM</td>
1.160 brook 11241: <td>FAM_ACCEPTED</td>
1.156 leot 11242: </tr>
11243: <tr>
1.172 rillig 11244: <td>FAM_DEFAULT</td>
1.160 brook 11245: <td>FAM_SERVER</td>
1.156 leot 11246: </tr>
11247: <tr>
1.172 rillig 11248: <td>FCPATH</td>
1.160 brook 11249: <td>FEATURE_CPPFLAGS</td>
1.156 leot 11250: </tr>
11251: <tr>
1.172 rillig 11252: <td>FEATURE_LDFLAGS</td>
1.160 brook 11253: <td>FEATURE_LIBS</td>
1.156 leot 11254: </tr>
11255: <tr>
1.172 rillig 11256: <td>FETCH_AFTER_ARGS</td>
1.160 brook 11257: <td>FETCH_BEFORE_ARGS</td>
1.156 leot 11258: </tr>
11259: <tr>
1.172 rillig 11260: <td>FETCH_CMD</td>
1.160 brook 11261: <td>FETCH_OUTPUT_ARGS</td>
1.156 leot 11262: </tr>
11263: <tr>
1.172 rillig 11264: <td>FETCH_PROXY</td>
1.160 brook 11265: <td>FETCH_RESUME_ARGS</td>
1.156 leot 11266: </tr>
11267: <tr>
1.172 rillig 11268: <td>FETCH_USING</td>
1.160 brook 11269: <td>FILES_SUBST</td>
1.156 leot 11270: </tr>
11271: <tr>
1.172 rillig 11272: <td>FILES_SUBST_SED</td>
1.160 brook 11273: <td>FIX_SYSTEM_HEADERS</td>
1.156 leot 11274: </tr>
11275: <tr>
1.172 rillig 11276: <td>FLUXBOX_USE_GNOME</td>
1.160 brook 11277: <td>FLUXBOX_USE_KDE</td>
1.156 leot 11278: </tr>
11279: <tr>
1.172 rillig 11280: <td>FLUXBOX_USE_XFT</td>
1.156 leot 11281: <td>FLUXBOX_USE_XINERAMA</td>
11282: </tr>
11283: <tr>
1.172 rillig 11284: <td>FONTDIR</td>
1.156 leot 11285: <td>FONTS_DIRS</td>
11286: </tr>
11287: <tr>
1.172 rillig 11288: <td>FONTS_VERBOSE</td>
1.156 leot 11289: <td>FOO_HACKS_MK</td>
1.161 leot 11290: </tr>
11291: <tr>
1.172 rillig 11292: <td>FOSSIL_EXTRACTDIR</td>
1.161 leot 11293: <td>FOSSIL_REPO</td>
11294: </tr>
11295: <tr>
1.172 rillig 11296: <td>FOSSIL_REPOSITORIES</td>
1.161 leot 11297: <td>FOSSIL_VERSION</td>
1.156 leot 11298: </tr>
11299: <tr>
1.172 rillig 11300: <td>FOX_USE_XUNICODE</td>
1.156 leot 11301: <td>FREEWNN_GROUP</td>
11302: </tr>
11303: <tr>
1.172 rillig 11304: <td>FREEWNN_USER</td>
1.156 leot 11305: <td>FTP_PKG_URL_DIR</td>
11306: </tr>
11307: <tr>
1.172 rillig 11308: <td>FTP_PKG_URL_HOST</td>
1.156 leot 11309: <td>GAMEDATAMODE</td>
11310: </tr>
11311: <tr>
1.172 rillig 11312: <td>GAMEDATA_PERMS</td>
1.156 leot 11313: <td>GAMEDIRMODE</td>
11314: </tr>
11315: <tr>
1.172 rillig 11316: <td>GAMEDIR_PERMS</td>
1.156 leot 11317: <td>GAMEGRP</td>
11318: </tr>
11319: <tr>
1.172 rillig 11320: <td>GAMEMODE</td>
1.156 leot 11321: <td>GAMEOWN</td>
11322: </tr>
11323: <tr>
1.172 rillig 11324: <td>GAMES_GROUP</td>
1.156 leot 11325: <td>GAMES_USER</td>
11326: </tr>
11327: <tr>
1.172 rillig 11328: <td>GCC</td>
1.156 leot 11329: <td>GCCBASE</td>
11330: </tr>
11331: <tr>
1.172 rillig 11332: <td>GCC_REQD</td>
1.156 leot 11333: <td>GCC_VERSION_SUFFIX</td>
11334: </tr>
11335: <tr>
1.172 rillig 11336: <td>GEM_BUILD</td>
1.156 leot 11337: <td>GEM_CLEANBUILD</td>
11338: </tr>
11339: <tr>
1.172 rillig 11340: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.156 leot 11341: <td>GEM_DOCDIR</td>
11342: </tr>
11343: <tr>
1.172 rillig 11344: <td>GEM_EXTSDIR</td>
1.156 leot 11345: <td>GEM_HOME</td>
11346: </tr>
11347: <tr>
1.172 rillig 11348: <td>GEM_LIBDIR</td>
1.156 leot 11349: <td>GEM_NAME</td>
11350: </tr>
11351: <tr>
1.172 rillig 11352: <td>GEM_PATH</td>
1.156 leot 11353: <td>GEM_SPECFILE</td>
11354: </tr>
11355: <tr>
1.172 rillig 11356: <td>GENERATE_PLIST</td>
1.156 leot 11357: <td>GHOSTSCRIPT_REQD</td>
11358: </tr>
11359: <tr>
1.172 rillig 11360: <td>GITHUB_PROJECT</td>
1.156 leot 11361: <td>GITHUB_RELEASE</td>
11362: </tr>
11363: <tr>
1.172 rillig 11364: <td>GITHUB_TAG</td>
1.156 leot 11365: <td>GITHUB_TYPE</td>
1.161 leot 11366: </tr>
11367: <tr>
1.172 rillig 11368: <td>GIT_BRANCH</td>
1.161 leot 11369: <td>GIT_ENV</td>
11370: </tr>
11371: <tr>
1.172 rillig 11372: <td>GIT_EXTRACTDIR</td>
1.161 leot 11373: <td>GIT_REPO</td>
11374: </tr>
11375: <tr>
1.172 rillig 11376: <td>GIT_REPOSITORIES</td>
1.161 leot 11377: <td>GIT_REVISION</td>
11378: </tr>
11379: <tr>
1.172 rillig 11380: <td>GIT_TAG</td>
1.160 brook 11381: <td>GNU</td>
1.159 rillig 11382: </tr>
11383: <tr>
1.172 rillig 11384: <td>GNU_CONFIGURE</td>
1.160 brook 11385: <td>GNU_CONFIGURE_INFODIR</td>
1.156 leot 11386: </tr>
11387: <tr>
1.172 rillig 11388: <td>GNU_CONFIGURE_MANDIR</td>
1.160 brook 11389: <td>GNU_CONFIGURE_STRICT</td>
1.156 leot 11390: </tr>
11391: <tr>
1.172 rillig 11392: <td>GODEP_REDIRECTS</td>
1.160 brook 11393: <td>GO_BUILD_PATTERN</td>
1.156 leot 11394: </tr>
11395: <tr>
1.172 rillig 11396: <td>GO_DEPS</td>
1.160 brook 11397: <td>GO_DIST_BASE</td>
1.156 leot 11398: </tr>
11399: <tr>
1.172 rillig 11400: <td>GO_SRCPATH</td>
1.161 leot 11401: <td>GO_VERSION_DEFAULT</td>
1.156 leot 11402: </tr>
11403: <tr>
1.172 rillig 11404: <td>GROUP_SPECIFIC_PKGS</td>
1.159 rillig 11405: <td>GRUB_NETWORK_CARDS</td>
1.156 leot 11406: </tr>
11407: <tr>
1.172 rillig 11408: <td>GRUB_PRESET_COMMAND</td>
1.159 rillig 11409: <td>GRUB_SCAN_ARGS</td>
1.156 leot 11410: </tr>
11411: <tr>
1.172 rillig 11412: <td>GZIP</td>
1.159 rillig 11413: <td>HASKELL_COMPILER</td>
1.156 leot 11414: </tr>
11415: <tr>
1.172 rillig 11416: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.159 rillig 11417: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.156 leot 11418: </tr>
11419: <tr>
1.172 rillig 11420: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.169 rillig 11421: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.156 leot 11422: </tr>
11423: <tr>
1.172 rillig 11424: <td>HAS_CONFIGURE</td>
1.169 rillig 11425: <td>HEADER_TEMPLATES</td>
1.161 leot 11426: </tr>
11427: <tr>
1.172 rillig 11428: <td>HG_REPO</td>
1.169 rillig 11429: <td>HG_REPOSITORIES</td>
1.161 leot 11430: </tr>
11431: <tr>
1.172 rillig 11432: <td>HG_TAG</td>
1.169 rillig 11433: <td>HOST_PKGTOOLS_ARGS</td>
1.156 leot 11434: </tr>
11435: <tr>
1.172 rillig 11436: <td>HOST_SPECIFIC_PKGS</td>
1.169 rillig 11437: <td>HOWL_GROUP</td>
1.156 leot 11438: </tr>
11439: <tr>
1.172 rillig 11440: <td>HOWL_USER</td>
1.169 rillig 11441: <td>ICCBASE</td>
1.156 leot 11442: </tr>
11443: <tr>
1.172 rillig 11444: <td>ICECAST_CHROOTDIR</td>
1.169 rillig 11445: <td>ICON_THEMES</td>
1.156 leot 11446: </tr>
11447: <tr>
1.172 rillig 11448: <td>IDOBASE</td>
1.169 rillig 11449: <td>IGNORE_CCACHE</td>
1.156 leot 11450: </tr>
11451: <tr>
1.172 rillig 11452: <td>IGNORE_INFO_DIRS</td>
1.169 rillig 11453: <td>IGNORE_INTERACTIVE_FETCH</td>
1.156 leot 11454: </tr>
11455: <tr>
1.172 rillig 11456: <td>IMAKE</td>
1.169 rillig 11457: <td>IMAKEOPTS</td>
1.156 leot 11458: </tr>
11459: <tr>
1.172 rillig 11460: <td>IMAKE_MAKE</td>
1.169 rillig 11461: <td>IMAKE_MANINSTALL</td>
1.156 leot 11462: </tr>
11463: <tr>
1.172 rillig 11464: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.169 rillig 11465: <td>IMDICTDIR</td>
1.156 leot 11466: </tr>
11467: <tr>
1.172 rillig 11468: <td>INCOMPAT_CURSES</td>
1.169 rillig 11469: <td>INFO_DIR</td>
1.156 leot 11470: </tr>
11471: <tr>
1.172 rillig 11472: <td>INFO_FILES</td>
1.169 rillig 11473: <td>INFO_FILES_VERBOSE</td>
1.156 leot 11474: </tr>
11475: <tr>
1.172 rillig 11476: <td>INFO_MSG</td>
1.169 rillig 11477: <td>INIT_SYSTEM</td>
1.156 leot 11478: </tr>
11479: <tr>
1.172 rillig 11480: <td>INN_DATA_DIR</td>
1.169 rillig 11481: <td>INN_GROUP</td>
1.156 leot 11482: </tr>
11483: <tr>
1.172 rillig 11484: <td>INN_USER</td>
1.169 rillig 11485: <td>INSTALLATION_DIRS</td>
1.172 rillig 11486: </tr>
11487: <tr>
1.156 leot 11488: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.172 rillig 11489: <td>INSTALL_ENV</td>
1.156 leot 11490: </tr>
11491: <tr>
11492: <td>INSTALL_SH_OVERRIDE</td>
1.172 rillig 11493: <td>INSTALL_SRC</td>
1.156 leot 11494: </tr>
11495: <tr>
11496: <td>INSTALL_TEMPLATES</td>
1.172 rillig 11497: <td>INSTALL_UNSTRIPPED</td>
1.156 leot 11498: </tr>
11499: <tr>
11500: <td>IRCD_HYBRID_IRC_GROUP</td>
1.172 rillig 11501: <td>IRCD_HYBRID_IRC_USER</td>
1.156 leot 11502: </tr>
11503: <tr>
11504: <td>IRCD_HYBRID_MAXCONN</td>
1.172 rillig 11505: <td>IRCD_HYBRID_NICLEN</td>
1.156 leot 11506: </tr>
11507: <tr>
11508: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.172 rillig 11509: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.156 leot 11510: </tr>
11511: <tr>
11512: <td>IRCD_HYBRID_TOPICLEN</td>
1.172 rillig 11513: <td>IRIX</td>
1.156 leot 11514: </tr>
11515: <tr>
11516: <td>IRRD_USE_PGP</td>
1.172 rillig 11517: <td>JABBERD_GROUP</td>
1.156 leot 11518: </tr>
11519: <tr>
11520: <td>JABBERD_LOGDIR</td>
1.172 rillig 11521: <td>JABBERD_PIDDIR</td>
1.156 leot 11522: </tr>
11523: <tr>
11524: <td>JABBERD_SPOOLDIR</td>
1.172 rillig 11525: <td>JABBERD_USER</td>
1.156 leot 11526: </tr>
11527: <tr>
11528: <td>JAKARTA_HOME</td>
1.172 rillig 11529: <td>JAVA_APP_PATH</td>
1.156 leot 11530: </tr>
11531: <tr>
1.161 leot 11532: <td>JAVA_APP_TARGETS</td>
1.172 rillig 11533: <td>JAVA_BINPREFIX</td>
1.161 leot 11534: </tr>
11535: <tr>
1.156 leot 11536: <td>JAVA_CLASSPATH</td>
1.172 rillig 11537: <td>JAVA_HOME</td>
1.156 leot 11538: </tr>
11539: <tr>
11540: <td>JAVA_LD_LIBRARY_PATH</td>
1.172 rillig 11541: <td>JAVA_NAME</td>
1.156 leot 11542: </tr>
11543: <tr>
11544: <td>JAVA_UNLIMIT</td>
1.172 rillig 11545: <td>JAVA_WRAPPERS</td>
1.156 leot 11546: </tr>
11547: <tr>
11548: <td>JPEG_ACCEPTED</td>
1.172 rillig 11549: <td>JPEG_DEFAULT</td>
1.156 leot 11550: </tr>
11551: <tr>
11552: <td>KERBEROS</td>
1.172 rillig 11553: <td>KERMIT_SUID_UUCP</td>
1.156 leot 11554: </tr>
11555: <tr>
11556: <td>KJS_USE_PCRE</td>
1.172 rillig 11557: <td>KNEWS_DOMAIN_FILE</td>
1.156 leot 11558: </tr>
11559: <tr>
11560: <td>KNEWS_DOMAIN_NAME</td>
1.172 rillig 11561: <td>KRB5_ACCEPTED</td>
1.156 leot 11562: </tr>
11563: <tr>
11564: <td>KRB5_DEFAULT</td>
1.172 rillig 11565: <td>LANGUAGES</td>
1.156 leot 11566: </tr>
11567: <tr>
1.161 leot 11568: <td>LAPACK_LIBS</td>
1.172 rillig 11569: <td>LATEX2HTML_ICONPATH</td>
1.156 leot 11570: </tr>
11571: <tr>
11572: <td>LDCONFIG_ADD_CMD</td>
1.172 rillig 11573: <td>LDCONFIG_REMOVE_CMD</td>
1.156 leot 11574: </tr>
11575: <tr>
11576: <td>LEAFNODE_DATA_DIR</td>
1.172 rillig 11577: <td>LEAFNODE_GROUP</td>
1.156 leot 11578: </tr>
11579: <tr>
11580: <td>LEAFNODE_USER</td>
1.172 rillig 11581: <td>LIBDVDCSS_HOMEPAGE</td>
1.156 leot 11582: </tr>
11583: <tr>
11584: <td>LIBDVDCSS_MASTER_SITES</td>
1.172 rillig 11585: <td>LIBRSVG_TYPE</td>
1.157 leot 11586: </tr>
11587: <tr>
1.156 leot 11588: <td>LIBTOOL</td>
1.172 rillig 11589: <td>LIBTOOLIZE_PLIST</td>
1.156 leot 11590: </tr>
11591: <tr>
11592: <td>LIBTOOL_M4_OVERRIDE</td>
1.172 rillig 11593: <td>LIBUSB_TYPE</td>
1.156 leot 11594: </tr>
11595: <tr>
11596: <td>LICENSE</td>
1.172 rillig 11597: <td>LINKER_RPATH_FLAG</td>
1.156 leot 11598: </tr>
11599: <tr>
11600: <td>LINK_RPATH_FLAG</td>
1.172 rillig 11601: <td>LINUX_BASE_NODEPS</td>
1.161 leot 11602: </tr>
11603: <tr>
11604: <td>LINUX_BASE_PREFERRED</td>
1.172 rillig 11605: <td>LINUX_BASE_REQUIRED</td>
1.161 leot 11606: </tr>
11607: <tr>
1.159 rillig 11608: <td>LINUX_LOCALES</td>
1.172 rillig 11609: <td>LOCALBASE</td>
1.156 leot 11610: </tr>
11611: <tr>
1.158 brook 11612: <td>LOCALBASE_LOCKTYPE</td>
1.172 rillig 11613: <td>LOCALPATCHES</td>
1.156 leot 11614: </tr>
11615: <tr>
1.158 brook 11616: <td>LOVE_DATA</td>
1.172 rillig 11617: <td>LOVE_GAME</td>
1.156 leot 11618: </tr>
11619: <tr>
1.158 brook 11620: <td>LOVE_VERSION</td>
1.172 rillig 11621: <td>LP64PLATFORMS</td>
1.156 leot 11622: </tr>
11623: <tr>
1.158 brook 11624: <td>MACHINE_PLATFORM</td>
1.172 rillig 11625: <td>MAILAGENT_DOMAIN</td>
1.156 leot 11626: </tr>
11627: <tr>
1.158 brook 11628: <td>MAILAGENT_EMAIL</td>
1.172 rillig 11629: <td>MAILAGENT_FQDN</td>
1.156 leot 11630: </tr>
11631: <tr>
1.158 brook 11632: <td>MAILAGENT_ORGANIZATION</td>
1.172 rillig 11633: <td>MAJORDOMO_HOMEDIR</td>
1.156 leot 11634: </tr>
11635: <tr>
1.161 leot 11636: <td>MAJOR_OS_VERSION</td>
1.172 rillig 11637: <td>MAKEINFO_ARGS</td>
1.159 rillig 11638: </tr>
11639: <tr>
11640: <td>MAKE_DIRS</td>
1.172 rillig 11641: <td>MAKE_DIRS_PERMS</td>
1.156 leot 11642: </tr>
11643: <tr>
1.159 rillig 11644: <td>MAKE_ENV</td>
1.172 rillig 11645: <td>MAKE_FILE</td>
1.156 leot 11646: </tr>
11647: <tr>
1.159 rillig 11648: <td>MAKE_FLAGS</td>
1.172 rillig 11649: <td>MAKE_JOBS</td>
1.156 leot 11650: </tr>
11651: <tr>
1.159 rillig 11652: <td>MAKE_JOBS_SAFE</td>
1.172 rillig 11653: <td>MAKE_PROGRAM</td>
1.156 leot 11654: </tr>
11655: <tr>
1.159 rillig 11656: <td>MANINSTALL</td>
1.172 rillig 11657: <td>MANZ</td>
1.156 leot 11658: </tr>
11659: <tr>
1.159 rillig 11660: <td>MASTER_SITES</td>
1.172 rillig 11661: <td>MASTER_SITE_BACKUP</td>
1.156 leot 11662: </tr>
11663: <tr>
1.159 rillig 11664: <td>MASTER_SITE_CYGWIN</td>
1.172 rillig 11665: <td>MASTER_SITE_GNOME</td>
1.156 leot 11666: </tr>
11667: <tr>
1.159 rillig 11668: <td>MASTER_SITE_GNU</td>
1.172 rillig 11669: <td>MASTER_SITE_LOCAL</td>
1.156 leot 11670: </tr>
11671: <tr>
1.159 rillig 11672: <td>MASTER_SITE_MOZILLA</td>
1.172 rillig 11673: <td>MASTER_SITE_OPENOFFICE</td>
1.156 leot 11674: </tr>
11675: <tr>
1.159 rillig 11676: <td>MASTER_SITE_OVERRIDE</td>
1.172 rillig 11677: <td>MASTER_SITE_PERL_CPAN</td>
1.156 leot 11678: </tr>
11679: <tr>
1.159 rillig 11680: <td>MASTER_SITE_SUNSITE</td>
1.172 rillig 11681: <td>MASTER_SITE_SUSE</td>
1.156 leot 11682: </tr>
11683: <tr>
1.159 rillig 11684: <td>MASTER_SITE_TEX_CTAN</td>
1.172 rillig 11685: <td>MASTER_SITE_XCONTRIB</td>
1.156 leot 11686: </tr>
11687: <tr>
1.159 rillig 11688: <td>MASTER_SITE_XEMACS</td>
1.172 rillig 11689: <td>MASTER_SORT</td>
1.156 leot 11690: </tr>
11691: <tr>
1.159 rillig 11692: <td>MASTER_SORT_RANDOM</td>
1.172 rillig 11693: <td>MASTER_SORT_REGEX</td>
1.156 leot 11694: </tr>
11695: <tr>
1.159 rillig 11696: <td>MECAB_CHARSET</td>
1.172 rillig 11697: <td>MEDIATOMB_GROUP</td>
1.156 leot 11698: </tr>
11699: <tr>
1.159 rillig 11700: <td>MEDIATOMB_USER</td>
1.172 rillig 11701: <td>MIPSPROBASE</td>
1.156 leot 11702: </tr>
11703: <tr>
1.159 rillig 11704: <td>MIREDO_GROUP</td>
1.172 rillig 11705: <td>MIREDO_USER</td>
1.156 leot 11706: </tr>
11707: <tr>
1.159 rillig 11708: <td>MISSING_FEATURES</td>
1.172 rillig 11709: <td>MKDIR</td>
1.156 leot 11710: </tr>
11711: <tr>
1.159 rillig 11712: <td>MLDONKEY_GROUP</td>
1.172 rillig 11713: <td>MLDONKEY_HOME</td>
1.156 leot 11714: </tr>
11715: <tr>
1.159 rillig 11716: <td>MLDONKEY_USER</td>
1.172 rillig 11717: <td>MONOTONE_GROUP</td>
1.156 leot 11718: </tr>
11719: <tr>
1.159 rillig 11720: <td>MONOTONE_USER</td>
1.172 rillig 11721: <td>MOTIFBASE</td>
1.156 leot 11722: </tr>
11723: <tr>
1.159 rillig 11724: <td>MOTIF_TYPE</td>
1.172 rillig 11725: <td>MOTIF_TYPE_DEFAULT</td>
1.156 leot 11726: </tr>
11727: <tr>
1.159 rillig 11728: <td>MPI_TYPE</td>
1.172 rillig 11729: <td>MSGFMT_STRIP_MSGCTXT</td>
1.156 leot 11730: </tr>
11731: <tr>
1.159 rillig 11732: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.172 rillig 11733: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.156 leot 11734: </tr>
11735: <tr>
1.159 rillig 11736: <td>MUST</td>
1.172 rillig 11737: <td>MV</td>
1.156 leot 11738: </tr>
11739: <tr>
1.159 rillig 11740: <td>MYSQL_CHARSET</td>
1.172 rillig 11741: <td>MYSQL_DATADIR</td>
1.156 leot 11742: </tr>
11743: <tr>
1.159 rillig 11744: <td>MYSQL_EXTRA_CHARSET</td>
1.172 rillig 11745: <td>MYSQL_GROUP</td>
1.156 leot 11746: </tr>
11747: <tr>
1.159 rillig 11748: <td>MYSQL_PKGSRCDIR</td>
1.172 rillig 11749: <td>MYSQL_USER</td>
1.156 leot 11750: </tr>
11751: <tr>
1.159 rillig 11752: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.172 rillig 11753: <td>MYSQL_VERSION_DEFAULT</td>
1.156 leot 11754: </tr>
11755: <tr>
1.159 rillig 11756: <td>NAGIOSCMD_GROUP</td>
1.172 rillig 11757: <td>NAGIOSDIR</td>
1.156 leot 11758: </tr>
11759: <tr>
1.159 rillig 11760: <td>NAGIOS_GROUP</td>
1.172 rillig 11761: <td>NAGIOS_USER</td>
1.156 leot 11762: </tr>
11763: <tr>
1.159 rillig 11764: <td>NATIVE_APPEND_ABI</td>
1.172 rillig 11765: <td>NATIVE_APPEND_ELF</td>
1.156 leot 11766: </tr>
11767: <tr>
1.159 rillig 11768: <td>NATIVE_EXEC_FMT</td>
1.172 rillig 11769: <td>NATIVE_MACHINE_PLATFORM</td>
1.156 leot 11770: </tr>
11771: <tr>
1.159 rillig 11772: <td>NATIVE_OBJECT_FMT</td>
1.172 rillig 11773: <td>NBPAX_PROGRAM_PREFIX</td>
1.156 leot 11774: </tr>
11775: <tr>
1.159 rillig 11776: <td>NETBSD_LOGIN_NAME</td>
1.172 rillig 11777: <td>NMH_EDITOR</td>
1.156 leot 11778: </tr>
11779: <tr>
1.159 rillig 11780: <td>NMH_MTA</td>
1.172 rillig 11781: <td>NMH_PAGER</td>
1.156 leot 11782: </tr>
11783: <tr>
1.159 rillig 11784: <td>NOLOGIN</td>
1.172 rillig 11785: <td>NONZERO_FILESIZE_P</td>
1.156 leot 11786: </tr>
11787: <tr>
1.159 rillig 11788: <td>NOTE</td>
1.172 rillig 11789: <td>NOT_FOR_PLATFORM</td>
1.156 leot 11790: </tr>
11791: <tr>
1.159 rillig 11792: <td>NOT_PAX_ASLR_SAFE</td>
1.172 rillig 11793: <td>NOT_PAX_MPROTECT_SAFE</td>
1.156 leot 11794: </tr>
11795: <tr>
1.159 rillig 11796: <td>NO_BUILD</td>
1.172 rillig 11797: <td>NO_CHECKSUM</td>
1.156 leot 11798: </tr>
11799: <tr>
1.159 rillig 11800: <td>NO_CONFIGURE</td>
1.172 rillig 11801: <td>NO_SKIP</td>
1.156 leot 11802: </tr>
11803: <tr>
1.159 rillig 11804: <td>NS_PREFERRED</td>
1.172 rillig 11805: <td>NULLMAILER_GROUP</td>
1.156 leot 11806: </tr>
11807: <tr>
1.159 rillig 11808: <td>NULLMAILER_USER</td>
1.172 rillig 11809: <td>OASIS</td>
1.156 leot 11810: </tr>
11811: <tr>
1.159 rillig 11812: <td>OASIS_BUILD_ARGS</td>
1.172 rillig 11813: <td>OBJHOSTNAME</td>
1.156 leot 11814: </tr>
11815: <tr>
1.159 rillig 11816: <td>OBJMACHINE</td>
1.172 rillig 11817: <td>OCAML_FINDLIB_DIRS</td>
1.156 leot 11818: </tr>
11819: <tr>
1.159 rillig 11820: <td>OCAML_FINDLIB_REGISTER</td>
1.172 rillig 11821: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.156 leot 11822: </tr>
11823: <tr>
1.159 rillig 11824: <td>OCAML_SITELIBDIR</td>
1.172 rillig 11825: <td>OCAML_TOPKG_DOCDIR</td>
1.156 leot 11826: </tr>
11827: <tr>
1.159 rillig 11828: <td>OCAML_USE_DUNE</td>
1.172 rillig 11829: <td>OCAML_USE_FINDLIB</td>
1.156 leot 11830: </tr>
11831: <tr>
1.159 rillig 11832: <td>OCAML_USE_JBUILDER</td>
1.172 rillig 11833: <td>OCAML_USE_OASIS</td>
1.156 leot 11834: </tr>
11835: <tr>
1.159 rillig 11836: <td>OCAML_USE_OASIS_DYNRUN</td>
1.172 rillig 11837: <td>OCAML_USE_OPAM</td>
1.156 leot 11838: </tr>
11839: <tr>
1.159 rillig 11840: <td>OCAML_USE_OPT_COMPILER</td>
1.172 rillig 11841: <td>OCAML_USE_TOPKG</td>
1.156 leot 11842: </tr>
11843: <tr>
1.159 rillig 11844: <td>OMF</td>
1.172 rillig 11845: <td>ONLY_FOR_COMPILER</td>
1.156 leot 11846: </tr>
11847: <tr>
1.159 rillig 11848: <td>ONLY_FOR_PLATFORM</td>
1.172 rillig 11849: <td>OPENSSH_CHROOT</td>
1.156 leot 11850: </tr>
11851: <tr>
1.159 rillig 11852: <td>OPENSSH_GROUP</td>
1.172 rillig 11853: <td>OPENSSH_USER</td>
1.156 leot 11854: </tr>
11855: <tr>
1.159 rillig 11856: <td>OPSYS</td>
1.172 rillig 11857: <td>OPSYS_EMULDIR</td>
1.156 leot 11858: </tr>
11859: <tr>
1.159 rillig 11860: <td>OSS_TYPE</td>
1.172 rillig 11861: <td>OSX</td>
1.156 leot 11862: </tr>
11863: <tr>
1.159 rillig 11864: <td>OSX_TOLERATE_SDK_SKEW</td>
1.172 rillig 11865: <td>OS_HAVE_ALSA</td>
1.161 leot 11866: </tr>
11867: <tr>
11868: <td>OS_HAVE_RCD</td>
1.172 rillig 11869: <td>OS_VARIANT</td>
1.159 rillig 11870: </tr>
11871: <tr>
11872: <td>OS_VERSION</td>
1.172 rillig 11873: <td>OTF_FONTS_DIR</td>
1.156 leot 11874: </tr>
11875: <tr>
1.159 rillig 11876: <td>OVERRIDE_DIRDEPTH</td>
1.172 rillig 11877: <td>OVERRIDE_GEMSPEC</td>
1.156 leot 11878: </tr>
11879: <tr>
1.159 rillig 11880: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.172 rillig 11881: <td>OVERRIDE_ROCKSPEC</td>
1.161 leot 11882: </tr>
11883: <tr>
1.158 brook 11884: <td>OWN_DIRS</td>
1.172 rillig 11885: <td>OWN_DIRS_PERMS</td>
1.156 leot 11886: </tr>
11887: <tr>
1.158 brook 11888: <td>P4GROUP</td>
1.172 rillig 11889: <td>P4PORT</td>
1.156 leot 11890: </tr>
11891: <tr>
1.158 brook 11892: <td>P4ROOT</td>
1.172 rillig 11893: <td>P4USER</td>
1.156 leot 11894: </tr>
11895: <tr>
1.158 brook 11896: <td>PACKAGES</td>
1.172 rillig 11897: <td>PALMOS_DEFAULT_SDK</td>
1.156 leot 11898: </tr>
11899: <tr>
1.158 brook 11900: <td>PAMBASE</td>
1.172 rillig 11901: <td>PAM_DEFAULT</td>
1.156 leot 11902: </tr>
11903: <tr>
1.158 brook 11904: <td>PAPERSIZE</td>
1.172 rillig 11905: <td>PASSIVE_FETCH</td>
1.156 leot 11906: </tr>
11907: <tr>
1.158 brook 11908: <td>PATCHDIR</td>
1.172 rillig 11909: <td>PATCHFILES</td>
1.156 leot 11910: </tr>
11911: <tr>
1.158 brook 11912: <td>PATCH_ARGS</td>
1.172 rillig 11913: <td>PATCH_DEBUG</td>
1.169 rillig 11914: </tr>
11915: <tr>
11916: <td>PATCH_DIST_ARGS</td>
1.172 rillig 11917: <td>PATCH_DIST_CAT</td>
1.156 leot 11918: </tr>
11919: <tr>
1.169 rillig 11920: <td>PATCH_DIST_STRIP</td>
1.172 rillig 11921: <td>PATCH_FUZZ_FACTOR</td>
1.156 leot 11922: </tr>
11923: <tr>
1.169 rillig 11924: <td>PATCH_STRIP</td>
1.172 rillig 11925: <td>PATH</td>
1.156 leot 11926: </tr>
11927: <tr>
1.169 rillig 11928: <td>PCCBASE</td>
1.172 rillig 11929: <td>PEAR</td>
1.156 leot 11930: </tr>
11931: <tr>
1.169 rillig 11932: <td>PEAR_CHANNEL</td>
1.172 rillig 11933: <td>PEAR_CHANNEL_ALIAS</td>
1.156 leot 11934: </tr>
11935: <tr>
1.169 rillig 11936: <td>PEAR_CHANNEL_VERSION</td>
1.172 rillig 11937: <td>PEAR_CMD</td>
1.161 leot 11938: </tr>
11939: <tr>
1.169 rillig 11940: <td>PEAR_LIB</td>
1.172 rillig 11941: <td>PEAR_PACKAGE_XML</td>
1.161 leot 11942: </tr>
11943: <tr>
1.169 rillig 11944: <td>PERL5</td>
1.172 rillig 11945: <td>PERL5_CONFIGURE</td>
1.156 leot 11946: </tr>
11947: <tr>
1.169 rillig 11948: <td>PERL5_CONFIGURE_DIRS</td>
1.172 rillig 11949: <td>PERL5_LDFLAGS</td>
1.156 leot 11950: </tr>
11951: <tr>
1.169 rillig 11952: <td>PERL5_LICENSE</td>
1.172 rillig 11953: <td>PERL5_MODULE_TYPE</td>
1.156 leot 11954: </tr>
11955: <tr>
1.169 rillig 11956: <td>PERL5_PACKLIST</td>
1.172 rillig 11957: <td>PERL5_PACKLIST_DIR</td>
1.156 leot 11958: </tr>
11959: <tr>
1.169 rillig 11960: <td>PERL5_PERLBASE</td>
1.172 rillig 11961: <td>PERL5_SITEBASE</td>
1.156 leot 11962: </tr>
11963: <tr>
1.169 rillig 11964: <td>PERL5_USE_PACKLIST</td>
1.172 rillig 11965: <td>PERL5_VENDORBASE</td>
1.156 leot 11966: </tr>
11967: <tr>
1.169 rillig 11968: <td>PFCTL</td>
1.172 rillig 11969: <td>PFVAR_H</td>
1.156 leot 11970: </tr>
11971: <tr>
1.169 rillig 11972: <td>PF_VERSION</td>
1.172 rillig 11973: <td>PGGROUP</td>
1.156 leot 11974: </tr>
11975: <tr>
1.169 rillig 11976: <td>PGHOME</td>
1.172 rillig 11977: <td>PGPKGSRCDIR</td>
1.156 leot 11978: </tr>
11979: <tr>
1.169 rillig 11980: <td>PGSQL_TYPE</td>
1.172 rillig 11981: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.156 leot 11982: </tr>
11983: <tr>
1.169 rillig 11984: <td>PGSQL_VERSION_DEFAULT</td>
1.172 rillig 11985: <td>PGUSER</td>
1.156 leot 11986: </tr>
11987: <tr>
1.169 rillig 11988: <td>PG_LIB_EXT</td>
1.172 rillig 11989: <td>PHP</td>
1.156 leot 11990: </tr>
11991: <tr>
1.169 rillig 11992: <td>PHPCOMMON_MK</td>
1.172 rillig 11993: <td>PHPPKGSRCDIR</td>
1.156 leot 11994: </tr>
11995: <tr>
1.169 rillig 11996: <td>PHP_BASE_VERS</td>
1.172 rillig 11997: <td>PHP_CHECK_INSTALLED</td>
1.156 leot 11998: </tr>
11999: <tr>
1.169 rillig 12000: <td>PHP_EXTENSION_DIR</td>
1.172 rillig 12001: <td>PHP_INITIAL_TEENY</td>
1.156 leot 12002: </tr>
12003: <tr>
1.169 rillig 12004: <td>PHP_PKG_PREFIX</td>
1.172 rillig 12005: <td>PHP_VERSION</td>
1.156 leot 12006: </tr>
12007: <tr>
1.169 rillig 12008: <td>PHP_VERSIONS_ACCEPTED</td>
1.172 rillig 12009: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.156 leot 12010: </tr>
12011: <tr>
1.169 rillig 12012: <td>PHP_VERSION_DEFAULT</td>
1.172 rillig 12013: <td>PHP_VERSION_REQD</td>
1.156 leot 12014: </tr>
12015: <tr>
1.169 rillig 12016: <td>PILRC_USE_GTK</td>
1.172 rillig 12017: <td>PKGCONFIG_BASE</td>
1.156 leot 12018: </tr>
12019: <tr>
1.169 rillig 12020: <td>PKGCONFIG_FILE</td>
1.172 rillig 12021: <td>PKGCONFIG_OVERRIDE</td>
1.156 leot 12022: </tr>
12023: <tr>
1.169 rillig 12024: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.172 rillig 12025: <td>PKGDIR</td>
1.156 leot 12026: </tr>
12027: <tr>
1.169 rillig 12028: <td>PKGGNUDIR</td>
1.172 rillig 12029: <td>PKGINFODIR</td>
1.156 leot 12030: </tr>
12031: <tr>
1.169 rillig 12032: <td>PKGLOCALEDIR</td>
1.172 rillig 12033: <td>PKGMANDIR</td>
1.156 leot 12034: </tr>
12035: <tr>
1.169 rillig 12036: <td>PKGNAME</td>
1.172 rillig 12037: <td>PKGNAME_REQD</td>
1.156 leot 12038: </tr>
12039: <tr>
1.169 rillig 12040: <td>PKGPATH</td>
1.172 rillig 12041: <td>PKGREVISION</td>
1.156 leot 12042: </tr>
12043: <tr>
1.169 rillig 12044: <td>PKGSRC_BLAS_TYPES</td>
1.172 rillig 12045: <td>PKGSRC_CHANGES</td>
1.156 leot 12046: </tr>
12047: <tr>
1.169 rillig 12048: <td>PKGSRC_COMPILER</td>
1.172 rillig 12049: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.159 rillig 12050: </tr>
12051: <tr>
1.169 rillig 12052: <td>PKGSRC_LOCKTYPE</td>
1.172 rillig 12053: <td>PKGSRC_MAKE_ENV</td>
1.156 leot 12054: </tr>
12055: <tr>
1.169 rillig 12056: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.172 rillig 12057: <td>PKGSRC_MKPIE</td>
1.156 leot 12058: </tr>
12059: <tr>
1.169 rillig 12060: <td>PKGSRC_MKREPRO</td>
1.172 rillig 12061: <td>PKGSRC_RUN_TEST</td>
1.156 leot 12062: </tr>
12063: <tr>
1.169 rillig 12064: <td>PKGSRC_SETENV</td>
1.172 rillig 12065: <td>PKGSRC_SLEEPSECS</td>
1.156 leot 12066: </tr>
12067: <tr>
1.169 rillig 12068: <td>PKGSRC_TODO</td>
1.172 rillig 12069: <td>PKGSRC_USE_CTF</td>
1.156 leot 12070: </tr>
12071: <tr>
1.169 rillig 12072: <td>PKGSRC_USE_FORTIFY</td>
1.172 rillig 12073: <td>PKGSRC_USE_RELRO</td>
1.156 leot 12074: </tr>
12075: <tr>
1.169 rillig 12076: <td>PKGSRC_USE_SSP</td>
1.172 rillig 12077: <td>PKGSRC_USE_STACK_CHECK</td>
1.156 leot 12078: </tr>
12079: <tr>
1.169 rillig 12080: <td>PKGTASKS_DATAFILE</td>
1.172 rillig 12081: <td>PKGTOOLS_ARGS</td>
1.156 leot 12082: </tr>
12083: <tr>
1.169 rillig 12084: <td>PKGTOOLS_ENV</td>
1.172 rillig 12085: <td>PKG_ALTERNATIVES</td>
1.156 leot 12086: </tr>
12087: <tr>
1.169 rillig 12088: <td>PKG_APACHE</td>
1.172 rillig 12089: <td>PKG_APACHE_ACCEPTED</td>
1.156 leot 12090: </tr>
12091: <tr>
1.169 rillig 12092: <td>PKG_APACHE_DEFAULT</td>
1.172 rillig 12093: <td>PKG_BEST_EXISTS</td>
1.156 leot 12094: </tr>
12095: <tr>
1.169 rillig 12096: <td>PKG_BUILD_OPTIONS</td>
1.172 rillig 12097: <td>PKG_COMPRESSION</td>
1.156 leot 12098: </tr>
12099: <tr>
1.169 rillig 12100: <td>PKG_CONFIG</td>
1.172 rillig 12101: <td>PKG_CONFIG_PERMS</td>
1.156 leot 12102: </tr>
12103: <tr>
1.169 rillig 12104: <td>PKG_CREATE_USERGROUP</td>
1.172 rillig 12105: <td>PKG_DB_TMPDIR</td>
1.156 leot 12106: </tr>
12107: <tr>
1.169 rillig 12108: <td>PKG_DEBUG_LEVEL</td>
1.172 rillig 12109: <td>PKG_DEFAULT_OPTIONS</td>
1.156 leot 12110: </tr>
12111: <tr>
1.169 rillig 12112: <td>PKG_DESTDIR_SUPPORT</td>
1.172 rillig 12113: <td>PKG_DEVELOPER</td>
1.156 leot 12114: </tr>
12115: <tr>
1.169 rillig 12116: <td>PKG_DISABLED_OPTIONS</td>
1.172 rillig 12117: <td>PKG_FATAL_ERRORS</td>
1.156 leot 12118: </tr>
12119: <tr>
1.169 rillig 12120: <td>PKG_FC</td>
1.172 rillig 12121: <td>PKG_FILELIST_CMD</td>
1.156 leot 12122: </tr>
12123: <tr>
1.169 rillig 12124: <td>PKG_GECOS</td>
1.172 rillig 12125: <td>PKG_GID</td>
1.156 leot 12126: </tr>
12127: <tr>
1.169 rillig 12128: <td>PKG_GROUPS</td>
1.172 rillig 12129: <td>PKG_GROUPS_VARS</td>
1.156 leot 12130: </tr>
12131: <tr>
1.169 rillig 12132: <td>PKG_HOME</td>
1.172 rillig 12133: <td>PKG_INIT_SCRIPTS</td>
1.156 leot 12134: </tr>
12135: <tr>
1.169 rillig 12136: <td>PKG_JAVA_HOME</td>
1.172 rillig 12137: <td>PKG_JVM</td>
1.156 leot 12138: </tr>
12139: <tr>
1.169 rillig 12140: <td>PKG_JVMS_ACCEPTED</td>
1.172 rillig 12141: <td>PKG_JVM_DEFAULT</td>
1.156 leot 12142: </tr>
12143: <tr>
1.169 rillig 12144: <td>PKG_LEGACY_OPTIONS</td>
1.172 rillig 12145: <td>PKG_LIBTOOL</td>
1.156 leot 12146: </tr>
12147: <tr>
1.169 rillig 12148: <td>PKG_OPTIONS</td>
1.172 rillig 12149: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.156 leot 12150: </tr>
12151: <tr>
1.169 rillig 12152: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.172 rillig 12153: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.156 leot 12154: </tr>
12155: <tr>
1.169 rillig 12156: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.172 rillig 12157: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.156 leot 12158: </tr>
12159: <tr>
1.169 rillig 12160: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.172 rillig 12161: <td>PKG_OPTIONS_VAR</td>
1.156 leot 12162: </tr>
12163: <tr>
1.169 rillig 12164: <td>PKG_PHP</td>
1.172 rillig 12165: <td>PKG_PHP_MAJOR_VERS</td>
1.156 leot 12166: </tr>
12167: <tr>
1.169 rillig 12168: <td>PKG_PHP_VERSION</td>
1.172 rillig 12169: <td>PKG_RCD_SCRIPTS</td>
1.156 leot 12170: </tr>
12171: <tr>
1.169 rillig 12172: <td>PKG_REFCOUNT_DBDIR</td>
1.172 rillig 12173: <td>PKG_REGISTER_SHELLS</td>
1.156 leot 12174: </tr>
12175: <tr>
1.169 rillig 12176: <td>PKG_RESUME_TRANSFERS</td>
1.172 rillig 12177: <td>PKG_SHELL</td>
1.156 leot 12178: </tr>
12179: <tr>
1.169 rillig 12180: <td>PKG_SUGGESTED_OPTIONS</td>
1.172 rillig 12181: <td>PKG_SUPPORTED_OPTIONS</td>
1.156 leot 12182: </tr>
12183: <tr>
1.169 rillig 12184: <td>PKG_SYSCONFBASE</td>
1.172 rillig 12185: <td>PKG_SYSCONFBASEDIR</td>
1.156 leot 12186: </tr>
12187: <tr>
1.169 rillig 12188: <td>PKG_SYSCONFDIR</td>
1.172 rillig 12189: <td>PKG_SYSCONFDIR_PERMS</td>
1.156 leot 12190: </tr>
12191: <tr>
1.169 rillig 12192: <td>PKG_SYSCONFSUBDIR</td>
1.172 rillig 12193: <td>PKG_SYSCONFVAR</td>
1.156 leot 12194: </tr>
12195: <tr>
1.169 rillig 12196: <td>PKG_TOOLS_BIN</td>
1.172 rillig 12197: <td>PKG_UID</td>
1.156 leot 12198: </tr>
12199: <tr>
1.169 rillig 12200: <td>PKG_UPDATE_FONTS_DB</td>
1.172 rillig 12201: <td>PKG_USERS</td>
1.156 leot 12202: </tr>
12203: <tr>
1.169 rillig 12204: <td>PKG_USERS_VARS</td>
1.172 rillig 12205: <td>PKG_VERBOSE</td>
1.156 leot 12206: </tr>
12207: <tr>
1.169 rillig 12208: <td>PLIST</td>
1.172 rillig 12209: <td>PLIST_AWK</td>
1.156 leot 12210: </tr>
12211: <tr>
1.169 rillig 12212: <td>PLIST_AWK_ENV</td>
1.172 rillig 12213: <td>PLIST_SRC</td>
1.156 leot 12214: </tr>
12215: <tr>
1.169 rillig 12216: <td>PLIST_SUBST</td>
1.172 rillig 12217: <td>PLIST_TYPE</td>
1.156 leot 12218: </tr>
12219: <tr>
1.169 rillig 12220: <td>PLIST_VARS</td>
1.172 rillig 12221: <td>POPTOP_USE_MPPE</td>
1.156 leot 12222: </tr>
12223: <tr>
1.169 rillig 12224: <td>POST_FETCH_HOOK</td>
1.172 rillig 12225: <td>PREFER</td>
1.156 leot 12226: </tr>
12227: <tr>
1.169 rillig 12228: <td>PREFER_NATIVE</td>
1.172 rillig 12229: <td>PREFER_NATIVE_PTHREADS</td>
1.156 leot 12230: </tr>
12231: <tr>
1.169 rillig 12232: <td>PREFER_PKGSRC</td>
1.172 rillig 12233: <td>PREFIX</td>
1.156 leot 12234: </tr>
12235: <tr>
1.169 rillig 12236: <td>PREPEND_PATH</td>
1.172 rillig 12237: <td>PRE_ROOT_CMD</td>
1.156 leot 12238: </tr>
12239: <tr>
1.169 rillig 12240: <td>PRIVILEGED_STAGES</td>
1.172 rillig 12241: <td>PS</td>
1.156 leot 12242: </tr>
12243: <tr>
1.169 rillig 12244: <td>PTHREAD_AUTO_VARS</td>
1.172 rillig 12245: <td>PTHREAD_CFLAGS</td>
1.156 leot 12246: </tr>
12247: <tr>
1.169 rillig 12248: <td>PTHREAD_LDFLAGS</td>
1.172 rillig 12249: <td>PTHREAD_LIBS</td>
1.156 leot 12250: </tr>
12251: <tr>
1.169 rillig 12252: <td>PTHREAD_OPTS</td>
1.172 rillig 12253: <td>PTHREAD_TYPE</td>
1.156 leot 12254: </tr>
12255: <tr>
1.169 rillig 12256: <td>PVM_SSH</td>
1.172 rillig 12257: <td>PYPKGPREFIX</td>
1.156 leot 12258: </tr>
12259: <tr>
1.169 rillig 12260: <td>PYTHON_FOR_BUILD_ONLY</td>
1.172 rillig 12261: <td>PYTHON_SELF_CONFLICT</td>
1.156 leot 12262: </tr>
12263: <tr>
1.169 rillig 12264: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.172 rillig 12265: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.156 leot 12266: </tr>
12267: <tr>
1.169 rillig 12268: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.172 rillig 12269: <td>PYTHON_VERSION_DEFAULT</td>
1.156 leot 12270: </tr>
12271: <tr>
1.169 rillig 12272: <td>PYTHON_VERSION_REQD</td>
1.172 rillig 12273: <td>PYVERSSUFFIX</td>
1.156 leot 12274: </tr>
12275: <tr>
1.169 rillig 12276: <td>PY_NO_EGG</td>
1.172 rillig 12277: <td>QMAILDIR</td>
1.156 leot 12278: </tr>
12279: <tr>
1.169 rillig 12280: <td>QMAIL_ALIAS_USER</td>
1.172 rillig 12281: <td>QMAIL_DAEMON_USER</td>
1.156 leot 12282: </tr>
12283: <tr>
1.169 rillig 12284: <td>QMAIL_LOG_USER</td>
1.172 rillig 12285: <td>QMAIL_NOFILES_GROUP</td>
1.156 leot 12286: </tr>
12287: <tr>
1.169 rillig 12288: <td>QMAIL_PASSWD_USER</td>
1.172 rillig 12289: <td>QMAIL_QMAIL_GROUP</td>
1.156 leot 12290: </tr>
12291: <tr>
1.169 rillig 12292: <td>QMAIL_QUEUE_DIR</td>
1.172 rillig 12293: <td>QMAIL_QUEUE_EXTRA</td>
1.156 leot 12294: </tr>
12295: <tr>
1.169 rillig 12296: <td>QMAIL_QUEUE_USER</td>
1.172 rillig 12297: <td>QMAIL_REMOTE_USER</td>
1.156 leot 12298: </tr>
12299: <tr>
1.169 rillig 12300: <td>QMAIL_ROOT_USER</td>
1.172 rillig 12301: <td>QMAIL_SEND_USER</td>
1.156 leot 12302: </tr>
12303: <tr>
1.169 rillig 12304: <td>QPOPPER_FAC</td>
1.172 rillig 12305: <td>QPOPPER_SPOOL_DIR</td>
1.156 leot 12306: </tr>
12307: <tr>
1.169 rillig 12308: <td>QPOPPER_USER</td>
1.172 rillig 12309: <td>RAKE_NAME</td>
1.156 leot 12310: </tr>
12311: <tr>
1.169 rillig 12312: <td>RASMOL_DEPTH</td>
1.172 rillig 12313: <td>RCD_DIR</td>
1.156 leot 12314: </tr>
12315: <tr>
1.169 rillig 12316: <td>RCD_ORDER</td>
1.172 rillig 12317: <td>RCD_SCRIPTS</td>
1.161 leot 12318: </tr>
12319: <tr>
1.169 rillig 12320: <td>RCD_SCRIPTS_DIR</td>
1.172 rillig 12321: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.159 rillig 12322: </tr>
12323: <tr>
1.169 rillig 12324: <td>RCD_SCRIPTS_MODE</td>
1.172 rillig 12325: <td>RCD_SCRIPTS_SHELL</td>
1.156 leot 12326: </tr>
12327: <tr>
1.169 rillig 12328: <td>RCD_SCRIPT_SRC</td>
1.172 rillig 12329: <td>RCD_SUBR</td>
1.156 leot 12330: </tr>
12331: <tr>
1.169 rillig 12332: <td>RDOC</td>
1.172 rillig 12333: <td>READLINE_DEFAULT</td>
1.161 leot 12334: </tr>
12335: <tr>
1.169 rillig 12336: <td>READLINE_TYPE</td>
1.172 rillig 12337: <td>REAL_ROOT_GROUP</td>
1.156 leot 12338: </tr>
12339: <tr>
1.169 rillig 12340: <td>REAL_ROOT_USER</td>
1.172 rillig 12341: <td>RECURSIVE_MAKE</td>
1.156 leot 12342: </tr>
12343: <tr>
1.169 rillig 12344: <td>RELAY_CTRL_DIR</td>
1.172 rillig 12345: <td>REPLACE_AWK</td>
1.156 leot 12346: </tr>
12347: <tr>
1.169 rillig 12348: <td>REPLACE_BASH</td>
1.172 rillig 12349: <td>REPLACE_CSH</td>
1.156 leot 12350: </tr>
12351: <tr>
1.169 rillig 12352: <td>REPLACE_KSH</td>
1.172 rillig 12353: <td>REPLACE_PERL</td>
1.156 leot 12354: </tr>
12355: <tr>
1.169 rillig 12356: <td>REPLACE_PERL6</td>
1.172 rillig 12357: <td>REPLACE_PHP</td>
1.156 leot 12358: </tr>
12359: <tr>
1.169 rillig 12360: <td>REPLACE_PYTHON</td>
1.172 rillig 12361: <td>REPLACE_RUBY</td>
1.166 leot 12362: </tr>
12363: <tr>
1.169 rillig 12364: <td>REPLACE_RUBY_DIRS</td>
1.172 rillig 12365: <td>REPLACE_RUBY_PAT</td>
1.156 leot 12366: </tr>
12367: <tr>
1.169 rillig 12368: <td>REPLACE_SH</td>
1.172 rillig 12369: <td>REPLACE_TEXLUA</td>
1.156 leot 12370: </tr>
12371: <tr>
1.169 rillig 12372: <td>REQD_DIRS</td>
1.172 rillig 12373: <td>REQD_DIRS_PERMS</td>
1.156 leot 12374: </tr>
12375: <tr>
1.169 rillig 12376: <td>REQD_FILES</td>
1.172 rillig 12377: <td>REQD_FILES_MODE</td>
1.156 leot 12378: </tr>
12379: <tr>
1.169 rillig 12380: <td>REQD_FILES_PERMS</td>
1.172 rillig 12381: <td>RESOLV_AUTO_VARS</td>
1.156 leot 12382: </tr>
12383: <tr>
1.169 rillig 12384: <td>RESOLV_LDFLAGS</td>
1.172 rillig 12385: <td>RESOLV_LIBS</td>
1.156 leot 12386: </tr>
12387: <tr>
1.169 rillig 12388: <td>RM</td>
1.172 rillig 12389: <td>ROCKSPEC_NAME</td>
1.156 leot 12390: </tr>
12391: <tr>
1.169 rillig 12392: <td>ROCKSPEC_SPECFILE</td>
1.172 rillig 12393: <td>ROOT_CMD</td>
1.161 leot 12394: </tr>
12395: <tr>
1.169 rillig 12396: <td>ROOT_GROUP</td>
1.172 rillig 12397: <td>ROOT_USER</td>
1.156 leot 12398: </tr>
12399: <tr>
1.169 rillig 12400: <td>RPCGEN</td>
1.172 rillig 12401: <td>RPM</td>
1.156 leot 12402: </tr>
12403: <tr>
1.169 rillig 12404: <td>RPM2PKG_PLIST</td>
1.172 rillig 12405: <td>RPM2PKG_PREFIX</td>
1.156 leot 12406: </tr>
12407: <tr>
1.169 rillig 12408: <td>RPM2PKG_STAGE</td>
1.172 rillig 12409: <td>RPM2PKG_STRIP</td>
1.156 leot 12410: </tr>
12411: <tr>
1.169 rillig 12412: <td>RPM2PKG_SUBPREFIX</td>
1.172 rillig 12413: <td>RPMFILES</td>
1.156 leot 12414: </tr>
12415: <tr>
1.169 rillig 12416: <td>RPMIGNOREPATH</td>
1.172 rillig 12417: <td>RPM_DB_PREFIX</td>
1.156 leot 12418: </tr>
12419: <tr>
1.169 rillig 12420: <td>RSSH_CVS_PATH</td>
1.172 rillig 12421: <td>RSSH_RDIST_PATH</td>
1.156 leot 12422: </tr>
12423: <tr>
1.169 rillig 12424: <td>RSSH_RSYNC_PATH</td>
1.172 rillig 12425: <td>RSSH_SCP_PATH</td>
1.156 leot 12426: </tr>
12427: <tr>
1.169 rillig 12428: <td>RSSH_SFTP_SERVER_PATH</td>
1.172 rillig 12429: <td>RUBY</td>
1.156 leot 12430: </tr>
12431: <tr>
1.169 rillig 12432: <td>RUBYGEM</td>
1.172 rillig 12433: <td>RUBYGEM_NAME</td>
1.156 leot 12434: </tr>
12435: <tr>
1.169 rillig 12436: <td>RUBYGEM_OPTIONS</td>
1.172 rillig 12437: <td>RUBY_ABI_VERSION</td>
1.156 leot 12438: </tr>
12439: <tr>
1.169 rillig 12440: <td>RUBY_ARCH</td>
1.172 rillig 12441: <td>RUBY_ARCHINC</td>
1.156 leot 12442: </tr>
12443: <tr>
1.169 rillig 12444: <td>RUBY_ARCHLIB</td>
1.172 rillig 12445: <td>RUBY_BASE</td>
1.156 leot 12446: </tr>
12447: <tr>
1.169 rillig 12448: <td>RUBY_BASERIDIR</td>
1.172 rillig 12449: <td>RUBY_BUILD_DOCUMENT</td>
1.156 leot 12450: </tr>
12451: <tr>
1.169 rillig 12452: <td>RUBY_DLEXT</td>
1.172 rillig 12453: <td>RUBY_DOC</td>
1.156 leot 12454: </tr>
12455: <tr>
1.169 rillig 12456: <td>RUBY_DYNAMIC_DIRS</td>
1.172 rillig 12457: <td>RUBY_EG</td>
1.156 leot 12458: </tr>
12459: <tr>
1.169 rillig 12460: <td>RUBY_ENCODING_ARG</td>
1.172 rillig 12461: <td>RUBY_EXTCONF</td>
1.156 leot 12462: </tr>
12463: <tr>
1.169 rillig 12464: <td>RUBY_EXTCONF_CHECK</td>
1.172 rillig 12465: <td>RUBY_EXTCONF_DEBUG</td>
1.156 leot 12466: </tr>
12467: <tr>
1.169 rillig 12468: <td>RUBY_EXTCONF_MAKEFILE</td>
1.172 rillig 12469: <td>RUBY_GEM_BASE</td>
1.156 leot 12470: </tr>
12471: <tr>
1.169 rillig 12472: <td>RUBY_INC</td>
1.172 rillig 12473: <td>RUBY_LIB</td>
1.156 leot 12474: </tr>
12475: <tr>
1.169 rillig 12476: <td>RUBY_LIB_BASE</td>
1.172 rillig 12477: <td>RUBY_NAME</td>
1.156 leot 12478: </tr>
12479: <tr>
1.169 rillig 12480: <td>RUBY_NOVERSION</td>
1.172 rillig 12481: <td>RUBY_PKGPREFIX</td>
1.156 leot 12482: </tr>
12483: <tr>
1.169 rillig 12484: <td>RUBY_RAILS</td>
1.172 rillig 12485: <td>RUBY_RAILS42_VERSION</td>
1.156 leot 12486: </tr>
12487: <tr>
1.169 rillig 12488: <td>RUBY_RAILS51_VERSION</td>
1.172 rillig 12489: <td>RUBY_RAILS52_VERSION</td>
1.156 leot 12490: </tr>
12491: <tr>
1.169 rillig 12492: <td>RUBY_RAILS_ACCEPTED</td>
1.172 rillig 12493: <td>RUBY_RAILS_DEFAULT</td>
1.156 leot 12494: </tr>
12495: <tr>
1.169 rillig 12496: <td>RUBY_RAILS_REQD</td>
1.172 rillig 12497: <td>RUBY_RAILS_STRICT_DEP</td>
1.156 leot 12498: </tr>
12499: <tr>
1.169 rillig 12500: <td>RUBY_RIDIR</td>
1.172 rillig 12501: <td>RUBY_SETUP</td>
1.156 leot 12502: </tr>
12503: <tr>
1.169 rillig 12504: <td>RUBY_SHLIB</td>
1.172 rillig 12505: <td>RUBY_SHLIBALIAS</td>
1.156 leot 12506: </tr>
12507: <tr>
1.169 rillig 12508: <td>RUBY_SHLIBVER</td>
1.172 rillig 12509: <td>RUBY_SIMPLE_INSTALL</td>
1.156 leot 12510: </tr>
12511: <tr>
1.169 rillig 12512: <td>RUBY_SITEARCHLIB</td>
1.172 rillig 12513: <td>RUBY_SITELIB</td>
1.156 leot 12514: </tr>
12515: <tr>
1.169 rillig 12516: <td>RUBY_SITELIB_BASE</td>
1.172 rillig 12517: <td>RUBY_SITERIDIR</td>
1.156 leot 12518: </tr>
12519: <tr>
1.169 rillig 12520: <td>RUBY_SLEXT</td>
1.172 rillig 12521: <td>RUBY_SRCDIR</td>
1.156 leot 12522: </tr>
12523: <tr>
1.169 rillig 12524: <td>RUBY_STATICLIB</td>
1.172 rillig 12525: <td>RUBY_SUFFIX</td>
1.156 leot 12526: </tr>
12527: <tr>
1.169 rillig 12528: <td>RUBY_SYSRIDIR</td>
1.172 rillig 12529: <td>RUBY_USE_PTHREAD</td>
1.156 leot 12530: </tr>
12531: <tr>
1.169 rillig 12532: <td>RUBY_VENDORARCHLIB</td>
1.172 rillig 12533: <td>RUBY_VENDORLIB</td>
1.156 leot 12534: </tr>
12535: <tr>
1.169 rillig 12536: <td>RUBY_VENDORLIB_BASE</td>
1.172 rillig 12537: <td>RUBY_VER</td>
1.156 leot 12538: </tr>
12539: <tr>
1.169 rillig 12540: <td>RUBY_VERSION</td>
1.172 rillig 12541: <td>RUBY_VERSIONS_ACCEPTED</td>
1.156 leot 12542: </tr>
12543: <tr>
1.169 rillig 12544: <td>RUBY_VERSION_DEFAULT</td>
1.172 rillig 12545: <td>RUBY_VERSION_REQD</td>
1.156 leot 12546: </tr>
12547: <tr>
1.169 rillig 12548: <td>RUBY_VER_DIR</td>
1.172 rillig 12549: <td>RUN</td>
1.156 leot 12550: </tr>
12551: <tr>
1.169 rillig 12552: <td>RUN_LDCONFIG</td>
1.172 rillig 12553: <td>SAWFISH_THEMES</td>
1.156 leot 12554: </tr>
12555: <tr>
1.169 rillig 12556: <td>SCO</td>
1.172 rillig 12557: <td>SCREWS_GROUP</td>
1.156 leot 12558: </tr>
12559: <tr>
1.169 rillig 12560: <td>SCREWS_USER</td>
1.172 rillig 12561: <td>SCRIPTS_ENV</td>
1.156 leot 12562: </tr>
12563: <tr>
1.169 rillig 12564: <td>SCROLLKEEPER_DATADIR</td>
1.172 rillig 12565: <td>SCROLLKEEPER_REBUILDDB</td>
1.156 leot 12566: </tr>
12567: <tr>
1.169 rillig 12568: <td>SCROLLKEEPER_UPDATEDB</td>
1.172 rillig 12569: <td>SDIST_PAWD</td>
1.156 leot 12570: </tr>
12571: <tr>
1.169 rillig 12572: <td>SERIAL_DEVICES</td>
1.172 rillig 12573: <td>SETGIDGAME</td>
1.156 leot 12574: </tr>
12575: <tr>
1.169 rillig 12576: <td>SETGID_GAMES_PERMS</td>
1.172 rillig 12577: <td>SETUID_ROOT_PERMS</td>
1.156 leot 12578: </tr>
12579: <tr>
1.169 rillig 12580: <td>SH</td>
1.172 rillig 12581: <td>SHLIB</td>
1.156 leot 12582: </tr>
12583: <tr>
1.169 rillig 12584: <td>SHORTNAME</td>
1.172 rillig 12585: <td>SIGN_PACKAGES</td>
1.156 leot 12586: </tr>
12587: <tr>
1.169 rillig 12588: <td>SILC_CLIENT_WITH_PERL</td>
1.172 rillig 12589: <td>SITE_SPECIFIC_PKGS</td>
1.156 leot 12590: </tr>
12591: <tr>
1.169 rillig 12592: <td>SKIP_DEPENDS</td>
1.172 rillig 12593: <td>SMF_INSTANCES</td>
1.159 rillig 12594: </tr>
12595: <tr>
1.169 rillig 12596: <td>SMF_MANIFEST</td>
1.172 rillig 12597: <td>SMF_METHODS</td>
1.156 leot 12598: </tr>
12599: <tr>
1.169 rillig 12600: <td>SMF_METHOD_SHELL</td>
1.172 rillig 12601: <td>SMF_METHOD_SRC</td>
1.156 leot 12602: </tr>
12603: <tr>
1.169 rillig 12604: <td>SMF_NAME</td>
1.172 rillig 12605: <td>SMF_PREFIX</td>
1.156 leot 12606: </tr>
12607: <tr>
1.169 rillig 12608: <td>SMF_SRCDIR</td>
1.172 rillig 12609: <td>SNIPROXY_GROUP</td>
1.156 leot 12610: </tr>
12611: <tr>
1.169 rillig 12612: <td>SNIPROXY_USER</td>
1.172 rillig 12613: <td>SOURCE_BUFFSIZE</td>
1.156 leot 12614: </tr>
12615: <tr>
1.169 rillig 12616: <td>SPECIAL_PERMS</td>
1.172 rillig 12617: <td>SPECIFIC_PKGS</td>
1.156 leot 12618: </tr>
12619: <tr>
1.169 rillig 12620: <td>SSH_SUID</td>
1.172 rillig 12621: <td>SSP_SUPPORTED</td>
1.156 leot 12622: </tr>
12623: <tr>
1.169 rillig 12624: <td>SSYNC_PAWD</td>
1.172 rillig 12625: <td>STEP_MSG</td>
1.156 leot 12626: </tr>
12627: <tr>
1.169 rillig 12628: <td>STRIP</td>
1.172 rillig 12629: <td>STRIP_DBG</td>
1.156 leot 12630: </tr>
12631: <tr>
1.169 rillig 12632: <td>STRIP_DEBUG</td>
1.172 rillig 12633: <td>STRIP_DEBUG_SUPPORTED</td>
1.156 leot 12634: </tr>
12635: <tr>
1.169 rillig 12636: <td>STRIP_FILES_SKIP</td>
1.172 rillig 12637: <td>SU</td>
1.156 leot 12638: </tr>
12639: <tr>
1.169 rillig 12640: <td>SUBDIR</td>
1.172 rillig 12641: <td>SUBST_CLASSES</td>
1.156 leot 12642: </tr>
12643: <tr>
1.169 rillig 12644: <td>SUBST_FILES</td>
1.172 rillig 12645: <td>SUBST_FILTER_CMD</td>
1.156 leot 12646: </tr>
12647: <tr>
1.169 rillig 12648: <td>SUBST_MESSAGE</td>
1.172 rillig 12649: <td>SUBST_SED</td>
1.156 leot 12650: </tr>
12651: <tr>
1.169 rillig 12652: <td>SUBST_SHOW_DIFF</td>
1.172 rillig 12653: <td>SUBST_SKIP_TEXT_CHECK</td>
1.156 leot 12654: </tr>
12655: <tr>
1.169 rillig 12656: <td>SUBST_STAGE</td>
1.172 rillig 12657: <td>SUBST_VARS</td>
1.156 leot 12658: </tr>
12659: <tr>
1.169 rillig 12660: <td>SUNWSPROBASE</td>
1.172 rillig 12661: <td>SUSE_PREFER</td>
1.156 leot 12662: </tr>
12663: <tr>
1.169 rillig 12664: <td>SU_CMD</td>
1.172 rillig 12665: <td>SVN_EXTRACTDIR</td>
1.156 leot 12666: </tr>
12667: <tr>
1.169 rillig 12668: <td>SVN_REPO</td>
1.172 rillig 12669: <td>SVN_REPOSITORIES</td>
1.161 leot 12670: </tr>
12671: <tr>
1.169 rillig 12672: <td>SVN_REVISION</td>
1.172 rillig 12673: <td>TERMCAP_TYPE</td>
1.161 leot 12674: </tr>
12675: <tr>
1.169 rillig 12676: <td>TERMINFO_DEFAULT</td>
1.172 rillig 12677: <td>TERMINFO_TYPE</td>
1.159 rillig 12678: </tr>
12679: <tr>
1.169 rillig 12680: <td>TEST</td>
1.172 rillig 12681: <td>TEST_DEPENDS</td>
1.156 leot 12682: </tr>
12683: <tr>
1.169 rillig 12684: <td>TEST_DIRS</td>
1.172 rillig 12685: <td>TEST_ENV</td>
1.156 leot 12686: </tr>
12687: <tr>
1.169 rillig 12688: <td>TEST_MAKE_CMD</td>
1.172 rillig 12689: <td>TEST_MAKE_FLAGS</td>
1.156 leot 12690: </tr>
12691: <tr>
1.169 rillig 12692: <td>TEST_TARGET</td>
1.172 rillig 12693: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.156 leot 12694: </tr>
12695: <tr>
1.169 rillig 12696: <td>TEXLIVE_REV</td>
1.172 rillig 12697: <td>TEXLIVE_UNVERSIONED</td>
1.156 leot 12698: </tr>
12699: <tr>
1.169 rillig 12700: <td>TEXMFSITE</td>
1.172 rillig 12701: <td>TEX_FORMATS</td>
1.156 leot 12702: </tr>
12703: <tr>
1.169 rillig 12704: <td>TEX_HYPHEN_DAT</td>
1.172 rillig 12705: <td>TEX_HYPHEN_DEF</td>
1.156 leot 12706: </tr>
12707: <tr>
1.169 rillig 12708: <td>TEX_TEXMF_DIRS</td>
1.172 rillig 12709: <td>THTTPD_LOG_FACILITY</td>
1.156 leot 12710: </tr>
12711: <tr>
1.169 rillig 12712: <td>TO</td>
1.172 rillig 12713: <td>TOOLS_ALIASES</td>
1.156 leot 12714: </tr>
12715: <tr>
1.169 rillig 12716: <td>TOOLS_ARGS</td>
1.172 rillig 12717: <td>TOOLS_BROKEN</td>
1.156 leot 12718: </tr>
12719: <tr>
1.169 rillig 12720: <td>TOOLS_CMD</td>
1.172 rillig 12721: <td>TOOLS_CREATE</td>
1.156 leot 12722: </tr>
12723: <tr>
1.169 rillig 12724: <td>TOOLS_DIR</td>
1.172 rillig 12725: <td>TOOLS_FAIL</td>
1.156 leot 12726: </tr>
12727: <tr>
1.169 rillig 12728: <td>TOOLS_GNU_MISSING</td>
1.172 rillig 12729: <td>TOOLS_LDCONFIG</td>
1.156 leot 12730: </tr>
12731: <tr>
1.169 rillig 12732: <td>TOOLS_NOOP</td>
1.172 rillig 12733: <td>TOOLS_PATH</td>
1.156 leot 12734: </tr>
12735: <tr>
1.169 rillig 12736: <td>TOOLS_SCRIPT</td>
1.172 rillig 12737: <td>TOOL_DEPENDS</td>
1.156 leot 12738: </tr>
12739: <tr>
1.169 rillig 12740: <td>TTF_FONTDIR</td>
1.172 rillig 12741: <td>TTF_FONTS_DIR</td>
1.161 leot 12742: </tr>
12743: <tr>
1.169 rillig 12744: <td>TYPE</td>
1.172 rillig 12745: <td>UAC_REQD_EXECS</td>
1.156 leot 12746: </tr>
12747: <tr>
1.169 rillig 12748: <td>UCSPI_SSL_GROUP</td>
1.172 rillig 12749: <td>UCSPI_SSL_USER</td>
1.156 leot 12750: </tr>
12751: <tr>
1.169 rillig 12752: <td>UNLIMIT_RESOURCES</td>
1.172 rillig 12753: <td>UNPRIVILEGED</td>
1.156 leot 12754: </tr>
12755: <tr>
1.169 rillig 12756: <td>UNPRIVILEGED_GROUP</td>
1.172 rillig 12757: <td>UNPRIVILEGED_GROUPS</td>
1.156 leot 12758: </tr>
12759: <tr>
1.169 rillig 12760: <td>UNPRIVILEGED_USER</td>
1.172 rillig 12761: <td>UNWRAP_FILES</td>
1.156 leot 12762: </tr>
12763: <tr>
1.169 rillig 12764: <td>UNWRAP_PATTERNS</td>
1.172 rillig 12765: <td>UPDATE_GEMSPEC</td>
1.156 leot 12766: </tr>
12767: <tr>
1.169 rillig 12768: <td>UPDATE_TARGET</td>
1.172 rillig 12769: <td>URI</td>
1.156 leot 12770: </tr>
12771: <tr>
1.169 rillig 12772: <td>USA</td>
1.172 rillig 12773: <td>USERGROUP_PHASE</td>
1.156 leot 12774: </tr>
12775: <tr>
1.169 rillig 12776: <td>USERPPP_GROUP</td>
1.172 rillig 12777: <td>USER_SPECIFIC_PKGS</td>
1.156 leot 12778: </tr>
12779: <tr>
1.169 rillig 12780: <td>USE_ABI_DEPENDS</td>
1.172 rillig 12781: <td>USE_APR</td>
1.156 leot 12782: </tr>
12783: <tr>
1.169 rillig 12784: <td>USE_BSD_MAKEFILE</td>
1.172 rillig 12785: <td>USE_BUILTIN</td>
1.156 leot 12786: </tr>
12787: <tr>
1.169 rillig 12788: <td>USE_CROSS_COMPILE</td>
1.172 rillig 12789: <td>USE_CURSES</td>
1.156 leot 12790: </tr>
12791: <tr>
1.169 rillig 12792: <td>USE_CWRAPPERS</td>
1.172 rillig 12793: <td>USE_DB185</td>
1.156 leot 12794: </tr>
12795: <tr>
1.169 rillig 12796: <td>USE_FEATURES</td>
1.172 rillig 12797: <td>USE_GAMESGROUP</td>
1.156 leot 12798: </tr>
12799: <tr>
1.169 rillig 12800: <td>USE_GCC_RUNTIME</td>
1.172 rillig 12801: <td>USE_IMAKE</td>
1.156 leot 12802: </tr>
12803: <tr>
1.169 rillig 12804: <td>USE_JAVA</td>
1.172 rillig 12805: <td>USE_JAVA2</td>
1.156 leot 12806: </tr>
12807: <tr>
1.169 rillig 12808: <td>USE_LANGUAGES</td>
1.172 rillig 12809: <td>USE_LIBTOOL</td>
1.156 leot 12810: </tr>
12811: <tr>
1.169 rillig 12812: <td>USE_NATIVE_GCC</td>
1.172 rillig 12813: <td>USE_NETBSD_REPO</td>
1.156 leot 12814: </tr>
12815: <tr>
1.169 rillig 12816: <td>USE_PKGSRC_GCC</td>
1.172 rillig 12817: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.156 leot 12818: </tr>
12819: <tr>
1.169 rillig 12820: <td>USE_PKGTASKS</td>
1.172 rillig 12821: <td>USE_PKG_ADMIN_DIGEST</td>
1.156 leot 12822: </tr>
12823: <tr>
1.157 leot 12824: <td>USE_RUBY_EXTCONF</td>
1.172 rillig 12825: <td>USE_RUBY_INSTALL</td>
1.156 leot 12826: </tr>
12827: <tr>
1.157 leot 12828: <td>USE_RUBY_SETUP</td>
1.172 rillig 12829: <td>USE_RUBY_SETUP_PKG</td>
1.156 leot 12830: </tr>
12831: <tr>
1.157 leot 12832: <td>USE_TOOLS</td>
1.172 rillig 12833: <td>UUCP_GROUP</td>
1.156 leot 12834: </tr>
12835: <tr>
1.157 leot 12836: <td>UUCP_USER</td>
1.172 rillig 12837: <td>VARBASE</td>
1.156 leot 12838: </tr>
12839: <tr>
1.157 leot 12840: <td>VARNAME</td>
1.172 rillig 12841: <td>VIM_EXTRA_OPTS</td>
1.156 leot 12842: </tr>
12843: <tr>
1.157 leot 12844: <td>WARNING_MSG</td>
1.172 rillig 12845: <td>WCALC_CGIDIR</td>
1.156 leot 12846: </tr>
12847: <tr>
1.157 leot 12848: <td>WCALC_CGIPATH</td>
1.172 rillig 12849: <td>WCALC_HTMLDIR</td>
1.156 leot 12850: </tr>
12851: <tr>
1.157 leot 12852: <td>WCALC_HTMLPATH</td>
1.172 rillig 12853: <td>WDM_MANAGERS</td>
1.156 leot 12854: </tr>
12855: <tr>
1.157 leot 12856: <td>WRAPPER_REORDER_CMDS</td>
1.172 rillig 12857: <td>WRKDIR</td>
1.156 leot 12858: </tr>
12859: <tr>
1.157 leot 12860: <td>WRKDIR_BASENAME</td>
1.172 rillig 12861: <td>WRKDIR_LOCKTYPE</td>
1.156 leot 12862: </tr>
12863: <tr>
1.157 leot 12864: <td>WRKLOG</td>
1.172 rillig 12865: <td>WRKOBJDIR</td>
1.156 leot 12866: </tr>
12867: <tr>
1.157 leot 12868: <td>WRKSRC</td>
1.172 rillig 12869: <td>WXGTK_ACCEPTED</td>
1.156 leot 12870: </tr>
12871: <tr>
1.157 leot 12872: <td>WXGTK_DEFAULT</td>
1.172 rillig 12873: <td>X10_PORT</td>
1.156 leot 12874: </tr>
12875: <tr>
1.157 leot 12876: <td>X11</td>
1.172 rillig 12877: <td>X11BASE</td>
1.156 leot 12878: </tr>
12879: <tr>
1.157 leot 12880: <td>X11_PKGSRCDIR</td>
1.172 rillig 12881: <td>X11_TYPE</td>
1.156 leot 12882: </tr>
12883: <tr>
1.157 leot 12884: <td>X509_CERTIFICATE</td>
1.172 rillig 12885: <td>X509_KEY</td>
1.156 leot 12886: </tr>
12887: <tr>
1.157 leot 12888: <td>XAW_TYPE</td>
1.172 rillig 12889: <td>XLOCK_DEFAULT_MODE</td>
1.156 leot 12890: </tr>
12891: <tr>
1.157 leot 12892: <td>XMKMF_FLAGS</td>
1.172 rillig 12893: <td>XXX</td>
1.156 leot 12894: </tr>
12895: <tr>
1.161 leot 12896: <td>XXXX</td>
1.172 rillig 12897: <td>YES</td>
1.159 rillig 12898: </tr>
12899: <tr>
12900: <td>ZERO_FILESIZE_P</td>
1.172 rillig 12901: <td>ZSH_STATIC</td>
1.156 leot 12902: </tr>
12903: <tr>
1.159 rillig 12904: <td>__stdc__</td>
1.172 rillig 12905: <td>_vargroups</td>
1.156 leot 12906: </tr>
12907: <tr>
1.159 rillig 12908: <td>add</td>
1.172 rillig 12909: <td>all</td>
1.156 leot 12910: </tr>
12911: <tr>
1.159 rillig 12912: <td>alternatives</td>
1.172 rillig 12913: <td>aslr</td>
1.156 leot 12914: </tr>
12915: <tr>
1.159 rillig 12916: <td>asprintf</td>
1.172 rillig 12917: <td>atlas</td>
1.161 leot 12918: </tr>
12919: <tr>
1.158 brook 12920: <td>autoconf</td>
1.172 rillig 12921: <td>automake</td>
1.156 leot 12922: </tr>
12923: <tr>
1.158 brook 12924: <td>autoreconf</td>
1.172 rillig 12925: <td>awk</td>
1.156 leot 12926: </tr>
12927: <tr>
1.158 brook 12928: <td>bash</td>
1.172 rillig 12929: <td>big-endian</td>
1.156 leot 12930: </tr>
12931: <tr>
1.158 brook 12932: <td>bin-install</td>
1.172 rillig 12933: <td>binpkg-list</td>
1.156 leot 12934: </tr>
12935: <tr>
1.161 leot 12936: <td>blas</td>
1.172 rillig 12937: <td>bootstrap-depends</td>
1.159 rillig 12938: </tr>
12939: <tr>
12940: <td>broken</td>
1.172 rillig 12941: <td>broken_on_platform</td>
1.156 leot 12942: </tr>
12943: <tr>
1.159 rillig 12944: <td>build</td>
1.172 rillig 12945: <td>build-env</td>
1.156 leot 12946: </tr>
12947: <tr>
1.159 rillig 12948: <td>buildlink-directories</td>
1.172 rillig 12949: <td>buildlink-oss-soundcard-h</td>
1.156 leot 12950: </tr>
12951: <tr>
1.159 rillig 12952: <td>c</td>
1.172 rillig 12953: <td>c++</td>
1.156 leot 12954: </tr>
12955: <tr>
1.159 rillig 12956: <td>ccache</td>
1.172 rillig 12957: <td>cce</td>
1.156 leot 12958: </tr>
12959: <tr>
1.159 rillig 12960: <td>cdefs</td>
1.172 rillig 12961: <td>changes</td>
1.156 leot 12962: </tr>
12963: <tr>
1.159 rillig 12964: <td>changes-entry</td>
1.172 rillig 12965: <td>changes-entry-noupdate</td>
1.156 leot 12966: </tr>
12967: <tr>
1.159 rillig 12968: <td>check</td>
1.172 rillig 12969: <td>check-clean</td>
1.156 leot 12970: </tr>
12971: <tr>
1.159 rillig 12972: <td>check-files</td>
1.172 rillig 12973: <td>check-files-clean</td>
1.156 leot 12974: </tr>
12975: <tr>
1.159 rillig 12976: <td>check-vulnerable</td>
1.172 rillig 12977: <td>checksum</td>
1.156 leot 12978: </tr>
12979: <tr>
1.159 rillig 12980: <td>checksum-phase</td>
1.172 rillig 12981: <td>clean</td>
1.156 leot 12982: </tr>
12983: <tr>
1.159 rillig 12984: <td>clean-depends</td>
1.172 rillig 12985: <td>cleandir</td>
1.156 leot 12986: </tr>
12987: <tr>
1.159 rillig 12988: <td>commit</td>
1.172 rillig 12989: <td>commit-changes-entry</td>
1.156 leot 12990: </tr>
12991: <tr>
1.159 rillig 12992: <td>compact</td>
1.172 rillig 12993: <td>compiler</td>
1.156 leot 12994: </tr>
12995: <tr>
1.159 rillig 12996: <td>conf</td>
1.172 rillig 12997: <td>config.guess</td>
1.156 leot 12998: </tr>
12999: <tr>
1.159 rillig 13000: <td>config.sub</td>
1.172 rillig 13001: <td>configuration</td>
1.156 leot 13002: </tr>
13003: <tr>
1.159 rillig 13004: <td>configure</td>
1.172 rillig 13005: <td>configure-env</td>
1.156 leot 13006: </tr>
13007: <tr>
1.166 leot 13008: <td>configure-help</td>
1.159 rillig 13009: <td>configure_args</td>
1.156 leot 13010: </tr>
13011: <tr>
1.166 leot 13012: <td>cputime</td>
1.159 rillig 13013: <td>create-usergroup</td>
1.156 leot 13014: </tr>
13015: <tr>
1.166 leot 13016: <td>csh</td>
1.159 rillig 13017: <td>ctf</td>
1.161 leot 13018: </tr>
13019: <tr>
1.166 leot 13020: <td>cvs</td>
1.157 leot 13021: <td>debug</td>
1.156 leot 13022: </tr>
13023: <tr>
1.166 leot 13024: <td>declaration</td>
1.157 leot 13025: <td>declare</td>
1.156 leot 13026: </tr>
13027: <tr>
1.166 leot 13028: <td>defined</td>
1.157 leot 13029: <td>depend</td>
1.156 leot 13030: </tr>
13031: <tr>
1.166 leot 13032: <td>dependencies</td>
1.157 leot 13033: <td>depends</td>
1.156 leot 13034: </tr>
13035: <tr>
1.166 leot 13036: <td>depends-checksum</td>
1.157 leot 13037: <td>depends-fetch</td>
1.156 leot 13038: </tr>
13039: <tr>
1.166 leot 13040: <td>deps</td>
1.157 leot 13041: <td>describe</td>
1.156 leot 13042: </tr>
13043: <tr>
1.166 leot 13044: <td>destdir</td>
1.162 rillig 13045: <td>disable</td>
13046: </tr>
13047: <tr>
1.166 leot 13048: <td>distclean</td>
1.161 leot 13049: <td>distinfo</td>
1.156 leot 13050: </tr>
13051: <tr>
1.166 leot 13052: <td>dl</td>
1.161 leot 13053: <td>dlopen</td>
1.156 leot 13054: </tr>
13055: <tr>
1.166 leot 13056: <td>do-build</td>
1.161 leot 13057: <td>do-buildlink</td>
1.156 leot 13058: </tr>
13059: <tr>
1.166 leot 13060: <td>do-clean</td>
1.170 rillig 13061: <td>do-configure</td>
13062: </tr>
13063: <tr>
1.161 leot 13064: <td>do-configure-post-hook</td>
1.170 rillig 13065: <td>do-extract</td>
1.156 leot 13066: </tr>
13067: <tr>
1.161 leot 13068: <td>do-fetch</td>
1.170 rillig 13069: <td>do-install</td>
1.156 leot 13070: </tr>
13071: <tr>
1.160 brook 13072: <td>emul</td>
1.170 rillig 13073: <td>emulation</td>
1.159 rillig 13074: </tr>
13075: <tr>
1.160 brook 13076: <td>emulator</td>
1.170 rillig 13077: <td>enable</td>
1.156 leot 13078: </tr>
13079: <tr>
1.159 rillig 13080: <td>endian</td>
1.170 rillig 13081: <td>enomem</td>
1.156 leot 13082: </tr>
13083: <tr>
1.159 rillig 13084: <td>err</td>
1.170 rillig 13085: <td>errx</td>
1.156 leot 13086: </tr>
13087: <tr>
1.159 rillig 13088: <td>etc</td>
1.170 rillig 13089: <td>feature</td>
1.156 leot 13090: </tr>
13091: <tr>
1.159 rillig 13092: <td>features</td>
1.170 rillig 13093: <td>fetch</td>
1.156 leot 13094: </tr>
13095: <tr>
1.159 rillig 13096: <td>fetch-list</td>
1.170 rillig 13097: <td>follows</td>
1.156 leot 13098: </tr>
13099: <tr>
1.159 rillig 13100: <td>forbids</td>
1.170 rillig 13101: <td>form</td>
1.156 leot 13102: </tr>
13103: <tr>
1.159 rillig 13104: <td>format</td>
1.170 rillig 13105: <td>fortify</td>
1.156 leot 13106: </tr>
13107: <tr>
1.159 rillig 13108: <td>fortify_source</td>
1.170 rillig 13109: <td>fossil</td>
1.161 leot 13110: </tr>
13111: <tr>
1.157 leot 13112: <td>friend</td>
1.170 rillig 13113: <td>from</td>
1.156 leot 13114: </tr>
13115: <tr>
1.157 leot 13116: <td>fts</td>
1.170 rillig 13117: <td>fts_close</td>
1.156 leot 13118: </tr>
13119: <tr>
1.157 leot 13120: <td>fts_open</td>
1.170 rillig 13121: <td>fts_read</td>
1.156 leot 13122: </tr>
13123: <tr>
1.157 leot 13124: <td>fts_set</td>
1.170 rillig 13125: <td>full</td>
1.156 leot 13126: </tr>
13127: <tr>
1.157 leot 13128: <td>gcc</td>
1.170 rillig 13129: <td>getopt_long</td>
1.156 leot 13130: </tr>
13131: <tr>
1.157 leot 13132: <td>getprogname</td>
1.170 rillig 13133: <td>gettext</td>
1.156 leot 13134: </tr>
13135: <tr>
1.161 leot 13136: <td>git</td>
1.170 rillig 13137: <td>github</td>
1.159 rillig 13138: </tr>
13139: <tr>
13140: <td>glob</td>
1.170 rillig 13141: <td>gnu</td>
1.156 leot 13142: </tr>
13143: <tr>
1.159 rillig 13144: <td>gnu_configure_strict</td>
1.170 rillig 13145: <td>go</td>
1.156 leot 13146: </tr>
13147: <tr>
1.159 rillig 13148: <td>go-deps</td>
1.170 rillig 13149: <td>golang</td>
1.156 leot 13150: </tr>
13151: <tr>
1.159 rillig 13152: <td>guess-license</td>
1.170 rillig 13153: <td>hashbang</td>
1.156 leot 13154: </tr>
13155: <tr>
1.159 rillig 13156: <td>heimdal</td>
1.170 rillig 13157: <td>help</td>
1.156 leot 13158: </tr>
13159: <tr>
1.161 leot 13160: <td>hg</td>
1.170 rillig 13161: <td>imake</td>
1.161 leot 13162: </tr>
13163: <tr>
1.157 leot 13164: <td>increment</td>
1.170 rillig 13165: <td>interp</td>
1.156 leot 13166: </tr>
13167: <tr>
1.157 leot 13168: <td>interpreter</td>
1.170 rillig 13169: <td>intl</td>
1.156 leot 13170: </tr>
13171: <tr>
1.157 leot 13172: <td>iso</td>
1.170 rillig 13173: <td>kerberos</td>
1.156 leot 13174: </tr>
13175: <tr>
1.157 leot 13176: <td>krb</td>
1.170 rillig 13177: <td>krb5</td>
1.156 leot 13178: </tr>
13179: <tr>
1.157 leot 13180: <td>ksh</td>
1.170 rillig 13181: <td>lapack</td>
1.156 leot 13182: </tr>
13183: <tr>
13184: <td>latex</td>
1.170 rillig 13185: <td>libnbcompat</td>
1.159 rillig 13186: </tr>
13187: <tr>
13188: <td>libs</td>
1.170 rillig 13189: <td>libtool</td>
1.156 leot 13190: </tr>
13191: <tr>
1.159 rillig 13192: <td>licence</td>
1.170 rillig 13193: <td>license</td>
1.156 leot 13194: </tr>
13195: <tr>
1.159 rillig 13196: <td>lintl</td>
1.170 rillig 13197: <td>little-endian</td>
1.156 leot 13198: </tr>
13199: <tr>
1.159 rillig 13200: <td>lock</td>
1.170 rillig 13201: <td>locking</td>
1.156 leot 13202: </tr>
13203: <tr>
1.159 rillig 13204: <td>lvalue</td>
1.170 rillig 13205: <td>make</td>
1.156 leot 13206: </tr>
13207: <tr>
1.159 rillig 13208: <td>makesum</td>
1.170 rillig 13209: <td>memory</td>
1.156 leot 13210: </tr>
13211: <tr>
1.161 leot 13212: <td>mercurial</td>
1.170 rillig 13213: <td>meta</td>
1.161 leot 13214: </tr>
13215: <tr>
1.158 brook 13216: <td>meta-package</td>
1.170 rillig 13217: <td>meta_package</td>
1.156 leot 13218: </tr>
13219: <tr>
1.158 brook 13220: <td>mit-krb5</td>
1.170 rillig 13221: <td>mk.conf</td>
1.156 leot 13222: </tr>
13223: <tr>
1.161 leot 13224: <td>mkl</td>
1.170 rillig 13225: <td>mount</td>
1.159 rillig 13226: </tr>
13227: <tr>
13228: <td>mprotect</td>
1.170 rillig 13229: <td>mremap</td>
1.156 leot 13230: </tr>
13231: <tr>
1.159 rillig 13232: <td>nb</td>
1.170 rillig 13233: <td>nbcompat</td>
1.156 leot 13234: </tr>
13235: <tr>
1.159 rillig 13236: <td>no</td>
1.170 rillig 13237: <td>obstack</td>
1.156 leot 13238: </tr>
13239: <tr>
1.159 rillig 13240: <td>obstack_ptr_grow</td>
1.170 rillig 13241: <td>occurs</td>
1.156 leot 13242: </tr>
13243: <tr>
1.159 rillig 13244: <td>only</td>
1.170 rillig 13245: <td>openblas</td>
1.161 leot 13246: </tr>
13247: <tr>
1.158 brook 13248: <td>options</td>
1.170 rillig 13249: <td>options.mk</td>
1.156 leot 13250: </tr>
13251: <tr>
1.158 brook 13252: <td>order</td>
1.170 rillig 13253: <td>override</td>
1.156 leot 13254: </tr>
13255: <tr>
1.158 brook 13256: <td>override-intltool</td>
1.170 rillig 13257: <td>override-message-intltool</td>
1.156 leot 13258: </tr>
13259: <tr>
1.158 brook 13260: <td>package</td>
1.170 rillig 13261: <td>parallel</td>
1.156 leot 13262: </tr>
13263: <tr>
1.158 brook 13264: <td>partial</td>
1.170 rillig 13265: <td>path</td>
1.156 leot 13266: </tr>
13267: <tr>
1.158 brook 13268: <td>pax</td>
1.170 rillig 13269: <td>paxctl</td>
1.156 leot 13270: </tr>
13271: <tr>
1.158 brook 13272: <td>pbulk-index</td>
1.170 rillig 13273: <td>pc</td>
1.156 leot 13274: </tr>
13275: <tr>
1.158 brook 13276: <td>perl</td>
1.170 rillig 13277: <td>perl5</td>
1.156 leot 13278: </tr>
13279: <tr>
1.158 brook 13280: <td>perms</td>
1.170 rillig 13281: <td>php</td>
1.156 leot 13282: </tr>
13283: <tr>
1.158 brook 13284: <td>pkg-build-options</td>
1.170 rillig 13285: <td>pkg-config</td>
1.156 leot 13286: </tr>
13287: <tr>
1.158 brook 13288: <td>pkg_build_options</td>
1.170 rillig 13289: <td>platform</td>
1.156 leot 13290: </tr>
13291: <tr>
1.158 brook 13292: <td>plist</td>
1.170 rillig 13293: <td>post-extract</td>
1.156 leot 13294: </tr>
13295: <tr>
1.158 brook 13296: <td>post-fetch</td>
1.170 rillig 13297: <td>post-wrapper</td>
1.156 leot 13298: </tr>
13299: <tr>
1.158 brook 13300: <td>pre-configure</td>
1.170 rillig 13301: <td>pre-extract</td>
1.156 leot 13302: </tr>
13303: <tr>
1.158 brook 13304: <td>pre-fetch</td>
1.170 rillig 13305: <td>print-go-deps</td>
1.156 leot 13306: </tr>
13307: <tr>
1.158 brook 13308: <td>print-plist</td>
1.170 rillig 13309: <td>print-summary-data</td>
1.156 leot 13310: </tr>
13311: <tr>
1.158 brook 13312: <td>privileged-install-hook</td>
1.170 rillig 13313: <td>pypi</td>
1.156 leot 13314: </tr>
13315: <tr>
1.158 brook 13316: <td>python</td>
1.170 rillig 13317: <td>readme-all</td>
1.156 leot 13318: </tr>
13319: <tr>
1.158 brook 13320: <td>regcomp</td>
1.170 rillig 13321: <td>relro</td>
1.156 leot 13322: </tr>
13323: <tr>
1.158 brook 13324: <td>rename</td>
1.170 rillig 13325: <td>reorder</td>
1.156 leot 13326: </tr>
13327: <tr>
1.158 brook 13328: <td>replace</td>
1.170 rillig 13329: <td>replace_interpreter</td>
1.156 leot 13330: </tr>
13331: <tr>
1.158 brook 13332: <td>reproducible</td>
1.170 rillig 13333: <td>resolv</td>
1.156 leot 13334: </tr>
13335: <tr>
1.158 brook 13336: <td>root</td>
1.170 rillig 13337: <td>ruby</td>
1.156 leot 13338: </tr>
13339: <tr>
1.158 brook 13340: <td>setenv</td>
1.170 rillig 13341: <td>setgid</td>
1.156 leot 13342: </tr>
13343: <tr>
1.158 brook 13344: <td>setprogname</td>
1.170 rillig 13345: <td>setuid</td>
1.156 leot 13346: </tr>
13347: <tr>
1.158 brook 13348: <td>sh</td>
1.170 rillig 13349: <td>show</td>
1.156 leot 13350: </tr>
13351: <tr>
1.158 brook 13352: <td>show-all</td>
1.170 rillig 13353: <td>show-build-defs</td>
1.156 leot 13354: </tr>
13355: <tr>
1.158 brook 13356: <td>show-depends</td>
1.170 rillig 13357: <td>show-deps</td>
1.156 leot 13358: </tr>
13359: <tr>
1.158 brook 13360: <td>show-distfiles</td>
1.170 rillig 13361: <td>show-downlevel</td>
1.156 leot 13362: </tr>
13363: <tr>
1.158 brook 13364: <td>show-subdir-var</td>
1.170 rillig 13365: <td>show-tools</td>
1.156 leot 13366: </tr>
13367: <tr>
1.158 brook 13368: <td>show-var</td>
1.170 rillig 13369: <td>show-vars</td>
1.156 leot 13370: </tr>
13371: <tr>
1.158 brook 13372: <td>snprintf</td>
1.170 rillig 13373: <td>ssp</td>
1.156 leot 13374: </tr>
13375: <tr>
1.158 brook 13376: <td>st_mode</td>
1.170 rillig 13377: <td>stage-install</td>
1.156 leot 13378: </tr>
13379: <tr>
1.162 rillig 13380: <td>strict</td>
1.170 rillig 13381: <td>strip</td>
1.162 rillig 13382: </tr>
13383: <tr>
1.161 leot 13384: <td>strnlen</td>
1.170 rillig 13385: <td>strong</td>
1.156 leot 13386: </tr>
13387: <tr>
1.161 leot 13388: <td>subst</td>
1.170 rillig 13389: <td>subversion</td>
1.156 leot 13390: </tr>
13391: <tr>
1.160 brook 13392: <td>sun</td>
1.170 rillig 13393: <td>sunpro</td>
1.159 rillig 13394: </tr>
13395: <tr>
1.156 leot 13396: <td>sunwspro</td>
1.170 rillig 13397: <td>svn</td>
1.156 leot 13398: </tr>
13399: <tr>
1.161 leot 13400: <td>symlink</td>
1.170 rillig 13401: <td>test</td>
1.161 leot 13402: </tr>
13403: <tr>
1.157 leot 13404: <td>tex</td>
1.170 rillig 13405: <td>texlive</td>
1.156 leot 13406: </tr>
13407: <tr>
1.157 leot 13408: <td>tmp</td>
1.170 rillig 13409: <td>tool</td>
1.156 leot 13410: </tr>
13411: <tr>
1.157 leot 13412: <td>tools</td>
1.170 rillig 13413: <td>tools-libtool-m4-override</td>
1.156 leot 13414: </tr>
13415: <tr>
1.157 leot 13416: <td>type</td>
1.170 rillig 13417: <td>ulimit</td>
1.156 leot 13418: </tr>
13419: <tr>
1.157 leot 13420: <td>undefined</td>
1.170 rillig 13421: <td>undo-replace</td>
1.156 leot 13422: </tr>
13423: <tr>
1.157 leot 13424: <td>unlimit</td>
1.170 rillig 13425: <td>unprivileged</td>
1.156 leot 13426: </tr>
13427: <tr>
1.157 leot 13428: <td>unprivileged-install-hook</td>
1.170 rillig 13429: <td>unstripped</td>
1.156 leot 13430: </tr>
13431: <tr>
1.157 leot 13432: <td>update</td>
1.170 rillig 13433: <td>upload</td>
1.156 leot 13434: </tr>
13435: <tr>
1.157 leot 13436: <td>upload-distfiles</td>
1.170 rillig 13437: <td>usage</td>
1.156 leot 13438: </tr>
13439: <tr>
1.157 leot 13440: <td>use_tools</td>
1.170 rillig 13441: <td>user</td>
1.156 leot 13442: </tr>
13443: <tr>
1.157 leot 13444: <td>utimes</td>
1.170 rillig 13445: <td>vasprintf</td>
1.156 leot 13446: </tr>
13447: <tr>
1.157 leot 13448: <td>verbose</td>
1.170 rillig 13449: <td>vsnprintf</td>
1.156 leot 13450: </tr>
13451: <tr>
1.157 leot 13452: <td>warn</td>
1.170 rillig 13453: <td>warning</td>
1.156 leot 13454: </tr>
13455: <tr>
1.157 leot 13456: <td>warnings</td>
1.170 rillig 13457: <td>warnx</td>
1.156 leot 13458: </tr>
13459: <tr>
1.157 leot 13460: <td>weak</td>
1.170 rillig 13461: <td>work</td>
1.156 leot 13462: </tr>
13463: <tr>
1.157 leot 13464: <td>wrapper</td>
1.170 rillig 13465: <td>wrkdir</td>
1.156 leot 13466: </tr>
13467: <tr>
13468: <td>yes</td>
1.170 rillig 13469: <td> </td>
1.156 leot 13470: </tr>
13471: </table>
1.154 rillig 13472: </div>
13473: <div class="appendix">
13474: <div class="titlepage"><div><div><h1 class="title">
13475: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 13476: <div class="toc">
13477: <p><b>Table of Contents</b></p>
1.100 leot 13478: <dl class="toc">
1.154 rillig 13479: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
13480: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1 dsieger 13481: </dl>
13482: </div>
13483: <p>This section contains information on editing the pkgsrc
13484: guide itself.</p>
1.41 asau 13485: <div class="sect1">
1.1 dsieger 13486: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 13487: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.1 dsieger 13488: <p>The pkgsrc guide's source code is stored in
13489: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
13490: are created from it:</p>
1.41 asau 13491: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 13492: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
13493: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
13494: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
13495: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1 dsieger 13496: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 13497: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1 dsieger 13498: PostScript version of the pkgsrc guide.</p></li>
13499: </ul></div>
13500: </div>
1.41 asau 13501: <div class="sect1">
1.1 dsieger 13502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 13503: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.1 dsieger 13504: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 13505: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 13506: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 13507: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 13508: documentation) installed. These are automatically installed when
1.137 leot 13509: you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.41 asau 13510: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 13511: right directory. All further steps will take place
13512: here.</p></li>
1.41 asau 13513: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 13514: <code class="filename">files/</code>.</p></li>
1.41 asau 13515: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 13516: guide for valid XML and to build the final output files. If you
13517: get any errors at this stage, you can just edit the files, as
13518: there are only symbolic links in the working directory, pointing
13519: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 13520: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 13521: commit)</strong></span></p></li>
1.41 asau 13522: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 13523: regenerate the output files with the proper RCS
13524: Ids.</p></li>
1.41 asau 13525: <li class="step">
1.10 hubertf 13526: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 13527: commit the files in both <code class="filename">pkgsrc/doc</code> and
13528: <code class="filename">htdocs</code>.</p>
1.41 asau 13529: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 13530: <h3 class="title">Note</h3>
13531: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 13532: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
13533: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 13534: directory.</p>
13535: </div>
13536: </li>
13537: </ol></div>
13538: </div>
13539: </div>
13540: </div></body>
13541: </html>
CVSweb <webmaster@jp.NetBSD.org>