Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.170
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>
336: <dt><span class="sect2"><a href="#undefined-reference">21.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
337: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
338: </dl></dd>
339: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
340: <dd><dl>
341: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
342: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
343: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
344: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
345: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
346: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
347: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
348: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
349: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
350: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
351: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
352: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
353: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
354: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
355: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
356: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
357: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
358: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 359: emulation</a></span></dt>
1.154 rillig 360: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
361: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 362: </dl></dd>
1.154 rillig 363: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 364: </dl></dd>
1.154 rillig 365: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
366: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 367: <dd><dl>
1.154 rillig 368: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
369: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
370: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
371: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
372: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
373: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
374: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
375: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
376: </dl></dd>
377: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
378: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
379: <dd><dl>
380: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
381: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
382: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
383: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1 dsieger 384: </dl></dd>
385: </dl></dd>
386: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
387: <dd><dl>
1.154 rillig 388: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 389: <dd><dl>
1.154 rillig 390: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
391: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
392: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 393: <dd><dl>
1.154 rillig 394: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
395: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 396: </dl></dd>
1.154 rillig 397: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
398: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 399: <dd><dl>
1.154 rillig 400: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
401: <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 402: </dl></dd>
1.154 rillig 403: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 404: <dd><dl>
1.154 rillig 405: <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>
406: <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 407: </dl></dd>
408: </dl></dd>
1.154 rillig 409: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1 dsieger 410: <dd><dl>
1.154 rillig 411: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
412: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 413: <dd><dl>
1.154 rillig 414: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
415: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 416: </dl></dd>
417: </dl></dd>
1.154 rillig 418: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
419: <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 420: </dl></dd>
421: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
422: <dd><dl>
423: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
424: <dd><dl>
425: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
426: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
427: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 428: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1 dsieger 429: </dl></dd>
430: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
431: </dl></dd>
432: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
433: <dd><dl>
434: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
435: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
436: </dl></dd>
437: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
438: <dd><dl>
1.23 wiz 439: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
440: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
441: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
442: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
443: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148 leot 444: <code class="filename">stable</code>,
1.23 wiz 445: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 446: source packages</a></span></dt>
447: </dl></dd>
1.154 rillig 448: <dt><span class="appendix"><a href="#help-topics">D. Help topics</a></span></dt>
449: <dt><span class="appendix"><a href="#editing">E. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1 dsieger 450: <dd><dl>
1.154 rillig 451: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
452: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1 dsieger 453: </dl></dd>
454: </dl>
455: </div>
456: <div class="list-of-tables">
457: <p><b>List of Tables</b></p>
458: <dl>
459: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
460: </dt>
1.154 rillig 461: <dt>13.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 462: </dt>
1.154 rillig 463: <dt>25.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 464: </dt>
465: </dl>
466: </div>
1.41 asau 467: <div class="chapter">
468: <div class="titlepage"><div><div><h1 class="title">
469: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 470: <div class="toc">
471: <p><b>Table of Contents</b></p>
1.100 leot 472: <dl class="toc">
1.1 dsieger 473: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
474: <dd><dl>
475: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
476: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
477: </dl></dd>
478: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
479: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
480: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
481: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
482: </dl>
483: </div>
1.41 asau 484: <div class="sect1">
1.1 dsieger 485: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
486: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
487: <p>There is a lot of software freely available for Unix-based
488: systems, which is usually available in form of the source code. Before
489: such software can be used, it needs to be configured to the local
490: system, compiled and installed, and this is exactly what The NetBSD
491: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
492: to handle binary packages, so that not every user has to build the
493: packages for himself, which is a time-costly task.</p>
494: <p>pkgsrc currently contains several thousand packages,
495: including:</p>
1.41 asau 496: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 497: <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 498: web server</p></li>
1.137 leot 499: <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 500: web browser</p></li>
1.137 leot 501: <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 502: Desktop Environment</p></li>
1.137 leot 503: <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 504: Desktop Environment</p></li>
505: </ul></div>
1.108 rillig 506: <p>… just to name a few.</p>
1.1 dsieger 507: <p>pkgsrc has built-in support for handling varying dependencies,
508: such as pthreads and X11, and extended features such as IPv6 support on
509: a range of platforms.</p>
1.41 asau 510: <div class="sect2">
1.1 dsieger 511: <div class="titlepage"><div><div><h3 class="title">
512: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
513: <p>
514: pkgsrc provides the following key features:
515: </p>
1.41 asau 516: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 517: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 518: and installation of binary packages. The source and latest
519: patches are retrieved from a master or mirror download site, checksum
520: verified, then built on your system. Support for binary-only
521: distributions is available for both native platforms and NetBSD
522: emulated platforms.</p></li>
1.23 wiz 523: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 524: including binaries, libraries, man pages and other
525: documentation.</p></li>
1.104 sevan 526: <li class="listitem"><p>Tracking of package dependencies automatically, including when
527: performing updates, to ensure required packages are installed. The
528: configuration files of various packages are handled automatically during
529: updates, so local changes are preserved.</p></li>
1.23 wiz 530: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 531: consists of highly portable code. This allows the greatest speed of
1.25 spz 532: development when porting to a new platform. This portability also
1.1 dsieger 533: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
534: platforms</em></span>.</p></li>
1.23 wiz 535: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 536: international encryption requirements and build-time options for a
537: large number of packages are all set in a simple, central
538: configuration file.</p></li>
1.23 wiz 539: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 540: freely available under a BSD license, so you may extend and adapt
541: pkgsrc to your needs. Support for local packages and patches is
542: available right out of the box, so you can configure it specifically
543: for your environment.</p></li>
544: </ul></div>
545: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 546: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 547: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 548: — That means, if a package contains bugs, it's better to find
1.1 dsieger 549: them and to complain about them rather than to just install the package
550: and hope that it works. There are numerous checks in pkgsrc that try to
1.137 leot 551: 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 552: of shell scripts), and post-installation checks (installed files,
553: references to shared libraries, script interpreters).</p></li>
1.23 wiz 554: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 555: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 556: pkgsrc has been ported to many operating systems. Care is taken that
557: packages behave the same on all platforms.</p></li>
558: </ul></div>
559: </div>
1.41 asau 560: <div class="sect2">
1.1 dsieger 561: <div class="titlepage"><div><div><h3 class="title">
562: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
563: <p>pkgsrc consists of both a source distribution and a binary
564: distribution for these operating systems. After retrieving the required
565: source or binaries, you can be up and running with pkgsrc in just
566: minutes!</p>
567: <p>pkgsrc was derived from FreeBSD's ports system, and
568: initially developed for NetBSD only. Since then, pkgsrc has
569: grown a lot, and now supports the following platforms:</p>
570: <div class="table">
571: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 572: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 573: <colgroup>
574: <col>
575: <col>
1.92 sevan 576: <col>
1.1 dsieger 577: </colgroup>
578: <thead><tr>
579: <th>Platform</th>
580: <th>Date Support Added</th>
1.92 sevan 581: <th>Notes</th>
1.1 dsieger 582: </tr></thead>
583: <tbody>
584: <tr>
1.10 hubertf 585: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 586: <td align="center">Aug 1997</td>
1.92 sevan 587: <td class="auto-generated"> </td>
1.1 dsieger 588: </tr>
589: <tr>
1.10 hubertf 590: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 591: <td align="center">Mar 1999</td>
1.151 sevan 592: <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 593: </tr>
594: <tr>
1.10 hubertf 595: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 596: <td align="center">Jun 1999</td>
1.151 sevan 597: <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 598: </tr>
599: <tr>
600: <td>
1.118 sevan 601: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 602: </td>
603: <td align="center">Oct 2001</td>
1.151 sevan 604: <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 605: </tr>
606: <tr>
1.10 hubertf 607: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 608: <td align="center">Nov 2002</td>
1.151 sevan 609: <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 610: </tr>
611: <tr>
1.10 hubertf 612: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 613: <td align="center">Nov 2002</td>
1.151 sevan 614: <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 615: </tr>
616: <tr>
1.10 hubertf 617: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 618: <td align="center">Dec 2002</td>
1.92 sevan 619: <td>
1.151 sevan 620: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
621: <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 622: </td>
1.1 dsieger 623: </tr>
624: <tr>
625: <td>BSD/OS</td>
626: <td align="center">Dec 2003</td>
1.92 sevan 627: <td class="auto-generated"> </td>
1.1 dsieger 628: </tr>
629: <tr>
1.10 hubertf 630: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 631: <td align="center">Dec 2003</td>
1.151 sevan 632: <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 633: </tr>
634: <tr>
635: <td>
1.10 hubertf 636: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 637: (Microsoft Windows Services for Unix)
638: </td>
639: <td align="center">Mar 2004</td>
1.151 sevan 640: <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 641: </tr>
642: <tr>
1.10 hubertf 643: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 644: <td align="center">Oct 2004</td>
1.92 sevan 645: <td class="auto-generated"> </td>
1.1 dsieger 646: </tr>
647: <tr>
1.10 hubertf 648: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 649: <td align="center">Nov 2004</td>
1.151 sevan 650: <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 651: </tr>
652: <tr>
1.10 hubertf 653: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 654: <td align="center">Apr 2007</td>
1.151 sevan 655: <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 656: </tr>
1.23 wiz 657: <tr>
658: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
659: <td align="center">Sep 2010</td>
1.151 sevan 660: <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 661: </tr>
1.45 obache 662: <tr>
663: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 664: <td align="center">Jan 2011</td>
1.92 sevan 665: <td class="auto-generated"> </td>
1.45 obache 666: </tr>
667: <tr>
668: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
669: <td align="center">Nov 2011</td>
1.151 sevan 670: <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 671: </tr>
672: <tr>
673: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
674: <td align="center">Mar 2013</td>
1.151 sevan 675: <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 676: </tr>
1.58 ryoon 677: <tr>
678: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
679: <td align="center">Jul 2013</td>
1.151 sevan 680: <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 681: </tr>
1.104 sevan 682: <tr>
683: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
684: <td align="center">Jun 2014</td>
1.151 sevan 685: <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 686: </tr>
1.1 dsieger 687: </tbody>
688: </table></div>
689: </div>
690: <br class="table-break">
691: </div>
692: </div>
1.41 asau 693: <div class="sect1">
1.1 dsieger 694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
695: <a name="overview"></a>1.2. Overview</h2></div></div></div>
696: <p>This document is divided into three parts. The first,
1.10 hubertf 697: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 698: describes how one can use one of the packages in the Package
699: Collection, either by installing a precompiled binary package,
700: or by building one's own copy using the NetBSD package system.
1.10 hubertf 701: 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 702: package so it can be easily built by other NetBSD users without
703: knowing about the package's building details. The third part,
1.10 hubertf 704: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 705: is intended for those who want to understand how pkgsrc is
706: implemented.</p>
707: <p>This document is available in various formats:
1.10 hubertf 708: <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 709: </div>
1.41 asau 710: <div class="sect1">
1.1 dsieger 711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
712: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 713: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
714: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 715: terminology used within this document.</p>
1.41 asau 716: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 717: <dt><span class="term">Package</span></dt>
718: <dd><p>A set of files and building instructions
719: that describe what's necessary
720: to build a certain piece of software using
721: pkgsrc. Packages are traditionally stored under
1.123 wiz 722: <code class="filename">/usr/pkgsrc</code>,
723: but may be stored in any location,
724: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1 dsieger 725: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 726: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 727: is part of the NetBSD operating system and can be bootstrapped
728: to run on non-NetBSD operating systems as well. It handles
729: building (compiling), installing, and removing of
730: packages.</p></dd>
731: <dt><span class="term">Distfile</span></dt>
732: <dd><p>This term describes the file or files that are
733: provided by the author of the piece of software to
734: distribute his work. All the changes necessary to build on
735: NetBSD are reflected in the corresponding package. Usually
736: the distfile is in the form of a compressed tar-archive,
737: but other types are possible, too. Distfiles are usually
738: stored below
739: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
740: <dt><span class="term">Port</span></dt>
741: <dd><p>This is the term used by FreeBSD and OpenBSD people
742: for what we call a package.
1.23 wiz 743: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 744: architecture.</p></dd>
745: <dt><span class="term">Precompiled/binary package</span></dt>
746: <dd>
747: <p>A set of binaries built with pkgsrc from a distfile
748: and stuffed together in a single <code class="filename">.tgz</code>
749: file so it can be installed on machines of the same
750: machine architecture without the need to
751: recompile. Packages are usually generated in
752: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 753: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 754: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 755: especially in the context of precompiled packages.</p>
756: </dd>
757: <dt><span class="term">Program</span></dt>
758: <dd><p>The piece of software to be installed which will be
759: constructed from all the files in the distfile by the
760: actions defined in the corresponding package.</p></dd>
761: </dl></div>
1.41 asau 762: <div class="sect2">
1.1 dsieger 763: <div class="titlepage"><div><div><h3 class="title">
764: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 765: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 766: <dt><span class="term">pkgsrc users</span></dt>
767: <dd>
768: <p>The
769: pkgsrc users are people who use the packages provided by pkgsrc.
770: Typically they are system administrators. The people using the
1.23 wiz 771: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
772: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 773: <p>There are two kinds of pkgsrc users: Some only want to
774: install pre-built binary packages. Others build the pkgsrc
775: packages from source, either for installing them directly or for
1.10 hubertf 776: 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 777: documentation.</p>
778: </dd>
779: <dt><span class="term">package maintainers</span></dt>
780: <dd><p>A
1.10 hubertf 781: 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 782: <dt><span class="term">infrastructure developers</span></dt>
783: <dd><p>These people are involved in all those files
784: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 785: 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 786: too.</p></dd>
787: </dl></div>
788: </div>
789: </div>
1.41 asau 790: <div class="sect1">
1.1 dsieger 791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
792: <a name="typography"></a>1.4. Typography</h2></div></div></div>
793: <p>When giving examples for commands, shell prompts are used to
794: show if the command should/can be issued as root, or if
1.23 wiz 795: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 796: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
797: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
798: bourne shell and derivatives.</p>
1.1 dsieger 799: </div>
800: </div>
1.41 asau 801: <div class="part">
1.1 dsieger 802: <div class="titlepage"><div><div><h1 class="title">
803: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
804: <div class="toc">
805: <p><b>Table of Contents</b></p>
1.100 leot 806: <dl class="toc">
1.154 rillig 807: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
808: <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 809: <dd><dl>
1.154 rillig 810: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 811: <dd><dl>
1.154 rillig 812: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
813: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 814: </dl></dd>
1.154 rillig 815: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 816: <dd><dl>
1.154 rillig 817: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
818: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 819: </dl></dd>
820: </dl></dd>
1.154 rillig 821: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 822: <dd><dl>
1.154 rillig 823: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
824: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 825: </dl></dd>
1.154 rillig 826: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 827: <dd><dl>
1.154 rillig 828: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 829: <dd><dl>
1.154 rillig 830: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
831: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
832: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
833: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
834: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
835: <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>
836: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.1 dsieger 837: </dl></dd>
1.154 rillig 838: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 839: <dd><dl>
1.154 rillig 840: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
841: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
842: <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 843: </dl></dd>
844: </dl></dd>
1.154 rillig 845: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 846: <dd><dl>
1.154 rillig 847: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
848: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
849: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
850: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 851: <dd><dl>
1.154 rillig 852: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
853: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
854: <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 855: </dl></dd>
1.154 rillig 856: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
857: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 858: </dl></dd>
1.154 rillig 859: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 860: <dd><dl>
1.154 rillig 861: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
862: <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 863: </dl></dd>
1.154 rillig 864: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 865: builds)</a></span></dt>
1.1 dsieger 866: <dd><dl>
1.154 rillig 867: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
868: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
869: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
870: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
871: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
872: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
873: </dl></dd>
874: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
875: <dd><dl>
876: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
877: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
878: </dl></dd>
879: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
880: <dd><dl>
881: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
882: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
883: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
884: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
885: <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>
886: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
887: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
888: <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>
889: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
890: <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 891: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 892: <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>
893: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
894: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
895: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
896: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
897: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
898: <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 899: </dl></dd>
900: </dl>
901: </div>
1.41 asau 902: <div class="chapter">
1.1 dsieger 903: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 904: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
905: <p>
906: To get help when using pkgsrc, the definitive source is this
907: document, the pkgsrc guide. If you don't find anything here,
908: there are alternatives:
909: </p>
910: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
911: <li class="listitem">
912: <p>
913: The built-in pkgsrc help, which is available after bootstrapping
914: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
915: help for any topic, such as a variable name like
916: <code class="varname">BUILD_DEFS</code>, a make target like
917: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
918: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
919: <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>
920: </li>
921: <li class="listitem"><p>
1.163 rillig 922: To see the value of a single variable, run <span class="command"><strong>bmake
923: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
924: </p></li>
925: <li class="listitem"><p>
926: To see the values of the most common variables, run
927: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
928: topic. To see the variables for a single topic, run
929: <span class="command"><strong>bmake
930: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
931: <span class="command"><strong>bmake show-all-fetch</strong></span>.
932: </p></li>
933: <li class="listitem"><p>
1.154 rillig 934: The pkgsrc-users mailing list, to which
935: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
936: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
937: questions</a>.</p></li>
938: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
939: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
940: or by using a specialized chat program such as
941: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
942: Pick any user name and join the channel #pkgsrc.</p></li>
943: </ul></div>
944: </div>
945: <div class="chapter">
946: <div class="titlepage"><div><div><h2 class="title">
947: <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 948: <div class="toc">
949: <p><b>Table of Contents</b></p>
1.100 leot 950: <dl class="toc">
1.154 rillig 951: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 952: <dd><dl>
1.154 rillig 953: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
954: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 955: </dl></dd>
1.154 rillig 956: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 957: <dd><dl>
1.154 rillig 958: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
959: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 960: </dl></dd>
961: </dl>
962: </div>
963: <p>Before you download and extract the files, you need to decide
964: where you want to extract them. When using pkgsrc as root user, pkgsrc
965: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
966: free to install the sources and binary packages wherever you want in
967: your filesystem, provided that the pathname does not contain white-space
968: or other characters that are interpreted specially by the shell and some
969: other programs. A safe bet is to use only letters, digits, underscores
970: and dashes.</p>
1.41 asau 971: <div class="sect1">
1.1 dsieger 972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 973: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 974: <p>Before you download any pkgsrc files, you should decide
975: whether you want the <span class="emphasis"><em>current</em></span> branch or the
976: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
977: quarterly basis from the current branch and only gets modified
978: for security updates. The names of the stable branches are built
979: from the year and the quarter, for example
1.167 leot 980: <code class="literal">2019Q4</code>.</p>
1.1 dsieger 981: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 982: want to download pkgsrc. You can get it as a tar file or via CVS.
983: Both ways are described here.</p>
1.51 asau 984: <p>Note that tar archive contains CVS working copy.
985: Thus you can switch to using CVS at any later time.</p>
1.41 asau 986: <div class="sect2">
1.1 dsieger 987: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 988: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 989: <p>The primary download location for all pkgsrc files is
1.151 sevan 990: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 991: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
992: (it points to the same location).
993: There are a number of subdirectories for different purposes,
994: 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>
995: <p>The tar archive for the current branch is in the directory
1.151 sevan 996: <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 997: It is autogenerated weekly.</p>
1.51 asau 998: <p>To save download time we provide bzip2- and
999: xz-compressed archives which are published at
1.151 sevan 1000: <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 1001: and
1.151 sevan 1002: <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 1003: respectively.
1004: </p>
1005: <p>You can fetch the same files using FTP.</p>
1.167 leot 1006: <p>The tar file for the stable branch 2019Q4 is in the
1007: 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 1008: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 1009: <pre class="screen">
1.167 leot 1010: <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 1011: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1012: or your web browser.</p>
1.12 weinem 1013: <p>Then, extract it with:</p>
1.78 snj 1014: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1015: <p>This will create the directory <code class="filename">pkgsrc/</code>
1016: in <code class="filename">/usr/</code> and all the package source will be
1017: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1018: <p>To download pkgsrc-current, run:</p>
1019: <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 1020: </div>
1.41 asau 1021: <div class="sect2">
1.1 dsieger 1022: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1023: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1024: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.167 leot 1025: <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 1026: </pre>
1027: <p>This will create the directory <code class="filename">pkgsrc/</code>
1028: in your <code class="filename">/usr/</code> directory and all the package source
1029: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1030: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1031: <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 1032: </pre>
1.78 snj 1033: <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 1034: <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 1035: <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 1036: </pre>
1037: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1038: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1039: or better globally in <code class="filename">/etc/profile</code>:</p>
1040: <pre class="programlisting">
1041: # set CVS remote shell command
1042: CVS_RSH=ssh
1043: export CVS_RSH
1044: </pre>
1045: <p>By default, CVS doesn't do things like most people would expect it to do.
1046: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1047: in your home directory and saving the following lines to it.
1048: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1049: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1050: <pre class="programlisting">
1051: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1052: cvs -q
1.2 rillig 1053: checkout -P
1.4 rillig 1054: update -dP
1055: diff -upN
1.2 rillig 1056: rdiff -u
1.23 wiz 1057: release -d
1.2 rillig 1058: </pre>
1.1 dsieger 1059: </div>
1060: </div>
1.41 asau 1061: <div class="sect1">
1.1 dsieger 1062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1063: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1064: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1065: (which also works if you have first installed it via a tar
1066: file). It saves bandwidth and hard disk activity, compared to
1067: downloading the tar file again.</p>
1.41 asau 1068: <div class="sect2">
1.1 dsieger 1069: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1070: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1071: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1072: <h3 class="title">Warning</h3>
1073: <p>When updating from a tar file, you first need to
1074: completely remove the old pkgsrc directory. Otherwise those
1075: files that have been removed from pkgsrc in the mean time will
1076: not be removed on your local disk, resulting in inconsistencies.
1077: When removing the old files, any changes that you have done to
1078: the pkgsrc files will be lost after updating. Therefore updating
1079: via CVS is strongly recommended.</p>
1080: </div>
1081: <p>Note that by default the distfiles and the binary packages
1082: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1083: before updating. You can also configure pkgsrc to store distfiles
1084: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1085: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154 rillig 1086: 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 1087: <p>To update pkgsrc from a tar file, download the tar file as
1088: explained above. Then, make sure that you have not made any
1089: changes to the files in the pkgsrc directory. Remove the pkgsrc
1090: directory and extract the new tar file. Done.</p>
1091: </div>
1.41 asau 1092: <div class="sect2">
1.1 dsieger 1093: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1094: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1095: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1096: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1097: </pre>
1098: <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>
1099: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1100: </pre>
1.41 asau 1101: <div class="sect3">
1.1 dsieger 1102: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1103: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1104: <p>When updating pkgsrc, the CVS program keeps track of the
1105: branch you selected. But if you, for whatever reason, want to
1106: switch from the stable branch to the current one, you can do it
1.23 wiz 1107: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1108: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1109: back to the stable branch, add the
1.167 leot 1110: <span class="quote">“<span class="quote">-rpkgsrc-2019Q4</span>”</span> option.</p>
1.1 dsieger 1111: </div>
1.41 asau 1112: <div class="sect3">
1.1 dsieger 1113: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1114: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1115: <p>When you update pkgsrc, the CVS program will only touch
1116: those files that are registered in the CVS repository. That
1117: means that any packages that you created on your own will stay
1118: unmodified. If you change files that are managed by CVS, later
1119: updates will try to merge your changes with those that have been
1120: done by others. See the CVS manual, chapter
1.23 wiz 1121: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1122: </div>
1123: </div>
1124: </div>
1125: </div>
1.41 asau 1126: <div class="chapter">
1.1 dsieger 1127: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1128: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1129: <div class="toc">
1130: <p><b>Table of Contents</b></p>
1.100 leot 1131: <dl class="toc">
1.154 rillig 1132: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1133: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1134: </dl>
1135: </div>
1.41 asau 1136: <div class="sect1">
1.1 dsieger 1137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1138: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1139: <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 1140: </div>
1.41 asau 1141: <div class="sect1">
1.1 dsieger 1142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1143: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1144: <p>pkgsrc can be bootstrapped for use in two different modes:
1145: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1146: to privileged one all programs are installed under one particular user
1.43 asau 1147: and cannot utilise privileged operations (packages don't create
1148: special users and all special file permissions like setuid are ignored).
1149: </p>
1.1 dsieger 1150: <p>Installing the bootstrap kit from source should be as simple as:</p>
1151: <pre class="screen">
1.60 asau 1152: <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 1153: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1154: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1155: </pre>
1.43 asau 1156: <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>
1157: <p>By default, in privileged mode pkgsrc uses
1158: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1159: where programs will be installed in,
1.118 sevan 1160: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1161: directory where pkgsrc will do its internal bookkeeping,
1162: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1163: where packages install their persistent data.
1164: In unprivileged mode pkgsrc uses
1165: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1166: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1167: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1168: </p>
1169: <p>You can change default layout using command-line arguments.
1170: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1171: </p>
1.41 asau 1172: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1173: <h3 class="title">Note</h3>
1.10 hubertf 1174: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1175: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1176: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1177: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1178: </div>
1.43 asau 1179: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1180: <h3 class="title">Note</h3>
1181: <p>It is possible to bootstrap multiple instances of pkgsrc
1182: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1183: corresponding to the installation you're working with to build
1184: and install packages.
1185: </p>
1186: </div>
1.1 dsieger 1187: </div>
1188: </div>
1.41 asau 1189: <div class="chapter">
1.1 dsieger 1190: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1191: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1192: <div class="toc">
1193: <p><b>Table of Contents</b></p>
1.100 leot 1194: <dl class="toc">
1.154 rillig 1195: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1196: <dd><dl>
1.154 rillig 1197: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1198: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1199: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
1200: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
1201: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1202: <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>
1203: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1204: </dl></dd>
1205: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1206: <dd><dl>
1207: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1208: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1209: <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 1210: </dl></dd>
1211: </dl>
1212: </div>
1213: <p>Basically, there are two ways of using pkgsrc. The first
1214: is to only install the package tools and to use binary packages
1.23 wiz 1215: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1216: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1217: of pkgsrc, too. Then you are able to build your own packages,
1218: and you can still use binary packages from someone else.</p>
1.41 asau 1219: <div class="sect1">
1.1 dsieger 1220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1221: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.151 sevan 1222: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1223: site and mirrors, there are collections of binary packages,
1.9 rillig 1224: ready to be installed. These binary packages have been built using the
1225: default settings for the directories, that is:</p>
1.41 asau 1226: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1227: <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>
1228: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1229: <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 1230: </ul></div>
1231: <p>If you cannot use these directories for whatever reasons (maybe
1232: because you're not root), you cannot use these binary packages, but
1.154 rillig 1233: 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 1234: <div class="sect2">
1.1 dsieger 1235: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1236: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1237: <p>To install binary packages, you first need to know from where
1238: to get them. The first place where you should look is on the main
1.151 sevan 1239: 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 1240: <p>This directory contains binary packages for multiple
1241: platforms. First, select your operating system. (Ignore the
1242: directories with version numbers attached to it, they just exist for
1243: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1244: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1245: <p>In this directory, you often find a file called
1246: <code class="filename">bootstrap.tar.gz</code> which contains the package
1247: management tools. If the file is missing, it is likely that your
1248: operating system already provides those tools. Download the file and
1249: extract it in the <code class="filename">/</code> directory. It will create
1250: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1251: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1252: </div>
1.41 asau 1253: <div class="sect2">
1.1 dsieger 1254: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1255: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1256: <p>In the directory from the last section, there is a
1.85 wiz 1257: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1258: binary packages that are available for the platform, excluding those
1259: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1260: medium you are using).</p>
1.9 rillig 1261: <p>To install packages directly from an FTP or HTTP server, run
1262: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1263: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1264: <pre class="screen">
1265: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.169 rillig 1266: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1267: <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 1268: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1269: </pre>
1270: <p>Instead of URLs, you can also use local paths, for example if
1271: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1272: repository. If you want to install packages from multiple sources,
1273: you can separate them by a semicolon in
1274: <code class="varname">PKG_PATH</code>.</p>
1275: <p>After these preparations, installing a package is very
1276: easy:</p>
1277: <pre class="screen">
1.118 sevan 1278: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
1279: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.9 rillig 1280: </pre>
1.1 dsieger 1281: <p>Note that any prerequisite packages needed to run the
1282: package in question will be installed, too, assuming they are
1283: present where you install from.</p>
1.23 wiz 1284: <p>Adding packages might install vulnerable packages.
1285: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1286: regularly, especially after installing new packages, and verify
1287: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1288: <p>After you've installed packages, be sure to have
1289: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1290: <code class="varname">PATH</code> so you can actually start the just
1291: installed program.</p>
1292: </div>
1.41 asau 1293: <div class="sect2">
1.1 dsieger 1294: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1295: <a name="using.pkg_delete"></a>5.1.3. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1296: <p>To deinstall a package, it does not matter whether it was
1297: installed from source code or from a binary package. The
1.10 hubertf 1298: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1299: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1300: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1301: name can be given with or without version number. Wildcards can
1302: also be used to deinstall a set of packages, for example
1303: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1304: so that the shell does not expand them before
1305: <code class="literal">pkg_delete</code> sees them.</p>
1306: <p>The <code class="option">-r</code> option is very powerful: it
1307: removes all the packages that require the package in question
1308: and then removes the package itself. For example:
1309:
1310: </p>
1311: <pre class="screen">
1312: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1313: </pre>
1314: <p>
1315:
1316: will remove jpeg and all the packages that used it; this allows
1317: upgrading the jpeg package.</p>
1318: </div>
1.41 asau 1319: <div class="sect2">
1.1 dsieger 1320: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1321: <a name="using.pkg_info"></a>5.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1322: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1323: installed packages or binary package files.</p>
1324: </div>
1.41 asau 1325: <div class="sect2">
1.1 dsieger 1326: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1327: <a name="vulnerabilities"></a>5.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1328: <p>
1.164 leot 1329: The pkgsrc Security Team and Packages Groups maintain a list of
1.1 dsieger 1330: known security vulnerabilities to packages which are (or have been)
1331: included in pkgsrc. The list is available from the NetBSD
1.165 leot 1332: 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 1333: </p>
1334: <p>
1.22 jakllsch 1335: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1336: this list can be downloaded
1337: automatically, and a security audit of all packages installed on a system
1338: can take place.
1339: </p>
1340: <p>
1.22 jakllsch 1341: There are two components to auditing. The first
1342: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1343: is for downloading
1.1 dsieger 1344: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1345: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1346: installed packages are vulnerable. If a package is vulnerable, you
1347: will see output similar to the following:
1348: </p>
1349: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1350: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1351: <p>
1.22 jakllsch 1352: You may wish to have the
1.151 sevan 1353: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1354: file downloaded daily so that
1355: it remains current. This may be done by adding an appropriate entry
1.167 leot 1356: 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 1357: </p>
1358: <pre class="screen">
1.121 sevan 1359: # Download vulnerabilities file
1.118 sevan 1360: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1361: # Audit the installed packages and email results to root
1362: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1363: root >/dev/null 2>&1
1.22 jakllsch 1364: </pre>
1365: <p>
1.118 sevan 1366: will update the vulnerability list every day at 3AM, followed by an audit
1367: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1368:
1.118 sevan 1369: On NetBSD this may be accomplished instead by adding the following
1370: line to <code class="filename">/etc/daily.conf</code>:
1371: </p>
1372: <pre class="screen">
1373: fetch_pkg_vulnerabilities=YES
1374: </pre>
1375: <p>
1376: to fetch the vulnerability list from the daily security script. The system
1377: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1378: desired (not required), by adding the following line to
1.118 sevan 1379: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1380: </p>
1381: <pre class="screen">
1.118 sevan 1382: check_pkg_vulnerabilities=YES
1.22 jakllsch 1383: </pre>
1384: <p>
1.167 leot 1385: 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 1386: </p>
1387: </div>
1.41 asau 1388: <div class="sect2">
1.1 dsieger 1389: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1390: <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 1391: <p>
1.137 leot 1392: 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 1393: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1394: argument to check if your packages are up-to-date, e.g.
1395: </p>
1396: <pre class="screen">
1397: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1398: ...
1399: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1400: </pre>
1.10 hubertf 1401: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1402: package on your system and rebuild any dependencies.
1403: </p>
1404: </div>
1.41 asau 1405: <div class="sect2">
1.1 dsieger 1406: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1407: <a name="using.pkg_admin"></a>5.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1408: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1409: administrative functions on the package system.</p>
1410: </div>
1411: </div>
1.41 asau 1412: <div class="sect1">
1.1 dsieger 1413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1414: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1 dsieger 1415: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1416: directory now contains a set of packages, organized into
1417: categories. You can browse the online index of packages, or run
1.10 hubertf 1418: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1419: directory to build local <code class="filename">README.html</code> files for
1.137 leot 1420: 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 1421: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1422: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1423: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1424: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1425: different <code class="varname">LOCALBASE</code> definitions on the same
1426: system (inside a chroot is an exception). </p>
1427: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1428: 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 1429: instructions how to create your own packages.</p>
1.41 asau 1430: <div class="sect2">
1.1 dsieger 1431: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1432: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1 dsieger 1433: <p>To build packages from source, you need a working C
1434: compiler. On NetBSD, you need to install the
1.23 wiz 1435: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1436: sets. If you want to build X11-related packages, the
1.23 wiz 1437: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1438: sets are required, too.</p>
1439: </div>
1.41 asau 1440: <div class="sect2">
1.1 dsieger 1441: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1442: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1 dsieger 1443: <p>The first step for building a package is downloading the
1444: distfiles (i.e. the unmodified source). If they have not yet been
1445: downloaded, pkgsrc will fetch them automatically.</p>
1446: <p>If you have all files that you need in the
1447: <code class="filename">distfiles</code> directory,
1448: you don't need to connect. If the distfiles are on CD-ROM, you can
1449: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1450: </p>
1451: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1452: <p>
1.10 hubertf 1453: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1454: <p>By default a list of distribution sites will be randomly
1455: intermixed to prevent huge load on servers which holding popular
1456: packages (for example, SourceForge.net mirrors). Thus, every
1457: time when you need to fetch yet another distfile all the mirrors
1458: will be tried in new (random) order. You can turn this feature
1459: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1460: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1461: <p>You can overwrite some of the major distribution sites to
1462: fit to sites that are close to your own. By setting one or two
1463: variables you can modify the order in which the master sites are
1464: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1465: delimited list of domain suffixes.
1466: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1467: contains a whitespace delimited list of regular expressions. It
1468: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1469: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1470: some examples. This may save some of your bandwidth and
1471: time.</p>
1472: <p>You can change these settings either in your shell's environment, or,
1473: if you want to keep the settings, by editing the
1.10 hubertf 1474: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1475: and adding the definitions there.</p>
1476: <p>
1477: If a package depends on many other packages (such as
1.137 leot 1478: <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 1479: alternate between periods of
1480: downloading source, and compiling. To ensure you have all the source
1481: downloaded initially you can run the command:
1482: </p>
1483: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1484: <p>
1485: which will output and run a set of shell commands to fetch the
1486: necessary files into the <code class="filename">distfiles</code> directory. You can
1487: also choose to download the files manually.
1488: </p>
1489: </div>
1.41 asau 1490: <div class="sect2">
1.1 dsieger 1491: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1492: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1 dsieger 1493: <p>
1494: Once the software has downloaded, any patches will be applied, then it
1495: will be compiled for you. This may take some time depending on your
1496: computer, and how many other packages the software depends on and their
1497: compile time.
1498: </p>
1.41 asau 1499: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1500: <h3 class="title">Note</h3>
1501: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1502: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1503: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1504: </div>
1505: <p>For example, type</p>
1506: <pre class="screen">
1507: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1508: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1509: </pre>
1510: <p>at the shell prompt to build the various components of the
1511: package.</p>
1512: <p>The next stage is to actually install the newly compiled
1513: program onto your system. Do this by entering:
1514:
1515: </p>
1516: <pre class="screen">
1517: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1518: </pre>
1519: <p>
1520:
1521: while you are still in the directory for whatever package you
1522: are installing.</p>
1523: <p>Installing the package on your system may require you to
1524: be root. However, pkgsrc has a
1525: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1526: to only become root for the actual installation step.</p>
1527: <p>That's it, the software should now be installed and setup for use.
1528: You can now enter:
1529:
1530: </p>
1531: <pre class="screen">
1532: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1533: </pre>
1534: <p>
1535:
1536: to remove the compiled files in the work directory, as you shouldn't need
1537: them any more. If other packages were also added to your system
1538: (dependencies) to allow your program to compile, you can tidy these up
1539: also with the command:</p>
1540: <pre class="screen">
1541: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1542: </pre>
1543: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 1544: 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 1545: <p>The program is installed under the default root of the
1546: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1547: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1548: variable in your environment, and it will use that value as the
1549: root of your packages tree. So, to use
1550: <code class="filename">/usr/local</code>, set
1551: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1552: Please note that you should use a directory which is dedicated to
1553: packages and not shared with other programs (i.e., do not try and
1554: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1555: to add any of your own files or directories (such as
1556: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1557: <code class="filename">pkgsrc/</code>) below the
1558: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1559: conflicts between programs and other files installed by the
1560: package system and whatever else may have been installed
1561: there.</p>
1.10 hubertf 1562: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1563: alter some configuration options at build time. Have a look at
1564: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1565: of what will be set there by default. Environment variables such
1566: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1567: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1568: set them each time you want to use pkgsrc.</p>
1.23 wiz 1569: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1570: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1571: or being installed. This may be for debugging purposes, or out of
1572: simple curiosity. A number of utility values have been added to
1573: help with this.</p>
1.23 wiz 1574: <div class="orderedlist"><ol class="orderedlist" type="1">
1575: <li class="listitem">
1.167 leot 1576: <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 1577: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1578: information will be displayed. For example,</p>
1579: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1580: <p>will show all the commands that are invoked, up to and
1.23 wiz 1581: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1582: </li>
1.23 wiz 1583: <li class="listitem">
1.167 leot 1584: <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 1585: definition, then the <code class="varname">VARNAME</code> definition
1586: should be used, in conjunction with the show-var
1.167 leot 1587: 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 1588: variable <code class="varname">LOCALBASE</code>:</p>
1589: <pre class="screen">
1590: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1591: /usr/pkg
1592: <code class="prompt">%</code>
1593: </pre>
1594: </li>
1595: </ol></div>
1596: <p>If you want to install a binary package that you've either
1597: created yourself (see next section), that you put into
1598: pkgsrc/packages manually or that is located on a remote FTP
1599: server, you can use the "bin-install" target. This target will
1.167 leot 1600: 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 1601: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1602: sites searched is kept in the variable
1603: <code class="varname">BINPKG_SITES</code>, which defaults to
1.167 leot 1604: 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 1605: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1606: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1607: details.</p>
1608: <p>A final word of warning: If you set up a system that has a
1609: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1610: set that before any packages are installed, as you cannot use
1611: several directories for the same purpose. Doing so will result in
1612: pkgsrc not being able to properly detect your installed packages,
1613: and fail miserably. Note also that precompiled binary packages are
1614: usually built with the default <code class="varname">LOCALBASE</code> of
1615: <code class="filename">/usr/pkg</code>, and that you should
1616: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1617: <code class="varname">LOCALBASE</code>.</p>
1618: </div>
1619: </div>
1620: </div>
1.41 asau 1621: <div class="chapter">
1.1 dsieger 1622: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1623: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1 dsieger 1624: <div class="toc">
1625: <p><b>Table of Contents</b></p>
1.100 leot 1626: <dl class="toc">
1.154 rillig 1627: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1628: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1629: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
1630: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1631: <dd><dl>
1632: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
1633: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1634: <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 1635: </dl></dd>
1.154 rillig 1636: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
1637: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 1638: </dl>
1639: </div>
1.4 rillig 1640: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1641: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1642: that file depends on the installation. On NetBSD, when you use
1.167 leot 1643: <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 1644: <code class="filename">/etc/</code>. In all other cases the default location is
1645: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1646: bootstrap program to install the binary packages.</p>
1647: <p>The format of the configuration file is that of the usual
1648: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1649: is done by setting variables in this file. Note that you can define all
1650: kinds of variables, and no special error checking (for example for
1.112 rillig 1651: spelling mistakes) takes place.</p>
1.41 asau 1652: <div class="sect1">
1.1 dsieger 1653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1654: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112 rillig 1655: <p>The following variables apply to all
1.1 dsieger 1656: pkgsrc packages. A complete list of the variables that can be
1657: configured by the user is available in
1658: <code class="filename">mk/defaults/mk.conf</code>, together with some
1659: comments that describe each variable's intent.</p>
1.41 asau 1660: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1661: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1662: packages will be installed. The default is
1663: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1664: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1665: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1666: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1667: installed. The default is
1668: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1669: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1670: X11 is installed on the system. The default is
1.84 wiz 1671: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1672: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1673: downloaded copies of the original source distributions used
1674: for building pkgsrc packages. The default is
1675: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1676: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1677: database about installed packages is stored. The default is
1.118 sevan 1678: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1679: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1680: If set, override the packages'
1681: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1682: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1683: Backup location(s) for distribution files and patch files
1684: if not found locally or in
1685: <code class="filename">${MASTER_SITES}</code> or
1686: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1687: The defaults is
1688: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1689: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1690: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1691: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1692: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1693: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1694: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1695: List of acceptable licenses. License names are case-sensitive.
1696: Whenever you try to build a package whose license is not in this
1697: list, you will get an error message. If the license condition is
1698: simple enough, the error message will include specific
1699: instructions on how to change this variable.</p></li>
1.1 dsieger 1700: </ul></div>
1701: </div>
1.41 asau 1702: <div class="sect1">
1.1 dsieger 1703: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1704: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1705: <p>
1.1 dsieger 1706: </p>
1.41 asau 1707: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1708: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1709: directory for the binary packages. The default is
1710: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1711: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1712: The top level directory where, if defined, the separate
1713: working directories will get created, and symbolically
1714: linked to from <code class="filename">${WRKDIR}</code> (see below).
1715: This is useful for building packages on several
1716: architectures, then <code class="filename">${PKGSRCDIR}</code>
1717: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1718: is local to every architecture. (It should be noted that
1719: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1720: — it is an internal definition which refers to the
1.1 dsieger 1721: root of the pkgsrc tree. It is possible to have many
1722: pkgsrc tree instances.)</p></li>
1.23 wiz 1723: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1724: Directory for local patches that aren't part of pkgsrc.
1.154 rillig 1725: 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 1726: information.</p></li>
1.23 wiz 1727: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1728: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1729: BSD-style Makefile. If this is not set,
1730: <code class="varname">MAKECONF</code> is set to
1731: <code class="filename">/dev/null</code> to avoid picking up
1732: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1733: </ul></div>
1734: </div>
1.41 asau 1735: <div class="sect1">
1.1 dsieger 1736: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1737: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.143 maya 1738: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
1739: By default, binary packages of built packages are
1.150 leot 1740: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143 maya 1741: this variable to "no" prevents this.</p></li></ul></div>
1.107 jnemeth 1742: <p>Packages have to support installation into a
1.4 rillig 1743: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1744: to be built, before the actual filesystem is touched. DESTDIR
1745: support exists in two variations:</p>
1.41 asau 1746: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1747: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1748: installation and packaging is still run as root.</p></li>
1749: <li class="listitem"><p>Full DESTDIR support can run the complete
1750: build, installation and packaging as normal user. Root
1751: privileges are only needed to add packages.</p></li>
1752: </ul></div>
1.4 rillig 1753: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1754: clean</code></strong> needs to be run as root.</p>
1.17 imil 1755: <p>Considering the <code class="filename">foo/bar</code> package,
1756: DESTDIR full support can be tested using the following commands
1757:
1758: </p>
1759: <pre class="programlisting">
1760: <code class="prompt">$</code> id
1761: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1762: <code class="prompt">$</code> mkdir $HOME/packages
1763: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1764: </pre>
1765: <p>
1766:
1767: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1768: should be needed
1769:
1770: </p>
1771: <pre class="programlisting">
1.66 asau 1772: <code class="prompt">$</code> make stage-install
1.17 imil 1773: </pre>
1774: <p>
1775:
1776: Create a package without root privileges
1777:
1778: </p>
1779: <pre class="programlisting">
1.66 asau 1780: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1781: </pre>
1782: <p>
1783:
1784: For the following command, you must be able to gain root
1.167 leot 1785: 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 1786:
1787: </p>
1788: <pre class="programlisting">
1.66 asau 1789: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1790: </pre>
1791: <p>
1792:
1793: Then, as a simple user
1794:
1795: </p>
1796: <pre class="programlisting">
1797: <code class="prompt">$</code> make clean
1798: </pre>
1799: <p>
1800:
1801: </p>
1.4 rillig 1802: </div>
1.41 asau 1803: <div class="sect1">
1.4 rillig 1804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1805: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1806: <div class="sect2">
1.1 dsieger 1807: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1808: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1809: <p>By default, pkgsrc will use GCC to build packages. This may be
1810: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1811: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1812: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1813: <dd>
1814: <p>This is a list of values specifying the chain of
1815: compilers to invoke when building packages. Valid values
1816: are:</p>
1.41 asau 1817: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1818: <li class="listitem"><p><code class="varname">ccc</code>:
1819: Compaq C Compilers (Tru64)</p></li>
1820: <li class="listitem"><p><code class="varname">ccache</code>:
1821: compiler cache (chainable)</p></li>
1822: <li class="listitem"><p><code class="varname">clang</code>:
1823: Clang C and Objective-C compiler</p></li>
1.23 wiz 1824: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1825: distributed C/C++ (chainable)</p></li>
1.66 asau 1826: <li class="listitem"><p><code class="varname">f2c</code>:
1827: Fortran 77 to C compiler (chainable)</p></li>
1828: <li class="listitem"><p><code class="varname">icc</code>:
1829: Intel C++ Compiler (Linux)</p></li>
1830: <li class="listitem"><p><code class="varname">ido</code>:
1831: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1832: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1833: GNU C/C++ Compiler</p></li>
1.66 asau 1834: <li class="listitem"><p><code class="varname">hp</code>:
1835: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1836: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1837: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1838: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1839: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1840: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1841: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1842: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1843: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1844: </ul></div>
1845: <p>The default is
1.23 wiz 1846: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1847: <code class="varname">ccache</code> and/or
1848: <code class="varname">distcc</code> with an appropriate
1849: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1850: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1851: variable should always be terminated with a value for
1852: a real compiler. Note that only one real compiler
1.23 wiz 1853: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1854: is not allowed).</p>
1855: </dd>
1856: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1857: <dd><p>This specifies the minimum version of GCC to use
1858: when building packages. If the system GCC doesn't
1859: satisfy this requirement, then pkgsrc will build and
1860: install one of the GCC packages to use instead.</p></dd>
1.153 leot 1861: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114 maya 1862: <dd><p>Specifies which version of python to use when several
1863: options are available.</p></dd>
1864: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1865: <dd><p>Specifies the fortran compiler to use.
1866: The default is <code class="varname">g95</code>, and
1867: <code class="varname">gfortran</code> is an alternative.</p></dd>
1868: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1869: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1870: <code class="varname">gfortran</code> is used, this option specifies which
1871: version to use.</p></dd>
1.1 dsieger 1872: </dl></div>
1873: </div>
1.41 asau 1874: <div class="sect2">
1.1 dsieger 1875: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1876: <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 1877: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1878: please make sure to use the <code class="literal">+=</code> operator
1879: instead of the <code class="literal">=</code> operator:</p>
1880: <pre class="programlisting">
1881: CFLAGS+= -your -flags
1882: </pre>
1883: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1884: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1885: need to add their own flags. You may want to take a look
1.137 leot 1886: 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 1887: package if you're interested in optimization specifically
1888: for the current CPU. </p>
1.1 dsieger 1889: </div>
1.41 asau 1890: <div class="sect2">
1.1 dsieger 1891: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1892: <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 1893: <p>If you want to pass flags to the linker, both in the configure
1894: step and the build step, you can do this in two ways. Either set
1895: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1896: between the two is that <code class="varname">LIBS</code> will be appended to
1897: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1898: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1899: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1900: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1901: <code class="varname">CFLAGS</code>, if you do not wish to override these
1902: settings, use the <code class="literal">+=</code> operator:</p>
1903: <pre class="programlisting">
1904: LDFLAGS+= -your -linkerflags
1905: </pre>
1906: </div>
1907: </div>
1.41 asau 1908: <div class="sect1">
1.1 dsieger 1909: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1910: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1911: <p>
1.1 dsieger 1912: </p>
1.41 asau 1913: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1914: <li class="listitem">
1.1 dsieger 1915: <p><code class="varname">PKG_DEVELOPER</code>:
1916: Run some sanity checks that package developers want:
1917: </p>
1.41 asau 1918: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1919: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 1920: fuzz</p></li>
1.23 wiz 1921: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 1922: binaries will find their shared libs.</p></li>
1923: </ul></div>
1924: <p>
1925: </p>
1926: </li>
1.23 wiz 1927: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 1928: of debugging output which is displayed whilst making and
1929: installing the package. The default value for this is 0,
1930: which will not display the commands as they are executed
1931: (normal, default, quiet operation); the value 1 will display
1932: all shell commands before their invocation, and the value 2
1933: will display both the shell commands before their invocation,
1.112 rillig 1934: as well as their actual execution progress with <span class="command"><strong>set
1935: -x</strong></span>.</p></li>
1.1 dsieger 1936: </ul></div>
1937: <p>
1938: </p>
1939: </div>
1.41 asau 1940: <div class="sect1">
1.1 dsieger 1941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1942: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1943: <p>Some packages have build time options, usually to select
1944: between different dependencies, enable optional support for big
1945: dependencies or enable experimental features.</p>
1946: <p>To see which options, if any, a package supports, and which
1.10 hubertf 1947: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 1948: show-options</strong></span>, for example:</p>
1949: <pre class="programlisting">
1950: The following options are supported by this package:
1951: ssl Enable SSL support.
1952: Exactly one of the following gecko options is required:
1953: firefox Use firefox as gecko rendering engine.
1954: mozilla Use mozilla as gecko rendering engine.
1955: At most one of the following database options may be selected:
1956: mysql Enable support for MySQL database.
1957: pgsql Enable support for PostgreSQL database.
1958:
1959: These options are enabled by default: firefox
1960: These options are currently enabled: mozilla ssl
1961: </pre>
1962: <p>The following variables can be defined in
1.10 hubertf 1963: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 1964: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1965: which can be used to select or disable options for all packages
1966: that support them, and
1967: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1968: which can be used to select or disable options specifically for
1969: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 1970: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 1971: are disabled. A few examples:</p>
1972: <pre class="screen">
1.10 hubertf 1973: <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 1974: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1975: PKG_OPTIONS.kdebase= debug -sasl
1976: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 1977: <p>It is important to note that options that were specifically
1.18 snj 1978: suggested by the package maintainer must be explicitly removed if
1.11 rillig 1979: you do not wish to include the option. If you are unsure you can view
1980: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 1981: <p>The following settings are consulted in the order given, and
1982: the last setting that selects or disables an option is
1983: used:</p>
1.23 wiz 1984: <div class="orderedlist"><ol class="orderedlist" type="1">
1985: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 1986: maintainer</p></li>
1.23 wiz 1987: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 1988: variables (see below)</p></li>
1.23 wiz 1989: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
1990: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 1991: </ol></div>
1992: <p>For groups of mutually exclusive options, the last option
1993: selected is used, all others are automatically disabled. If an
1994: option of the group is explicitly disabled, the previously
1995: selected option, if any, is used. It is an error if no option
1996: from a required group of options is selected, and building the
1997: package will fail.</p>
1998: <p>Before the options framework was introduced, build options
1999: were selected by setting a variable (often named
2000: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2001: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2002: transition to the options framework for the user, these legacy
2003: variables are converted to the appropriate options setting
2004: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2005: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2006: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2007: directly. Support for the legacy variables will be removed
2008: eventually.</p>
2009: </div>
2010: </div>
1.41 asau 2011: <div class="chapter">
1.1 dsieger 2012: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2013: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1 dsieger 2014: <div class="toc">
2015: <p><b>Table of Contents</b></p>
1.100 leot 2016: <dl class="toc">
1.154 rillig 2017: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2018: <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 2019: </dl>
2020: </div>
1.41 asau 2021: <div class="sect1">
1.1 dsieger 2022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2023: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1 dsieger 2024: <p>Once you have built and installed a package, you can create
2025: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.167 leot 2026: 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 2027: the same package on a group of hosts and wasting CPU time. It also
2028: provides a simple means for others to install your package, should
2029: you distribute it.</p>
2030: <p>To create a binary package, change into the appropriate
1.10 hubertf 2031: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2032: package</strong></span>:</p>
2033: <pre class="screen">
1.112 rillig 2034: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2035: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2036: </pre>
1.1 dsieger 2037: <p>This will build and install your package (if not already done),
2038: and then build a binary package from what was installed. You can
1.10 hubertf 2039: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2040: it. Binary packages are created by default in
2041: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2042: 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 2043: 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 2044: <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 2045: such a binary package.</p>
2046: </div>
1.41 asau 2047: <div class="sect1">
1.1 dsieger 2048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2049: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
2050: <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 2051: </div>
2052: </div>
1.41 asau 2053: <div class="chapter">
1.6 rillig 2054: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2055: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 2056: builds)</h2></div></div></div>
2057: <div class="toc">
2058: <p><b>Table of Contents</b></p>
1.100 leot 2059: <dl class="toc">
1.154 rillig 2060: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
2061: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
2062: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2063: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
2064: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2065: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2066: </dl>
2067: </div>
1.71 wiz 2068: <p>For a number of reasons you may want to build binary packages
2069: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2070: For instance, when you have multiple machines that should run the same software,
2071: it is wasted time if they all build their packages themselves from source.
2072: Or you may want to build a list of packages you want and check them before
2073: deploying onto production system.
2074: There is a way of getting a set of binary packages:
1.112 rillig 2075: The bulk build system, or pbulk ("p" stands for "parallel").
2076: This chapter describes how to set it up.</p>
1.41 asau 2077: <div class="sect1">
1.6 rillig 2078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2079: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71 wiz 2080: <p>First of all, you have to decide whether you build all packages
2081: or a limited set of them. Full bulk builds usually consume a lot more resources,
2082: both space and time, than builds for some practical sets of packages.
2083: There exists a number of particularly heavy packages that are not actually
2084: interesting to a wide audience.
2085:
2086: For a limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2087: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2088: </p>
2089: <p>During bulk builds various packages are installed and deinstalled
2090: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2091: so make sure that you don't need any package during the builds.
1.112 rillig 2092: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2093: or something even more restrictive, depending on what the operating system provides,
2094: or dedicate the whole physical machine.
2095: As a useful side effect this makes sure that bulk builds cannot
2096: break anything in your system. There have been numerous cases where
1.6 rillig 2097: certain packages tried to install files outside the
2098: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2099: <code class="filename">/etc</code>.
2100: </p>
1.6 rillig 2101: </div>
1.41 asau 2102: <div class="sect1">
1.6 rillig 2103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2104: <a name="bulk.pbulk"></a>8.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2105: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2106: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2107: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2108: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2109: </ul></div>
1.41 asau 2110: <div class="sect2">
1.15 rillig 2111: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2112: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112 rillig 2113: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2114: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2115: Configure network access to fetch distribution files.
1.112 rillig 2116: Create a user with name "pbulk".</p>
1.68 asau 2117: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2118: <pre class="screen">
1.151 sevan 2119: <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>
2120: <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 2121: <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 2122: </pre>
2123: <p>Or any other way that fits (e.g., curl, wget).</p>
2124: <p>Deploy and configure pbulk tools, e.g.:</p>
2125: <pre class="screen">
1.118 sevan 2126: <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 2127: <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>
2128: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2129: </pre>
2130: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2131: <h3 class="title">Note</h3>
2132: <p><code class="filename">mk.conf.frag</code> is a fragment of
2133: <code class="filename">mk.conf</code> that contains settings you want to
2134: apply to packages you build. For instance,</p>
2135: <pre class="programlisting">
1.112 rillig 2136: PKG_DEVELOPER= yes # perform more checks
2137: X11_TYPE= modular # use pkgsrc X11
2138: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2139: # when building all packages)
1.68 asau 2140: </pre>
2141: </div>
2142: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2143: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2144: <pre class="programlisting">
2145: www/firefox
2146: mail/thunderbird
2147: misc/libreoffice4
2148: </pre>
1.69 asau 2149: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2150: and make final amendments, if wanted.</p>
1.68 asau 2151: <p>Start it:</p>
2152: <pre class="screen">
2153: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2154: </pre>
2155: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2156: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2157: </p>
2158: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2159: <h3 class="title">Note</h3>
2160: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2161: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2162: The script is kept small enough for better understanding.</p>
2163: </div>
2164: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2165: <h3 class="title">Note</h3>
2166: <p>The <code class="filename">pbulk.sh</code> script supports running
2167: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2168: </div>
1.6 rillig 2169: </div>
2170: </div>
1.41 asau 2171: <div class="sect1">
1.6 rillig 2172: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2173: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71 wiz 2174: <p>A complete bulk build requires lots of disk space. Some of the
2175: disk space can be read-only, some other must be writable. Some can be on
2176: remote filesystems (such as NFS) and some should be local. Some can be
2177: temporary filesystems, others must survive a sudden reboot.</p>
2178: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2179: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2180: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2181: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2182: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2183: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2184: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2185: </ul></div>
2186: </div>
2187: <div class="sect1">
2188: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2189: <a name="creating-cdroms"></a>8.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2190: <p>After your pkgsrc bulk-build has completed, you may wish to
2191: create a CD-ROM set of the resulting binary packages to assist
2192: in installing packages on other machines. The
1.137 leot 2193: <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 2194: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2195: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2196: way that keeps all the dependencies for a given package on the same
2197: CD as that package.</p>
1.41 asau 2198: <div class="sect2">
1.1 dsieger 2199: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2200: <a name="cdpack-example"></a>8.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2201: <p>Complete documentation for cdpack is found in the cdpack(1)
2202: man page. The following short example assumes that the binary
2203: packages are left in
2204: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2205: sufficient disk space exists in <code class="filename">/u2</code> to
2206: hold the ISO 9660 images.</p>
2207: <pre class="screen">
2208: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2209: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2210: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2211: </pre>
2212: <p>If you wish to include a common set of files
2213: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2214: etc.) on each CD in the collection, then you need to create a
2215: directory which contains these files. e.g.</p>
2216: <pre class="screen">
2217: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2218: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2219: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2220: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2221: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2222: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2223: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2224: </pre>
2225: <p>Now create the images:</p>
2226: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2227: <p>Each image will contain <code class="filename">README</code>,
2228: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2229: in their root directories.</p>
2230: </div>
2231: </div>
2232: </div>
1.41 asau 2233: <div class="chapter">
1.1 dsieger 2234: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2235: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2236: <div class="toc">
2237: <p><b>Table of Contents</b></p>
1.100 leot 2238: <dl class="toc">
1.154 rillig 2239: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2240: <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 2241: </dl>
2242: </div>
2243: <p>The files that are installed by pkgsrc are organized in a way that
2244: is similar to what you find in the <code class="filename">/usr</code> directory
2245: of the base system. But some details are different. This is because
2246: pkgsrc initially came from FreeBSD and had adopted its file system
2247: hierarchy. Later it was largely influenced by NetBSD. But no matter
2248: which operating system you are using pkgsrc with, you can expect the
2249: same layout for pkgsrc.</p>
2250: <p>There are mainly four root directories for pkgsrc, which are all
2251: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2252: When pkgsrc has been installed as root, the default locations
2253: are:</p>
2254: <pre class="programlisting">
2255: LOCALBASE= /usr/pkg
2256: PKG_SYSCONFBASE= /usr/pkg/etc
2257: VARBASE= /var
1.119 sevan 2258: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2259: </pre>
2260: <p>In unprivileged mode (when pkgsrc has been installed as any other
2261: user), the default locations are:</p>
2262: <pre class="programlisting">
2263: LOCALBASE= ${HOME}/pkg
2264: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2265: VARBASE= ${HOME}/pkg/var
1.119 sevan 2266: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2267: </pre>
2268: <p>What these four directories are for, and what they look like is
2269: explained below.</p>
1.41 asau 2270: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2271: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2272: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2273: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2274: the well-known subdirectories like <code class="filename">bin</code>,
2275: <code class="filename">include</code>, <code class="filename">lib</code>,
2276: <code class="filename">share</code> and
2277: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2278: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2279: <code class="filename">/var</code> in the base system. Some programs (especially
2280: games, network daemons) need write access to it during normal
2281: operation.</p></li>
1.23 wiz 2282: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2283: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2284: 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 2285: itself.</p></li>
2286: </ul></div>
1.41 asau 2287: <div class="sect1">
1.1 dsieger 2288: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2289: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2290: </h2></div></div></div>
2291: <p>The following directories exist in a typical pkgsrc installation
2292: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2293: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2294: <dt><span class="term"><code class="filename">bin</code></span></dt>
2295: <dd><p>Contains executable programs that are intended to be
2296: directly used by the end user.</p></dd>
2297: <dt><span class="term"><code class="filename">emul</code></span></dt>
2298: <dd><p>Contains files for the emulation layers of various other
2299: operating systems, especially for
2300: NetBSD.</p></dd>
2301: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2302: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2303: <dd><p>Contains
2304: the configuration files.</p></dd>
2305: <dt><span class="term"><code class="filename">include</code></span></dt>
2306: <dd><p>Contains headers for the C and C++ programming
2307: languages.</p></dd>
2308: <dt><span class="term"><code class="filename">info</code></span></dt>
2309: <dd><p>Contains GNU info files of various
2310: packages.</p></dd>
2311: <dt><span class="term"><code class="filename">lib</code></span></dt>
2312: <dd><p>Contains shared and static
2313: libraries.</p></dd>
2314: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2315: <dd><p>Contains data files that don't change after
2316: installation. Other data files belong into
2317: <code class="filename">${VARBASE}</code>.</p></dd>
2318: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2319: <dd><p>Contains programs that are not intended to be used by
2320: end users, such as helper programs or network
2321: daemons.</p></dd>
2322: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2323: <dd><p>Contains programs that are intended to be executed as
2324: CGI scripts by a web server.</p></dd>
2325: <dt><span class="term"><code class="filename">man</code> (the usual value of
2326: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2327: <dd><p>Contains brief
2328: documentation in form of manual pages.</p></dd>
2329: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2330: <dd><p>Contains programs that are intended to be used only by
2331: the super-user.</p></dd>
2332: <dt><span class="term"><code class="filename">share</code></span></dt>
2333: <dd><p>Contains platform-independent data files that don't
2334: change after installation.</p></dd>
2335: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2336: <dd><p>Contains documentation files provided by the
2337: packages.</p></dd>
2338: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2339: <dd><p>Contains example files provided by the packages. Among
2340: others, the original configuration files are saved here and copied to
2341: <code class="filename">${PKG_SYSCONFDIR}</code> during
2342: installation.</p></dd>
2343: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2344: <dd><p>Contains the original files for rc.d
2345: scripts.</p></dd>
2346: <dt><span class="term"><code class="filename">var</code> (the usual location of
2347: <code class="filename">${VARBASE}</code>)</span></dt>
2348: <dd><p>Contains files
2349: that may be modified after
2350: installation.</p></dd>
2351: </dl></div>
2352: </div>
1.41 asau 2353: <div class="sect1">
1.1 dsieger 2354: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2355: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2356: </h2></div></div></div>
1.41 asau 2357: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2358: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2359: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2360: <dd><p>Contains
2361: information about the currently installed
2362: packages.</p></dd>
2363: <dt><span class="term"><code class="filename">games</code></span></dt>
2364: <dd><p>Contains highscore
2365: files.</p></dd>
2366: <dt><span class="term"><code class="filename">log</code></span></dt>
2367: <dd><p>Contains log files.</p></dd>
2368: <dt><span class="term"><code class="filename">run</code></span></dt>
2369: <dd><p>Contains informational files about daemons that are
2370: currently running.</p></dd>
2371: </dl></div>
2372: </div>
2373: </div>
1.41 asau 2374: <div class="chapter">
1.1 dsieger 2375: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2376: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2377: <div class="toc">
2378: <p><b>Table of Contents</b></p>
1.100 leot 2379: <dl class="toc">
1.154 rillig 2380: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2381: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2382: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2383: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2384: <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>
2385: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2386: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2387: <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>
2388: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2389: <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 2390: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 2391: <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>
2392: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
2393: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2394: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2395: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2396: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2397: <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 2398: </dl>
2399: </div>
2400: <p>This section contains hints, tips & tricks on special things in
2401: pkgsrc that we didn't find a better place for in the previous chapters, and
2402: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2403: <div class="sect1">
1.1 dsieger 2404: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2405: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2406: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2407: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2408: <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 2409: This is a general purpose list for most issues regarding
2410: pkgsrc, regardless of platform, e.g. soliciting user help
2411: for pkgsrc configuration, unexpected build failures, using
2412: particular packages, upgrading pkgsrc installations,
2413: questions regarding the pkgsrc release branches, etc. General announcements or
2414: proposals for changes that impact the pkgsrc user community,
2415: e.g. major infrastructure changes, new features, package
2416: removals, etc., may also be posted.</p></li>
1.23 wiz 2417: <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 2418: A list where the results of pkgsrc bulk builds are sent and
2419: discussed.</p></li>
1.23 wiz 2420: <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 2421: This list is for those who are interested in getting a
2422: commit message for every change committed to pkgsrc. It is
2423: also available in digest form, meaning one daily message
2424: containing all commit messages for changes to the package
2425: source tree in that 24 hour period.</p></li>
2426: </ul></div>
2427: <p>To subscribe, do:</p>
2428: <pre class="programlisting">
2429: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2430: </pre>
2431: <p>Archives for all these mailing lists are available from
1.10 hubertf 2432: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2433: </div>
1.41 asau 2434: <div class="sect1">
1.1 dsieger 2435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2436: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2437: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2438: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2439: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2440: they might be useful, and not to duplicate the documentation that comes
2441: with each package.</p>
2442: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.137 leot 2443: <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 2444: Symlinks for use by buildlink.</p></li></ul></div>
2445: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2446: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2447: <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 2448: Calculates various kinds of checksums (including SHA3).</p></li>
1.137 leot 2449: <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 2450: Compatibility library for pkgsrc tools.</p></li>
1.137 leot 2451: <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 2452: non-BSD systems due to lack of native mtree.</p></li>
1.137 leot 2453: <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 2454: Up-to-date replacement for
2455: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2456: systems where pkg_install is not present.</p></li>
2457: </ul></div>
2458: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2459: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2460: <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 2461: Create a binary package from an
1.10 hubertf 2462: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2463: save the old package.</p></li>
1.137 leot 2464: <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 2465: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2466: from multiple locations. It currently supports the following
2467: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.137 leot 2468: <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 2469: the best compiler flags to optimise code for your current
1.23 wiz 2470: CPU and compiler. </p></li>
1.1 dsieger 2471: </ul></div>
2472: <p>Utilities for keeping track of installed packages, being up to date,
2473: etc:</p>
1.41 asau 2474: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2475: <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 2476: update tool similar to apt(1). Download, install, and upgrade
2477: binary packages easily.</p></li>
1.137 leot 2478: <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 2479: packages whose installed versions do not match the latest pkgsrc
2480: entries.</p></li>
1.137 leot 2481: <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 2482: dependency graphs of packages, to aid in choosing a strategy for
2483: updating.</p></li>
1.137 leot 2484: <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
2485: 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>
2486: <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 2487: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.137 leot 2488: <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 2489: does various checks on the complete pkgsrc system.</p></li>
1.137 leot 2490: <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 2491: packages you have installed.</p></li>
2492: </ul></div>
2493: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2494: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2495: <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 2496: making and maintaining patches for a package (includes pkgdiff,
2497: pkgvi, mkpatches, etc.).</p></li>
1.137 leot 2498: <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 2499: converting to pkgsrc.</p></li>
2500: </ul></div>
2501: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2502: utilities)</p>
1.41 asau 2503: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2504: <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 2505: packages in a chrooted area.</p></li>
1.137 leot 2506: <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 2507: kernel version for chrooted cross builds.</p></li>
2508: </ul></div>
2509: </div>
1.41 asau 2510: <div class="sect1">
1.1 dsieger 2511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2512: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2513: <p>To install packages from source as a non-root user, download
1.154 rillig 2514: 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 2515: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2516: --unprivileged</strong></span>.</p>
2517: <p>This will install the binary part of pkgsrc to
2518: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2519: into <code class="filename">~/pkg/etc</code>.</p>
2520: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2521: </div>
1.41 asau 2522: <div class="sect1">
1.1 dsieger 2523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2524: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2525: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2526: enable this feature by adding the option
2527: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2528: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2529: distfile is found, pkgsrc will try to resume it.</p>
2530: <p>You can also
1.61 wiz 2531: use a different program than the platform default program by changing the
1.16 jnemeth 2532: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2533: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2534: by using the value manual. A value of custom disables the system defaults
2535: and dependency tracking for the fetch program. In that case you have to
2536: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2537: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2538: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2539: <p>For example, if you want to use
1.16 jnemeth 2540: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2541: like:</p>
2542: <pre class="programlisting">
1.112 rillig 2543: FETCH_USING= wget
1.1 dsieger 2544: </pre>
2545: </div>
1.41 asau 2546: <div class="sect1">
1.1 dsieger 2547: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2548: <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 2549: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2550: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2551: you will have to add the following line into
1.10 hubertf 2552: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2553: <pre class="programlisting">
1.4 rillig 2554: X11_TYPE=modular
1.1 dsieger 2555: </pre>
2556: </div>
1.41 asau 2557: <div class="sect1">
1.1 dsieger 2558: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2559: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2560: <p>If you are sitting behind a firewall which does not allow direct
2561: connections to Internet hosts (i.e. non-NAT), you may specify the
2562: relevant proxy hosts. This is done using an environment variable in the
2563: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2564: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2565: port 80 as the proxy port number. So the proxy environment variables
2566: are:</p>
2567: <pre class="programlisting">
2568: ftp_proxy=ftp://orpheus.amdahl.com:80/
2569: http_proxy=http://orpheus.amdahl.com:80/
2570: </pre>
2571: </div>
1.41 asau 2572: <div class="sect1">
1.1 dsieger 2573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2574: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2575: <p>Some fetch tools are not prepared to support HTTPS by default
2576: (for example, the one in NetBSD 6.0), or the one installed by the
2577: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2578: dependency graph).</p>
2579: <p>Usually you won't notice, because distribution files are
2580: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2581: be often enough if you are following pkgsrc-current. In that case, set
2582: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2583: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2584: with HTTPS support by default. Of course, these tools need to be
2585: installed before you can use them this way.</p>
2586: </div>
2587: <div class="sect1">
2588: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2589: <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 2590: <p>This depends on which utility is used to retrieve distfiles. From
2591: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2592: the first available command from the following list:</p>
1.41 asau 2593: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2594: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2595: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2596: </ul></div>
2597: <p>On a default NetBSD installation, this will be
2598: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2599: connections first, and falls back to active connections if the server
2600: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2601: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2602: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2603: <p>Having that option present will prevent
2604: <code class="filename">/usr/bin/ftp</code> from falling back to active
2605: transfers.</p>
2606: </div>
1.41 asau 2607: <div class="sect1">
1.1 dsieger 2608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2609: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2610: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2611: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2612: 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 2613: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2614: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2615: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2616: resulting list to your machine at work/school and use it there. If you
1.167 leot 2617: 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 2618: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2619: URL:</p>
2620: <p>At home:</p>
2621: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2622: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2623: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2624: <p>At work:</p>
2625: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2626: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2627: home.</p>
2628: <p>If you have a machine running NetBSD, and you want to get
2629: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2630: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2631: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2632: directly by running:</p>
2633: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2634: <p>If you even decide to ignore
2635: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2636: by running:</p>
2637: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2638: </div>
1.41 asau 2639: <div class="sect1">
1.1 dsieger 2640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2641: <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 2642: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.137 leot 2643: <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 2644: package, you get the error from make that it doesn't know how to make
2645: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2646: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2647: the NetBSD base distribution on your machine. It is recommended to do
2648: that to format man pages.</p>
1.137 leot 2649: <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 2650: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2651: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2652: </div>
1.41 asau 2653: <div class="sect1">
1.1 dsieger 2654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2655: <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 2656: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2657: when you installed your NetBSD machine. Please get and install it, by
2658: extracting it in <code class="filename">/</code>:</p>
2659: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2660: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2661: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2662: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2663: -r</strong></span>).</p>
2664: </div>
1.41 asau 2665: <div class="sect1">
1.1 dsieger 2666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2667: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 2668: <p>When installing packages as non-root user and using the just-in-time
1.167 leot 2669: <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 2670: password for each required package installed. To avoid this, the sudo
2671: package can be used, which does password caching over a limited time. To
2672: use it, install sudo (either as binary package or from
1.137 leot 2673: <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 2674: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2675: <span class="emphasis"><em>after</em></span> the definition of the
2676: <code class="varname">LOCALBASE</code> variable:</p>
2677: <pre class="programlisting">
2678: .if exists(${LOCALBASE}/bin/sudo)
2679: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2680: .endif
2681: </pre>
2682: </div>
1.41 asau 2683: <div class="sect1">
1.1 dsieger 2684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2685: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 2686: <p>As the system administrator, you can choose where configuration files
2687: are installed. The default settings make all these files go into
2688: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
2689: be suboptimal depending on your expectations (e.g., a read-only,
2690: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2691: configuration of the provided packages).</p>
2692: <p>In order to change the defaults, you can modify the
2693: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 2694: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 2695: directory; some common examples include <code class="filename">/etc</code> or
2696: <code class="filename">/etc/pkg</code>.</p>
2697: <p>Furthermore, you can change this value on a per-package basis by
2698: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2699: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2700: package you would like to modify, that is, the contents of
2701: <code class="varname">PKGBASE</code>.</p>
2702: <p>Note that after changing these settings, you must rebuild and
2703: reinstall any affected packages.</p>
2704: </div>
1.41 asau 2705: <div class="sect1">
1.1 dsieger 2706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2707: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1 dsieger 2708: <p>Please be aware that there can often be bugs in third-party software,
2709: and some of these bugs can leave a machine vulnerable to exploitation by
2710: attackers. In an effort to lessen the exposure, the NetBSD packages team
2711: maintains a database of known-exploits to packages which have at one time
2712: been included in pkgsrc. The database can be downloaded automatically, and
2713: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 2714: do this, refer to the following two tools (installed as part of the
1.137 leot 2715: <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 2716: <div class="orderedlist"><ol class="orderedlist" type="1">
2717: <li class="listitem">
1.20 snj 2718: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 2719: download a list of the security vulnerabilities information. This list
1.25 spz 2720: is kept up to date by the pkgsrc security team, and is distributed
2721: from the NetBSD ftp server:</p>
2722: <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 2723: </li>
1.23 wiz 2724: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
2725: current machine, checking each known vulnerability. If a
1.1 dsieger 2726: vulnerable package is installed, it will be shown by output to stdout,
2727: including a description of the type of vulnerability, and a URL
2728: containing more information.</p></li>
2729: </ol></div>
1.121 sevan 2730: <p>Use of these tools is strongly recommended!
1.154 rillig 2731: 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 2732: reporting.</p>
2733: <p>If this database is installed, pkgsrc builds will use it to
2734: perform a security check before building any package.</p>
1.1 dsieger 2735: </div>
1.41 asau 2736: <div class="sect1">
1.1 dsieger 2737: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2738: <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 2739: <p>When you add your own preferences to the
2740: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 2741: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 2742: environment variables to the <code class="filename">./configure</code>
1.167 leot 2743: 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 2744: <code class="varname">CFLAGS</code> from the environment variable by
2745: overriding them in the <code class="filename">Makefile</code>s of their
2746: package.</p>
2747: <p>Currently there is no solution to this problem. If you
2748: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 2749: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 2750: directory and then inspect any <code class="filename">Makefile</code> and
2751: <code class="filename">Makefile.in</code> for whether they define
2752: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 2753: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 2754: programmers write so bad code that it only works for the
2755: specific combination of <code class="varname">CFLAGS</code> they have
2756: chosen.</p>
2757: </div>
1.41 asau 2758: <div class="sect1">
1.1 dsieger 2759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2760: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 2761: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 2762: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 2763: case that occurs often is that people only update pkgsrc in
2764: parts, because of performance reasons. Since pkgsrc is one large
2765: system, not a collection of many small systems, there are
2766: sometimes changes that only work when the whole pkgsrc tree is
2767: updated.</p></li>
1.41 asau 2768: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 2769: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
2770: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 2771: files.</p></li>
1.41 asau 2772: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 2773: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 2774: verify this.</p></li>
1.108 rillig 2775: <li class="step"><p>If you are a package developer who wants to invest
1.154 rillig 2776: 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 2777: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 2778: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2779: </ol></div>
2780: </div>
1.41 asau 2781: <div class="sect1">
1.1 dsieger 2782: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2783: <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 2784: <p>You have modified a file from pkgsrc, and someone else has
2785: modified that same file afterwards in the CVS repository. Both changes
2786: are in the same region of the file, so when you updated pkgsrc, the
2787: <code class="literal">cvs</code> command marked the conflicting changes in the
2788: file. Because of these markers, the file is no longer a valid
2789: <code class="filename">Makefile</code>.</p>
2790: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 2791: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 2792: -dP</strong></span> in that directory to download the current version.</p>
2793: </div>
2794: </div>
2795: </div>
1.41 asau 2796: <div class="part">
1.1 dsieger 2797: <div class="titlepage"><div><div><h1 class="title">
2798: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 2799: <div class="partintro">
1.1 dsieger 2800: <div></div>
2801: <p>This part of the book deals with creating and
1.23 wiz 2802: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 2803: guide on creating a new package. The remaining chapters are more
2804: like a reference manual for pkgsrc.</p>
2805: <div class="toc">
2806: <p><b>Table of Contents</b></p>
1.100 leot 2807: <dl class="toc">
1.154 rillig 2808: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
2809: <dt><span class="chapter"><a href="#creating">12. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 2810: <dd><dl>
1.154 rillig 2811: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1 dsieger 2812: <dd><dl>
1.154 rillig 2813: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
2814: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160 brook 2815: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
2816: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1 dsieger 2817: </dl></dd>
1.154 rillig 2818: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
2819: <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 2820: </dl></dd>
1.154 rillig 2821: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.6 rillig 2822: <dd><dl>
1.154 rillig 2823: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
2824: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
2825: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 2826: <dd><dl>
1.154 rillig 2827: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
2828: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
2829: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
2830: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
2831: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
1.6 rillig 2832: </dl></dd>
1.154 rillig 2833: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
2834: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
1.6 rillig 2835: <dd><dl>
1.154 rillig 2836: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
2837: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
2838: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.6 rillig 2839: </dl></dd>
1.154 rillig 2840: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
2841: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 2842: </dl></dd>
1.154 rillig 2843: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 2844: <dd><dl>
1.154 rillig 2845: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
2846: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
2847: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
2848: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
1.6 rillig 2849: <dd><dl>
1.154 rillig 2850: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
2851: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
2852: <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>
2853: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 2854: </dl></dd>
2855: </dl></dd>
1.154 rillig 2856: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.6 rillig 2857: <dd><dl>
1.154 rillig 2858: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
2859: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
2860: <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>
2861: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
2862: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
2863: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
2864: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
2865: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
2866: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.6 rillig 2867: </dl></dd>
1.154 rillig 2868: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.6 rillig 2869: <dd><dl>
1.154 rillig 2870: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
2871: <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 2872: <dd><dl>
1.154 rillig 2873: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
2874: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26 wiz 2875: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2876: and
2877: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2878: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 2879: </dl></dd>
1.154 rillig 2880: <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 2881: <dd><dl>
1.154 rillig 2882: <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>
2883: <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 2884: </dl></dd>
2885: </dl></dd>
1.154 rillig 2886: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.6 rillig 2887: <dd><dl>
1.154 rillig 2888: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
2889: <dd><dl>
2890: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
2891: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
2892: </dl></dd>
2893: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
2894: <dd><dl>
2895: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
2896: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
2897: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
2898: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
2899: </dl></dd>
2900: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
2901: <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>
2902: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
2903: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
2904: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
2905: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
2906: <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>
2907: </dl></dd>
2908: <dt><span class="chapter"><a href="#options">18. Options handling</a></span></dt>
2909: <dd><dl>
2910: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
2911: <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>
2912: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
2913: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
2914: </dl></dd>
2915: <dt><span class="chapter"><a href="#build">19. The build process</a></span></dt>
2916: <dd><dl>
2917: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
2918: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
2919: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
2920: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
2921: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
2922: <dd><dl>
2923: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
2924: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
2925: </dl></dd>
2926: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
2927: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
2928: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
2929: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
2930: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
2931: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2932: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2933: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
2934: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
2935: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
2936: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
2937: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
2938: </dl></dd>
2939: <dt><span class="chapter"><a href="#tools">20. Tools needed for building or running</a></span></dt>
2940: <dd><dl>
2941: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
2942: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
2943: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
2944: </dl></dd>
2945: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
2946: <dd><dl>
2947: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
2948: <dd><dl>
2949: <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>
2950: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
2951: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
2952: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
2953: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
2954: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
2955: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
2956: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
2957: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
2958: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
2959: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
2960: </dl></dd>
2961: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
2962: <dd><dl>
2963: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
2964: <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>
2965: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
2966: </dl></dd>
2967: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2968: <dd><dl>
2969: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
2970: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
2971: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
2972: </dl></dd>
2973: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
2974: <dd><dl>
2975: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
2976: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
2977: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
2978: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
2979: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
2980: </dl></dd>
2981: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2982: <dd><dl>
2983: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
2984: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
2985: <dt><span class="sect2"><a href="#undefined-reference">21.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
2986: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
2987: </dl></dd>
2988: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
2989: <dd><dl>
2990: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
2991: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
2992: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
2993: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
2994: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
2995: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
2996: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
2997: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
2998: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
2999: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
3000: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
3001: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
3002: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
3003: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
3004: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
3005: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
3006: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
3007: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 3008: emulation</a></span></dt>
1.154 rillig 3009: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
3010: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3011: </dl></dd>
1.154 rillig 3012: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3013: </dl></dd>
1.154 rillig 3014: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
3015: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3016: <dd><dl>
1.154 rillig 3017: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3018: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3019: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3020: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3021: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3022: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3023: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3024: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3025: </dl></dd>
3026: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
3027: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
3028: <dd><dl>
3029: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
3030: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
3031: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
3032: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1 dsieger 3033: </dl></dd>
3034: </dl>
3035: </div>
3036: </div>
1.41 asau 3037: <div class="chapter">
1.1 dsieger 3038: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3039: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3040: <p>
3041: To get help when developing pkgsrc, the definitive source is this
3042: document, the pkgsrc guide. If you don't find anything here,
3043: there are alternatives:
3044: </p>
3045: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3046: <li class="listitem">
3047: <p>
3048: The built-in pkgsrc help, which is available after bootstrapping
3049: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3050: help for any topic, such as a variable name like
3051: <code class="varname">BUILD_DEFS</code>, a make target like
3052: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3053: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
3054: <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>
3055: </li>
3056: <li class="listitem"><p>
1.163 rillig 3057: To see the value of a single variable, run <span class="command"><strong>bmake
3058: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3059: </p></li>
3060: <li class="listitem"><p>
3061: To see the values of the most common variables, run
3062: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3063: topic. To see the variables for a single topic, run
3064: <span class="command"><strong>bmake
3065: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3066: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3067: </p></li>
3068: <li class="listitem"><p>
1.154 rillig 3069: The tech-pkg mailing list, to which
3070: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3071: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3072: questions</a>.</p></li>
3073: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3074: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3075: or by using a specialized chat program such as
3076: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3077: Pick any user name and join the channel #pkgsrc.</p></li>
3078: </ul></div>
3079: </div>
3080: <div class="chapter">
3081: <div class="titlepage"><div><div><h2 class="title">
3082: <a name="creating"></a>Chapter 12. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3083: <div class="toc">
3084: <p><b>Table of Contents</b></p>
1.100 leot 3085: <dl class="toc">
1.154 rillig 3086: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1 dsieger 3087: <dd><dl>
1.154 rillig 3088: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
3089: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160 brook 3090: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
3091: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1 dsieger 3092: </dl></dd>
1.154 rillig 3093: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
3094: <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 3095: </dl>
3096: </div>
3097: <p>When you find a package that is not yet in pkgsrc, you
3098: most likely have a URL from where you can download the source
3099: code. Starting with this URL, creating a package involves only a
3100: few steps.</p>
1.23 wiz 3101: <div class="procedure"><ol class="procedure" type="1">
1.137 leot 3102: <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 3103: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3104: category in which you want to place your package. You can also create a
3105: directory of your own (maybe called <code class="filename">local</code>). In that
3106: category directory, create another directory for your package and change
3107: into it.</p></li>
1.41 asau 3108: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3109: you for a URL. Enter the URL of the distribution file (in most cases a
3110: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3111: of your package are created automatically. The distribution file is
3112: extracted automatically to fill in some details in the
3113: <code class="filename">Makefile</code> that would otherwise have to be done
3114: manually.</p></li>
1.41 asau 3115: <li class="step">
1.1 dsieger 3116: <p>Examine the extracted files to determine the dependencies of
3117: your package. Ideally, this is mentioned in some
3118: <code class="filename">README</code> file, but things may differ. For each of
3119: these dependencies, look where it exists in pkgsrc, and if there is a
3120: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3121: line to your package <code class="filename">Makefile</code> which includes that
3122: file just before the last line. If the
1.25 spz 3123: <code class="filename">buildlink3.mk</code> file does not exist, it must be
1.161 leot 3124: created first. The <code class="filename">buildlink3.mk</code> file makes sure
3125: that the package's include files and libraries are provided.</p>
1.25 spz 3126: <p>If you just need binaries from a package, add a
1.1 dsieger 3127: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3128: version of the dependency and where it can be found in pkgsrc. This line
3129: should be placed in the third paragraph. If the dependency is only
3130: needed for building the package, but not when using it, use
1.156 leot 3131: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
3132: instead of <code class="varname">DEPENDS</code>.
3133: The difference between <code class="varname">TOOL_DEPENDS</code> and
3134: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
3135: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
3136: packages, i.e. packages for the architecture where the package
3137: is built;
3138: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
3139: packages, i.e. packages for the architecture for which the package
3140: is built.
1.1 dsieger 3141: Your package may then look like this:</p>
3142: <pre class="programlisting">
3143: [...]
3144:
1.156 leot 3145: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3146: DEPENDS+= screen-[0-9]*:../../misc/screen
3147: DEPENDS+= screen>=4.0:../../misc/screen
3148:
3149: [...]
3150:
3151: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3152: .include "../../devel/glib2/buildlink3.mk"
3153: .include "../../mk/bsd.pkg.mk"
3154: </pre>
3155: </li>
1.41 asau 3156: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3157: 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 3158: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3159: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3160: -e</strong></span>, which outputs additional
3161: explanations.</p></li>
1.41 asau 3162: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.154 rillig 3163: 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 3164: over there, you can hopefully continue here.</p></li>
1.41 asau 3165: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3166: directory from the extracted files. Besides these files, a lot of cache
3167: files and other system information has been saved in the working
3168: directory, which may become wrong after you edited the
3169: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3170: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.154 rillig 3171: 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 3172: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3173: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3174: everything works.</p></li>
1.41 asau 3175: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3176: contains a list of the files that are installed by the package, is
1.10 hubertf 3177: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3178: >PLIST</strong></span> to generate a probably correct list. Check
3179: the file using your preferred text editor to see if the list of
3180: files looks plausible.</p></li>
1.41 asau 3181: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3182: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3183: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3184: has been registered in the database of installed files, but with an
1.10 hubertf 3185: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3186: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3187: registered with the list of files from
3188: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3189: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3190: package from the set of installed files.</p></li>
3191: </ol></div>
1.41 asau 3192: <div class="sect1">
1.1 dsieger 3193: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3194: <a name="creating.common"></a>12.1. Common types of packages</h2></div></div></div>
1.41 asau 3195: <div class="sect2">
1.1 dsieger 3196: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3197: <a name="creating.perl-module"></a>12.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3198: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3199: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3200: </div>
1.41 asau 3201: <div class="sect2">
1.1 dsieger 3202: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3203: <a name="creating.python-module"></a>12.1.2. Python modules and programs</h3></div></div></div>
1.17 imil 3204: <p>Python modules and programs packages are easily created using a
3205: set of predefined variables.</p>
3206: <p>
1.63 wiz 3207: If some Python versions are not supported by the software, set the
3208: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3209: that are not supported, e.g.
1.17 imil 3210: </p>
3211: <pre class="programlisting">
1.93 sevan 3212: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3213: </pre>
3214: <p>
1.103 wiz 3215: If the packaged software is a Python module, include one of
3216: <code class="filename">../../lang/python/egg.mk</code>,
3217: <code class="filename">../../lang/python/distutils.mk</code>, or
3218: <code class="filename">../../lang/python/extension.mk</code>.</p>
3219: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3220: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3221: if the packaged software is using setuptools, you only need
3222: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3223: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3224: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3225: so pkgsrc will use this framework.
3226: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3227: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3228: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3229: to the name of the script.</p>
3230: <p>Either way, the package directory should be called
1.23 wiz 3231: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3232: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3233: </p>
3234: <pre class="programlisting">
3235: DISTNAME= foopymodule-1.2.10
3236: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3237: </pre>
1.63 wiz 3238: <p>If it is an application, include
3239: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3240: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3241: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3242: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3243: For example:
1.17 imil 3244: </p>
3245: <pre class="programlisting">
1.35 wiz 3246: REPLACE_PYTHON= *.py
1.17 imil 3247: </pre>
1.63 wiz 3248: <p>Some Python modules have separate distributions for Python-2.x
3249: and Python-3.x support. In pkgsrc this is handled by the
3250: <code class="filename">versioned_dependencies.mk</code> file. Set
3251: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3252: packages that should be depended upon and include
3253: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3254: then the pkgsrc infrastructure will depend on the appropriate package
3255: version. For example:
3256: </p>
3257: <pre class="programlisting">
1.135 wiz 3258: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.63 wiz 3259: </pre>
3260: <p>
3261: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3262: of supported packages.</p>
1.17 imil 3263: </div>
1.160 brook 3264: <div class="sect2">
3265: <div class="titlepage"><div><div><h3 class="title">
3266: <a name="creating.R-package"></a>12.1.3. R packages</h3></div></div></div>
3267: <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>
3268: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
3269: 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>.
3270: Individual packages (and optionally their dependencies) may be created
3271: and updated. R packages generally follow the same form, and most of
3272: the relevant information needed is contained in a
3273: <code class="filename">DESCRIPTION</code> file as part of each R package on
3274: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
3275: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
3276: creates or updates a package in the canonical form. The resulting
3277: package should be reviewed for correctness.</p>
3278: </div>
3279: <div class="sect2">
3280: <div class="titlepage"><div><div><h3 class="title">
3281: <a name="creating.TeX-package"></a>12.1.4. TeXlive packages</h3></div></div></div>
3282: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
3283: <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>
3284: <p>If the TeXlive package name is not known, it may be useful to
3285: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
3286: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
3287: 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
3288: archive</a>.</p>
3289: <p>If the TeXlive package name is known, download the files from
3290: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
3291: archive</a>. For package <code class="filename">foo</code>, you will need
3292: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
3293: also have associated documentation packages, so download
3294: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
3295: should be placed in the appropriate category directory, which is often
3296: but not always <code class="filename">print</code>. Then run the following
3297: command in the category directory.</p>
3298: <pre class="programlisting">
3299: texlive2pkg foo.tar.xz foo.doc.tar.xz
3300: </pre>
3301: <p>This will create two packages, <code class="filename">tex-foo</code> and
3302: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
3303: are correct.</p>
3304: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
3305: currently does not include version information in package filenames
3306: and changes their contents periodically when updates occur.
3307: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
3308: pkgsrc archives. For each new or updated TeXlive package, e.g., the
3309: main one and the corresponding documentation, upload the distfiles
3310: with the following command in each package directory.</p>
3311: <pre class="programlisting">
3312: make upload-distfiles
3313: </pre>
3314: </div>
1.1 dsieger 3315: </div>
1.41 asau 3316: <div class="sect1">
1.1 dsieger 3317: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3318: <a name="creating.examples"></a>12.2. Examples</h2></div></div></div>
1.41 asau 3319: <div class="sect2">
1.1 dsieger 3320: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3321: <a name="creating.nvu"></a>12.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3322: <div class="sect3">
1.1 dsieger 3323: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 3324: <a name="creating.nvu.init"></a>12.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3325: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3326: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3327: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3328: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3329: <pre class="programlisting">
3330: <code class="prompt">$</code> mkdir www/nvu
3331: <code class="prompt">$</code> cd www/nvu
3332: </pre>
3333: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3334: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3335: <pre class="programlisting">
3336: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3337: </pre>
3338: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3339: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3340: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3341: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3342: <code class="varname">COMMENT</code> fields. Then the package
3343: <code class="filename">Makefile</code> looked like that:</p>
3344: <pre class="programlisting">
1.121 sevan 3345: # $NetBSD $
1.1 dsieger 3346: #
3347:
3348: DISTNAME= nvu-1.0-sources
3349: PKGNAME= nvu-1.0
3350: CATEGORIES= www
3351: MASTER_SITES= http://cvs.nvu.com/download/
3352: EXTRACT_SUFX= .tar.bz2
3353:
3354: MAINTAINER= rillig@NetBSD.org
3355: HOMEPAGE= http://cvs.nvu.com/
3356: COMMENT= Web Authoring System
3357:
3358: # url2pkg-marker (please do not remove this line.)
3359: .include "../../mk/bsd.pkg.mk"
3360: </pre>
1.124 wiz 3361: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.121 sevan 3362: this is a workaround to prevent CVS expanding to the filename of the
3363: guide.</p>
1.1 dsieger 3364: <p>Then, I quit the editor and watched pkgsrc downloading a large
3365: source archive:</p>
3366: <pre class="programlisting">
3367: url2pkg> Running "make makesum" ...
3368: => Required installed package digest>=20010302: digest-20060826 found
3369: => Fetching nvu-1.0-sources.tar.bz2
3370: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3371: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3372: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3373: url2pkg> Running "make extract" ...
3374: => Required installed package digest>=20010302: digest-20060826 found
3375: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3376: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3377: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3378: ===> Installing dependencies for nvu-1.0
3379: ===> Overriding tools for nvu-1.0
3380: ===> Extracting for nvu-1.0
3381: url2pkg> Adjusting the Makefile.
3382:
3383: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3384:
3385: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3386: </pre>
3387: </div>
1.41 asau 3388: <div class="sect3">
1.1 dsieger 3389: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 3390: <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 3391: <p>Now that the package has been extracted, let's see what's inside
3392: it. The package has a <code class="filename">README.txt</code>, but that only
3393: says something about mozilla, so it's probably useless for seeing what
3394: dependencies this package has. But since there is a GNU configure script
3395: in the package, let's hope that it will complain about everything it
3396: needs.</p>
3397: <pre class="programlisting">
3398: <code class="prompt">$</code> bmake
3399: => Required installed package digest>=20010302: digest-20060826 found
3400: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3401: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3402: ===> Patching for nvu-1.0
3403: ===> Creating toolchain wrappers for nvu-1.0
3404: ===> Configuring for nvu-1.0
3405: [...]
3406: configure: error: Perl 5.004 or higher is required.
3407: [...]
3408: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3409: [...]
3410: </pre>
3411: <p>That worked quite well. So I opened the package Makefile in my
3412: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3413: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3414: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3415: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3416: from scratch.</p>
3417: <pre class="programlisting">
3418: <code class="prompt">$</code> bmake clean
3419: ===> Cleaning for nvu-1.0
3420: <code class="prompt">$</code> bmake
3421: [...]
3422: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3423: GNU Make. You will not be able to build Mozilla without GNU Make.
3424: [...]
3425: </pre>
1.23 wiz 3426: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3427: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3428: <pre class="programlisting">
3429: [...]
3430: checking for GTK - version >= 1.2.0... no
3431: *** Could not run GTK test program, checking why...
3432: [...]
3433: </pre>
3434: <p>Now to the other dependencies. The first question is: Where is the
3435: GTK package hidden in pkgsrc?</p>
3436: <pre class="programlisting">
3437: <code class="prompt">$</code> echo ../../*/gtk*
3438: [many packages ...]
3439: <code class="prompt">$</code> echo ../../*/gtk
3440: ../../x11/gtk
3441: <code class="prompt">$</code> echo ../../*/gtk2
3442: ../../x11/gtk2
3443: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3444: ../../x11/gtk2/buildlink3.mk
3445: </pre>
3446: <p>The first try was definitely too broad. The second one had exactly
3447: one result, which is very good. But there is one pitfall with GNOME
3448: packages. Before GNOME 2 had been released, there were already many
3449: GNOME 1 packages in pkgsrc. To be able to continue to use these
3450: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3451: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3452: whether this was the case here, and indeed it was.</p>
3453: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3454: file, adding the dependency is very easy. I just inserted an
3455: <code class="literal">.include</code> line before the last line of the package
3456: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3457: <pre class="programlisting">
3458: [...]
3459: .include "../../x11/gtk2/buildlink3.mk"
3460: .include "../../mk/bsd.pkg.mk
3461: </pre>
1.10 hubertf 3462: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3463: was:</p>
3464: <pre class="programlisting">
3465: [...]
3466: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3467: checking for GTK - version >= 1.2.0... no
3468: *** Could not run GTK test program, checking why...
3469: *** The test program failed to compile or link. See the file config.log for the
3470: *** exact error that occured. This usually means GTK was incorrectly installed
3471: *** or that you have moved GTK since it was installed. In the latter case, you
3472: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3473: configure: error: Test for GTK failed.
3474: [...]
3475: </pre>
1.23 wiz 3476: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3477: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3478: told me that this package really wanted to have the GNOME 1 version of
3479: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3480: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3481: So I changed the <code class="literal">x11/gtk2</code> to
3482: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3483: and tried again.</p>
3484: <pre class="programlisting">
3485: [...]
1.59 jnemeth 3486: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3487: In file included from xpidl.c:42:
3488: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3489: In file included from xpidl.c:42:
3490: xpidl.h:132: error: parse error before "IDL_ns"
3491: [...]
3492: </pre>
3493: <p>The package still does not find all of its dependencies. Now the
3494: question is: Which package provides the
3495: <code class="filename">libIDL/IDL.h</code> header file?</p>
3496: <pre class="programlisting">
3497: <code class="prompt">$</code> echo ../../*/*idl*
3498: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3499: <code class="prompt">$</code> echo ../../*/*IDL*
3500: ../../net/libIDL
3501: </pre>
3502: <p>Let's take the one from the second try. So I included the
3503: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3504: again. But the error didn't change. After digging through some of the
3505: code, I concluded that the build process of the package was broken and
3506: couldn't have ever worked, but since the Mozilla source tree is quite
3507: large, I didn't want to fix it. So I added the following to the package
3508: <code class="filename">Makefile</code> and tried again:</p>
3509: <pre class="programlisting">
3510: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.139 leot 3511: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.1 dsieger 3512: </pre>
3513: <p>The latter line is needed because the package expects the library
3514: <code class="filename">libIDL.so</code>, but only
3515: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3516: wrapper to rewrite that on the fly.</p>
3517: <p>The next problem was related to a recent change of the FreeType
1.137 leot 3518: 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 3519: which patch files were relevant for this issue and copied them to the
3520: <code class="filename">patches</code> directory. Then I retried, fixed the
3521: patches so that they applied cleanly and retried again. This time,
3522: everything worked.</p>
3523: </div>
1.41 asau 3524: <div class="sect3">
1.1 dsieger 3525: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 3526: <a name="creating.nvu.inst"></a>12.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3527: <pre class="programlisting">
3528: <code class="prompt">$</code> bmake CHECK_FILES=no install
3529: [...]
3530: <code class="prompt">$</code> bmake print-PLIST >PLIST
3531: <code class="prompt">$</code> bmake deinstall
3532: <code class="prompt">$</code> bmake install
3533: </pre>
3534: </div>
3535: </div>
3536: </div>
3537: </div>
1.41 asau 3538: <div class="chapter">
1.1 dsieger 3539: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3540: <a name="components"></a>Chapter 13. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3541: <div class="toc">
3542: <p><b>Table of Contents</b></p>
1.100 leot 3543: <dl class="toc">
1.154 rillig 3544: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
3545: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
3546: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
3547: <dd><dl>
3548: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
3549: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
3550: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
3551: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
3552: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
3553: </dl></dd>
3554: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
3555: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
3556: <dd><dl>
3557: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
3558: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
3559: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3560: </dl></dd>
1.154 rillig 3561: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
3562: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3563: </dl>
3564: </div>
3565: <p>Whenever you're preparing a package, there are a number of
3566: files involved which are described in the following
3567: sections.</p>
1.41 asau 3568: <div class="sect1">
1.1 dsieger 3569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3570: <a name="components.Makefile"></a>13.1. <code class="filename">Makefile</code>
1.1 dsieger 3571: </h2></div></div></div>
3572: <p>Building, installation and creation of a binary package are all
3573: controlled by the package's <code class="filename">Makefile</code>.
3574: The <code class="filename">Makefile</code> describes various things about
3575: a package, for example from where to get it, how to configure,
3576: build, and install it.</p>
3577: <p>A package <code class="filename">Makefile</code> contains several
3578: sections that describe the package.</p>
3579: <p>In the first section there are the following variables, which
3580: should appear exactly in the order given here. The order and
3581: grouping of the variables is mostly historical and has no further
3582: meaning.</p>
1.41 asau 3583: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3584: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3585: distribution file to be downloaded from the package's
3586: website.</p></li>
1.23 wiz 3587: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 3588: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3589: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 3590: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3591: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3592: directory name together with the version number. It must match the
3593: regular expression
3594: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3595: starts with a letter or digit, and contains only letters, digits,
3596: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3597: <li class="listitem">
1.1 dsieger 3598: <p><code class="varname">CATEGORIES</code> is a list of categories
3599: which the package fits in. You can choose any of the top-level
3600: directories of pkgsrc for it.</p>
3601: <p>Currently the following values are available for
3602: <code class="varname">CATEGORIES</code>. If more than
3603: one is used, they need to be separated by spaces:</p>
3604: <pre class="programlisting">
3605: archivers cross geography meta-pkgs security
3606: audio databases graphics misc shells
3607: benchmarks devel ham multimedia sysutils
3608: biology editors inputmethod net textproc
3609: cad emulators lang news time
3610: chat finance mail parallel wm
3611: comms fonts math pkgtools www
3612: converters games mbone print x11
3613: </pre>
3614: </li>
1.23 wiz 3615: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 3616: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3617: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3618: and <code class="varname">DISTFILES</code> are discussed in detail in
1.154 rillig 3619: <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 3620: </ul></div>
3621: <p>The second section contains information about separately
3622: downloaded patches, if any.
3623: </p>
1.41 asau 3624: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 3625: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 3626: Name(s) of additional files that contain distribution patches.
3627: There is no default. pkgsrc will look for them at
3628: <code class="varname">PATCH_SITES</code>.
3629: They will automatically be uncompressed before patching if
3630: the names end with <code class="filename">.gz</code> or
3631: <code class="filename">.Z</code>.</p></li>
1.23 wiz 3632: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 3633: Primary location(s) for distribution patch files (see
1.80 wiz 3634: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3635: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.167 leot 3636: 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 3637: help find the correct files to patch. It defaults to
3638: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 3639: </ul></div>
3640: <p>The third section contains the following variables.
3641: </p>
1.41 asau 3642: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3643: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 3644: address of the person who feels responsible for this package,
3645: and who is most likely to look at problems or questions regarding
1.167 leot 3646: 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 3647: Other developers may contact the <code class="varname">MAINTAINER</code>
3648: before making changes to the package, but are not required to
3649: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3650: to yourself. If you really can't maintain the package for future
3651: updates, set it to
1.10 hubertf 3652: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 3653: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 3654: of <code class="varname">MAINTAINER</code> when you do not want other
3655: developers to update or change the package without contacting
3656: you first. A package Makefile should contain one of
3657: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3658: not both. </p></li>
1.23 wiz 3659: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 3660: find more information about the package.</p></li>
1.23 wiz 3661: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 3662: description of the package (should not include the package
3663: name).</p></li>
1.122 leot 3664: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.154 rillig 3665: 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 3666: </ul></div>
3667: <p>Other variables that affect the build:
3668: </p>
1.41 asau 3669: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 3670: <p><code class="varname">WRKSRC</code>: The directory where the
3671: interesting distribution files of the package are found. The
3672: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3673: works for most packages.</p>
3674: <p>If a package doesn't create a subdirectory for itself
3675: (most GNU software does, for instance), but extracts itself in
3676: the current directory, you should set
3677: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3678: <p>If a package doesn't create a subdirectory with the
3679: name of <code class="varname">DISTNAME</code> but some different name,
3680: set <code class="varname">WRKSRC</code> to point to the proper name in
3681: <code class="filename">${WRKDIR}</code>, for example
3682: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.137 leot 3683: <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 3684: <p>The name of the working directory created by pkgsrc is
3685: taken from the <code class="varname">WRKDIR_BASENAME</code>
3686: variable. By default, its value is
3687: <code class="filename">work</code>. If you want to use the same
3688: pkgsrc tree for building different kinds of binary packages,
3689: you can change the variable according to your needs. Two
3690: other variables handle common cases of setting
3691: <code class="varname">WRKDIR_BASENAME</code> individually. If
3692: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 3693: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 3694: the host's name is attached to the directory name. If
3695: <code class="varname">OBJMACHINE</code> is defined, the platform name
3696: is attached, which might look like
3697: <code class="filename">work.i386</code> or
3698: <code class="filename">work.sparc</code>.</p>
3699: </li></ul></div>
3700: <p>Please pay attention to the following gotchas:</p>
1.41 asau 3701: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3702: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 3703: installed in compressed form by the package. For packages using
3704: BSD-style makefiles which honor MANZ, there is
3705: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 3706: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3707: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 3708: below).</p></li>
1.154 rillig 3709: <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 3710: </ul></div>
3711: </div>
1.41 asau 3712: <div class="sect1">
1.1 dsieger 3713: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3714: <a name="components.distinfo"></a>13.2. <code class="filename">distinfo</code>
1.1 dsieger 3715: </h2></div></div></div>
3716: <p>The <code class="filename">distinfo</code> file contains the message
3717: digest, or checksum, of each distfile needed for the package. This
3718: ensures that the distfiles retrieved from the Internet have not been
3719: corrupted during transfer or altered by a malign force to introduce
1.108 rillig 3720: a security hole. To provide maximum security, all distfiles are
3721: protected using three different message digest algorithms (SHA1,
3722: RMD160, SHA512), as well as the file size.</p>
1.1 dsieger 3723: <p>The <code class="filename">distinfo</code> file also contains the
3724: checksums for all the patches found in the
1.154 rillig 3725: <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 3726: are only applied intentionally and that they don't accidentally change,
3727: e.g. when merging different changes together. They also make sure that
3728: new patches are actually added to CVS and old ones are removed.
3729: Too see whether the patches and the <code class="filename">distinfo</code> file
3730: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
1.1 dsieger 3731: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108 rillig 3732: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1 dsieger 3733: <p>Some packages have different sets of distfiles depending on
1.137 leot 3734: 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 3735: <code class="filename">distinfo</code> file and care should be taken when
3736: upgrading such a package to ensure distfile information is not
3737: lost.</p>
3738: </div>
1.41 asau 3739: <div class="sect1">
1.1 dsieger 3740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3741: <a name="components.patches"></a>13.3. <code class="filename">patches/*</code>
1.108 rillig 3742: </h2></div></div></div>
3743: <p>Some packages don't work out-of-the box on the various
3744: platforms that are supported by pkgsrc. These packages need
3745: to be patched to make them work. The patch files can be
1.1 dsieger 3746: found in the <code class="filename">patches/</code> directory.</p>
3747: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3748: applied to the files in <code class="varname">WRKSRC</code> directory after
1.108 rillig 3749: extracting them, in alphabetic order.</p>
1.41 asau 3750: <div class="sect2">
1.1 dsieger 3751: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3752: <a name="components.patch.structure"></a>13.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 3753: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 3754: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 3755: problems. (To force patches to apply with fuzz you can set
3756: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3757: should contain only changes for a single file, and no file should be
3758: patched by more than one patch file. This helps to keep future
3759: modifications simple.</p>
3760: <p>Each patch file is structured as follows: In the first line,
3761: there is the RCS Id of the patch itself. The second line should be
3762: empty for aesthetic reasons. After that, there should be a comment for
3763: each change that the patch does. There are a number of standard
3764: cases:</p>
1.41 asau 3765: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3766: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 3767: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 3768: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 3769: platform and other environment (for example, the compiler) that the
3770: patch is needed for.</p></li>
3771: </ul></div>
1.108 rillig 3772: <p>The patch should be commented so that any
1.1 dsieger 3773: developer who knows the code of the application can make some use of
3774: the patch. Special care should be taken for the upstream developers,
3775: since we generally want that they accept our patches, so we have less
3776: work in the future.</p>
3777: </div>
1.41 asau 3778: <div class="sect2">
1.1 dsieger 3779: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3780: <a name="components.patches.caveats"></a>13.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 3781: <p>One important thing to mention is to pay attention that no RCS
3782: IDs get stored in the patch files, as these will cause problems when
3783: later checked into the NetBSD CVS tree. Use the
1.137 leot 3784: <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 3785: problems.</p>
3786: <p>For even more automation, we recommend using
1.10 hubertf 3787: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 3788: whole set of patches. You just have to backup files before you
3789: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 3790: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3791: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 3792: you upgrade a package this way, you can easily compare the new
3793: set of patches with the previously existing one with
1.24 wiz 3794: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3795: are replaced by new files, so carefully check if you want to take all
3796: the changes.</p>
1.1 dsieger 3797: <p>When you have finished a package, remember to generate
1.10 hubertf 3798: the checksums for the patch files by using the <span class="command"><strong>make
1.154 rillig 3799: 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 3800: <p>When adding a patch that corrects a problem in the
3801: distfile (rather than e.g. enforcing pkgsrc's view of where
3802: man pages should go), send the patch as a bug report to the
3803: maintainer. This benefits non-pkgsrc users of the package,
3804: and usually makes it possible to remove the patch in future
3805: version.</p>
1.2 rillig 3806: <p>The file names of the patch files are usually of the form
1.24 wiz 3807: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3808: Many packages still use the previous convention
3809: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3810: but new patches should be of the form containing the filename.
1.137 leot 3811: <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 3812: automatically.</p>
1.1 dsieger 3813: </div>
1.41 asau 3814: <div class="sect2">
1.1 dsieger 3815: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3816: <a name="components.patches.sources"></a>13.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 3817: <p>If you want to share patches between multiple packages
3818: in pkgsrc, e.g. because they use the same distfiles, set
3819: <code class="varname">PATCHDIR</code> to the path where the patch files
3820: can be found, e.g.:</p>
3821: <pre class="programlisting">
1.159 rillig 3822: PATCHDIR= ../../editors/xemacs/patches
1.1 dsieger 3823: </pre>
3824: <p>Patch files that are distributed by the author or other
3825: maintainers can be listed in
3826: <code class="varname">PATCHFILES</code>.</p>
3827: <p>If it is desired to store any patches that should not be
3828: committed into pkgsrc, they can be kept outside the pkgsrc
3829: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3830: directory tree there is expected to have the same
1.23 wiz 3831: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 3832: patches are expected to be stored inside these dirs (also
3833: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3834: example, if you want to keep a private patch for
3835: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3836: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3837: files in the named directory are expected to be patch files,
3838: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3839: applied</em></span>.</p>
3840: </div>
1.41 asau 3841: <div class="sect2">
1.1 dsieger 3842: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3843: <a name="components.patches.guidelines"></a>13.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 3844: <p>When fixing a portability issue in the code do not use
3845: preprocessor magic to check for the current operating system nor
3846: platform. Doing so hurts portability to other platforms because
3847: the OS-specific details are not abstracted appropriately.</p>
3848: <p>The general rule to follow is: instead of checking for the
3849: operating system the application is being built on, check for the
3850: specific <span class="emphasis"><em>features</em></span> you need. For example,
3851: instead of assuming that kqueue is available under NetBSD and
3852: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 3853: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 3854: yes, this generally involves patching the
1.10 hubertf 3855: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 3856: that prevents some OSes from adopting interfaces from other OSes
3857: (e.g. Linux implementing kqueue), something that the above checks
3858: cannot take into account.</p>
3859: <p>Of course, checking for features generally involves more
3860: work on the developer's side, but the resulting changes are
3861: cleaner and there are chances they will work on many other
3862: platforms. Not to mention that there are higher chances of being
3863: later integrated into the mainstream sources. Remember:
3864: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3865: <p>Some typical examples:</p>
3866: <div class="table">
1.154 rillig 3867: <a name="patch-examples"></a><p class="title"><b>Table 13.1. Patching examples</b></p>
1.106 tnn 3868: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1 dsieger 3869: <colgroup>
3870: <col>
3871: <col>
3872: <col>
3873: </colgroup>
3874: <thead><tr>
3875: <th>Where</th>
3876: <th>Incorrect</th>
3877: <th>Correct</th>
3878: </tr></thead>
3879: <tbody>
3880: <tr>
3881: <td>configure script</td>
3882: <td>
3883: <pre class="programlisting">
3884: case ${target_os} in
3885: netbsd*) have_kvm=yes ;;
3886: *) have_kvm=no ;;
3887: esac
3888: </pre>
3889: </td>
3890: <td>
3891: <pre class="programlisting">
3892: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
3893: </pre>
3894: </td>
3895: </tr>
3896: <tr>
3897: <td>C source file</td>
3898: <td>
3899: <pre class="programlisting">
3900: #if defined(__NetBSD__)
3901: # include <sys/event.h>
3902: #endif
3903: </pre>
3904: </td>
3905: <td>
3906: <pre class="programlisting">
3907: #if defined(HAVE_SYS_EVENT_H)
3908: # include <sys/event.h>
3909: #endif
3910: </pre>
3911: </td>
3912: </tr>
3913: <tr>
3914: <td>C source file</td>
3915: <td>
3916: <pre class="programlisting">
3917: int
3918: monitor_file(...)
3919: {
3920: #if defined(__NetBSD__)
3921: int fd = kqueue();
3922: ...
3923: #else
3924: ...
3925: #endif
3926: }
3927: </pre>
3928: </td>
3929: <td>
3930: <pre class="programlisting">
3931: int
3932: monitor_file(...)
3933: {
3934: #if defined(HAVE_KQUEUE)
3935: int fd = kqueue();
3936: ...
3937: #else
1.112 rillig 3938: ...
1.1 dsieger 3939: #endif
3940: }
3941: </pre>
3942: </td>
3943: </tr>
3944: </tbody>
3945: </table></div>
3946: </div>
1.141 maya 3947: <br class="table-break">
1.1 dsieger 3948: </div>
1.41 asau 3949: <div class="sect2">
1.1 dsieger 3950: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3951: <a name="components.patches.feedback"></a>13.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 3952: <p>Always, always, <span class="strong"><strong>always</strong></span>
3953: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3954: improvements you do to a package to the mainstream developers.
3955: This is the only way to get their attention on portability issues
3956: and to ensure that future versions can be built out-of-the box on
3957: NetBSD. Furthermore, any user that gets newer distfiles will get
3958: the fixes straight from the packaged code.</p>
3959: <p>This generally involves cleaning up the patches
3960: (because sometimes the patches that are
1.40 wiz 3961: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 3962: appropriate trackers for the projects and working with the
3963: mainstream authors to accept your changes. It is
3964: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3965: the packages in pkgsrc are kept simple and thus further changes
3966: can be done without much hassle.</p>
1.24 wiz 3967: <p>When you have done this, please add a URL to the upstream
3968: bug report to the patch comment.</p>
1.1 dsieger 3969: <p>Support the idea of free software!</p>
3970: </div>
3971: </div>
1.41 asau 3972: <div class="sect1">
1.1 dsieger 3973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3974: <a name="other-mandatory-files"></a>13.4. Other mandatory files</h2></div></div></div>
1.41 asau 3975: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3976: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3977: <dd><p>A multi-line description of the piece of software. This should include
3978: any credits where they are due. Please bear in mind that others do not
3979: share your sense of humour (or spelling idiosyncrasies), and that others
3980: will read everything that you write here.</p></dd>
3981: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3982: <dd><p>This file governs the files that are installed on your
3983: system: all the binaries, manual pages, etc. There are other
3984: directives which may be entered in this file, to control the
3985: creation and deletion of directories, and the location of
1.154 rillig 3986: 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 3987: information.</p></dd>
3988: </dl></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="components.optional"></a>13.5. Optional files</h2></div></div></div>
1.41 asau 3993: <div class="sect2">
1.1 dsieger 3994: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3995: <a name="components.optional.bin"></a>13.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 3996: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3997: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 3998: <dd>
1.167 leot 3999: <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 4000: First time after package extraction and before files are
4001: moved in place, the second time after the files to install
4002: are moved in place. This can be used to do any custom
4003: procedures not possible with @exec commands in
1.167 leot 4004: <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
4005: <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 4006: Please note that you can modify variables in it easily by using
4007: <code class="varname">FILES_SUBST</code> in the package's
4008: <code class="filename">Makefile</code>:</p>
4009: <pre class="programlisting">
4010: FILES_SUBST+= SOMEVAR="somevalue"
4011: </pre>
4012: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4013: <code class="filename">INSTALL</code>. By default, substitution is
4014: performed for <code class="varname">PREFIX</code>,
4015: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4016: <code class="varname">VARBASE</code>, and a few others, type
4017: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4018: complete list.</p>
4019: </dd>
1.1 dsieger 4020: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4021: <dd><p>This script is executed before and after any files are removed. It is
4022: this script's responsibility to clean up any additional messy details
4023: around the package's installation, since all pkg_delete knows is how to
4024: delete the files created in the original distribution.
1.167 leot 4025: 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>
4026: 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 4027: The same methods to replace variables can be used as for
4028: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 4029: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4030: <dd>
4031: <p>This file is displayed after installation of the package.
4032: Useful for things like legal notices on almost-free
4033: software and hints for updating config files after
4034: installing modules for apache, PHP etc.
4035: Please note that you can modify variables in it easily by using
4036: <code class="varname">MESSAGE_SUBST</code> in the package's
4037: <code class="filename">Makefile</code>:</p>
4038: <pre class="programlisting">
4039: MESSAGE_SUBST+= SOMEVAR="somevalue"
4040: </pre>
1.23 wiz 4041: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 4042: <code class="filename">MESSAGE</code>. By default, substitution is
4043: performed for <code class="varname">PKGNAME</code>,
4044: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99 sevan 4045: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 4046: <code class="varname">PKG_SYSCONFDIR</code>,
4047: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 4048: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 4049: <p>You can display a different or additional files by
4050: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4051: default is <code class="filename">MESSAGE</code>, if the file
4052: exists.</p>
4053: </dd>
4054: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 4055: <dd>
4056: <p>This file is used by the alternatives framework.
4057: It creates, configures, and destroys generic wrappers used to
4058: run programs with similar interfaces.
4059: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4060: for more information.</p>
4061: <p>Each line of the file contains two filenames, first
4062: the wrapper and then the alternative provided by the package.
4063: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4064: </dd>
1.1 dsieger 4065: </dl></div>
4066: </div>
1.41 asau 4067: <div class="sect2">
1.1 dsieger 4068: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4069: <a name="components.optional.build"></a>13.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 4070: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4071: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4072: <dd><p>This file contains arbitrary things that could
4073: also go into a <code class="filename">Makefile</code>, but its purpose is
4074: to be used by more than one package. This file should only be
4075: used when the packages that will use the file are known in
4076: advance. For other purposes it is often better to write a
4077: <code class="filename">*.mk</code> file and give it a good name that
4078: describes what it does.</p></dd>
4079: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4080: <dd><p>This file contains the dependency information
1.154 rillig 4081: 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 4082: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4083: <dd><p>This file contains workarounds for compiler bugs
4084: and similar things. It is included automatically by the pkgsrc
4085: infrastructure, so you don't need an extra
4086: <code class="literal">.include</code> line for
4087: it.</p></dd>
4088: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4089: <dd><p>This file contains the code for the
1.154 rillig 4090: 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 4091: selected by the user. If a package has only one or two options,
4092: it is equally acceptable to put the code directly into the
4093: <code class="filename">Makefile</code>.</p></dd>
4094: </dl></div>
4095: </div>
1.41 asau 4096: <div class="sect2">
1.1 dsieger 4097: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4098: <a name="components.optional.none"></a>13.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 4099: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4100: <dt><span class="term"><code class="filename">README*</code></span></dt>
4101: <dd><p>These files do not take place in the creation of
4102: a package and thus are purely informative to the package
4103: developer.</p></dd>
4104: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4105: <dd><p>This file contains things that need to be done
4106: to make the package even
4107: better.</p></dd>
4108: </dl></div>
4109: </div>
4110: </div>
1.41 asau 4111: <div class="sect1">
1.1 dsieger 4112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4113: <a name="work-dir"></a>13.6. <code class="filename">work*</code>
1.1 dsieger 4114: </h2></div></div></div>
1.10 hubertf 4115: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 4116: unpacked into the directory denoted by
4117: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 4118: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 4119: directory is also used to keep various timestamp files.
4120: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4121: The default is <code class="filename">${.CURDIR}/work</code>
4122: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4123: if <code class="varname">OBJMACHINE</code> is set.</p>
4124: </div>
1.41 asau 4125: <div class="sect1">
1.1 dsieger 4126: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4127: <a name="files-dir"></a>13.7. <code class="filename">files/*</code>
1.1 dsieger 4128: </h2></div></div></div>
4129: <p>If you have any files that you wish to be placed in the package prior
4130: to configuration or building, you could place these files here and use
1.10 hubertf 4131: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 4132: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 4133: this. Alternatively, you could simply diff the file against
4134: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4135: the creation of this file.</p>
4136: <p>If you want to share files in this way with other
4137: packages, set the <code class="varname">FILESDIR</code> variable to point
4138: to the other package's <code class="filename">files</code> directory,
4139: e.g.:</p>
4140: <pre class="programlisting">
1.159 rillig 4141: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 4142: </pre>
4143: </div>
4144: </div>
1.41 asau 4145: <div class="chapter">
1.1 dsieger 4146: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 4147: <a name="makefile"></a>Chapter 14. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4148: <div class="toc">
4149: <p><b>Table of Contents</b></p>
1.100 leot 4150: <dl class="toc">
1.154 rillig 4151: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
4152: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
4153: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
4154: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
4155: <dd><dl>
4156: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
4157: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
4158: <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>
4159: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 4160: </dl></dd>
4161: </dl>
4162: </div>
4163: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4164: each of which forms a well-defined part of the pkgsrc system. Using
1.167 leot 4165: 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 4166: like pkgsrc requires some discipline to keep the code correct and
4167: understandable.</p>
4168: <p>The basic ingredients for <code class="filename">Makefile</code>
1.154 rillig 4169: programming are variables and shell
1.1 dsieger 4170: commands. Among these shell commands may even be more complex ones
1.167 leot 4171: 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 4172: as intended it is necessary to quote all variables correctly when they
4173: are used.</p>
1.154 rillig 4174: <p>This chapter describes some patterns that appear quite often in
1.1 dsieger 4175: <code class="filename">Makefile</code>s, including the pitfalls that come along
4176: with them.</p>
1.41 asau 4177: <div class="sect1">
1.1 dsieger 4178: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4179: <a name="makefile.style"></a>14.1. Caveats</h2></div></div></div>
1.41 asau 4180: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4181: <p>When you are creating a file as a
4182: target of a rule, always write the data to a temporary file first
4183: and finally rename that file. Otherwise there might occur an error
4184: in the middle of generating the file, and when the user runs
1.167 leot 4185: <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 4186: regenerated properly. Example:</p>
4187: <pre class="programlisting">
4188: wrong:
4189: @echo "line 1" > ${.TARGET}
4190: @echo "line 2" >> ${.TARGET}
4191: @false
4192:
4193: correct:
4194: @echo "line 1" > ${.TARGET}.tmp
4195: @echo "line 2" >> ${.TARGET}.tmp
4196: @false
4197: @mv ${.TARGET}.tmp ${.TARGET}
4198: </pre>
1.10 hubertf 4199: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4200: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4201: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4202: correct</strong></span> gives an error message twice, as expected.</p>
1.167 leot 4203: <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 4204: <code class="literal">${.TARGET}</code> in case of error, but this only
4205: happens when it is interrupted, for example by pressing
1.154 rillig 4206: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.167 leot 4207: 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 4208: </li></ul></div>
4209: </div>
1.41 asau 4210: <div class="sect1">
1.1 dsieger 4211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4212: <a name="makefile.variables"></a>14.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4213: <p><code class="filename">Makefile</code> variables contain strings that
1.154 rillig 4214: can be processed using the five operators <code class="code">=</code>,
4215: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.167 leot 4216: <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 4217: page.</p>
4218: <p>When a variable's value is parsed from a
1.154 rillig 4219: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
4220: the backslash character <code class="code">\</code> are handled specially. If a
4221: backslash is the last character in a line, that backslash is removed
4222: from the line and the line continues with the next line of the file.</p>
4223: <p>The <code class="code">#</code> character starts a comment that reaches
4224: until the end of the line. To get an actual <code class="code">#</code> character,
4225: such as in a URL, write <code class="code">\#</code> instead.</p>
1.108 rillig 4226: <p>The evaluation of variables either happens immediately or lazy.
1.154 rillig 4227: It happens immediately when the variable occurs on the right-hand
4228: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
1.108 rillig 4229: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4230: In the other cases, it is evaluated lazily.</p>
1.1 dsieger 4231: <p>Some of the modifiers split the string into words and then
1.154 rillig 4232: operate on the words, others operate on the string as a whole. When a
4233: string is split into words, double quotes and single quotes are
1.167 leot 4234: 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 4235: <div class="sect2">
1.1 dsieger 4236: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4237: <a name="makefile.variables.names"></a>14.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4238: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4239: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4240: are reserved for use by the pkgsrc infrastructure. They shall
1.154 rillig 4241: not be used by packages.</p></li>
1.23 wiz 4242: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4243: lowercase variable names for the iteration
4244: variables.</p></li>
1.154 rillig 4245: <li class="listitem"><p>All list variables should have a plural name,
4246: such as <code class="varname">PKG_OPTIONS</code> or
1.1 dsieger 4247: <code class="varname">DISTFILES</code>.</p></li>
4248: </ul></div>
4249: </div>
4250: </div>
1.41 asau 4251: <div class="sect1">
1.1 dsieger 4252: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4253: <a name="makefile.code"></a>14.3. Code snippets</h2></div></div></div>
1.41 asau 4254: <div class="sect2">
1.1 dsieger 4255: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4256: <a name="adding-to-list"></a>14.3.1. Adding things to a list</h3></div></div></div>
1.108 rillig 4257: <p>When adding a string that possibly contains whitespace or quotes to
4258: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4259: modifier.</p>
4260: <p>When adding another list to a list (example 2), it must not be
4261: quoted, since its elements are already quoted.</p>
1.1 dsieger 4262: <pre class="programlisting">
1.108 rillig 4263: STRING= foo * bar `date`
4264: LIST= # empty
4265: ANOTHER_LIST= a=b c=d
4266:
4267: LIST+= ${STRING:Q} # 1
4268: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4269: </pre>
4270: </div>
1.41 asau 4271: <div class="sect2">
1.1 dsieger 4272: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4273: <a name="echo-literal"></a>14.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.108 rillig 4274: <p>Echoing a string containing special characters needs special
4275: work.</p>
1.1 dsieger 4276: <pre class="programlisting">
4277: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 4278: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4279:
4280: all:
4281: echo ${STRING} # 1
1.108 rillig 4282: echo ${STRING:Q} # 2
4283: printf '%s\n' ${STRING:Q}'' # 3
4284: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
4285: </pre>
4286: <p>Example 1 leads to a syntax error in the shell, as the characters
4287: are just copied.</p>
4288: <p>Example 2 quotes the string so that the shell interprets it
4289: correctly. But the echo command may additionally interpret strings with a
4290: leading dash or those containing backslashes.</p>
1.167 leot 4291: <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 4292: interprets the format string, but not the next argument. The trailing
4293: single quotes handle the case when the string is empty. In that case, the
4294: :Q modifier would result in an empty string too, which would then be
1.167 leot 4295: 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 4296: but other programs may care.</p>
1.108 rillig 4297: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4298: need to be quoted because the quoting has already been done
4299: when adding elements to the list.</p>
1.1 dsieger 4300: </div>
1.41 asau 4301: <div class="sect2">
1.1 dsieger 4302: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4303: <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 4304: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4305: GNU-style configure script (especially those that call other configure
4306: scripts), it must not have leading or trailing whitespace, since
4307: otherwise the configure script gets confused. To trim leading and
4308: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4309: following example:</p>
1.1 dsieger 4310: <pre class="programlisting">
4311: CPPFLAGS= # empty
1.108 rillig 4312: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.1 dsieger 4313: CPPFLAGS+= ${MY_CPPFLAGS}
4314:
4315: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4316:
4317: all:
4318: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.108 rillig 4319: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4320: </pre>
1.108 rillig 4321: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4322: trailing whitespace because the <code class="code">+=</code> operator always adds a
4323: space.</p>
4324: </div>
4325: <div class="sect2">
4326: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4327: <a name="empty-variables"></a>14.3.4. Handling possibly empty variables</h3></div></div></div>
1.108 rillig 4328: <p>When a possibly empty variable is used in a shell program, it may
4329: lead to a syntax error.</p>
4330: <pre class="programlisting">
4331: EGFILES= # empty
4332:
4333: install-examples: # produces a syntax error in the shell
4334: for egfile in ${EGFILES}; do \
4335: echo "Installing $$egfile"; \
4336: done
4337: </pre>
4338: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.167 leot 4339: <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 4340: To fix this syntax error, use one of the snippets below.</p>
4341: <pre class="programlisting">
4342: EMPTY= # empty
4343:
4344: install-examples:
4345: for egfile in ${EGFILES} ""; do \
4346: [ -n "$$egfile" ] || continue; \
4347: echo "Installing $$egfile"; \
1.1 dsieger 4348: done
1.108 rillig 4349: </pre>
4350: <p>In this case, an empty string is appended to the iteration list (to
4351: prevent the syntax error) and filtered out later.</p>
4352: <pre class="programlisting">
4353: EGFILES= # empty
1.1 dsieger 4354:
1.108 rillig 4355: install-examples:
4356: .for egfile in ${EGFILES}
4357: echo "Installing ${egfile}"
1.1 dsieger 4358: .endfor
4359: </pre>
1.154 rillig 4360: <p>If one of the filenames contains special characters, it should be
4361: enclosed in single or double quotes.</p>
1.108 rillig 4362: <p>To have a shell command test whether a make variable is empty, use
4363: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1 dsieger 4364: </div>
4365: </div>
4366: </div>
1.41 asau 4367: <div class="chapter">
1.1 dsieger 4368: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 4369: <a name="plist"></a>Chapter 15. PLIST issues</h2></div></div></div>
1.1 dsieger 4370: <div class="toc">
4371: <p><b>Table of Contents</b></p>
1.100 leot 4372: <dl class="toc">
1.154 rillig 4373: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
4374: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4375: <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>
4376: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
4377: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
4378: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
4379: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
4380: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
4381: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4382: </dl>
4383: </div>
4384: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4385: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4386: the package (relative to the <code class="filename">${PREFIX}</code>
4387: directory it's been installed in) plus some additional statements
1.167 leot 4388: - 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 4389: This chapter addresses some issues that need attention when
4390: dealing with the <code class="filename">PLIST</code> file (or files, see
4391: below!).</p>
1.41 asau 4392: <div class="sect1">
1.1 dsieger 4393: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4394: <a name="rcs-id"></a>15.1. RCS ID</h2></div></div></div>
1.1 dsieger 4395: <p>Be sure to add a RCS ID line as the first thing in any
4396: <code class="filename">PLIST</code> file you write:</p>
4397: <pre class="programlisting">
1.121 sevan 4398: @comment $NetBSD $
1.111 sevan 4399: </pre>
1.123 wiz 4400: <p>An artificial space has been added between NetBSD and $, this is a
1.121 sevan 4401: workaround here to prevent CVS expanding to the filename of the guide. When
1.125 leot 4402: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 4403: </div>
1.41 asau 4404: <div class="sect1">
1.1 dsieger 4405: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4406: <a name="automatic-plist-generation"></a>15.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4407: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4408: to output a PLIST that matches any new files since the package
1.154 rillig 4409: 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 4410: more information on this target.</p>
4411: </div>
1.41 asau 4412: <div class="sect1">
1.1 dsieger 4413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4414: <a name="print-PLIST"></a>15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4415: </h2></div></div></div>
4416: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4417: of AWK patterns and actions that are used to filter the output of
4418: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4419: scripting you like to it, but be careful with quoting.</p>
4420: <p>For example, to get all files inside the
4421: <code class="filename">libdata/foo</code> directory removed from the
4422: resulting PLIST:</p>
4423: <pre class="programlisting">
4424: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.111 sevan 4425: </pre>
1.1 dsieger 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="plist.misc"></a>15.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4430: <p>A number of variables are substituted automatically in
4431: PLISTs when a package is installed on a system. This includes the
4432: following variables:</p>
1.41 asau 4433: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4434: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4435: <dd>
4436: <p>Some packages like emacs and perl embed information
4437: about which architecture they were built on into the
4438: pathnames where they install their files. To handle this
4439: case, PLIST will be preprocessed before actually used, and
4440: the symbol
1.23 wiz 4441: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4442: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4443: same is done if the string
4444: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4445: PLIST somewhere - use this on packages that have GNU
4446: autoconf-created configure scripts.</p>
1.41 asau 4447: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4448: <h3 class="title">Legacy note</h3>
4449: <p>There used to be a symbol
1.23 wiz 4450: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4451: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4452: -m</strong></span>, but that's no longer supported and has
4453: been removed.</p>
4454: </div>
4455: </dd>
4456: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4457: <dd>
4458: <p>Some packages want to embed the OS name and version
4459: into some paths. To do this, use these variables in the
4460: <code class="filename">PLIST</code>:
4461: </p>
1.41 asau 4462: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4463: <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>
4464: <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>
4465: <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 4466: </ul></div>
4467: </dd>
4468: </dl></div>
1.88 tnn 4469: <p>For a list of values which are replaced by
4470: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4471: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4472: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4473: <p>If you want to change other variables not listed above, you
4474: can add variables and their expansions to this variable in the
1.154 rillig 4475: 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 4476: <pre class="programlisting">
4477: PLIST_SUBST+= SOMEVAR="somevalue"
1.111 sevan 4478: </pre>
1.23 wiz 4479: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4480: in the <code class="filename">PLIST</code> with
1.23 wiz 4481: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4482: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4483: the common case of conditionally including some
4484: <code class="filename">PLIST</code> entries. It can be done by adding
4485: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4486: setting the corresponding <code class="varname">PLIST.foo</code> variable
4487: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4488: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4489: in the <code class="filename">PLIST</code> with either
1.23 wiz 4490: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4491: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 4492: For example, in <code class="filename">Makefile</code>:</p>
4493: <pre class="programlisting">
1.112 rillig 4494: PLIST_VARS+= foo
1.18 snj 4495: .if <em class="replaceable"><code>condition</code></em>
1.112 rillig 4496: PLIST.foo= yes
1.18 snj 4497: .else
1.111 sevan 4498: </pre>
1.18 snj 4499: <p>And then in <code class="filename">PLIST</code>:</p>
4500: <pre class="programlisting">
1.121 sevan 4501: @comment $NetBSD $
1.18 snj 4502: bin/bar
4503: man/man1/bar.1
4504: ${PLIST.foo}bin/foo
4505: ${PLIST.foo}man/man1/foo.1
4506: ${PLIST.foo}share/bar/foo.data
1.111 sevan 4507: </pre>
1.123 wiz 4508: <p>An artificial space has been added between NetBSD and $, this is a
1.121 sevan 4509: workaround here to prevent CVS expanding to the filename of the guide. When
4510: adding the RCS ID the space should be ommited.</p>
1.1 dsieger 4511: </div>
1.41 asau 4512: <div class="sect1">
1.1 dsieger 4513: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4514: <a name="manpage-compression"></a>15.5. Man page compression</h2></div></div></div>
1.1 dsieger 4515: <p>Man pages should be installed in compressed form if
4516: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4517: and uncompressed otherwise. To handle this in the
1.23 wiz 4518: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 4519: appended/removed automatically for man pages according to
4520: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4521: or not, see above for details. This modification of the
4522: <code class="filename">PLIST</code> file is done on a copy of it, not
4523: <code class="filename">PLIST</code> itself.</p>
4524: </div>
1.41 asau 4525: <div class="sect1">
1.1 dsieger 4526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4527: <a name="using-PLIST_SRC"></a>15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 4528: </h2></div></div></div>
4529: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
4530: in generating the binary package, set the variable
4531: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.167 leot 4532: 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 4533: important. The default for <code class="varname">PLIST_SRC</code> is
4534: <code class="filename">${PKGDIR}/PLIST</code>.</p>
4535: </div>
1.41 asau 4536: <div class="sect1">
1.1 dsieger 4537: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4538: <a name="platform-specific-plist"></a>15.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 4539: <p>Some packages decide to install a different set of files based on
4540: the operating system being used. These differences can be
4541: automatically handled by using the following files:</p>
1.41 asau 4542: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4543: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4544: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4545: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4546: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4547: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 4548: </ul></div>
4549: </div>
1.41 asau 4550: <div class="sect1">
1.1 dsieger 4551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4552: <a name="build-plist"></a>15.8. Build-specific PLISTs</h2></div></div></div>
1.86 wiz 4553: <p>Some packages decide to generate hard-to-guess file names
4554: during installation that are hard to wire down.</p>
4555: <p>In such cases, you can set the
4556: <code class="varname">GENERATE_PLIST</code> variable to shell code
4557: terminated (with a semicolon) that will output PLIST entries which
4558: will be appended to the PLIST</p>
4559: <p>You can find one example in editors/xemacs:</p>
4560: <pre class="programlisting">
1.111 sevan 4561: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4562: </pre>
1.86 wiz 4563: <p>which will append something like
4564: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4565: <code class="filename">PLIST</code>.
4566: </p>
4567: </div>
4568: <div class="sect1">
4569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4570: <a name="faq.common-dirs"></a>15.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 4571: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 4572: multiple (and unrelated) packages install files. These
1.22 jakllsch 4573: directories were problematic because you had to add special
4574: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 4575: centralized package handle them.</p>
1.22 jakllsch 4576: <p>In pkgsrc, it is now easy: Each package should create
4577: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4578: will remove any directories left empty after uninstalling a
4579: package.</p>
4580: <p>If a package needs an empty directory to work, create
4581: the directory during installation as usual, and also add an
4582: entry to the PLIST:
1.111 sevan 4583:
4584: </p>
1.1 dsieger 4585: <pre class="programlisting">
1.22 jakllsch 4586: @pkgdir path/to/empty/directory
1.111 sevan 4587: </pre>
1.22 jakllsch 4588: <p>
1.111 sevan 4589:
1.86 wiz 4590: or take a look at <code class="varname">MAKE_DIRS</code> and
4591: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 4592: </p>
1.1 dsieger 4593: </div>
4594: </div>
1.41 asau 4595: <div class="chapter">
1.1 dsieger 4596: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 4597: <a name="buildlink"></a>Chapter 16. Buildlink methodology</h2></div></div></div>
1.1 dsieger 4598: <div class="toc">
4599: <p><b>Table of Contents</b></p>
1.100 leot 4600: <dl class="toc">
1.154 rillig 4601: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
4602: <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 4603: <dd><dl>
1.154 rillig 4604: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
4605: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26 wiz 4606: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4607: and
4608: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4609: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4610: </dl></dd>
1.154 rillig 4611: <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 4612: <dd><dl>
1.154 rillig 4613: <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>
4614: <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 4615: </dl></dd>
4616: </dl>
4617: </div>
4618: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
4619: are seen by a package's configure and build processes. This is implemented
4620: in a two step process:</p>
1.23 wiz 4621: <div class="orderedlist"><ol class="orderedlist" type="1">
4622: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 4623: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4624: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 4625: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 4626: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4627: <code class="option">-L${LOCALBASE}/lib</code> into references to
4628: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4629: native compiler on some operating systems look like GCC, so that
4630: packages that expect GCC won't require modifications to build with
4631: those native compilers.</p></li>
4632: </ol></div>
4633: <p>This normalizes the environment in which a package is built so that the
4634: package may be built consistently despite what other software may be
4635: installed. Please note that the normal system header and library paths,
4636: e.g. <code class="filename">/usr/include</code>,
4637: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4638: designed to insulate the package build from non-system-supplied
4639: software.</p>
1.41 asau 4640: <div class="sect1">
1.1 dsieger 4641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4642: <a name="converting-to-buildlink3"></a>16.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 4643: <p>The process of converting packages to use the buildlink3
1.23 wiz 4644: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 4645: The things to keep in mind are:</p>
1.23 wiz 4646: <div class="orderedlist"><ol class="orderedlist" type="1">
4647: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 4648: instead of the actual toolchain. Some packages are tricky,
4649: and the only way to know for sure is the check
4650: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4651: wrappers are being invoked.</p></li>
1.23 wiz 4652: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 4653: the package Makefile, e.g. Java VMs, standalone shells,
4654: etc., because the code to symlink files into
4655: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 4656: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 4657: </p></li>
1.23 wiz 4658: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 4659: <code class="filename">buildlink3.mk</code> files that you list in a
4660: package's Makefile are added as dependencies for that package.
4661: </p></li>
4662: </ol></div>
4663: <p>If a dependency on a particular package is required for its libraries and
4664: headers, then we replace:</p>
4665: <pre class="programlisting">
4666: DEPENDS+= foo>=1.1.0:../../category/foo
4667: </pre>
4668: <p>with</p>
4669: <pre class="programlisting">
4670: .include "../../category/foo/buildlink3.mk"
4671: </pre>
4672: <p>The buildlink3.mk files usually define the required dependencies.
4673: If you need a newer version of the dependency when using buildlink3.mk
4674: files, then you can define it in your Makefile; for example:</p>
4675: <pre class="programlisting">
4676: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4677: .include "../../category/foo/buildlink3.mk"
4678: </pre>
4679: <p>There are several <code class="filename">buildlink3.mk</code>
4680: files in <code class="filename">pkgsrc/mk</code>
4681: that handle special package issues:</p>
1.41 asau 4682: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4683: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 4684: the native or a pkgsrc Berkeley DB implementation based on
4685: the values of <code class="varname">BDB_ACCEPTED</code> and
4686: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 4687: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 4688: comes with neither Curses nor NCurses, this will take care
1.137 leot 4689: 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 4690: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 4691: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4692: adding a dependency on Heimdal or MIT-krb5 for packages that
4693: require a Kerberos 5 implementation.</p></li>
1.23 wiz 4694: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 4695: system-provided Motif installation or adds a dependency on
1.137 leot 4696: <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 4697: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.126 leot 4698: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
4699: to choose which Motif version will be used.</p></li>
1.55 ryoon 4700: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 4701: system-provided GNU readline or editline (libedit) installation,
1.137 leot 4702: 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>,
4703: <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 4704: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4705: If your package really needs GNU readline library, its Makefile
4706: should include <code class="filename">devel/readline/buildlink3.mk</code>
4707: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 4708: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 4709: variables that may be used by packages that use the
4710: Open Sound System (OSS) API.</p></li>
1.23 wiz 4711: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 4712: any of the Postgres versions in the variable
4713: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4714: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 4715: the file for more information.</p></li>
1.23 wiz 4716: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 4717: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.137 leot 4718: 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 4719: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 4720: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4721: library.</p></li>
4722: </ul></div>
4723: <p>The comments in those <code class="filename">buildlink3.mk</code>
4724: files provide a more complete
4725: description of how to use them properly.</p>
4726: </div>
1.41 asau 4727: <div class="sect1">
1.1 dsieger 4728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4729: <a name="creating-buildlink3.mk"></a>16.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 4730: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 4731: included by Makefiles to indicate the need to compile and link
4732: against header files and libraries provided by the package. A
4733: <code class="filename">buildlink3.mk</code> file should always provide
4734: enough information to add the correct type of dependency
4735: relationship and include any other
4736: <code class="filename">buildlink3.mk</code> files that it needs to find
4737: headers and libraries that it needs in turn.</p>
4738: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.137 leot 4739: 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 4740: package is highly recommended. For most packages, the following
4741: command will generate a good starting point for
4742: <code class="filename">buildlink3.mk</code> files:</p>
4743: <pre class="screen">
4744: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4745: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4746: </pre>
1.41 asau 4747: <div class="sect2">
1.1 dsieger 4748: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4749: <a name="anatomy-of-bl3"></a>16.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 4750: <p>The following real-life example
4751: <code class="filename">buildlink3.mk</code> is taken
4752: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
4753: <pre class="programlisting">
1.18 snj 4754: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 4755:
1.112 rillig 4756: BUILDLINK_TREE+= tiff
1.1 dsieger 4757:
1.18 snj 4758: .if !defined(TIFF_BUILDLINK3_MK)
4759: TIFF_BUILDLINK3_MK:=
1.1 dsieger 4760:
1.112 rillig 4761: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4762: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
4763: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 4764:
4765: .include "../../devel/zlib/buildlink3.mk"
4766: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 4767: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 4768:
1.112 rillig 4769: BUILDLINK_TREE+= -tiff
1.1 dsieger 4770: </pre>
4771: <p>The header and footer manipulate
1.18 snj 4772: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 4773: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 4774: the dependency tree.</p>
4775: <p>The main section is protected from multiple inclusion
1.1 dsieger 4776: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4777: added. Several important variables are set in the section:</p>
1.41 asau 4778: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4779: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4780: is the actual dependency recorded in the installed
4781: package; this should always be set using
1.10 hubertf 4782: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 4783: we're appending to any pre-existing list of values. This
4784: variable should be set to the first version of the
1.26 wiz 4785: package that had an backwards-incompatible API change.
1.1 dsieger 4786: </p></li>
1.23 wiz 4787: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4788: is the location of the <em class="replaceable"><code>pkg</code></em>
4789: pkgsrc directory.</p></li>
1.23 wiz 4790: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4791: (not shown above) controls whether we use
4792: <code class="varname">BUILD_DEPENDS</code> or
4793: <code class="varname">DEPENDS</code> to add the dependency on
4794: <em class="replaceable"><code>pkg</code></em>. The build dependency is
4795: selected by setting
4796: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4797: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 4798: used.</p></li>
1.23 wiz 4799: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4800: and
4801: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
4802: (not shown above) are lists of subdirectories of
4803: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4804: to add to the header and library search paths. These
1.23 wiz 4805: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 4806: respectively.</p></li>
1.23 wiz 4807: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4808: (not shown above) is the list of preprocessor flags to add
4809: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 4810: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 4811: should be avoided and instead be handled using
4812: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
4813: above.</p></li>
4814: </ul></div>
4815: <p>The following variables are all optionally defined within
4816: this second section (protected against multiple inclusion) and
4817: control which package files are symlinked into
4818: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
4819: transformed during the symlinking:</p>
1.41 asau 4820: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4821: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4822: (not shown above) is a shell glob pattern relative to
4823: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4824: to be symlinked into
4825: <code class="filename">${BUILDLINK_DIR}</code>,
4826: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 4827: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4828: (not shown above) is a shell pipeline that
4829: outputs to stdout a list of files relative to
4830: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
4831: The resulting files are to be symlinked
4832: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
4833: this takes the <code class="filename">+CONTENTS</code> of a
4834: <em class="replaceable"><code>pkg</code></em> and filters it through
4835: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 4836: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4837: (not shown above) is a filter command that filters
4838: <code class="filename">+CONTENTS</code> input into a list of files
4839: relative to
4840: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 4841: on stdout. By default,
1.1 dsieger 4842: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
4843: outputs the contents of the <code class="filename">include</code>
4844: and <code class="filename">lib</code> directories in the package
1.84 wiz 4845: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 4846: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4847: (not shown above) is a list of sed arguments used to
4848: transform the name of the source filename into a
1.10 hubertf 4849: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 4850: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
4851: </ul></div>
1.18 snj 4852: <p>This section can additionally include any
1.1 dsieger 4853: <code class="filename">buildlink3.mk</code> needed for
4854: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
4855: Including these <code class="filename">buildlink3.mk</code> files
4856: means that the headers and libraries for these
4857: dependencies are also symlinked into
4858: <code class="filename">${BUILDLINK_DIR}</code>
4859: whenever the <em class="replaceable"><code>pkg</code></em>
4860: <code class="filename">buildlink3.mk</code>
1.18 snj 4861: file is included. Dependencies are only added for directly
4862: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 4863: <p>When providing a <code class="filename">buildlink3.mk</code> and
4864: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 4865: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 4866: header files are automatically exposed when the package is
4867: use.</p>
4868: <p>In particular, if only an executable
4869: (<code class="filename">bin/foo</code>) is linked against a library, that
4870: library does not need to be propagated in the
4871: <code class="filename">buildlink3.mk</code> file.</p>
4872: <p>The following steps should help you decide if a
4873: <code class="filename">buildlink3.mk</code> file needs to be included:
4874: </p>
4875: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4876: <li class="listitem"><p>Look at the installed header files: What
4877: headers do they include? The packages providing these files
4878: must be buildlinked.</p></li>
1.49 wiz 4879: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
4880: libraries and look against what other libraries they link.
4881: Some of the packages providing these probably need to be
4882: buildlinked; however, it's not automatic, since e.g. GTK on
4883: some systems pulls in the X libraries, so they will show up in
4884: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 4885: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 4886: used as a hint.</p></li>
1.47 wiz 4887: </ul></div>
4888: <p>
4889: </p>
1.1 dsieger 4890: </div>
1.41 asau 4891: <div class="sect2">
1.1 dsieger 4892: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4893: <a name="updating-buildlink-depends"></a>16.2.2. Updating
1.1 dsieger 4894: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4895: and
4896: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4897: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
4898: <p>These two variables differ in that one describes source
4899: compatibility (API) and the other binary compatibility (ABI).
4900: The difference is that a change in the API breaks compilation of
4901: programs while changes in the ABI stop compiled programs from
4902: running.</p>
4903: <p>Changes to the
1.27 wiz 4904: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4905: variable in a <code class="filename">buildlink3.mk</code> file happen
4906: very rarely. One possible reason is that all packages depending
4907: on this already need a newer version. In case it is bumped see
4908: the description below.</p>
4909: <p>The most common example of an ABI change is that the major
4910: version of a shared library is increased. In this case,
4911: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4912: should be adjusted to require at least the new package version.
4913: Then the packages that depend on this package need their
4914: <code class="varname">PKGREVISION</code>s increased and, if they have
4915: <code class="filename">buildlink3.mk</code> files, their
4916: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4917: adjusted, too. This is needed so pkgsrc will require the correct
4918: package dependency and not settle for an older one when building
4919: the source.</p>
1.154 rillig 4920: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for
1.26 wiz 4921: more information about dependencies on other packages,
4922: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 4923: <code class="varname">ABI_DEPENDS</code> definitions.</p>
4924: <p>Please take careful consideration before adjusting
4925: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4926: or
4927: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4928: as we don't want to cause unneeded package deletions and
4929: rebuilds. In many cases, new versions of packages work just
4930: fine with older dependencies.</p>
4931: <p>Also it is not needed to set
1.26 wiz 4932: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4933: when it is identical to
1.1 dsieger 4934: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
4935: </div>
4936: </div>
1.41 asau 4937: <div class="sect1">
1.1 dsieger 4938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4939: <a name="writing-builtin.mk"></a>16.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 4940: <p>Some packages in pkgsrc install headers and libraries that
4941: coincide with headers and libraries present in the base system.
4942: Aside from a <code class="filename">buildlink3.mk</code> file, these
4943: packages should also include a <code class="filename">builtin.mk</code>
4944: file that includes the necessary checks to decide whether using
4945: the built-in software or the pkgsrc software is
4946: appropriate.</p>
4947: <p>The only requirements of a builtin.mk file for
4948: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 4949: <div class="orderedlist"><ol class="orderedlist" type="1">
4950: <li class="listitem"><p>It should set
1.1 dsieger 4951: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4952: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 4953: after it is included.</p></li>
1.23 wiz 4954: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 4955: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4956: which is already set before the
4957: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 4958: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 4959: is <span class="emphasis"><em>very</em></span> important and takes careful
4960: attention to <code class="filename">Makefile</code> coding.</p></li>
4961: </ol></div>
1.41 asau 4962: <div class="sect2">
1.1 dsieger 4963: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4964: <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 4965: <p>The following is the recommended template for builtin.mk
4966: files:</p>
4967: <pre class="programlisting">
4968: .if !defined(IS_BUILTIN.foo)
4969: #
4970: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4971: # genuinely exists in the system or not.
4972: #
4973: IS_BUILTIN.foo?= no
4974:
4975: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4976: # version can be determined.
4977: #
4978: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4979: BUILTIN_PKG.foo?= foo-1.0
4980: . endif
4981: .endif # IS_BUILTIN.foo
4982:
4983: .if !defined(USE_BUILTIN.foo)
4984: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4985: . if defined(BUILTIN_PKG.foo)
4986: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4987: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4988: USE_BUILTIN.foo!= \
4989: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4990: && ${ECHO} "yes" || ${ECHO} "no"
4991: . endif
4992: . endfor
4993: . endif
4994: .endif # USE_BUILTIN.foo
4995:
4996: CHECK_BUILTIN.foo?= no
4997: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4998: #
4999: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5000: # "yes" or "no".
5001: #
5002: .endif # CHECK_BUILTIN.foo
5003: </pre>
5004: <p>The first section sets
5005: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5006: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5007: in the base system. This should not be a base system software
5008: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 5009: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 5010: included as part of the base system. This variable is only
5011: used internally within the <code class="filename">builtin.mk</code>
5012: file.</p>
5013: <p>The second section sets
5014: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5015: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5016: system if it exists (if
5017: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5018: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 5019: within the <code class="filename">builtin.mk</code> file.</p>
5020: <p>The third section sets
5021: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5022: and is <span class="emphasis"><em>required</em></span> in all
5023: <code class="filename">builtin.mk</code> files. The code in this
5024: section must make the determination whether the built-in
5025: software is adequate to satisfy the dependencies listed in
5026: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5027: This is typically done by comparing
5028: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5029: against each of the dependencies in
5030: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5031: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5032: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5033: end of the <code class="filename">builtin.mk</code> file. Note that
5034: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5035: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 5036: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5037: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 5038: that the built-in version of the software is similar enough to
5039: be used as a replacement.</p>
5040: <p>The last section is guarded by
5041: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5042: and includes code that uses the value of
5043: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5044: set in the previous section. This typically includes, e.g.,
5045: adding additional dependency restrictions and listing additional
5046: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5047: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5048: </div>
1.41 asau 5049: <div class="sect2">
1.1 dsieger 5050: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5051: <a name="native-or-pkgsrc-preference"></a>16.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5052: <p>When building packages, it's possible to choose whether to set
5053: a global preference for using either the built-in (native)
5054: version or the pkgsrc version of software to satisfy a
5055: dependency. This is controlled by setting
5056: <code class="varname">PREFER_PKGSRC</code> and
5057: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 5058: 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 5059: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5060: use the pkgsrc versions of software, while
5061: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5062: built-in versions. Preferences are determined by the most
5063: specific instance of the package in either
5064: <code class="varname">PREFER_PKGSRC</code> or
5065: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5066: in neither or in both variables, then
5067: <code class="varname">PREFER_PKGSRC</code> has precedence over
5068: <code class="varname">PREFER_NATIVE</code>. For example, to require
5069: using pkgsrc versions of software for all but the most basic
5070: bits on a NetBSD system, you can set:</p>
5071: <pre class="programlisting">
5072: PREFER_PKGSRC= yes
5073: PREFER_NATIVE= getopt skey tcp_wrappers
5074: </pre>
5075: <p>A package <span class="emphasis"><em>must</em></span> have a
5076: <code class="filename">builtin.mk</code>
5077: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5078: otherwise it is simply ignored in that list.</p>
1.117 sevan 5079: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
5080: straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
5081: bootstrap.
5082: Switching between settings globally at a later date can introduce
5083: complications with dependency resolution. This is caused by packages
5084: built with the opposite preference being installed alongside each other.</p>
5085: <pre class="screen">
5086: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
5087: </pre>
1.1 dsieger 5088: </div>
5089: </div>
5090: </div>
1.41 asau 5091: <div class="chapter">
1.1 dsieger 5092: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 5093: <a name="pkginstall"></a>Chapter 17. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5094: <div class="toc">
5095: <p><b>Table of Contents</b></p>
1.100 leot 5096: <dl class="toc">
1.154 rillig 5097: <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 5098: <dd><dl>
1.154 rillig 5099: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
5100: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
1.1 dsieger 5101: </dl></dd>
1.154 rillig 5102: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
1.1 dsieger 5103: <dd><dl>
1.154 rillig 5104: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5105: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
5106: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
5107: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
5108: </dl></dd>
5109: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
5110: <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>
5111: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
5112: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
5113: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
5114: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
5115: <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 5116: </dl>
5117: </div>
5118: <p>This chapter describes the framework known as
5119: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5120: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5121: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5122: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5123: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5124: provided that packages are correctly designed.</p></li>
1.23 wiz 5125: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5126: <li class="listitem"><p>Registration of system users and groups.</p></li>
5127: <li class="listitem"><p>Registration of system shells.</p></li>
5128: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5129: </ul></div>
5130: <p>The following sections inspect each of the above points in detail.</p>
5131: <p>You may be thinking that many of the things described here could be
5132: easily done with simple code in the package's post-installation target
5133: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5134: as the code in them is only executed when building from source. Machines
5135: using binary packages could not benefit from it at all (as the code itself
5136: could be unavailable). Therefore, the only way to achieve any of the items
5137: described above is by means of the installation scripts, which are
5138: automatically generated by pkginstall.</p>
1.41 asau 5139: <div class="sect1">
1.1 dsieger 5140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5141: <a name="files-and-dirs-outside-prefix"></a>17.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5142: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5143: of files and directories that belong to a package. The names used in it
5144: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5145: which means that it cannot register files outside this directory (absolute
5146: path names are not allowed). Despite this restriction, some packages need
5147: to install files outside this location; e.g., under
5148: <code class="filename">${VARBASE}</code> or
5149: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5150: is to create such files during installation time by using
5151: installation scripts.</p>
5152: <p>The generic installation scripts are shell scripts that can
5153: contain arbitrary code. The list of scripts to execute is taken from
5154: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5155: <code class="filename">INSTALL</code>. A similar variable exists for package
5156: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5157: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5158: commands, so they have the potential to create and manage files
5159: anywhere in the file system.</p>
5160: <p>Using these general installation files is not recommended, but
5161: may be needed in some special cases. One reason for avoiding them is
5162: that the user has to trust the packager that there is no unwanted or
5163: simply erroneous code included in the installation script. Also,
5164: previously there were many similar scripts for the same functionality,
5165: and fixing a common error involved finding and changing all of
5166: them.</p>
5167: <p>The pkginstall framework offers another, standardized way. It
5168: provides generic scripts to abstract the manipulation of such files
5169: and directories based on variables set in the package's
5170: <code class="filename">Makefile</code>. The rest of this section describes
5171: these variables.</p>
1.41 asau 5172: <div class="sect2">
1.1 dsieger 5173: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5174: <a name="dirs-outside-prefix"></a>17.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5175: <p>The following variables can be set to request the creation of
5176: directories anywhere in the file system:</p>
1.41 asau 5177: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108 rillig 5178: <li class="listitem">
5179: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5180: contain a list of directories that should be created and should attempt
5181: to be destroyed by the installation scripts. The difference between
5182: the two is that the latter prompts the administrator to remove any
5183: directories that may be left after deinstallation (because they were
1.108 rillig 5184: not empty), while the former does not. Example:</p>
5185: <pre class="programlisting">
5186: MAKE_DIRS+= ${VARBASE}/foo/private
5187: </pre>
5188: </li>
1.23 wiz 5189: <li class="listitem">
1.1 dsieger 5190: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5191: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5192: which directories should be created and should attempt to be destroyed
5193: by the installation scripts. Each tuple holds the following values,
5194: separated by spaces: the directory name, its owner, its group and its
5195: numerical mode. For example:</p>
5196: <pre class="programlisting">
1.108 rillig 5197: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5198: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5199: </pre>
5200: <p>The difference between the two is exactly the same as their
5201: non-<code class="varname">PERMS</code> counterparts.</p>
5202: </li>
5203: </ul></div>
5204: </div>
1.41 asau 5205: <div class="sect2">
1.1 dsieger 5206: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5207: <a name="files-outside-prefix"></a>17.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5208: <p>Creating non-empty files outside the installation prefix is tricky
5209: because the <code class="filename">PLIST</code> forces all files to be inside it.
5210: To overcome this problem, the only solution is to extract the file in the
5211: known place (i.e., inside the installation prefix) and copy it to the
5212: appropriate location during installation (done by the installation scripts
5213: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5214: file</em></span> in the following paragraphs, which describe the variables
5215: that can be used to automatically and consistently handle files outside the
5216: installation prefix:</p>
1.41 asau 5217: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5218: <li class="listitem">
1.1 dsieger 5219: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5220: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5221: During installation time, the master file is copied to the target one
5222: if and only if the latter does not exist. Upon deinstallation, the
5223: target file is removed provided that it was not modified by the
5224: installation.</p>
5225: <p>The difference between the two is that the latter prompts the
5226: administrator to remove any files that may be left after
5227: deinstallation (because they were not empty), while the former does
5228: not.</p>
5229: </li>
1.23 wiz 5230: <li class="listitem">
1.1 dsieger 5231: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5232: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5233: files as well as their target locations. For each of them, it also
5234: specifies their owner, their group and their numeric permissions, in
5235: this order. For example:</p>
5236: <pre class="programlisting">
1.108 rillig 5237: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5238: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5239: </pre>
5240: <p>The difference between the two is exactly the same as their
5241: non-<code class="varname">PERMS</code> counterparts.</p>
5242: </li>
5243: </ul></div>
5244: </div>
5245: </div>
1.41 asau 5246: <div class="sect1">
1.1 dsieger 5247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5248: <a name="conf-files"></a>17.2. Configuration files</h2></div></div></div>
1.1 dsieger 5249: <p>Configuration files are special in the sense that they are installed
5250: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5251: need special treatment during installation (most of which is automated by
5252: pkginstall). The main concept you must bear in mind is that files marked
5253: as configuration files are automatically copied to the right place (somewhere
5254: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5255: and only if</em></span> they didn't exist before. Similarly, they will not
5256: be removed if they have local modifications. This ensures that
5257: administrators never lose any custom changes they may have made.</p>
1.41 asau 5258: <div class="sect2">
1.1 dsieger 5259: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5260: <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 5261: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5262: specifies where configuration files shall be installed. Its contents are
5263: set based upon the following variables:</p>
1.41 asau 5264: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5265: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5266: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5267: be overridden by the user to point to his preferred location (e.g.,
5268: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5269: Packages must not use it directly.</p></li>
1.23 wiz 5270: <li class="listitem">
1.1 dsieger 5271: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5272: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5273: for the package being built shall be installed. The definition of this
5274: variable only makes sense in the package's
5275: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5276: <p>As an example, consider the Apache package,
1.137 leot 5277: <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 5278: configuration files under the
5279: <code class="filename">httpd/</code> subdirectory of
5280: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5281: Makefile.</p>
5282: </li>
1.23 wiz 5283: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5284: variable that holds this package's configuration directory (if
5285: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5286: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5287: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5288: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5289: directory where the configuration files for the package identified by
5290: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5291: </ul></div>
5292: <p>Based on the above variables, pkginstall determines the value of
5293: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5294: variable that can be used within a package to refer to its configuration
5295: directory. The algorithm used to set its value is basically the
5296: following:</p>
1.23 wiz 5297: <div class="orderedlist"><ol class="orderedlist" type="1">
5298: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5299: its value is used.</p></li>
1.23 wiz 5300: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5301: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5302: <code class="filename">Makefile</code>, the resulting value is
5303: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5304: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5305: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5306: </ol></div>
5307: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.154 rillig 5308: 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 5309: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5310: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5311: </div>
1.41 asau 5312: <div class="sect2">
1.1 dsieger 5313: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5314: <a name="conf-files-configure"></a>17.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5315: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5316: known place, you need to teach each package where it shall install its
5317: files. In some cases you will have to patch the package Makefiles to
5318: achieve it. If you are lucky, though, it may be as easy as passing an
5319: extra flag to the configuration script; this is the case of GNU Autoconf-
5320: generated files:</p>
5321: <pre class="programlisting">
5322: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5323: </pre>
5324: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5325: for</em></span> its configuration files, not where they will be originally
5326: installed (although the difference is never explicit,
5327: unfortunately).</p>
5328: </div>
1.41 asau 5329: <div class="sect2">
1.1 dsieger 5330: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5331: <a name="conf-files-patching"></a>17.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5332: <p>As said before, pkginstall automatically handles configuration files.
5333: This means that <span class="strong"><strong>the packages themselves must not
5334: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5335: directly</strong></span>. Bad news is that many software installation scripts
5336: will, out of the box, mess with the contents of that directory. So what is
5337: the correct procedure to fix this issue?</p>
5338: <p>You must teach the package (usually by manually patching it) to
5339: install any configuration files under the examples hierarchy,
5340: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5341: <code class="filename">PLIST</code> registers them and the administrator always
5342: has the original copies available.</p>
5343: <p>Once the required configuration files are in place (i.e., under the
5344: examples hierarchy), the pkginstall framework can use them as master copies
5345: during the package installation to update what is in
5346: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5347: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.154 rillig 5348: 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 5349: about their syntax and their purpose. Here is an example, taken from the
1.137 leot 5350: <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 5351: <pre class="programlisting">
5352: EGDIR= ${PREFIX}/share/doc/mutt/samples
5353: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5354: </pre>
5355: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5356: package and has no meaning outside it.</p>
5357: </div>
1.41 asau 5358: <div class="sect2">
1.1 dsieger 5359: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5360: <a name="conf-files-disable"></a>17.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5361: <p>The automatic copying of config files can be toggled by setting the
5362: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5363: installation.</p>
5364: </div>
5365: </div>
1.41 asau 5366: <div class="sect1">
1.1 dsieger 5367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5368: <a name="rcd-scripts"></a>17.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5369: <p>System startup scripts are special files because they must be
5370: installed in a place known by the underlying OS, usually outside the
1.154 rillig 5371: 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 5372: can be used. However, pkginstall provides a special mechanism to handle
5373: these files.</p>
5374: <p>In order to provide system startup scripts, the package has
5375: to:</p>
1.23 wiz 5376: <div class="orderedlist"><ol class="orderedlist" type="1">
5377: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5378: the <code class="literal">.sh</code> suffix appended. Considering the
1.137 leot 5379: <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 5380: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5381: <li class="listitem">
1.1 dsieger 5382: <p>Tell pkginstall to handle it, appending the name of the script,
5383: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5384: Continuing the previous example:</p>
5385: <pre class="programlisting">
5386: RCD_SCRIPTS+= cupsd
5387: </pre>
5388: </li>
5389: </ol></div>
5390: <p>Once this is done, pkginstall will do the following steps for each
5391: script in an automated fashion:</p>
1.23 wiz 5392: <div class="orderedlist"><ol class="orderedlist" type="1">
5393: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5394: substitutions described in the <code class="filename">FILES_SUBST</code>
5395: variable.</p></li>
1.23 wiz 5396: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5397: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5398: that this master file must be explicitly registered in the
5399: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5400: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5401: from the examples hierarchy into the system-wide startup scripts
5402: directory.</p></li>
5403: </ol></div>
1.41 asau 5404: <div class="sect2">
1.1 dsieger 5405: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5406: <a name="rcd-scripts-disable"></a>17.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5407: <p>The automatic copying of config files can be toggled by setting the
5408: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5409: installation. Note that the scripts will be always copied inside the
5410: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5411: matter what the value of this variable is.</p>
5412: </div>
5413: </div>
1.41 asau 5414: <div class="sect1">
1.1 dsieger 5415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5416: <a name="users-and-groups"></a>17.4. System users and groups</h2></div></div></div>
1.1 dsieger 5417: <p>If a package needs to create special users and/or groups during
5418: installation, it can do so by using the pkginstall framework.</p>
5419: <p>Users can be created by adding entries to the
5420: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5421: syntax:</p>
5422: <pre class="programlisting">
5423: user:group
5424: </pre>
5425: <p>Further specification of user details may be done by setting
5426: per-user variables.
5427: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5428: numeric UID for the user.
5429: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5430: user's description or comment.
5431: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5432: user's home directory, and defaults to
5433: <code class="filename">/nonexistent</code> if not specified.
5434: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5435: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5436: not specified.</p>
5437: <p>Similarly, groups can be created by adding entries to the
5438: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5439: <pre class="programlisting">
5440: group
5441: </pre>
5442: <p>The numeric GID of the group may be set by defining
5443: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5444: <p>If a package needs to create the users and groups at an earlier
1.116 wiz 5445: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
5446: <code class="literal">configure</code>,<code class="literal">build</code>, or
5447: <code class="literal">pre-install</code> to indicate the phase before which the
5448: users and groups are created. In this case, the numeric UIDs and GIDs
5449: of the created users and groups are automatically hardcoded into the
5450: final installation scripts.</p>
1.1 dsieger 5451: </div>
1.41 asau 5452: <div class="sect1">
1.1 dsieger 5453: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5454: <a name="shells"></a>17.5. System shells</h2></div></div></div>
1.1 dsieger 5455: <p>Packages that install system shells should register them in the shell
5456: database, <code class="filename">/etc/shells</code>, to make things easier to the
5457: administrator. This must be done from the installation scripts to keep
5458: binary packages working on any system. pkginstall provides an easy way to
5459: accomplish this task.</p>
5460: <p>When a package provides a shell interpreter, it has to set the
5461: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5462: add some hooks to the installation scripts to handle it. Consider the
1.137 leot 5463: 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 5464: <pre class="programlisting">
5465: PKG_SHELL= ${PREFIX}/bin/zsh
5466: </pre>
1.41 asau 5467: <div class="sect2">
1.1 dsieger 5468: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5469: <a name="shells-disable"></a>17.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5470: <p>The automatic registration of shell interpreters can be disabled by
5471: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5472: environment variable to <code class="literal">NO</code>.</p>
5473: </div>
5474: </div>
1.41 asau 5475: <div class="sect1">
1.1 dsieger 5476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5477: <a name="fonts"></a>17.6. Fonts</h2></div></div></div>
1.1 dsieger 5478: <p>Packages that install X11 fonts should update the database files
5479: that index the fonts within each fonts directory. This can easily be
5480: accomplished within the pkginstall framework.</p>
5481: <p>When a package installs X11 fonts, it must list the directories in
5482: which fonts are installed in the
5483: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5484: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5485: <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 5486: installation scripts to run the appropriate commands to update the fonts
5487: database files within each of those directories. For convenience, if the
5488: directory path is relative, it is taken to be relative to the package's
1.137 leot 5489: 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 5490: <pre class="programlisting">
1.67 wiz 5491: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5492: </pre>
1.41 asau 5493: <div class="sect2">
1.1 dsieger 5494: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5495: <a name="fonts-disable"></a>17.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5496: <p>The automatic update of fonts databases can be disabled by
5497: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5498: environment variable to <code class="literal">NO</code>.</p>
5499: </div>
5500: </div>
5501: </div>
1.41 asau 5502: <div class="chapter">
1.1 dsieger 5503: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 5504: <a name="options"></a>Chapter 18. Options handling</h2></div></div></div>
1.1 dsieger 5505: <div class="toc">
5506: <p><b>Table of Contents</b></p>
1.100 leot 5507: <dl class="toc">
1.154 rillig 5508: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
5509: <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>
5510: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
5511: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5512: </dl>
5513: </div>
5514: <p>Many packages have the ability to be built to support different
5515: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5516: in pkgsrc that provides generic handling of those options that
5517: determine different ways in which the packages can be built. It's
5518: possible for the user to specify exactly which sets of options will be
5519: built into a package or to allow a set of global default options
5520: apply.</p>
1.7 rillig 5521: <p>There are two broad classes of behaviors that one might want to
5522: control via options. One is whether some particular feature is
5523: enabled in a program that will be built anyway, often by including or
5524: not including a dependency on some other package. The other is
5525: whether or not an additional program will be built as part of the
5526: package. Generally, it is better to make a split package for such
5527: additional programs instead of using options, because it enables
5528: binary packages to be built which can then be added separately. For
5529: example, the foo package might have minimal dependencies (those
5530: packages without which foo doesn't make sense), and then the foo-gfoo
5531: package might include the GTK frontend program gfoo. This is better
5532: than including a gtk option to foo that adds gfoo, because either that
5533: option is default, in which case binary users can't get foo without
5534: gfoo, or not default, in which case they can't get gfoo. With split
5535: packages, they can install foo without having GTK, and later decide to
5536: install gfoo (pulling in GTK at that time). This is an advantage to
5537: source users too, avoiding the need for rebuilds.</p>
5538: <p>Plugins with widely varying dependencies should usually be split
5539: instead of options.</p>
5540: <p>It is often more work to maintain split packages, especially if
5541: the upstream package does not support this. The decision of split
5542: vs. option should be made based on the likelihood that users will want
5543: or object to the various pieces, the size of the dependencies that are
5544: included, and the amount of work.</p>
5545: <p>A further consideration is licensing. Non-free parts, or parts
5546: that depend on non-free dependencies (especially plugins) should
5547: almost always be split if feasible.</p>
1.41 asau 5548: <div class="sect1">
1.1 dsieger 5549: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5550: <a name="global-default-options"></a>18.1. Global default options</h2></div></div></div>
1.1 dsieger 5551: <p>Global default options are listed in
5552: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5553: that should be built into every package if that option is supported.
1.10 hubertf 5554: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5555: </div>
1.41 asau 5556: <div class="sect1">
1.1 dsieger 5557: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5558: <a name="converting-to-options"></a>18.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 5559: </h2></div></div></div>
5560: <p>The following example shows how
5561: <code class="filename">bsd.options.mk</code> should be used
5562: by the hypothetical ``wibble'' package, either in the package
5563: <code class="filename">Makefile</code>, or in a file,
5564: e.g. <code class="filename">options.mk</code>, that is included by the
5565: main package <code class="filename">Makefile</code>.</p>
5566: <pre class="programlisting">
5567: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5568: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5569: PKG_OPTIONS_OPTIONAL_GROUPS= database
5570: PKG_OPTIONS_GROUP.database= mysql pgsql
5571: PKG_SUGGESTED_OPTIONS= wibble-foo
5572: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5573: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5574:
5575: .include "../../mk/bsd.prefs.mk"
5576:
5577: # this package was previously named wibble2
5578: .if defined(PKG_OPTIONS.wibble2)
5579: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5580: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5581: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5582: .endif
5583:
5584: .include "../../mk/bsd.options.mk"
5585:
5586: # Package-specific option-handling
5587:
5588: ###
5589: ### FOO support
5590: ###
5591: .if !empty(PKG_OPTIONS:Mwibble-foo)
5592: CONFIGURE_ARGS+= --enable-foo
5593: .endif
5594:
5595: ###
5596: ### LDAP support
5597: ###
5598: .if !empty(PKG_OPTIONS:Mldap)
5599: . include "../../databases/openldap-client/buildlink3.mk"
5600: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5601: .endif
5602:
5603: ###
5604: ### database support
5605: ###
5606: .if !empty(PKG_OPTIONS:Mmysql)
5607: . include "../../mk/mysql.buildlink3.mk"
5608: .endif
5609: .if !empty(PKG_OPTIONS:Mpgsql)
5610: . include "../../mk/pgsql.buildlink3.mk"
5611: .endif
5612: </pre>
5613: <p>The first section contains the information about which build
5614: options are supported by the package, and any default options settings
5615: if needed.</p>
1.23 wiz 5616: <div class="orderedlist"><ol class="orderedlist" type="1">
5617: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.167 leot 5618: <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 5619: options. It should be set to
5620: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5621: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5622: at the point where the options are processed.</p></li>
1.23 wiz 5623: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 5624: build options supported by the package.</p></li>
1.23 wiz 5625: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 5626: list of names of groups of mutually exclusive options. The options in
5627: each group are listed in
5628: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5629: The most specific setting of any option from the group takes
5630: precedence over all other options in the group. Options from the
5631: groups will be automatically added to
5632: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 5633: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 5634: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5635: packages will fail if no option from the group is
5636: selected.</p></li>
1.23 wiz 5637: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 5638: of names of sets of options. At least one option from each set must
5639: be selected. The options in each set are listed in
5640: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5641: Options from the sets will be automatically added to
5642: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5643: fail if no option from the set is selected.</p></li>
1.23 wiz 5644: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 5645: build options which are enabled by default.</p></li>
1.23 wiz 5646: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 5647: of
1.23 wiz 5648: <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 5649: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 5650: their option counterparts. Pairs should be added with
1.23 wiz 5651: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 5652: warning will be issued if the user uses a legacy
5653: variable.</p></li>
1.23 wiz 5654: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 5655: of
1.23 wiz 5656: <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 5657: pairs that map options that have been renamed to their new
1.23 wiz 5658: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 5659: the listing of global legacy options. A warning will be issued if
5660: the user uses a legacy option.</p></li>
1.23 wiz 5661: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 5662: options implied by deprecated variables used. This can be used for
5663: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5664: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5665: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 5666: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 5667: a list of warnings about deprecated variables or options used, and
5668: what to use instead.</p></li>
5669: </ol></div>
5670: <p>A package should never modify
5671: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5672: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5673: To suggest a default set of options, use
5674: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5675: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5676: including <code class="filename">bsd.options.mk</code>. If none of
5677: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5678: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5679: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5680: happen with platform-specific options if none of them is supported on
5681: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5682: empty list and the package is otherwise treated as not using the
5683: options framework.</p>
5684: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5685: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5686: build options, properly filtered to remove unsupported and duplicate
5687: options.</p>
5688: <p>The remaining sections contain the logic that is specific to
5689: each option. The correct way to check for an option is to check
5690: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5691: <pre class="programlisting">
5692: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
5693: </pre>
5694: </div>
1.41 asau 5695: <div class="sect1">
1.1 dsieger 5696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5697: <a name="option-names"></a>18.3. Option Names</h2></div></div></div>
1.1 dsieger 5698: <p>Options that enable similar features in different packages (like
5699: optional support for a library) should use a common name in all
5700: packages that support it (like the name of the library). If another
5701: package already has an option with the same meaning, use the same
5702: name.</p>
5703: <p>Options that enable features specific to one package, where it's
5704: unlikely that another (unrelated) package has the same (or a similar)
5705: optional feature, should use a name prefixed with
5706: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5707: <p>If a group of related packages share an optional feature
5708: specific to that group, prefix it with the name of the
1.23 wiz 5709: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 5710: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5711: <p>For new options, add a line to
5712: <code class="filename">mk/defaults/options.description</code>. Lines have two
5713: fields, separated by tab. The first field is the option name, the
5714: second its description. The description should be a whole sentence
5715: (starting with an uppercase letter and ending with a period) that
1.23 wiz 5716: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5717: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 5718: </div>
1.41 asau 5719: <div class="sect1">
1.7 rillig 5720: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5721: <a name="option-build"></a>18.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 5722: <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 5723: different dependencies based on the options with which the package was
5724: built. For querying these options, the file
5725: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5726: typical example looks like this:</p>
5727: <pre class="programlisting">
5728: pkgbase := libpurple
5729: .include "../../mk/pkg-build-options.mk"
5730:
5731: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5732: ...
5733: .endif
5734: </pre>
5735: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5736: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5737: options of the libpurple package, which can then be queried like
5738: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5739: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5740: details.</p>
5741: </div>
1.1 dsieger 5742: </div>
1.41 asau 5743: <div class="chapter">
1.1 dsieger 5744: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 5745: <a name="build"></a>Chapter 19. The build process</h2></div></div></div>
1.1 dsieger 5746: <div class="toc">
5747: <p><b>Table of Contents</b></p>
1.100 leot 5748: <dl class="toc">
1.154 rillig 5749: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
5750: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
5751: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
5752: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
5753: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
5754: <dd><dl>
5755: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
5756: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
5757: </dl></dd>
5758: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5759: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5760: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5761: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5762: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5763: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5764: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5765: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5766: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5767: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
5768: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
5769: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
1.1 dsieger 5770: </dl>
5771: </div>
1.41 asau 5772: <div class="sect1">
1.1 dsieger 5773: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5774: <a name="build.intro"></a>19.1. Introduction</h2></div></div></div>
1.1 dsieger 5775: <p>This chapter gives a detailed description on how a package is
5776: built. Building a package is separated into different
5777: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5778: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 5779: described in the following sections. Each phase is split into
1.1 dsieger 5780: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
5781: containing phase, prefixed by one of <code class="varname">pre-</code>,
5782: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
5783: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
5784: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
5785: <p>Never override the regular targets (like
5786: <code class="varname">fetch</code>), if you have to, override the
5787: <code class="varname">do-*</code> ones instead.</p>
5788: <p>The basic steps for building a program are always the same. First
5789: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
5790: the local system and then extracted. After any pkgsrc-specific patches
5791: to compile properly are applied, the software can be configured, then
5792: built (usually by compiling), and finally the generated binaries, etc.
5793: can be put into place on the system.</p>
5794: <p>To get more details about what is happening at each step,
5795: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
5796: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
5797: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
5798: </div>
1.41 asau 5799: <div class="sect1">
1.1 dsieger 5800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5801: <a name="build.prefix"></a>19.2. Program location</h2></div></div></div>
1.1 dsieger 5802: <p>Before outlining the process performed by the NetBSD package system in
5803: the next section, here's a brief discussion on where programs are
5804: installed, and which variables influence this.</p>
5805: <p>The automatic variable <code class="varname">PREFIX</code> indicates
5806: where all files of the final program shall be installed. It is
5807: usually set to <code class="varname">LOCALBASE</code>
5808: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
5809: for pkgs in the <code class="filename">cross</code> category. The value of
5810: <code class="varname">PREFIX</code> needs to be put
5811: into the various places in the program's source where paths to
1.154 rillig 5812: 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 5813: <p>When choosing which of these variables to use,
5814: follow the following rules:</p>
1.41 asau 5815: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5816: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 5817: where the current pkg will be installed. When referring to a
5818: pkg's own installation path, use
1.23 wiz 5819: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
5820: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 5821: are installed. If you need to construct a -I or -L argument
5822: to the compiler to find includes and libraries installed by
1.23 wiz 5823: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 5824: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
5825: installed all packages in <code class="filename">/usr/local</code>. As
5826: pkgsrc leaves <code class="filename">/usr/local</code> for the system
5827: administrator, this variable is a misnomer.</p></li>
1.23 wiz 5828: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 5829: distribution (from xsrc, etc.) is installed. When looking for
5830: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 5831: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.99 sevan 5832: <li class="listitem"><p>X11-based packages using imake must set
5833: <code class="varname">USE_IMAKE</code> to be installed correctly under
5834: <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5835: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.167 leot 5836: 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 5837: manual pages go into <code class="filename">${PREFIX}/man</code>, not
5838: <code class="filename">${PREFIX}/share/man</code>.</p></li>
5839: </ul></div>
5840: </div>
1.41 asau 5841: <div class="sect1">
1.1 dsieger 5842: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5843: <a name="build.builddirs"></a>19.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 5844: <p>When building a package, various directories are used to store
1.1 dsieger 5845: source files, temporary files, pkgsrc-internal files, and so on. These
5846: directories are explained here.</p>
5847: <p>Some of the directory variables contain relative pathnames. There
5848: are two common base directories for these relative directories:
5849: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
5850: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
5851: inside the package itself.</p>
1.41 asau 5852: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5853: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
5854: <dd><p>This is an absolute pathname that points to the pkgsrc
5855: root directory. Generally, you don't need
5856: it.</p></dd>
5857: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
5858: <dd><p>This is an absolute pathname that points to the
5859: current package.</p></dd>
5860: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
5861: <dd><p>This is a pathname relative to
5862: <code class="varname">PKGSRCDIR</code> that points to the current
5863: package.</p></dd>
5864: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
5865: <dd><p>This is an absolute pathname pointing to the directory
5866: where all work takes place. The distfiles are extracted to this
5867: directory. It also contains temporary directories and log files used by
5868: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
5869: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
5870: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
5871: <dd><p>This is an absolute pathname pointing to the directory
5872: where the distfiles are extracted. It is usually a direct subdirectory
5873: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
5874: that isn't hidden. This variable may be changed by a package
5875: <code class="filename">Makefile</code>.</p></dd>
5876: </dl></div>
1.14 jmcneill 5877: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
5878: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 5879: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 5880: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
5881: If users would like to have their pkgsrc trees behave in a
5882: read-only manner, then the value of
5883: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
5884: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 5885: </div>
1.41 asau 5886: <div class="sect1">
1.1 dsieger 5887: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5888: <a name="build.running"></a>19.4. Running a phase</h2></div></div></div>
1.10 hubertf 5889: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 5890: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
5891: phase. This will automatically run all phases that are required for this
5892: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 5893: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 5894: the package will be built, but not installed.</p>
5895: </div>
1.41 asau 5896: <div class="sect1">
1.1 dsieger 5897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5898: <a name="build.fetch"></a>19.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 5899: <p>The first step in building a package is to fetch the
5900: distribution files (distfiles) from the sites that are providing
5901: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
5902: phase.</p>
1.41 asau 5903: <div class="sect2">
1.1 dsieger 5904: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5905: <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 5906: <p>In simple cases, <code class="varname">MASTER_SITES</code>
5907: defines all URLs from where the distfile, whose name is
5908: derived from the <code class="varname">DISTNAME</code> variable, is
5909: fetched. The more complicated cases are described
5910: below.</p>
5911: <p>The variable <code class="varname">DISTFILES</code> specifies
5912: the list of distfiles that have to be fetched. Its value
1.66 asau 5913: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
5914: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 5915: so that most packages don't need to define it at all.
5916: <code class="varname">EXTRACT_SUFX</code> is
5917: <code class="literal">.tar.gz</code> by default, but can be changed
5918: freely. Note that if your package requires additional
5919: distfiles to the default one, you cannot just append the
5920: additional filenames using the <code class="literal">+=</code>
5921: operator, but you have write for example:</p>
5922: <pre class="programlisting">
1.66 asau 5923: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 5924: </pre>
5925: <p>Each distfile is fetched from a list of sites, usually
5926: <code class="varname">MASTER_SITES</code>. If the package has multiple
5927: <code class="varname">DISTFILES</code> or multiple
5928: <code class="varname">PATCHFILES</code> from different sites, you can
5929: set
5930: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
5931: to the list of URLs where the file
5932: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
5933: (including the suffix) can be found.</p>
5934: <pre class="programlisting">
5935: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5936: DISTFILES+= foo-file.tar.gz
5937: SITES.foo-file.tar.gz= \
5938: http://www.somewhere.com/somehow/ \
5939: http://www.somewhereelse.com/mirror/somehow/
5940: </pre>
5941: <p>When actually fetching the distfiles, each item from
5942: <code class="varname">MASTER_SITES</code> or
5943: <code class="varname">SITES.*</code> gets the name of each distfile
5944: appended to it, without an intermediate slash. Therefore,
5945: all site values have to end with a slash or other separator
5946: character. This allows for example to set
5947: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
5948: that gets the name of the distfile as a parameter. In this
5949: case, the definition would look like:</p>
5950: <pre class="programlisting">
5951: MASTER_SITES= http://www.example.com/download.cgi?file=
5952: </pre>
1.22 jakllsch 5953: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 5954: In that case the URL is taken as is, fetched and the result
5955: stored under the name of the distfile. You can use this style
5956: for the case when the download URL style does not match the
5957: above common case. For example, if permanent download URL is a
5958: redirector to the real download URL, or the download file name
5959: is offered by an HTTP Content-Disposition header. In the
5960: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
5961: created instead of the default
5962: <code class="filename">v1.0.0.tar.gz</code>.</p>
5963: <pre class="programlisting">
5964: DISTNAME= foo-1.0.0
5965: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
5966: </pre>
1.1 dsieger 5967: <p>There are some predefined values for
5968: <code class="varname">MASTER_SITES</code>, which can be used in
5969: packages. The names of the variables should speak for
5970: themselves.</p>
1.156 leot 5971: <table border="0" summary="Simple list" class="simplelist">
5972: <tr>
5973: <td>MASTER_SITE_APACHE</td>
5974: <td>MASTER_SITE_BACKUP</td>
5975: </tr>
5976: <tr>
5977: <td>MASTER_SITE_CRATESIO</td>
5978: <td>MASTER_SITE_CYGWIN</td>
5979: </tr>
5980: <tr>
5981: <td>MASTER_SITE_DEBIAN</td>
5982: <td>MASTER_SITE_FREEBSD</td>
5983: </tr>
5984: <tr>
5985: <td>MASTER_SITE_FREEBSD_LOCAL</td>
5986: <td>MASTER_SITE_GENTOO</td>
5987: </tr>
5988: <tr>
5989: <td>MASTER_SITE_GITHUB</td>
5990: <td>MASTER_SITE_GNOME</td>
5991: </tr>
5992: <tr>
5993: <td>MASTER_SITE_GNU</td>
5994: <td>MASTER_SITE_GNUSTEP</td>
5995: </tr>
5996: <tr>
5997: <td>MASTER_SITE_HASKELL_HACKAGE</td>
5998: <td>MASTER_SITE_IFARCHIVE</td>
5999: </tr>
6000: <tr>
6001: <td>MASTER_SITE_KDE</td>
6002: <td>MASTER_SITE_MOZILLA</td>
6003: </tr>
6004: <tr>
6005: <td>MASTER_SITE_MOZILLA_ALL</td>
6006: <td>MASTER_SITE_MYSQL</td>
6007: </tr>
6008: <tr>
6009: <td>MASTER_SITE_NETLIB</td>
6010: <td>MASTER_SITE_OPENBSD</td>
6011: </tr>
6012: <tr>
6013: <td>MASTER_SITE_OPENOFFICE</td>
6014: <td>MASTER_SITE_OSDN</td>
6015: </tr>
6016: <tr>
6017: <td>MASTER_SITE_PERL_CPAN</td>
6018: <td>MASTER_SITE_PGSQL</td>
6019: </tr>
6020: <tr>
6021: <td>MASTER_SITE_PYPI</td>
6022: <td>MASTER_SITE_RUBYGEMS</td>
6023: </tr>
6024: <tr>
6025: <td>MASTER_SITE_R_CRAN</td>
6026: <td>MASTER_SITE_SOURCEFORGE</td>
6027: </tr>
6028: <tr>
6029: <td>MASTER_SITE_SUNSITE</td>
6030: <td>MASTER_SITE_SUSE</td>
6031: </tr>
6032: <tr>
6033: <td>MASTER_SITE_TEX_CTAN</td>
6034: <td>MASTER_SITE_XCONTRIB</td>
6035: </tr>
6036: <tr>
6037: <td>MASTER_SITE_XEMACS</td>
6038: <td>MASTER_SITE_XORG</td>
6039: </tr>
6040: </table>
1.1 dsieger 6041: <p>Some explanations for the less self-explaining ones:
6042: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 6043: 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 6044: 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 6045: <p>If you choose one of these predefined sites, you may
6046: want to specify a subdirectory of that site. Since these
6047: macros may expand to more than one actual site, you
6048: <span class="emphasis"><em>must</em></span> use the following construct to
6049: specify a subdirectory:</p>
6050: <pre class="programlisting">
6051: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6052: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6053: </pre>
6054: <p>Note the trailing slash after the subdirectory
6055: name.</p>
6056: </div>
1.41 asau 6057: <div class="sect2">
1.1 dsieger 6058: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 6059: <a name="build.fetch.how"></a>19.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6060: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6061: all the distfiles exist in a local directory
6062: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6063: user). If the files do not exist, they are fetched using
6064: commands of the form</p>
6065: <pre class="programlisting">
6066: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6067: </pre>
6068: <p>where <code class="literal">${site}</code> varies through
6069: several possibilities in turn: first,
6070: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6071: sites specified in either <code class="varname">SITES.file</code> if
6072: defined, else <code class="varname">MASTER_SITES</code> or
6073: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6074: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6075: all except the first and the last can be optionally sorted
6076: by the user, via setting either
6077: <code class="varname">MASTER_SORT_RANDOM</code>, and
6078: <code class="varname">MASTER_SORT_AWK</code> or
6079: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 6080: <p> The specific command and arguments used depend on the
6081: <code class="varname">FETCH_USING</code> parameter. The example above is
6082: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 6083: <p>The distfiles mirror run by the NetBSD Foundation uses the
6084: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6085: distfiles, if they are freely distributable. Packages setting
6086: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 6087: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 6088: mirrored.</p>
6089: </div>
6090: </div>
1.41 asau 6091: <div class="sect1">
1.1 dsieger 6092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6093: <a name="build.checksum"></a>19.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6094: <p>After the distfile(s) are fetched, their checksum is
6095: generated and compared with the checksums stored in the
6096: distinfo file. If the checksums don't match, the build is
6097: aborted. This is to ensure the same distfile is used for
6098: building, and that the distfile wasn't changed, e.g. by some
6099: malign force, deliberately changed distfiles on the master
6100: distribution site or network lossage.</p>
6101: </div>
1.41 asau 6102: <div class="sect1">
1.1 dsieger 6103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6104: <a name="build.extract"></a>19.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6105: <p>When the distfiles are present on the local system, they
6106: need to be extracted, as they usually come in the form of some
6107: compressed archive format.</p>
6108: <p>By default, all <code class="varname">DISTFILES</code> are
6109: extracted. If you only need some of them, you can set the
6110: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6111: files.</p>
6112: <p>Extracting the files is usually done by a little
6113: program, <code class="filename">mk/extract/extract</code>, which
6114: already knows how to extract various archive formats, so most
6115: likely you will not need to change anything here. But if you
6116: need, the following variables may help you:</p>
1.41 asau 6117: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6118: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6119: <dd><p>Use these variables to override the default
6120: options for an extract command, which are defined in
6121: <code class="filename">mk/extract/extract</code>.</p></dd>
6122: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6123: <dd><p>This variable can be set to
1.14 jmcneill 6124: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6125: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 6126: absolute pathname pointing to the command with which tar
1.14 jmcneill 6127: archives should be extracted. It is preferred to choose bsdtar over gtar
6128: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 6129: </dl></div>
6130: <p>If the <code class="filename">extract</code> program doesn't
6131: serve your needs, you can also override the
6132: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6133: command used for extracting the files. This command is
6134: executed in the <code class="filename">${WRKSRC}</code>
6135: directory. During execution of this command, the shell
6136: variable <code class="varname">extract_file</code> holds the absolute
6137: pathname of the file that is going to be extracted.</p>
6138: <p>And if that still does not suffice, you can override the
6139: <code class="varname">do-extract</code> target in the package
6140: Makefile.</p>
6141: </div>
1.41 asau 6142: <div class="sect1">
1.1 dsieger 6143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6144: <a name="build.patch"></a>19.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6145: <p>After extraction, all the patches named by the
6146: <code class="varname">PATCHFILES</code>, those present in the patches
6147: subdirectory of the package as well as in
6148: $LOCALPATCHES/$PKGPATH (e.g.
6149: <code class="filename">/usr/local/patches/graphics/png</code>) are
6150: applied. Patchfiles ending in <code class="filename">.Z</code> or
6151: <code class="filename">.gz</code> are uncompressed before they are
6152: applied, files ending in <code class="filename">.orig</code> or
6153: <code class="filename">.rej</code> are ignored. Any special options to
1.167 leot 6154: <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 6155: <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 6156: <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 6157: it fail if the patches apply with some lines of fuzz. Please
6158: fix (regen) the patches so that they apply cleanly. The
6159: rationale behind this is that patches that don't apply cleanly
6160: may end up being applied in the wrong place, and cause severe
6161: harm there.</p>
6162: </div>
1.41 asau 6163: <div class="sect1">
1.1 dsieger 6164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6165: <a name="build.tools"></a>19.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6166: <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 6167: </p>
6168: </div>
1.41 asau 6169: <div class="sect1">
1.1 dsieger 6170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6171: <a name="build.wrapper"></a>19.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6172: <p>This phase creates wrapper programs for the compilers and
6173: linkers. The following variables can be used to tweak the
6174: wrappers.</p>
1.41 asau 6175: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6176: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6177: <dd><p>The command used to print progress
6178: messages. Does nothing by default. Set to
6179: <code class="literal">${ECHO}</code> to see the progress
6180: messages.</p></dd>
6181: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6182: <dd><p>This variable can be set to
6183: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6184: depending on whether you want additional information in the
6185: wrapper log file.</p></dd>
6186: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6187: <dd><p>This variable can be set to
6188: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6189: on whether the wrapper should use its cache, which will
6190: improve the speed. The default value is
6191: <code class="literal">yes</code>, but is forced to
6192: <code class="literal">no</code> if the platform does not support
6193: it.</p></dd>
6194: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6195: <dd><p>A list of reordering commands. A reordering
6196: command has the form
6197: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6198: It ensures that that
6199: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6200: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6201: </p></dd>
6202: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6203: <dd><p>A list of transformation commands. [TODO:
6204: investigate further]</p></dd>
6205: </dl></div>
6206: </div>
1.41 asau 6207: <div class="sect1">
1.1 dsieger 6208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6209: <a name="build.configure"></a>19.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6210: <p>Most pieces of software need information on the header
6211: files, system calls, and library routines which are available
6212: on the platform they run on. The process of determining this
6213: information is known as configuration, and is usually
6214: automated. In most cases, a script is supplied with the
6215: distfiles, and its invocation results in generation of header
6216: files, Makefiles, etc.</p>
6217: <p>If the package contains a configure script, this can be
6218: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6219: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6220: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6221: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6222: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6223: <pre class="programlisting">
6224: .for d in ${CONFIGURE_DIRS}
6225: cd ${WRKSRC} \
6226: && cd ${d} \
6227: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6228: .endfor
6229: </pre>
6230: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6231: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6232: <code class="varname">WRKSRC</code>. In each of these directories, the
6233: configure script is run with the environment
6234: <code class="varname">CONFIGURE_ENV</code> and arguments
6235: <code class="varname">CONFIGURE_ARGS</code>. The variables
6236: <code class="varname">CONFIGURE_ENV</code>,
6237: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6238: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6239: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6240: package.</p>
1.37 wiz 6241: <p>If the program uses the Perl way of configuration (mainly Perl
6242: modules, but not only), i.e. a file called
6243: <code class="filename">Makefile.PL</code>, it should include
6244: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6245: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6246: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6247: <p>If the program uses an <code class="filename">Imakefile</code>
6248: for configuration, the appropriate steps can be invoked by
6249: setting <code class="varname">USE_IMAKE</code> to
1.99 sevan 6250: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6251: You can add variables to xmkmf's environment by adding them to the
1.1 dsieger 6252: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6253: <p>If the program uses <code class="filename">cmake</code>
6254: for configuration, the appropriate steps can be invoked by
1.23 wiz 6255: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6256: You can add variables to cmake's environment by adding them to the
6257: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6258: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6259: The top directory argument is given by the
6260: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6261: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6262: <p>If there is no configure step at all, set
1.23 wiz 6263: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6264: </div>
1.41 asau 6265: <div class="sect1">
1.1 dsieger 6266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6267: <a name="build.build"></a>19.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6268: <p>For building a package, a rough equivalent of the
6269: following code is executed.</p>
6270: <pre class="programlisting">
6271: .for d in ${BUILD_DIRS}
6272: cd ${WRKSRC} \
6273: && cd ${d} \
6274: && env ${MAKE_ENV} \
6275: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6276: -f ${MAKE_FILE} \
6277: ${BUILD_TARGET}
6278: .endfor
6279: </pre>
6280: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6281: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6282: <code class="varname">WRKSRC</code>. In each of these directories,
6283: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6284: <code class="varname">MAKE_ENV</code> and arguments
6285: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6286: <code class="varname">MAKE_ENV</code>,
6287: <code class="varname">BUILD_MAKE_FLAGS</code>,
6288: <code class="varname">MAKE_FILE</code> and
6289: <code class="varname">BUILD_TARGET</code> may all be changed by the
6290: package.</p>
6291: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6292: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6293: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6294: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6295: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6296: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6297: <p>If there is no build step at all, set
1.23 wiz 6298: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6299: </div>
1.41 asau 6300: <div class="sect1">
1.1 dsieger 6301: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6302: <a name="build.test"></a>19.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6303: <p>[TODO]</p>
6304: </div>
1.41 asau 6305: <div class="sect1">
1.1 dsieger 6306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6307: <a name="build.install"></a>19.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6308: <p>Once the build stage has completed, the final step is to
6309: install the software in public directories, so users can
6310: access the programs and files.</p>
6311: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6312: equivalent of the following code is executed. Additionally,
6313: before and after this code, much magic is performed to do
6314: consistency checks, registering the package, and so on.</p>
6315: <pre class="programlisting">
6316: .for d in ${INSTALL_DIRS}
6317: cd ${WRKSRC} \
6318: && cd ${d} \
6319: && env ${MAKE_ENV} \
6320: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6321: -f ${MAKE_FILE} \
6322: ${INSTALL_TARGET}
6323: .endfor
6324: </pre>
6325: <p>The variable's meanings are analogous to the ones in the
6326: <span class="emphasis"><em>build</em></span> phase.
6327: <code class="varname">INSTALL_DIRS</code> defaults to
6328: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6329: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6330: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6331: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6332: defined.</p>
6333: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6334: variables are useful. They are all variations of the
1.167 leot 6335: <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 6336: permissions preset. <code class="varname">INSTALL</code> is the plain
6337: install command. The specialized variants, together with their
6338: intended use, are:</p>
1.41 asau 6339: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6340: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6341: <dd><p>directories that contain
6342: binaries</p></dd>
6343: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6344: <dd><p>directories that contain
6345: scripts</p></dd>
6346: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6347: <dd><p>directories that contain shared and static
6348: libraries</p></dd>
6349: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6350: <dd><p>directories that contain data
6351: files</p></dd>
6352: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6353: <dd><p>directories that contain man
6354: pages</p></dd>
1.100 leot 6355: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6356: <dd><p>directories that contain data files for games
6357: </p></dd>
1.1 dsieger 6358: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6359: <dd><p>binaries that can be stripped from debugging
6360: symbols</p></dd>
6361: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6362: <dd><p>binaries that cannot be
6363: stripped</p></dd>
6364: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6365: <dd><p>game
6366: binaries</p></dd>
6367: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6368: <dd><p>shared and static
6369: libraries</p></dd>
6370: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6371: <dd><p>data files</p></dd>
6372: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6373: <dd><p>data files for
6374: games</p></dd>
6375: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6376: <dd><p>man pages</p></dd>
6377: </dl></div>
6378: <p>Some other variables are:</p>
1.41 asau 6379: <div class="variablelist"><dl class="variablelist">
1.106 tnn 6380: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.167 leot 6381: <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 6382: when installing binaries. Any debugging sections and symbols present in
6383: binaries will be preserved.
6384: </p></dd>
1.1 dsieger 6385: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6386: <dd><p>A list of directories relative to
6387: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6388: beginning of the <span class="emphasis"><em>install</em></span> phase.
6389: The package is supposed to create all needed directories itself
6390: before installing files to it and list all other directories here.
6391: </p></dd>
6392: </dl></div>
6393: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6394: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6395: mostly relevant for packages in the <code class="filename">regress</code>
6396: category.</p>
6397: </div>
1.41 asau 6398: <div class="sect1">
1.1 dsieger 6399: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6400: <a name="build.package"></a>19.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6401: <p>Once the install stage has completed, a binary package of
6402: the installed files can be built. These binary packages can be
6403: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6404: the <span class="command"><strong>make bin-install</strong></span> or by using
6405: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6406: <p>By default, the binary packages are created in
6407: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6408: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6409: one for each category in the <code class="varname">CATEGORIES</code>
6410: variable. <code class="varname">PACKAGES</code> defaults to
6411: <code class="filename">pkgsrc/packages</code>.</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.clean"></a>19.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6416: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6417: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6418: to clean the work directories of all dependencies too, use
1.10 hubertf 6419: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6420: </div>
1.41 asau 6421: <div class="sect1">
1.1 dsieger 6422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6423: <a name="build.helpful-targets"></a>19.17. Other helpful targets</h2></div></div></div>
1.41 asau 6424: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6425: <dt><span class="term">pre/post-*</span></dt>
6426: <dd><p>For any of the main targets described in the
6427: previous section, two auxiliary targets exist with
1.23 wiz 6428: <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 6429: prefix for the main target's name. These targets are
6430: invoked before and after the main target is called,
6431: allowing extra configuration or installation steps be
6432: performed from a package's Makefile, for example, which
6433: a program's configure script or install target
6434: omitted.</p></dd>
6435: <dt><span class="term">do-*</span></dt>
6436: <dd><p>Should one of the main targets do the wrong thing,
6437: and should there be no variable to fix this, you can
6438: redefine it with the do-* target. (Note that redefining
6439: the target itself instead of the do-* target is a bad
6440: idea, as the pre-* and post-* targets won't be called
6441: anymore, etc.) You will not usually need to do
6442: this.</p></dd>
6443: <dt><span class="term">reinstall</span></dt>
6444: <dd>
1.10 hubertf 6445: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6446: you noticed some file was not installed properly, you
6447: can repeat the installation with this target, which will
1.23 wiz 6448: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6449: <p>This is the default value of
6450: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6451: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6452: package</strong></span>, where the defaults are
1.23 wiz 6453: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6454: respectively.</p>
6455: </dd>
6456: <dt><span class="term">deinstall</span></dt>
6457: <dd>
1.167 leot 6458: <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 6459: current directory, effectively de-installing the
6460: package. The following variables can be used to tune the
6461: behaviour:</p>
1.41 asau 6462: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6463: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.167 leot 6464: <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 6465: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6466: <dd><p>Remove all packages that require (depend on)
6467: the given package. This can be used to remove any
6468: packages that may have been pulled in by a given
1.10 hubertf 6469: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6470: DEINSTALLDEPENDS=1</strong></span> is done in
6471: <code class="filename">pkgsrc/x11/kde</code>, this is
6472: likely to remove whole KDE. Works by adding
1.167 leot 6473: <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 6474: command line.</p></dd>
6475: </dl></div>
6476: </dd>
6477: <dt><span class="term">bin-install</span></dt>
6478: <dd><p>Install a binary package from local disk and via FTP
6479: from a list of sites (see the
6480: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6481: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6482: available anywhere. The arguments given to
1.10 hubertf 6483: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6484: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6485: operation, etc.</p></dd>
1.95 wiz 6486: <dt><span class="term">install-clean</span></dt>
6487: <dd><p>This target removes the state files for the "install" and later
6488: phases so that the "install" target may be re-invoked. This can be
6489: used after editing the PLIST to install the package without
6490: rebuilding it.</p></dd>
6491: <dt><span class="term">build-clean</span></dt>
6492: <dd><p>This target removes the state files for the "build" and later
6493: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 6494: <dt><span class="term">update</span></dt>
6495: <dd>
6496: <p>This target causes the current package to be
6497: updated to the latest version. The package and all
6498: depending packages first get de-installed, then current
6499: versions of the corresponding packages get compiled and
6500: installed. This is similar to manually noting which
6501: packages are currently installed, then performing a
1.10 hubertf 6502: series of <span class="command"><strong>make deinstall</strong></span> and
6503: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6504: <code class="varname">UPDATE_TARGET</code> is set to) for these
6505: packages.</p>
1.23 wiz 6506: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6507: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6508: update</strong></span> was interrupted for some reason.
6509: However, in this case, make sure you don't call
1.10 hubertf 6510: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6511: list of dependent packages in <code class="varname">WRKDIR</code>.
6512: Otherwise, you lose the ability to automatically update
6513: the current package along with the dependent packages
6514: you have installed.</p>
1.10 hubertf 6515: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6516: update</strong></span> will only work as long as the package
6517: tree remains unchanged. If the source code for one of
6518: the packages to be updated has been changed, resuming
1.10 hubertf 6519: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 6520: fail!</p>
6521: <p>The following variables can be used either on the
1.10 hubertf 6522: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6523: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 6524: update</strong></span>:</p>
1.41 asau 6525: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6526: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
6527: <dd><p>Install target to recursively use for the
6528: updated package and the dependent packages.
6529: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 6530: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 6531: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 6532: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6533: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6534: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 6535: endless loop!</p></dd>
6536: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
6537: <dd><p>Don't clean up after updating. Useful if
6538: you want to leave the work sources of the updated
6539: packages around for inspection or other purposes.
6540: Be sure you eventually clean up the source tree
1.23 wiz 6541: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 6542: or you may run into troubles with old source code
6543: still lying around on your next
1.10 hubertf 6544: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 6545: update</strong></span>.</p></dd>
6546: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
6547: <dd><p>Deinstall each package before installing
6548: (making <code class="varname">DEPENDS_TARGET</code>). This
6549: may be necessary if the
1.23 wiz 6550: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 6551: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 6552: update</strong></span>.</p></dd>
6553: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
6554: <dd><p>Allows you to disable recursion and hardcode
6555: the target for packages. The default is
1.23 wiz 6556: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 6557: facilitating a recursive update of prerequisite
6558: packages. Only set
6559: <code class="varname">DEPENDS_TARGET</code> if you want to
6560: disable recursive updates. Use
6561: <code class="varname">UPDATE_TARGET</code> instead to just
6562: set a specific target for each package to be
1.10 hubertf 6563: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 6564: (see above).</p></dd>
6565: </dl></div>
6566: </dd>
6567: <dt><span class="term">clean-update</span></dt>
6568: <dd>
6569: <p>Clean the source tree for all packages that would
1.10 hubertf 6570: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 6571: from the current directory. This target should not be
6572: used if the current package (or any of its depending
6573: packages) have already been de-installed (e.g., after
1.10 hubertf 6574: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 6575: some packages you intended to update. As a rule of
6576: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 6577: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 6578: and only if you have a dirty package tree (e.g., if you
6579: used <code class="varname">NOCLEAN</code>).</p>
6580: <p>If you are unsure about whether your tree is
1.10 hubertf 6581: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 6582: clean</strong></span> at the top of the tree, or use the
6583: following sequence of commands from the directory of the
6584: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 6585: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 6586: time, otherwise you lose all the packages you wanted to
6587: update!):</p>
6588: <pre class="screen">
6589: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
6590: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
6591: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6592: </pre>
6593: <p>The following variables can be used either on the
1.10 hubertf 6594: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6595: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 6596: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6597: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 6598: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 6599: reconstruct the list of directories to update for
1.10 hubertf 6600: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 6601: update</strong></span> successfully installed all
6602: packages you wanted to update. Normally, this is
1.10 hubertf 6603: done automatically on <span class="command"><strong>make
1.1 dsieger 6604: update</strong></span>, but may have been suppressed by
6605: the <code class="varname">NOCLEAN</code> variable (see
6606: above).</p></dd>
6607: </dl></div>
6608: </dd>
6609: <dt><span class="term">replace</span></dt>
6610: <dd>
6611: <p>Update the installation of the current package. This
6612: differs from update in that it does not replace dependent
1.137 leot 6613: 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 6614: target to work.</p>
6615: <p><span class="emphasis"><em>Be careful when using this
6616: target!</em></span> There are no guarantees that dependent
6617: packages will still work, in particular they will most
1.10 hubertf 6618: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 6619: library package whose shared library major version changed
6620: between your installed version and the new one. For this
6621: reason, this target is not officially supported and only
6622: recommended for advanced users.</p>
6623: </dd>
6624: <dt><span class="term">info</span></dt>
1.167 leot 6625: <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 6626: package. You can use this to check which version of a
6627: package is installed.</p></dd>
6628: <dt><span class="term">index</span></dt>
6629: <dd>
6630: <p>This is a top-level command, i.e. it should be used in
6631: the <code class="filename">pkgsrc</code> directory. It creates a
6632: database of all packages in the local pkgsrc tree, including
6633: dependencies, comment, maintainer, and some other useful
6634: information. Individual entries are created by running
1.10 hubertf 6635: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 6636: directories. This index file is saved as
6637: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 6638: verbose format by running <span class="command"><strong>make
1.1 dsieger 6639: print-index</strong></span>. You can search in it with
1.10 hubertf 6640: <span class="command"><strong>make search
1.1 dsieger 6641: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6642: extract a list of all packages that depend on a particular
1.10 hubertf 6643: one by running <span class="command"><strong>make show-deps
1.1 dsieger 6644: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6645: <p>Running this command takes a very long time, some
6646: hours even on fast machines!</p>
6647: </dd>
6648: <dt><span class="term">readme</span></dt>
6649: <dd>
6650: <p>This target generates a
6651: <code class="filename">README.html</code> file, which can be
1.137 leot 6652: 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 6653: contain references to any packages which are in the
6654: <code class="varname">PACKAGES</code> directory on the local
6655: host. The generated files can be made to refer to URLs
6656: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6657: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6658: wanted to generate <code class="filename">README.html</code>
6659: files which pointed to binary packages on the local
6660: machine, in the directory
6661: <code class="filename">/usr/packages</code>, set
6662: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6663: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6664: <code class="varname">${PACKAGES}</code> directory and its
6665: subdirectories will be searched for all the binary
6666: packages.</p>
6667: <p>The target can be run at the toplevel or in category
6668: directories, in which case it descends recursively.</p>
6669: </dd>
6670: <dt><span class="term">readme-all</span></dt>
6671: <dd><p>This is a top-level command, run it in
6672: <code class="filename">pkgsrc</code>. Use this target to create a
6673: file <code class="filename">README-all.html</code> which contains a
6674: list of all packages currently available in the NetBSD
6675: Packages Collection, together with the category they belong
6676: to and a short description. This file is compiled from the
6677: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 6678: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 6679: readme</strong></span>.</p></dd>
6680: <dt><span class="term">cdrom-readme</span></dt>
6681: <dd><p>This is very much the same as the
1.23 wiz 6682: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 6683: used when generating a pkgsrc tree to be written to a
6684: CD-ROM. This target also produces
6685: <code class="filename">README.html</code> files, and can be made
6686: to refer to URLs based on
6687: <code class="varname">CDROM_PKG_URL_HOST</code> and
6688: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
6689: <dt><span class="term">show-distfiles</span></dt>
6690: <dd><p>This target shows which distfiles and patchfiles
6691: are needed to build the package
6692: (<code class="varname">ALLFILES</code>, which contains all
6693: <code class="varname">DISTFILES</code> and
6694: <code class="varname">PATCHFILES</code>, but not
6695: <code class="filename">patches/*</code>).</p></dd>
6696: <dt><span class="term">show-downlevel</span></dt>
6697: <dd><p>This target shows nothing if the package is not
6698: installed. If a version of this package is installed,
6699: but is not the version provided in this version of
6700: pkgsrc, then a warning message is displayed. This target
6701: can be used to show which of your installed packages are
6702: downlevel, and so the old versions can be deleted, and
6703: the current ones added.</p></dd>
6704: <dt><span class="term">show-pkgsrc-dir</span></dt>
6705: <dd><p>This target shows the directory in the pkgsrc
6706: hierarchy from which the package can be built and
6707: installed. This may not be the same directory as the one
6708: from which the package was installed. This target is
6709: intended to be used by people who may wish to upgrade
6710: many packages on a single host, and can be invoked from
6711: the top-level pkgsrc Makefile by using the
1.23 wiz 6712: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 6713: <dt><span class="term">show-installed-depends</span></dt>
6714: <dd><p>This target shows which installed packages match
6715: the current package's <code class="varname">DEPENDS</code>. Useful
6716: if out of date dependencies are causing build
6717: problems.</p></dd>
1.95 wiz 6718: <dt><span class="term">print-build-depends-list</span></dt>
6719: <dd><p>This target shows the list of packages that the current package
6720: depends on for building.</p></dd>
6721: <dt><span class="term">print-run-depends-list</span></dt>
6722: <dd><p>This target shows the list of packages that the current package
6723: depends on for running.</p></dd>
1.1 dsieger 6724: <dt><span class="term">check-shlibs</span></dt>
6725: <dd><p>After a package is installed, check all its
6726: binaries and (on ELF platforms) shared libraries to see
6727: if they find the shared libs they need. Run by default
1.10 hubertf 6728: 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 6729: <dt><span class="term">print-PLIST</span></dt>
6730: <dd>
1.23 wiz 6731: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 6732: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 6733: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 6734: -newer work/.extract_done</strong></span>. An attempt is made
6735: to care for shared libs etc., but it is
6736: <span class="emphasis"><em>strongly</em></span> recommended to review the
6737: result before putting it into
6738: <code class="filename">PLIST</code>. On upgrades, it's useful to
6739: diff the output of this command against an already
6740: existing <code class="filename">PLIST</code> file.</p>
1.167 leot 6741: <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 6742: other methods that don't update file access times, be
6743: sure to add these files manually to your
1.23 wiz 6744: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6745: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 6746: them!</p>
1.154 rillig 6747: <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 6748: information on this target.</p>
6749: </dd>
6750: <dt><span class="term">bulk-package</span></dt>
6751: <dd>
6752: <p>Used to do bulk builds. If an appropriate binary
6753: package already exists, no action is taken. If not, this
6754: target will compile, install and package it (and its
6755: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.154 rillig 6756: 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 6757: builds)</i></a>).
1.1 dsieger 6758: After creating the binary package, the sources, the
6759: just-installed package and its required packages are
6760: removed, preserving free disk space.</p>
6761: <p><span class="emphasis"><em>Beware that this target may deinstall
6762: all packages installed on a system!</em></span></p>
6763: </dd>
6764: <dt><span class="term">bulk-install</span></dt>
6765: <dd>
6766: <p>Used during bulk-installs to install required
6767: packages. If an up-to-date binary package is available,
1.167 leot 6768: 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 6769: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 6770: but the installed binary won't be removed.</p>
6771: <p>A binary package is considered
1.23 wiz 6772: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.167 leot 6773: <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 6774: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6775: <li class="listitem"><p>None of the package's files
1.1 dsieger 6776: (<code class="filename">Makefile</code>, ...) were modified
6777: since it was built.</p></li>
1.23 wiz 6778: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 6779: packages were modified since it was built.</p></li>
6780: </ul></div>
6781: <p><span class="emphasis"><em>Beware that this target may deinstall
6782: all packages installed on a system!</em></span></p>
6783: </dd>
6784: </dl></div>
6785: </div>
6786: </div>
1.41 asau 6787: <div class="chapter">
1.1 dsieger 6788: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 6789: <a name="tools"></a>Chapter 20. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6790: <div class="toc">
6791: <p><b>Table of Contents</b></p>
1.100 leot 6792: <dl class="toc">
1.154 rillig 6793: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
6794: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
6795: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6796: </dl>
6797: </div>
6798: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6799: by pkgsrc and also for individual packages to define what commands
1.156 leot 6800: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
1.1 dsieger 6801: or for later run-time of an installed packaged (such as
6802: <code class="varname">DEPENDS</code>).
6803: If the native system provides an adequate tool, then in many cases, a pkgsrc
6804: package will not be used.</p>
6805: <p>When building a package, the replacement tools are
6806: made available in a directory (as symlinks or wrapper scripts)
6807: that is early in the executable search path. Just like the buildlink
6808: system, this helps with consistent builds.</p>
6809: <p>A tool may be needed to help build a specific package. For example,
6810: perl, GNU make (gmake) or yacc may be needed.</p>
6811: <p>Also a tool may be needed, for example, because the native system's supplied
6812: tool may be inefficient for building a package with pkgsrc.
6813: For example, a package may need GNU awk, bison (instead of
6814: yacc) or a better sed.</p>
6815: <p>The tools used by a package can be listed by running
1.10 hubertf 6816: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6817: <div class="sect1">
1.1 dsieger 6818: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6819: <a name="pkgsrc-tools"></a>20.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 6820: <p>The default set of tools used by pkgsrc is defined in
6821: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 6822: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6823: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 6824: These can be seen by running:
1.10 hubertf 6825: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 6826: <p>If a package needs a specific program to build
6827: then the <code class="varname">USE_TOOLS</code> variable can be used
6828: to define the tools needed.</p>
6829: </div>
1.41 asau 6830: <div class="sect1">
1.1 dsieger 6831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6832: <a name="package-tools"></a>20.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 6833: <p>In the following examples, the :run means that it is needed at
6834: run-time (and becomes a DEPENDS).
1.1 dsieger 6835: The default is a build dependency which can be set with
6836: :build. (So in this example, it is the same as gmake:build
6837: and pkg-config:build.)</p>
6838: <pre class="programlisting">
6839: USE_TOOLS+= gmake perl:run pkg-config
6840: </pre>
6841: <p>When using the tools framework, a
6842: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6843: which contains the full path to the appropriate tool. For example,
1.23 wiz 6844: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 6845: on Linux systems.</p>
6846: <p>If you always need a pkgsrc version of the
6847: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6848: </p>
6849: </div>
1.41 asau 6850: <div class="sect1">
1.1 dsieger 6851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6852: <a name="platform-tools"></a>20.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 6853: <p>When improving or porting pkgsrc to a new platform, have a look
6854: at (or create) the corresponding platform specific make file fragment under
6855: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6856: the name of the common tools. For example:</p>
6857: <pre class="programlisting">
6858: .if exists(/usr/bin/bzcat)
6859: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6860: .elif exists(/usr/bin/bzip2)
6861: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6862: .endif
6863:
6864: TOOLS_PLATFORM.true?= true # shell builtin
6865: </pre>
6866: </div>
6867: </div>
1.41 asau 6868: <div class="chapter">
1.1 dsieger 6869: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 6870: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 6871: <div class="toc">
6872: <p><b>Table of Contents</b></p>
1.100 leot 6873: <dl class="toc">
1.154 rillig 6874: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 6875: <dd><dl>
1.154 rillig 6876: <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>
6877: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
6878: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
6879: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
6880: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
6881: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
6882: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
6883: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
6884: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
6885: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
6886: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
6887: </dl></dd>
6888: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6889: <dd><dl>
6890: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
6891: <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>
6892: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
6893: </dl></dd>
6894: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6895: <dd><dl>
6896: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
6897: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
6898: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
6899: </dl></dd>
6900: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
6901: <dd><dl>
6902: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
6903: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
6904: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
6905: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
6906: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
6907: </dl></dd>
6908: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6909: <dd><dl>
6910: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
6911: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
6912: <dt><span class="sect2"><a href="#undefined-reference">21.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
6913: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
6914: </dl></dd>
6915: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6916: <dd><dl>
6917: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
6918: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
6919: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
6920: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
6921: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
6922: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
6923: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
6924: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
6925: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
6926: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
6927: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
6928: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
6929: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
6930: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
6931: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
6932: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
6933: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
6934: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 6935: emulation</a></span></dt>
1.154 rillig 6936: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
6937: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 6938: </dl></dd>
1.154 rillig 6939: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 6940: </dl>
6941: </div>
1.41 asau 6942: <div class="sect1">
1.1 dsieger 6943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6944: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 6945: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 6946: different platforms. As a result, it is important to ensure,
6947: where possible, that packages in pkgsrc are portable. This
6948: chapter mentions some particular details you should pay
6949: attention to while working on pkgsrc.</p>
1.41 asau 6950: <div class="sect2">
1.1 dsieger 6951: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 6952: <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 6953: </h3></div></div></div>
6954: <p>The pkgsrc user can configure pkgsrc by overriding several
6955: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 6956: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 6957: want to use those variables in the preprocessor directives of
1.167 leot 6958: <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 6959: <code class="literal">.for</code>), you need to include the file
6960: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
6961: loads the user preferences.</p>
6962: <p>But note that some variables may not be completely defined
6963: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
6964: included, as they may contain references to variables that are
1.108 rillig 6965: not yet defined. In shell commands (the lines in
6966: <code class="filename">Makefile</code> that are indented with a tab) this
6967: is no problem, since variables are only expanded when they are
6968: used. But in the preprocessor directives mentioned above and in
6969: dependency lines (of the form <code class="literal">target:
1.1 dsieger 6970: dependencies</code>) the variables are expanded at load
6971: time.</p>
1.41 asau 6972: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 6973: <h3 class="title">Note</h3>
1.108 rillig 6974: <p>To check whether a variable can be used at load time,
6975: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 6976: </div>
6977: </div>
1.41 asau 6978: <div class="sect2">
1.1 dsieger 6979: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 6980: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 6981: <p>Occasionally, packages require interaction from the user,
6982: and this can be in a number of ways:</p>
1.41 asau 6983: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6984: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 6985: interaction such as entering username/password or accepting a
6986: license on a web page.</p></li>
1.23 wiz 6987: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 6988: passwords.</p></li>
1.23 wiz 6989: <li class="listitem"><p>help to configure the package before it is built</p></li>
6990: <li class="listitem"><p>help during the build process</p></li>
6991: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 6992: </ul></div>
1.108 rillig 6993: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
6994: variable to define which stages need interaction. This should be
6995: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 6996: <pre class="programlisting">
6997: INTERACTIVE_STAGE= configure install
1.111 sevan 6998: </pre>
1.1 dsieger 6999: <p>The user can then decide to skip this package by setting the
1.108 rillig 7000: <code class="varname">BATCH</code> variable. Packages that require interaction
7001: are also excluded from bulk builds.</p>
1.1 dsieger 7002: </div>
1.41 asau 7003: <div class="sect2">
1.1 dsieger 7004: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7005: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 7006: <p>Authors of software can choose the licence under which software
7007: can be copied. The Free Software Foundation has declared some
7008: licenses "Free", and the Open Source Initiative has a definition of
7009: "Open Source".</p>
7010: <p>By default, pkgsrc allows packages with Free or Open Source
7011: licenses to be built. To allow packages with other licenses to be
7012: built as well, the pkgsrc user needs to add these licenses to the
7013: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7014: that this variable only affects which packages may be
7015: <span class="emphasis"><em>built</em></span>, while the license terms often also
7016: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 7017: <p>One might want to only install packages with a BSD license,
1.108 rillig 7018: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 7019: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 7020: user can override the default by setting the
7021: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 7022: of "+=". The licenses accepted by default are defined in the
7023: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7024: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7025: <p>The license tag mechanism is intended to address
7026: copyright-related issues surrounding building, installing and
7027: using a package, and not to address redistribution issues (see
7028: <code class="varname">RESTRICTED</code> and
1.111 sevan 7029: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7030: Packages with redistribution restrictions should set these
7031: tags.</p>
1.1 dsieger 7032: <p>Denoting that a package may be copied according to a
7033: particular license is done by placing the license in
7034: <code class="filename">pkgsrc/licenses</code> and setting the
7035: <code class="varname">LICENSE</code> variable to a string identifying the
1.137 leot 7036: 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 7037: <pre class="programlisting">
7038: LICENSE= xv-license
1.111 sevan 7039: </pre>
1.1 dsieger 7040: <p>When trying to build, the user will get a notice that the
7041: package is covered by a license which has not been placed in the
7042: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7043: <pre class="programlisting">
7044: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7045: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7046: ===> To view the license, enter "/usr/bin/make show-license".
7047: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7048: ===> ACCEPTABLE_LICENSES+=xv-license
7049: *** Error code 1
1.111 sevan 7050: </pre>
1.10 hubertf 7051: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7052: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7053: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7054: convey to pkgsrc that it should not in the future fail because of
7055: that license:</p>
7056: <pre class="programlisting">
7057: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7058: </pre>
7059: <p>The use of <code class="varname">LICENSE=shareware</code>,
7060: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7061: is deprecated because it does not crisply refer to a particular
7062: license text. Another problem with such usage is that it does not
7063: enable a user to tell pkgsrc to proceed for a single package
7064: without also telling pkgsrc to proceed for all packages with that
7065: tag.</p>
7066: <div class="sect3">
7067: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7068: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7069: <p>When adding a package with a new license, the following steps
7070: are required:</p>
7071: <div class="orderedlist"><ol class="orderedlist" type="1">
7072: <li class="listitem">
1.169 rillig 7073: <p>Check whether the license qualifies as Free or Open Source by
7074: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7075: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111 sevan 7076: Open Source Initiative</a>. If this is the case, the filename in
7077: <code class="filename">pkgsrc/licenses/</code> does not need the
7078: <code class="filename">-license</code> suffix, and the license name should be
7079: added to:</p>
1.48 rodent 7080: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7081: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7082: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7083: <li class="listitem"><p>default_acceptable_licenses in
7084: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48 rodent 7085: </ul></div>
7086: </li>
1.169 rillig 7087: <li class="listitem"><p>The license text should be added to
7088: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7089: licenses can be seen in this directory.</p></li>
1.48 rodent 7090: </ol></div>
1.111 sevan 7091: </div>
7092: <div class="sect3">
7093: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7094: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7095: <p>When the license changes (in a way other than formatting),
1.111 sevan 7096: make sure that the new license has a different name (e.g.,
1.1 dsieger 7097: append the version number if it exists, or the date). Just
7098: because a user told pkgsrc to build programs under a previous
7099: version of a license does not mean that pkgsrc should build
7100: programs under the new licenses. The higher-level point is that
7101: pkgsrc does not evaluate licenses for reasonableness; the only
7102: test is a mechanistic test of whether a particular text has been
1.111 sevan 7103: approved by either of two bodies (FSF or OSI).</p>
7104: </div>
1.1 dsieger 7105: </div>
1.41 asau 7106: <div class="sect2">
1.1 dsieger 7107: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7108: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7109: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7110: By declaring the restrictions, package tools can
1.1 dsieger 7111: automatically refrain from e.g. placing binary packages on FTP
7112: sites.</p>
1.111 sevan 7113: <p>There are four possible restrictions, which are
1.1 dsieger 7114: the cross product of sources (distfiles) and binaries not being
7115: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7116: language in any license, and because non-Free licenses tend to be
7117: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7118: CD-ROM.
7119:
7120: "FTP" means making the source or binary file available over the
7121: Internet at no charge.
7122:
7123: "CD-ROM" means making the source or binary available on some kind of
7124: media, together with other source and binary packages, which is sold
7125: for a distribution charge.
1.1 dsieger 7126: </p>
7127: <p>In order to encode these restrictions, the package system
7128: defines five make variables that can be set to note these
7129: restrictions:</p>
1.41 asau 7130: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7131: <li class="listitem">
1.1 dsieger 7132: <p><code class="varname">RESTRICTED</code></p>
7133: <p>This variable should be set whenever a restriction
7134: exists (regardless of its kind). Set this variable to a
7135: string containing the reason for the restriction. It should
7136: be understood that those wanting to understand the restriction
7137: will have to read the license, and perhaps seek advice of
7138: counsel.</p>
7139: </li>
1.23 wiz 7140: <li class="listitem">
1.1 dsieger 7141: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7142: <p>Binaries may not be placed on CD-ROM containing other
7143: binary packages, for which a distribution charge may be made.
7144: In this case, set this variable to
7145: <code class="varname">${RESTRICTED}</code>.</p>
7146: </li>
1.23 wiz 7147: <li class="listitem">
1.1 dsieger 7148: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7149: <p>Binaries may not made available on the Internet without
7150: charge. In this case, set this variable to
7151: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7152: binary packages will not be included on ftp.NetBSD.org.</p>
7153: </li>
1.23 wiz 7154: <li class="listitem">
1.1 dsieger 7155: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7156: <p>Distfiles may not be placed on CD-ROM, together with
7157: other distfiles, for which a fee may be charged. In this
7158: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7159: </p>
7160: </li>
1.23 wiz 7161: <li class="listitem">
1.1 dsieger 7162: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7163: <p>Distfiles may not made available via FTP at no charge.
7164: In this case, set this variable to
7165: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7166: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7167: </li>
7168: </ul></div>
1.111 sevan 7169: <p>Please note that packages will be removed from pkgsrc when the
7170: distfiles are not distributable and cannot be obtained for a period
7171: of one full quarter branch. Packages with manual/interactive fetch
7172: must have a maintainer and it is his/her responsibility to ensure
7173: this.</p>
1.1 dsieger 7174: </div>
1.41 asau 7175: <div class="sect2">
1.1 dsieger 7176: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7177: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.1 dsieger 7178: <p>Your package may depend on some other package being present
7179: - and there are various ways of expressing this dependency.
7180: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
1.156 leot 7181: <code class="varname">DEPENDS</code> and
7182: <code class="varname">TOOL_DEPENDS</code> definitions, the
1.1 dsieger 7183: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7184: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7185: to handle dependencies, and which uses the variables named above.
1.154 rillig 7186: 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 7187: <p>The basic difference between the two variables is as
7188: follows: The <code class="varname">DEPENDS</code> definition registers
7189: that pre-requisite in the binary package so it will be pulled in
7190: when the binary package is later installed, whilst the
1.156 leot 7191: <code class="varname">BUILD_DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
7192: definitions does not, marking a dependency that is only needed for
7193: building the package.</p>
1.1 dsieger 7194: <p>This means that if you only need a package present whilst
7195: you are building, it should be noted as a
1.156 leot 7196: <code class="varname">TOOL_DEPENDS</code> or
7197: <code class="varname">BUILD_DEPENDS</code>. When cross-compiling,
7198: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7199: packages, i.e. packages for the architecture where the package
7200: is built;
7201: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
7202: packages, i.e. packages for the architecture for which the package
7203: is built.</p>
7204: <p>The format for <code class="varname">BUILD_DEPENDS</code>,
7205: <code class="varname">DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
7206: definition is:</p>
1.1 dsieger 7207: <pre class="programlisting">
7208: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7209: </pre>
1.23 wiz 7210: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7211: may include any of the wildcard version numbers recognized by
1.167 leot 7212: <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 7213: <div class="orderedlist"><ol class="orderedlist" type="1">
7214: <li class="listitem">
1.1 dsieger 7215: <p>If your package needs another package's binaries or
1.54 wiz 7216: libraries to build and run, and if that package has a
1.1 dsieger 7217: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7218: <pre class="programlisting">
7219: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7220: </pre>
1.1 dsieger 7221: </li>
1.23 wiz 7222: <li class="listitem">
1.54 wiz 7223: <p>If your package needs another package's binaries or
7224: libraries only for building, and if that package has a
7225: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7226: <pre class="programlisting">
7227: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7228: </pre>
1.54 wiz 7229: <p>but set
7230: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7231: to make it a build dependency only. This case is rather
7232: rare.</p>
7233: </li>
7234: <li class="listitem">
1.25 spz 7235: <p>If your package needs binaries from another package to build,
1.156 leot 7236: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7237: <pre class="programlisting">
1.156 leot 7238: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7239: </pre>
1.1 dsieger 7240: </li>
1.156 leot 7241: <li class="listitem"><p>If your package needs static libraries to link against, header
7242: files to include, etc. from another package to build,
7243: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7244: <li class="listitem"><p>If your package needs a library with which to link and
7245: there is no <code class="filename">buildlink3.mk</code> file
7246: available, create one. Using
7247: <code class="varname">DEPENDS</code> won't be sufficient because the
7248: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7249: <li class="listitem">
1.25 spz 7250: <p>If your package needs some executable to be able to run
7251: correctly and if there's no
7252: <code class="filename">buildlink3.mk</code> file, this is specified
7253: using the <code class="varname">DEPENDS</code> variable. The
1.137 leot 7254: <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 7255: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7256: when it runs, and that is specified:</p>
1.1 dsieger 7257: <pre class="programlisting">
1.129 wiz 7258: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7259: </pre>
1.25 spz 7260: </li>
7261: <li class="listitem">
7262: <p>You can use wildcards in package dependencies. Note that
7263: such wildcard dependencies are retained when creating binary
7264: packages. The dependency is checked when installing the binary
7265: package and any package which matches the pattern will be
7266: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7267: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7268: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7269: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7270: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7271: <p>Wildcards can also be used to specify that a package
7272: will only build against a certain minimum version of a
7273: pre-requisite:</p>
7274: <pre class="programlisting">
1.25 spz 7275: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7276: </pre>
1.25 spz 7277: <p>This means that the package will build using version 6.0
7278: of ImageMagick or newer. Such a dependency may be warranted
7279: if, for example, the command line options of an executable
7280: have changed.</p>
7281: <p>If you need to depend on minimum versions of libraries,
7282: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7283: <p>For security fixes, please update the package
1.154 rillig 7284: 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 7285: information.</p>
7286: </li>
7287: </ol></div>
7288: <p>If your package needs files from another package to build,
7289: add the relevant distribution files to
7290: <code class="varname">DISTFILES</code>, so they will be extracted
1.137 leot 7291: 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 7292: (It relies on the jpeg sources being present in source form
7293: during the build.)</p>
7294: </div>
1.41 asau 7295: <div class="sect2">
1.1 dsieger 7296: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7297: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7298: <p>Your package may conflict with other packages a user might
7299: already have installed on his system, e.g. if your package
7300: installs the same set of files as another package in the pkgsrc
1.80 wiz 7301: tree or has the same <code class="varname">PKGNAME</code>.</p>
1.142 leot 7302: <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>
7303: 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>
7304: install the same shared library, thus you set in
7305: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7306: <pre class="programlisting">
7307: CONFLICTS= Xaw-Xpm-[0-9]*
7308: </pre>
7309: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7310: <pre class="programlisting">
7311: CONFLICTS= libXaw3d-[0-9]*
7312: </pre>
1.167 leot 7313: <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 7314: that conflict with existing packages and abort. However, in many
7315: situations this is too late in the process. Binary package managers
7316: will not know about the conflict until they attempt to install the
7317: package after already downloading it and all its dependencies.
7318: Users may also waste time building a package and its dependencies
7319: only to find out at the end that it conflicts with another package
7320: they have installed.</p>
7321: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7322: should be added in all cases where it is known that packages conflict
7323: with each other. These <code class="varname">CONFLICTS</code> entries are
1.167 leot 7324: 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 7325: managers to inform users that packages cannot be installed onto
7326: the target system.</p>
1.1 dsieger 7327: </div>
1.41 asau 7328: <div class="sect2">
1.1 dsieger 7329: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7330: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7331: <p>There are several reasons why a package might be
7332: instructed to not build under certain circumstances. If the
7333: package builds and runs on most platforms, the exceptions
1.83 dholland 7334: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7335: the package builds and runs on a small handful of platforms,
7336: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7337: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7338: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7339: (OS-version-platform) that can use glob-style
7340: wildcards.</p>
7341: <p>If a package is not appropriate for some platforms (as
1.114 maya 7342: opposed to merely broken), a different set of variables should be
1.83 dholland 7343: used as this affects failure reporting and statistics.
7344: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7345: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7346: the package is appropriate for only a small handful of platforms
7347: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7348: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7349: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7350: (OS-version-platform) that can use glob-style
7351: wildcards.</p>
7352: <p>Some packages are tightly bound to a specific version of an
1.137 leot 7353: 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 7354: backwards compatible with other versions of the OS, and should be
7355: uploaded to a version specific directory on the FTP server. Mark
7356: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7357: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7358: the package system internals, but may be used in the
7359: future.</p>
7360: <p>If the package should be skipped (for example, because it
7361: provides functionality already provided by the system), set
7362: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7363: the package should fail because some preconditions are not met,
7364: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7365: message.</p>
7366: </div>
1.41 asau 7367: <div class="sect2">
1.1 dsieger 7368: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7369: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7370: <p>To ensure that a package may not be deleted, once it has been
7371: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7372: be set in the package Makefile. This will be carried into any
7373: binary package that is made from this pkgsrc entry. A
1.23 wiz 7374: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.167 leot 7375: 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 7376: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7377: </div>
1.41 asau 7378: <div class="sect2">
1.1 dsieger 7379: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7380: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7381: <p>When a vulnerability is found, this should be noted in
7382: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7383: and after committing that file, ask pkgsrc-security@NetBSD.org to
7384: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7385: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7386: <code class="varname">PKGREVISION</code> should be increased (this is of
7387: course not necessary if the problem is fixed by using a newer
7388: release of the software), and the pattern in the
7389: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7390: <p>Also, if the fix should be applied to the stable pkgsrc
7391: branch, be sure to submit a pullup request!</p>
7392: <p>Binary packages already on ftp.NetBSD.org will be handled
7393: semi-automatically by a weekly cron job.</p>
7394: </div>
1.41 asau 7395: <div class="sect2">
1.1 dsieger 7396: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7397: <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 7398: <p>When making fixes to an existing package it can be useful
7399: to change the version number in <code class="varname">PKGNAME</code>. To
7400: avoid conflicting with future versions by the original author, a
1.23 wiz 7401: <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 7402: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7403: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7404: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7405: <pre class="programlisting">
7406: DISTNAME= foo-17.42
7407: PKGREVISION= 9
1.111 sevan 7408: </pre>
1.1 dsieger 7409: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7410: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7411: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7412: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7413: <code class="varname">PKGNAME_NOREV</code>.</p>
7414: <p>When a new release of the package is released, the
7415: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7416: minor release of the above package, things should be like:</p>
7417: <pre class="programlisting">
7418: DISTNAME= foo-17.43
1.111 sevan 7419: </pre>
1.1 dsieger 7420: <p><code class="varname">PKGREVISION</code> should be incremented for any
7421: non-trivial change in the resulting binary package. Without a
7422: <code class="varname">PKGREVISION</code> bump, someone with the previous
7423: version installed has no way of knowing that their package is out
7424: of date. Thus, changes without increasing
7425: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7426: trivial that no reasonable person would want to upgrade", and this
7427: is the rough test for when increasing
7428: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7429: changes that do not merit increasing
7430: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7431: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7432: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169 rillig 7433: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7434: comments in Makefile.</p></li>
7435: <li class="listitem"><p>Changing build variables if the resulting binary
7436: package is the same.</p></li>
7437: <li class="listitem"><p>Changing
7438: <code class="filename">DESCR</code>.</p></li>
7439: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7440: default options don't change.</p></li>
1.1 dsieger 7441: </ul></div>
7442: <p>Examples of changes that do merit an increase to
7443: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7444: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7445: <li class="listitem"><p>Security fixes</p></li>
7446: <li class="listitem"><p>Changes or additions to a patch
7447: file</p></li>
7448: <li class="listitem"><p>Changes to the
7449: <code class="filename">PLIST</code></p></li>
7450: <li class="listitem"><p>A dependency is changed or
7451: renamed.</p></li>
1.1 dsieger 7452: </ul></div>
7453: <p>PKGREVISION must also be incremented when dependencies have ABI
7454: changes.</p>
7455: </div>
1.41 asau 7456: <div class="sect2">
1.1 dsieger 7457: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7458: <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 7459: <p>When you want to replace the same text in multiple files
7460: or when the replacement text varies, patches alone cannot help.
7461: This is where the SUBST framework comes in. It provides an
7462: easy-to-use interface for replacing text in files.
7463: Example:</p>
7464: <pre class="programlisting">
7465: SUBST_CLASSES+= fix-paths
7466: SUBST_STAGE.fix-paths= pre-configure
7467: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7468: SUBST_FILES.fix-paths= src/*.c
7469: SUBST_FILES.fix-paths+= scripts/*.sh
7470: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7471: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.111 sevan 7472: </pre>
1.1 dsieger 7473: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
7474: that are used to identify the different SUBST blocks that are
7475: defined. The SUBST framework is heavily used by pkgsrc, so it is
7476: important to always use the <code class="literal">+=</code> operator with
7477: this variable. Otherwise some substitutions may be
7478: skipped.</p>
7479: <p>The remaining variables of each SUBST block are
7480: parameterized with the identifier from the first line
7481: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7482: parameters to a function call.</p>
7483: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
7484: which the replacement will take place. All combinations of
7485: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7486: <code class="literal">post-</code> together with a phase name are
7487: possible, though only few are actually used. Most commonly used
7488: are <code class="literal">post-patch</code> and
7489: <code class="literal">pre-configure</code>. Of these two,
7490: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 7491: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 7492: have the state after applying the patches but before making any
7493: other changes. This is especially useful when you are debugging
7494: a package in order to create new patches for it. Similarly,
7495: <code class="literal">post-build</code> is preferred over
7496: <code class="literal">pre-install</code>, because the install phase should
7497: generally be kept as simple as possible. When you use
7498: <code class="literal">post-build</code>, you have the same files in the
7499: working directory that will be installed later, so you can check
7500: if the substitution has succeeded.</p>
7501: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
7502: that is printed just before the substitution is done.</p>
7503: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
7504: globbing patterns that specifies the files in which the
7505: substitution will take place. The patterns are interpreted
7506: relatively to the <code class="varname">WRKSRC</code> directory.</p>
7507: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.167 leot 7508: <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 7509: command should be prefixed with <code class="literal">-e</code>, so that
7510: all SUBST blocks look uniform.</p>
7511: <p>There are some more variables, but they are so seldomly
7512: used that they are only documented in the
7513: <code class="filename">mk/subst.mk</code> file.</p>
7514: </div>
7515: </div>
1.41 asau 7516: <div class="sect1">
1.1 dsieger 7517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7518: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 7519: <div class="sect2">
1.1 dsieger 7520: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7521: <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 7522: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 7523: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 7524: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7525: with the name of each file to download as an argument, expecting
7526: it to output the URL of the directory from which to download
1.137 leot 7527: 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 7528: example of this usage.</p>
7529: <p>If the download can't be automated, because the user must
7530: submit personal information to apply for a password, or must pay
7531: for the source, or whatever, you can set
7532: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7533: displayed to the user before aborting the build. Example:</p>
7534: <pre class="programlisting">
7535: FETCH_MESSAGE= "Please download the files"
7536: FETCH_MESSAGE+= " "${DISTFILES:Q}
7537: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 7538: </pre>
1.1 dsieger 7539: </div>
1.41 asau 7540: <div class="sect2">
1.1 dsieger 7541: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7542: <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 7543: <p>Sometimes authors of a software package make some
7544: modifications after the software was released, and they put up a
7545: new distfile without changing the package's version number. If a
7546: package is already in pkgsrc at that time, the checksum will
7547: no longer match. The contents of the new distfile should be
7548: compared against the old one before changing anything, to make
7549: sure the distfile was really updated on purpose, and that
7550: no trojan horse or so crept in.
7551: Please mention that the distfiles were compared and what was found
1.53 rodent 7552: in your commit message.</p>
1.109 wiz 7553: <p>Then, the correct way to work around this is to set
7554: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7555: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7556: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7557: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 7558: <code class="varname">PATCHFILES</code> for this package will be put in that
1.154 rillig 7559: 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 7560: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 7561: including the <code class="filename">nbX</code> suffix) or a date stamp can
7562: be appended, like
7563: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169 rillig 7564: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
7565: name does not contain a version and the distfile is apt to change. In
7566: cases where the likelihood of this is very small,
7567: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
7568: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
7569: distfile name changes, even if a package is being moved or
7570: renamed.</p>
1.53 rodent 7571: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 7572: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7573: path in the filenames.
1.53 rodent 7574: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 7575: Furthermore, a mail to the package's authors seems appropriate
7576: telling them that changing distfiles after releases without
7577: changing the file names is not good practice.</p>
7578: </div>
1.88 tnn 7579: <div class="sect2">
7580: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7581: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169 rillig 7582: <p>Helper methods exist for packages hosted on github.com which
7583: will often have distfile names that clash with other packages, for
7584: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
7585: from below:</p>
1.88 tnn 7586: <div class="sect3">
7587: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7588: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169 rillig 7589: <p>If your distfile URL looks similar to
7590: <code class="literal">http://github.com/username/exampleproject/archive/v1.0.zip</code>,
7591: then you are packaging a tagged release.</p>
1.88 tnn 7592: <pre class="programlisting">
7593: DISTNAME= exampleproject-1.0
1.90 tnn 7594: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7595: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7596: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 7597: EXTRACT_SUFX= .zip
7598: </pre>
7599: </div>
7600: <div class="sect3">
7601: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7602: <a name="build.fetch.github.commit"></a>21.2.3.2. Fetch based on a specific commit</h4></div></div></div>
1.169 rillig 7603: <p>If your distfile URL looks similar to
7604: <code class="literal">http://github.com​/example​/example​/archive​/988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz</code>,
7605: then you are packaging a specific commit not tied to a
7606: release.</p>
1.88 tnn 7607: <pre class="programlisting">
7608: DISTNAME= example-1.0
1.107 jnemeth 7609: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 7610: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7611: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 7612: </pre>
1.88 tnn 7613: </div>
7614: <div class="sect3">
7615: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7616: <a name="build.fetch.github.release"></a>21.2.3.3. Fetch based on release</h4></div></div></div>
1.169 rillig 7617: <p>If your distfile URL looks similar to
7618: <code class="literal">http://github.com​/username/exampleproject​/releases​/download​/rel-1.6​/offensive-1.6.zip</code>,
7619: then you are packaging a release.</p>
1.88 tnn 7620: <pre class="programlisting">
7621: DISTNAME= offensive-1.6
1.90 tnn 7622: PKGNAME= ${DISTNAME:S/offensive/proper/}
7623: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7624: GITHUB_PROJECT= exampleproject
7625: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
7626: EXTRACT_SUFX= .zip
1.111 sevan 7627: </pre>
1.88 tnn 7628: </div>
7629: </div>
1.1 dsieger 7630: </div>
1.41 asau 7631: <div class="sect1">
1.1 dsieger 7632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7633: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 7634: <div class="sect2">
1.1 dsieger 7635: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7636: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 7637: <p>pkgsrc supports many different machines, with different
7638: object formats like a.out and ELF, and varying abilities to do
7639: shared library and dynamic loading at all. To accompany this,
7640: varying commands and options have to be passed to the
7641: compiler, linker, etc. to get the Right Thing, which can be
7642: pretty annoying especially if you don't have all the machines
7643: at your hand to test things. The
1.137 leot 7644: <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 7645: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 7646: both static and dynamic libraries from a set of source files,
7647: thus being platform-independent.</p>
7648: <p>Here's how to use libtool in a package in seven simple
7649: steps:</p>
1.23 wiz 7650: <div class="orderedlist"><ol class="orderedlist" type="1">
7651: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 7652: Makefile.</p></li>
1.23 wiz 7653: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
7654: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 7655: add it to the definition of <code class="varname">CC</code>, if only
7656: libraries are being built in a given Makefile. This one command
7657: will build both PIC and non-PIC library objects, so you need not
7658: have separate shared and non-shared library rules.</p></li>
1.23 wiz 7659: <li class="listitem">
1.1 dsieger 7660: <p>For the linking of the library, remove any
1.23 wiz 7661: <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
7662: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 7663: <pre class="programlisting">
7664: ${LIBTOOL} --mode=link \
7665: ${CC} -o ${.TARGET:.a=.la} \
7666: ${OBJS:.o=.lo} \
7667: -rpath ${PREFIX}/lib \
7668: -version-info major:minor
1.111 sevan 7669: </pre>
1.1 dsieger 7670: <p>Note that the library is changed to have a
7671: <code class="filename">.la</code> extension, and the objects are
7672: changed to have a <code class="filename">.lo</code>
7673: extension. Change <code class="varname">OBJS</code> as
7674: necessary. This automatically creates all of the
7675: <code class="filename">.a</code>,
7676: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
7677: necessary) in the build directory. Be sure to include
1.23 wiz 7678: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 7679: minor are zero, as libtool will otherwise strip off the
7680: shared library version.</p>
7681: <p>From the libtool manual:</p>
7682: <pre class="programlisting">
7683: So, libtool library versions are described by three integers:
7684:
7685: CURRENT
7686: The most recent interface number that this library implements.
7687:
7688: REVISION
7689: The implementation number of the CURRENT interface.
7690:
7691: AGE
7692: The difference between the newest and oldest interfaces that
7693: this library implements. In other words, the library implements
7694: all the interface numbers in the range from number `CURRENT -
7695: AGE' to `CURRENT'.
7696:
7697: If two libraries have identical CURRENT and AGE numbers, then the
7698: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 7699: </pre>
1.23 wiz 7700: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 7701: different results for a.out and ELF (excluding symlinks)
7702: in only one case. An ELF library of the form
1.23 wiz 7703: <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 7704: will have a symlink of
1.23 wiz 7705: <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 7706: on an a.out platform. This is handled
7707: automatically.</p>
1.23 wiz 7708: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 7709: directory of the library being built.</p>
7710: <p>In the <code class="filename">PLIST</code>, include only the
7711: <code class="filename">.la</code> file, the other files will be
7712: added automatically.</p>
7713: </li>
1.23 wiz 7714: <li class="listitem">
1.1 dsieger 7715: <p>When linking shared object (<code class="filename">.so</code>)
1.167 leot 7716: 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 7717: shared libraries, use <span class="quote">“<span class="quote">-module
7718: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 7719: tacked on.</p>
7720: <p>The <code class="filename">PLIST</code> file gets the
7721: <code class="filename">foo.so</code> entry.</p>
7722: </li>
1.23 wiz 7723: <li class="listitem">
1.1 dsieger 7724: <p>When linking programs that depend on these libraries
7725: <span class="emphasis"><em>before</em></span> they are installed, preface
1.167 leot 7726: 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 7727: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 7728: libraries (static or shared), but please be aware that
7729: libtool will not allow you to specify a relative path in
1.23 wiz 7730: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 7731: expects you to change that argument to be the
7732: <code class="filename">.la</code> file. e.g.</p>
7733: <pre class="programlisting">
7734: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 7735: </pre>
1.1 dsieger 7736: <p>should be changed to:</p>
7737: <pre class="programlisting">
7738: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 7739: </pre>
1.1 dsieger 7740: <p>and it will do the right thing with the libraries.</p>
7741: </li>
1.23 wiz 7742: <li class="listitem">
1.167 leot 7743: <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>
7744: 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 7745: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 7746: <code class="filename">.la</code>. e.g.</p>
7747: <pre class="programlisting">
1.22 jakllsch 7748: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 7749: </pre>
1.1 dsieger 7750: <p>This will install the static <code class="filename">.a</code>,
7751: shared library, any needed symlinks, and run
1.167 leot 7752: <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 7753: </li>
1.23 wiz 7754: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 7755: the <code class="filename">.la</code>
7756: file (this is a change from previous behaviour).</p></li>
7757: </ol></div>
7758: </div>
1.41 asau 7759: <div class="sect2">
1.1 dsieger 7760: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7761: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 7762: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
7763: package Makefile. This will override the package's own libtool
7764: in most cases. For older libtool using packages, libtool is
7765: made by ltconfig script during the do-configure step; you can
1.10 hubertf 7766: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 7767: configure; find work*/ -name libtool</strong></span>.</p>
7768: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
7769: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 7770: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
7771: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 7772: package's libtool script(s), set it as appropriate.</p>
7773: <p>If you do not need <code class="filename">*.a</code> static
7774: libraries built and installed, then use
7775: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
7776: <p>If your package makes use of the platform-independent library
7777: for loading dynamic shared objects, that comes with libtool
7778: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
7779: <p>Some packages use libtool incorrectly so that the package
7780: may not work or build in some circumstances. Some of the more
7781: common errors are:</p>
1.41 asau 7782: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7783: <li class="listitem">
1.1 dsieger 7784: <p>The inclusion of a shared object (-module) as a dependent library in an
7785: executable or library. This in itself isn't a problem if one of two things
7786: has been done:</p>
1.23 wiz 7787: <div class="orderedlist"><ol class="orderedlist" type="1">
7788: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 7789: <code class="filename">libfoo.la</code>, not
7790: <code class="filename">foo.la</code></p></li>
1.23 wiz 7791: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 7792: </ol></div>
7793: </li>
1.23 wiz 7794: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 7795: The function lt_dlinit() should be called and the macro
7796: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
7797: executables.</p></li>
7798: </ul></div>
7799: </div>
1.41 asau 7800: <div class="sect2">
1.1 dsieger 7801: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7802: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 7803: <p>If a package needs GNU autoconf or automake to be executed
7804: to regenerate the configure script and Makefile.in makefile
7805: templates, then they should be executed in a pre-configure
7806: target.</p>
7807: <p>For packages that need only autoconf:</p>
7808: <pre class="programlisting">
7809: AUTOCONF_REQD= 2.50 # if default version is not good enough
7810: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
7811: ...
7812:
7813: pre-configure:
7814: cd ${WRKSRC} && autoconf
7815:
7816: ...
1.111 sevan 7817: </pre>
1.1 dsieger 7818: <p>and for packages that need automake and autoconf:</p>
7819: <pre class="programlisting">
7820: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
7821: USE_TOOLS+= automake # use "automake14" for automake-1.4
7822: ...
7823:
7824: pre-configure:
7825: set -e; cd ${WRKSRC}; \
7826: aclocal; autoheader; automake -a --foreign -i; autoconf
7827:
7828: ...
1.111 sevan 7829: </pre>
1.1 dsieger 7830: <p>Packages which use GNU Automake will almost certainly
7831: require GNU Make.</p>
7832: <p>There are times when the configure process makes
7833: additional changes to the generated files, which then causes
7834: the build process to try to re-execute the automake sequence.
7835: This is prevented by touching various files in the configure
7836: stage. If this causes problems with your package you can set
7837: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
7838: Makefile.</p>
7839: </div>
7840: </div>
1.41 asau 7841: <div class="sect1">
1.1 dsieger 7842: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7843: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41 asau 7844: <div class="sect2">
1.1 dsieger 7845: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7846: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 7847: <p>Compilers for the C, C++, and Fortran languages comes with
7848: the NetBSD base system. By default, pkgsrc assumes that a package
7849: is written in C and will hide all other compilers (via the wrapper
1.154 rillig 7850: framework, see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 7851: <p>To declare which language's compiler a package needs, set
7852: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 7853: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
7854: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
7855: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 7856: written in C++, usually need a C compiler for the configure
7857: phase.</p>
7858: </div>
1.41 asau 7859: <div class="sect2">
1.1 dsieger 7860: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7861: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 7862: <p>If a program is written in Java, use the Java framework in
7863: pkgsrc. The package must include
7864: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
7865: provides the following variables:</p>
1.41 asau 7866: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7867: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 7868: dependency on the JDK is added. If
1.23 wiz 7869: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 7870: there is only a runtime dependency on the JDK. The default is
1.23 wiz 7871: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 7872: JDK.</p></li>
1.23 wiz 7873: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 7874: a package needs a Java2 implementation. The supported values
1.23 wiz 7875: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
7876: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
7877: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
7878: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 7879: above. This variable is not set by default.</p></li>
1.24 wiz 7880: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
7881: automatically set to the runtime location of the used Java
7882: implementation dependency. It may be used to set
7883: <code class="varname">JAVA_HOME</code> to a good value if the program
7884: needs this variable to be defined.
7885: </p></li>
1.1 dsieger 7886: </ul></div>
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="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 7891: <p>If your package contains interpreted perl scripts, add
1.23 wiz 7892: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 7893: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
7894: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
7895: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 7896: that you want adjusted. Every occurrence of
7897: <code class="filename">*/bin/perl</code> in a she-bang line will be
7898: replaced with the full path to the perl executable.</p>
1.1 dsieger 7899: <p>If a particular version of perl is needed, set the
7900: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 7901: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.154 rillig 7902: <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 7903: about handling perl modules.</p>
7904: </div>
1.41 asau 7905: <div class="sect2">
1.1 dsieger 7906: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7907: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 7908: <p><code class="varname">REPLACE_SH</code>,
7909: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
7910: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
7911: hash bangs in files. Please use the appropriate one, prefering
7912: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 7913: Each should contain a list of scripts, relative to
7914: <code class="varname">WRKSRC</code>, that you want adjusted. Every
7915: occurrence of the matching shell in a she-bang line will be
7916: replaced with the full path to the shell executable.
1.40 wiz 7917: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
7918: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
7919: </div>
1.41 asau 7920: <div class="sect2">
1.40 wiz 7921: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7922: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 7923: <p>Currently, there is no special handling for other languages
7924: in pkgsrc. If a compiler package provides a
7925: <code class="filename">buildlink3.mk</code> file, include that, otherwise
7926: just add a (build) dependency on the appropriate compiler
7927: package.</p>
7928: </div>
7929: </div>
1.41 asau 7930: <div class="sect1">
1.1 dsieger 7931: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7932: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7933: <p>The most common failures when building a package are that
7934: some platforms do not provide certain header files, functions or
7935: libraries, or they provide the functions in a library that the
7936: original package author didn't know. To work around this, you
7937: can rewrite the source code in most cases so that it does not
7938: use the missing functions or provides a replacement function.</p>
1.41 asau 7939: <div class="sect2">
1.1 dsieger 7940: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7941: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 7942: <p>If a package already comes with a GNU configure script, the
7943: preferred way to fix the build failure is to change the
7944: configure script, not the code. In the other cases, you can
7945: utilize the C preprocessor, which defines certain macros
7946: depending on the operating system and hardware architecture it
7947: compiles for. These macros can be queried using for example
7948: <code class="varname">#if defined(__i386)</code>. Almost every operating
7949: system, hardware architecture and compiler has its own macro.
7950: For example, if the macros <code class="varname">__GNUC__</code>,
7951: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
7952: are all defined, you know that you are using NetBSD on an i386
7953: compatible CPU, and your compiler is GCC.</p>
7954: <p>The list of the following macros for hardware and
7955: operating system depends on the compiler that is used. For
7956: example, if you want to conditionally compile code on Solaris,
7957: don't use <code class="varname">__sun__</code>, as the SunPro compiler
7958: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 7959: <div class="sect3">
1.1 dsieger 7960: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7961: <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 7962: <p>To distinguish between 4.4 BSD-derived systems and the
7963: rest of the world, you should use the following code.</p>
7964: <pre class="programlisting">
7965: #include <sys/param.h>
7966: #if (defined(BSD) && BSD >= 199306)
7967: /* BSD-specific code goes here */
7968: #else
7969: /* non-BSD-specific code goes here */
7970: #endif
7971: </pre>
7972: <p>If this distinction is not fine enough, you can also test
7973: for the following macros.</p>
7974: <pre class="programlisting">
1.45 obache 7975: Cygwin __CYGWIN__
7976: DragonFly __DragonFly__
1.1 dsieger 7977: FreeBSD __FreeBSD__
1.45 obache 7978: Haiku __HAIKU__
1.1 dsieger 7979: Interix __INTERIX
7980: IRIX __sgi (TODO: get a definite source for this)
7981: Linux linux, __linux, __linux__
1.83 dholland 7982: Mac OS X __APPLE__
1.45 obache 7983: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7984: Minix3 __minix
1.1 dsieger 7985: NetBSD __NetBSD__
7986: OpenBSD __OpenBSD__
7987: Solaris sun, __sun
7988: </pre>
7989: </div>
1.41 asau 7990: <div class="sect3">
1.1 dsieger 7991: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7992: <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 7993: <pre class="programlisting">
7994: i386 i386, __i386, __i386__
7995: MIPS __mips
7996: SPARC sparc, __sparc
7997: </pre>
7998: </div>
1.41 asau 7999: <div class="sect3">
1.1 dsieger 8000: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8001: <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 8002: <pre class="programlisting">
8003: GCC __GNUC__ (major version), __GNUC_MINOR__
8004: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8005: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8006: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8007: </pre>
8008: </div>
8009: </div>
1.41 asau 8010: <div class="sect2">
1.1 dsieger 8011: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8012: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8013: <p>Some source files trigger bugs in the compiler, based on
8014: combinations of compiler version and architecture and almost
8015: always relation to optimisation being enabled. Common symptoms
8016: are gcc internal errors or never finishing compiling a
8017: file.</p>
8018: <p>Typically, a workaround involves testing the
8019: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8020: optimisation for that combination of file,
1.87 tnn 8021: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8022: <p>This used to be a big problem in the past, but is rarely
8023: needed now as compiler technology has matured. If you still need
8024: to add a compiler specific workaround, please do so in the file
8025: <code class="filename">hacks.mk</code> and describe the symptom and
8026: compiler version as detailed as possible.</p>
1.1 dsieger 8027: </div>
1.41 asau 8028: <div class="sect2">
1.1 dsieger 8029: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8030: <a name="undefined-reference"></a>21.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 8031: </h3></div></div></div>
1.1 dsieger 8032: <p>This error message often means that a package did not
8033: link to a shared library it needs. The following functions are
8034: known to cause this error message over and over.</p>
8035: <div class="informaltable">
1.106 tnn 8036: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 8037: <colgroup>
8038: <col>
8039: <col>
8040: <col>
8041: </colgroup>
8042: <thead><tr>
8043: <th>Function</th>
8044: <th>Library</th>
8045: <th>Affected platforms</th>
8046: </tr></thead>
8047: <tbody>
8048: <tr>
8049: <td>accept, bind, connect</td>
8050: <td>-lsocket</td>
8051: <td>Solaris</td>
8052: </tr>
8053: <tr>
8054: <td>crypt</td>
8055: <td>-lcrypt</td>
8056: <td>DragonFly, NetBSD</td>
8057: </tr>
8058: <tr>
8059: <td>dlopen, dlsym</td>
8060: <td>-ldl</td>
8061: <td>Linux</td>
8062: </tr>
8063: <tr>
8064: <td>gethost*</td>
8065: <td>-lnsl</td>
8066: <td>Solaris</td>
8067: </tr>
8068: <tr>
8069: <td>inet_aton</td>
8070: <td>-lresolv</td>
8071: <td>Solaris</td>
8072: </tr>
8073: <tr>
8074: <td>nanosleep, sem_*, timer_*</td>
8075: <td>-lrt</td>
8076: <td>Solaris</td>
8077: </tr>
8078: <tr>
8079: <td>openpty</td>
8080: <td>-lutil</td>
8081: <td>Linux</td>
8082: </tr>
8083: </tbody>
8084: </table>
8085: </div>
8086: <p>To fix these linker errors, it is often sufficient to say
8087: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8088: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8089: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8090: bmake</strong></span>.</p>
1.41 asau 8091: <div class="sect3">
1.1 dsieger 8092: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8093: <a name="undefined-reference-sunpro"></a>21.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8094: <p>When you are using the SunPro compiler, there is another
8095: possibility. That compiler cannot handle the following code:</p>
8096: <pre class="programlisting">
8097: extern int extern_func(int);
8098:
8099: static inline int
8100: inline_func(int x)
8101: {
8102: return extern_func(x);
8103: }
8104:
8105: int main(void)
8106: {
8107: return 0;
8108: }
8109: </pre>
8110: <p>It generates the code for <code class="function">inline_func</code> even if
8111: that function is never used. This code then refers to
8112: <code class="function">extern_func</code>, which can usually not be resolved. To
8113: solve this problem you can try to tell the package to disable inlining
8114: of functions.</p>
8115: </div>
8116: </div>
1.41 asau 8117: <div class="sect2">
1.1 dsieger 8118: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8119: <a name="out-of-memory"></a>21.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8120: <p>Sometimes packages fail to build because the compiler runs
8121: into an operating system specific soft limit. With the
8122: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 8123: to unlimit the resources. Currently, the allowed values are any combination of
8124: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8125: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 8126: Setting this variable is similar to running the shell builtin
1.10 hubertf 8127: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8128: segment size or maximum stack size of a process, respectively, to
8129: their hard limits.</p>
8130: </div>
8131: </div>
1.41 asau 8132: <div class="sect1">
1.1 dsieger 8133: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8134: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 8135: <div class="sect2">
1.1 dsieger 8136: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8137: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8138: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8139: with some operating systems cannot create more than one
8140: directory at a time. As such, you should call
8141: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8142: <pre class="programlisting">
8143: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8144: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 8145: </pre>
1.23 wiz 8146: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8147: dir2</code></span>”</span> to the
1.1 dsieger 8148: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8149: automatically do the right thing.</p>
8150: </div>
1.41 asau 8151: <div class="sect2">
1.1 dsieger 8152: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8153: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8154: <p>In general, documentation should be installed into
8155: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8156: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8157: includes the version number of the package).</p>
8158: <p>Many modern packages using GNU autoconf allow to set the
8159: directory where HTML documentation is installed with the
1.23 wiz 8160: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8161: is needed because otherwise the documentation ends up in
8162: <code class="filename">${PREFIX}/share/doc/html</code> or other
8163: places.</p>
8164: <p>An exception to the above is that library API documentation
1.137 leot 8165: 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 8166: browsers (devhelp) should be left at their default location, which
8167: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8168: documentation can be recognized from files ending in
8169: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8170: (It is also acceptable to install such files in
8171: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8172: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8173: <code class="filename">.devhelp*</code> file must be directly in that
8174: directory then, no additional subdirectory level is allowed in
8175: this case. This is usually achieved by using
1.23 wiz 8176: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8177: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8178: though.)</p>
8179: </div>
1.41 asau 8180: <div class="sect2">
1.1 dsieger 8181: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8182: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8183: <p>Certain packages, most of them in the games category, install
8184: a score file that allows all users on the system to record their
8185: highscores. In order for this to work, the binaries need to be
8186: installed setgid and the score files owned by the appropriate
1.35 wiz 8187: group and/or owner (traditionally the "games" user/group). Set
8188: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8189: following variables, documented in more detail in
8190: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8191: behaviour: <code class="varname">GAMEDATAMODE</code>,
8192: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8193: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8194: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8195: <code class="varname">GAMEDATA_PERMS</code> and
8196: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8197: <p>An example that illustrates some of the variables described above is
8198: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8199: used to properly set directory permissions of the directory where the
8200: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8201: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8202: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8203: binary:</p>
8204: <pre class="programlisting">
1.112 rillig 8205: USE_GAMESGROUP= yes
1.100 leot 8206:
1.112 rillig 8207: BUILD_DEFS+= VARBASE
1.100 leot 8208:
1.112 rillig 8209: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8210: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8211: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 8212: </pre>
1.100 leot 8213: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8214: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8215: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8216: needed to be accessed by setgid games and
8217: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8218: <p>A package should therefore never hard code file ownership or
1.100 leot 8219: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8220: or alternatively on <code class="varname">INSTALL_GAME</code>,
8221: <code class="varname">INSTALL_GAME_DATA</code> and
8222: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8223: </div>
1.41 asau 8224: <div class="sect2">
1.1 dsieger 8225: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8226: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8227: <p><code class="varname">DESTDIR</code> support means that a package
8228: installs into a staging directory, not the final location of the
8229: files. Then a binary package is created which can be used for
8230: installation as usual. There are two ways: Either the package must
1.23 wiz 8231: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8232: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8233: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8234: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 8235: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8236: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 8237: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8238: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8239: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8240: the inclusion.</p></li>
1.23 wiz 8241: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8242: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8243: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8244: automatically. Many manual rules and pre/post-install often are
8245: incorrect; fix them.</p></li>
1.23 wiz 8246: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8247: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8248: <li class="listitem"><p>In general, packages should support
1.4 rillig 8249: <code class="varname">UNPRIVILEGED</code> to be able to use
8250: DESTDIR.</p></li>
8251: </ul></div>
8252: </div>
1.41 asau 8253: <div class="sect2">
1.4 rillig 8254: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8255: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8256: <p>Your package may also contain scripts with hardcoded paths to
8257: other interpreters besides (or as well as) perl. To correct the
8258: full pathname to the script interpreter, you need to set the
8259: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8260: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8261: <pre class="programlisting">
8262: REPLACE_INTERPRETER+= tcl
8263: REPLACE.tcl.old= .*/bin/tclsh
8264: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8265: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8266: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 8267: </pre>
1.41 asau 8268: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8269: <h3 class="title">Note</h3>
8270: <p>Before March 2006, these variables were called
8271: <code class="varname">_REPLACE.*</code> and
8272: <code class="varname">_REPLACE_FILES.*</code>.</p>
8273: </div>
8274: </div>
1.41 asau 8275: <div class="sect2">
1.1 dsieger 8276: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8277: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8278: <p>Makefiles of packages providing perl5 modules should include
8279: the Makefile fragment
8280: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8281: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8282: configuration for such modules as well as various hooks to tune
8283: this configuration. See comments in this file for
8284: details.</p>
8285: <p>Perl5 modules will install into different places depending
8286: on the version of perl used during the build process. To
8287: address this, pkgsrc will append lines to the
8288: <code class="filename">PLIST</code> corresponding to the files listed in
8289: the installed <code class="filename">.packlist</code> file generated by
8290: most perl5 modules. This is invoked by defining
8291: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8292: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8293: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8294: e.g.:</p>
1.1 dsieger 8295: <pre class="programlisting">
1.47 wiz 8296: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 8297: </pre>
1.47 wiz 8298: <p>The perl5 config variables
8299: <code class="varname">installarchlib</code>,
8300: <code class="varname">installscript</code>,
8301: <code class="varname">installvendorbin</code>,
8302: <code class="varname">installvendorscript</code>,
8303: <code class="varname">installvendorarch</code>,
8304: <code class="varname">installvendorlib</code>,
8305: <code class="varname">installvendorman1dir</code>, and
8306: <code class="varname">installvendorman3dir</code> represent those
8307: locations in which components of perl5 modules may be installed,
8308: provided as variable with uppercase and prefixed with
8309: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8310: and may be used by perl5 packages that don't have a packlist.
8311: These variables are also substituted for in the
8312: <code class="filename">PLIST</code> as uppercase prefixed with
8313: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8314: </div>
1.41 asau 8315: <div class="sect2">
1.1 dsieger 8316: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8317: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8318: <p>Some packages install info files or use the
1.23 wiz 8319: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8320: commands. <code class="varname">INFO_FILES</code> should be defined in
8321: the package Makefile so that <code class="filename">INSTALL</code> and
8322: <code class="filename">DEINSTALL</code> scripts will be generated to
8323: handle registration of the info files in the Info directory
1.23 wiz 8324: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8325: files registration is either provided by the system, or by a
8326: special purpose package automatically added as dependency if
8327: needed.</p>
8328: <p><code class="varname">PKGINFODIR</code> is the directory under
8329: <code class="filename">${PREFIX}</code> where info files are primarily
8330: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8331: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8332: <p>The info files for the package should be listed in the
8333: package <code class="filename">PLIST</code>; however any split info files
8334: need not be listed.</p>
1.23 wiz 8335: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8336: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8337: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8338: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8339: should be noted with the <code class="varname">TEXINFO_REQD</code>
8340: variable in the package <code class="filename">Makefile</code>. By
8341: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8342: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8343: does not match the required minimum, a build dependency on the
1.137 leot 8344: <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 8345: be added automatically.</p>
8346: <p>The build and installation process of the software provided
8347: by the package should not use the
1.10 hubertf 8348: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8349: info files is the task of the package
8350: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8351: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8352: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8353: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8354: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8355: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8356: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8357: no effect except the logging of a message. The script overriding
1.10 hubertf 8358: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8359: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8360: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8361: </div>
1.41 asau 8362: <div class="sect2">
1.1 dsieger 8363: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8364: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8365: <p>All packages that install manual pages should install them
8366: into the same directory, so that there is one common place to look
8367: for them. In pkgsrc, this place is
8368: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8369: should be used in packages. The default for
8370: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8371: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8372: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8373: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8374: <h3 class="title">Note</h3>
8375: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8376: is far from complete.</p>
8377: </div>
8378: <p>The <code class="filename">PLIST</code> files can just use
8379: <code class="filename">man/</code> as the top level directory for the man
8380: page file entries, and the pkgsrc framework will convert as
8381: needed. In all other places, the correct
8382: <code class="varname">PKGMANDIR</code> must be used.</p>
8383: <p>Packages that are
8384: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8385: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8386: <code class="filename">./configure</code>
8387: --mandir switch to set where the man pages should be installed.
8388: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8389: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8390: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8391: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8392: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8393: Or if the <code class="filename">./configure</code> script uses
8394: a non-standard use of --mandir, you can set
8395: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.154 rillig 8396: <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 8397: information on installation of compressed manual pages.</p>
8398: </div>
1.41 asau 8399: <div class="sect2">
1.1 dsieger 8400: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8401: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8402: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8403: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8404: you need to take some extra steps to make sure they get registered
8405: in the database:</p>
1.23 wiz 8406: <div class="orderedlist"><ol class="orderedlist" type="1">
8407: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8408: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8409: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8410: deinstallation time, and tells the package where to install
1.7 rillig 8411: GConf data files using some standard configure arguments. It
1.1 dsieger 8412: also disallows any access to the database directly from the
8413: package.</p></li>
1.23 wiz 8414: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8415: <code class="filename">.schemas</code> files under
8416: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8417: installed under <code class="filename">${PREFIX}/etc</code>, you will
8418: need to manually patch the package.</p></li>
1.23 wiz 8419: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8420: directory, as they will be handled automatically. See
1.154 rillig 8421: <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 8422: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8423: your <code class="filename">Makefile</code> with a list of all
8424: <code class="filename">.schemas</code> files installed by the package, if
8425: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8426: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8427: your <code class="filename">Makefile</code> with a
8428: list of all <code class="filename">.entries</code> files installed by the
8429: package, if any. Names must not contain any directories in
8430: them.</p></li>
8431: </ol></div>
8432: </div>
1.41 asau 8433: <div class="sect2">
1.1 dsieger 8434: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8435: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8436: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8437: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8438: get registered in the database:</p>
1.23 wiz 8439: <div class="orderedlist"><ol class="orderedlist" type="1">
8440: <li class="listitem"><p>Include
1.18 snj 8441: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8442: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8443: takes care of rebuilding the scrollkeeper database at
8444: installation and deinstallation time, and disallows any access
8445: to it directly from the package.</p></li>
1.23 wiz 8446: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8447: <code class="filename">libdata/scrollkeeper</code> directory, as they
8448: will be handled automatically.</p></li>
1.23 wiz 8449: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8450: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8451: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8452: </ol></div>
8453: </div>
1.41 asau 8454: <div class="sect2">
1.1 dsieger 8455: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8456: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8457: <p>If a package installs font files, you will need to rebuild
8458: the fonts database in the directory where they get installed at
8459: installation and deinstallation time. This can be automatically
8460: done by using the pkginstall framework.</p>
8461: <p>You can list the directories where fonts are installed in the
8462: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8463: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8464: <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 8465: Also make sure that the database file
8466: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8467: <p>Note that you should not create new directories for fonts;
8468: instead use the standard ones to avoid that the user needs to
8469: manually configure his X server to find them.</p>
8470: </div>
1.41 asau 8471: <div class="sect2">
1.1 dsieger 8472: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8473: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8474: <p>If a package installs GTK2 immodules or loaders, you need to
8475: take some extra steps to get them registered in the GTK2 database
8476: properly:</p>
1.23 wiz 8477: <div class="orderedlist"><ol class="orderedlist" type="1">
8478: <li class="listitem"><p>Include
1.1 dsieger 8479: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8480: <code class="filename">buildlink3.mk</code> file. This takes care of
8481: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8482: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8483: your package installs GTK2 immodules.</p></li>
1.23 wiz 8484: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8485: GTK2 loaders.</p></li>
1.23 wiz 8486: <li class="listitem">
1.1 dsieger 8487: <p>Patch the package to not touch any of the GTK2
8488: databases directly. These are:</p>
1.41 asau 8489: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8490: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8491: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 8492: </ul></div>
8493: </li>
1.23 wiz 8494: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 8495: any entries under the <code class="filename">libdata/gtk-2.0</code>
8496: directory, as they will be handled automatically.</p></li>
8497: </ol></div>
8498: </div>
1.41 asau 8499: <div class="sect2">
1.1 dsieger 8500: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8501: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8502: <p>If a package installs SGML or XML data files that need to be
8503: registered in system-wide catalogs (like DTDs, sub-catalogs,
8504: etc.), you need to take some extra steps:</p>
1.23 wiz 8505: <div class="orderedlist"><ol class="orderedlist" type="1">
8506: <li class="listitem"><p>Include
1.1 dsieger 8507: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8508: your <code class="filename">Makefile</code>, which takes care of
8509: registering those files in system-wide catalogs at
8510: installation and deinstallation time.</p></li>
1.23 wiz 8511: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 8512: any SGML catalogs installed by the package.</p></li>
1.23 wiz 8513: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 8514: any XML catalogs installed by the package.</p></li>
1.23 wiz 8515: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 8516: to be added to the SGML catalog. These come in groups of
8517: three strings; see xmlcatmgr(1) for more information
8518: (specifically, arguments recognized by the 'add' action).
8519: Note that you will normally not use this variable.</p></li>
1.23 wiz 8520: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 8521: to be added to the XML catalog. These come in groups of three
8522: strings; see xmlcatmgr(1) for more information (specifically,
8523: arguments recognized by the 'add' action). Note that you will
8524: normally not use this variable.</p></li>
8525: </ol></div>
8526: </div>
1.41 asau 8527: <div class="sect2">
1.1 dsieger 8528: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8529: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 8530: <p>If a package provides extensions to the MIME database by
8531: installing <code class="filename">.xml</code> files inside
8532: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8533: need to take some extra steps to ensure that the database is kept
8534: consistent with respect to these new files:</p>
1.23 wiz 8535: <div class="orderedlist"><ol class="orderedlist" type="1">
8536: <li class="listitem"><p>Include
1.1 dsieger 8537: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8538: (avoid using the <code class="filename">buildlink3.mk</code> file from
8539: this same directory, which is reserved for inclusion from
8540: other <code class="filename">buildlink3.mk</code> files). It takes
8541: care of rebuilding the MIME database at installation and
8542: deinstallation time, and disallows any access to it directly
8543: from the package.</p></li>
1.23 wiz 8544: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8545: <code class="filename">share/mime</code> directory,
8546: <span class="emphasis"><em>except</em></span> for files saved under
8547: <code class="filename">share/mime/packages</code>. The former are
8548: handled automatically by
8549: the update-mime-database program, but the latter are
8550: package-dependent and must be removed by the package that
8551: installed them in the first place.</p></li>
1.23 wiz 8552: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 8553: from the PLIST. They will be handled by the shared-mime-info
8554: package.</p></li>
8555: </ol></div>
8556: </div>
1.41 asau 8557: <div class="sect2">
1.1 dsieger 8558: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8559: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 8560: <p>If a package uses intltool during its build, add
8561: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
8562: which forces it to use the intltool package provided by pkgsrc,
8563: instead of the one bundled with the distribution file.</p>
8564: <p>This tracks intltool's build-time dependencies and uses the
8565: latest available version; this way, the package benefits of any
8566: bug fixes that may have appeared since it was released.</p>
8567: </div>
1.41 asau 8568: <div class="sect2">
1.1 dsieger 8569: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8570: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 8571: <p>If a package contains a rc.d script, it won't be copied into
8572: the startup directory by default, but you can enable it, by adding
8573: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 8574: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 8575: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8576: it will automatically remove the scripts when the package is
8577: deinstalled.</p>
8578: </div>
1.41 asau 8579: <div class="sect2">
1.1 dsieger 8580: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8581: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 8582: <p>If a package installs TeX packages into the texmf tree,
8583: the <code class="filename">ls-R</code> database of the tree needs to be
8584: updated.</p>
1.41 asau 8585: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8586: <h3 class="title">Note</h3>
1.22 jakllsch 8587: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 8588: packages should install files
1.22 jakllsch 8589: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
8590: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 8591: </div>
1.23 wiz 8592: <div class="orderedlist"><ol class="orderedlist" type="1">
8593: <li class="listitem"><p>Include
1.22 jakllsch 8594: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 8595: takes care of rebuilding the <code class="filename">ls-R</code>
8596: database at installation and deinstallation time.</p></li>
1.23 wiz 8597: <li class="listitem">
1.1 dsieger 8598: <p>If your package installs files into a texmf
8599: tree other than the one
1.22 jakllsch 8600: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
8601: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 8602: trees that need database update.</p>
8603: <p>If your package also installs font map files that need
1.10 hubertf 8604: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 8605: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 8606: set <code class="varname">TEX_MAP_FILES</code> and/or
8607: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 8608: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 8609: be run automatically at installation/deinstallation to
8610: enable/disable font map files for TeX output
8611: drivers.</p>
8612: </li>
1.23 wiz 8613: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 8614: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 8615: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 8616: </ol></div>
8617: </div>
1.41 asau 8618: <div class="sect2">
1.1 dsieger 8619: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8620: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.1 dsieger 8621: emulation</h3></div></div></div>
8622: <p>There are some packages that provide libraries and
8623: executables for running binaries from a one operating system
8624: on a different one (if the latter supports it). One example
8625: is running Linux binaries on NetBSD.</p>
1.137 leot 8626: <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 8627: helps in extracting and packaging Linux rpm packages.</p>
8628: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 8629: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 8630: if all libraries for each installed executable can be found by
8631: the dynamic linker. Since the standard dynamic linker is run,
8632: this fails for emulation packages, because the libraries used
8633: by the emulation are not in the standard directories.</p>
8634: </div>
1.41 asau 8635: <div class="sect2">
1.1 dsieger 8636: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8637: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 8638: <p>If a package installs images under the
8639: <code class="filename">share/icons/hicolor</code> and/or updates the
8640: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8641: database, you need to take some extra steps to make sure that the
8642: shared theme directory is handled appropriately and that the cache
8643: database is rebuilt:</p>
1.23 wiz 8644: <div class="orderedlist"><ol class="orderedlist" type="1">
8645: <li class="listitem"><p>Include
1.1 dsieger 8646: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 8647: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 8648: entry that refers to the theme cache.</p></li>
1.23 wiz 8649: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 8650: directories from the <code class="filename">share/icons/hicolor</code>
8651: hierarchy because they will be handled automatically.</p></li>
8652: </ol></div>
8653: <p>The best way to verify that the PLIST is correct with
8654: respect to the last two points is to regenerate it using
1.10 hubertf 8655: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 8656: </div>
1.41 asau 8657: <div class="sect2">
1.1 dsieger 8658: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8659: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 8660: <p>If a package installs <code class="filename">.desktop</code> files
8661: under <code class="filename">share/applications</code> and these include
1.53 rodent 8662: MIME information (MimeType key), you need to take extra steps to
8663: ensure that they are registered into the MIME database:</p>
1.23 wiz 8664: <div class="orderedlist"><ol class="orderedlist" type="1">
8665: <li class="listitem"><p>Include
1.1 dsieger 8666: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 8667: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 8668: <code class="filename">share/applications/mimeinfo.cache</code> file.
8669: It will be handled automatically.</p></li>
8670: </ol></div>
8671: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 8672: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 8673: print-PLIST</strong></span>.</p>
8674: </div>
8675: </div>
1.41 asau 8676: <div class="sect1">
1.1 dsieger 8677: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8678: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 8679: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 8680: immediately. In this case, one can plainly mark a package as broken. For
8681: this, one just sets the variable <code class="varname">BROKEN</code> to the
8682: reason why the package is broken (similar to the
1.162 rillig 8683: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
1.22 jakllsch 8684: the package will immediately be shown this message, and the build
8685: will not be even tried.</p>
8686: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 8687: intervals.</p>
8688: </div>
8689: </div>
1.41 asau 8690: <div class="chapter">
1.1 dsieger 8691: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 8692: <a name="debug"></a>Chapter 22. Debugging</h2></div></div></div>
1.1 dsieger 8693: <p>To check out all the gotchas when building a package, here are
8694: the steps that I do in order to get a package working. Please note
8695: this is basically the same as what was explained in the previous
8696: sections, only with some debugging aids.</p>
1.41 asau 8697: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8698: <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>
8699: <li class="listitem">
1.137 leot 8700: <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 8701: create a directory for a new package, change into it, then run
1.10 hubertf 8702: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 8703: <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>
8704: <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>
8705: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
8706: </li>
1.23 wiz 8707: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
8708: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
8709: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
8710: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 8711: configure step to the package's
8712: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 8713: <li class="listitem">
1.1 dsieger 8714: <p>Make the package compile, doing multiple rounds of</p>
8715: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8716: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
8717: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
8718: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
8719: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
8720: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
8721: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
8722: <p>Doing this step as non-root user will ensure that no files
8723: are modified that shouldn't be, especially during the build
1.10 hubertf 8724: phase. <span class="command"><strong>mkpatches</strong></span>,
8725: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.137 leot 8726: 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 8727: package.</p>
8728: </li>
1.23 wiz 8729: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
1.154 rillig 8730: 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 8731: <li class="listitem">
1.1 dsieger 8732: <p>Generate a <code class="filename">PLIST</code>:</p>
8733: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8734: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
8735: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
8736: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8737: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
8738: <p>You usually need to be <code class="username">root</code> to do
8739: this. Look if there are any files left:</p>
8740: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8741: <p>If this reveals any files that are missing in
8742: <code class="filename">PLIST</code>, add them.</p>
8743: </li>
1.23 wiz 8744: <li class="listitem">
1.1 dsieger 8745: <p>Now that the <code class="filename">PLIST</code> is OK, install the
8746: package again and make a binary package:</p>
8747: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
8748: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
8749: </li>
1.23 wiz 8750: <li class="listitem">
1.1 dsieger 8751: <p>Delete the installed package:</p>
8752: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
8753: </li>
1.23 wiz 8754: <li class="listitem">
1.10 hubertf 8755: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 8756: command, which shouldn't find anything now:</p>
8757: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8758: </li>
1.23 wiz 8759: <li class="listitem">
1.1 dsieger 8760: <p>Reinstall the binary package:</p>
8761: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
8762: </li>
1.23 wiz 8763: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
8764: <li class="listitem">
1.137 leot 8765: <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 8766: reports:</p>
8767: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
8768: </li>
1.154 rillig 8769: <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 8770: </ul></div>
8771: </div>
1.41 asau 8772: <div class="chapter">
1.1 dsieger 8773: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 8774: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 8775: <div class="toc">
8776: <p><b>Table of Contents</b></p>
1.100 leot 8777: <dl class="toc">
1.154 rillig 8778: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
8779: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
8780: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
8781: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
8782: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
8783: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
8784: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
8785: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 8786: </dl>
8787: </div>
1.41 asau 8788: <div class="sect1">
1.1 dsieger 8789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8790: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 8791: <p>Our policy is that we accept binaries only from pkgsrc
8792: developers to guarantee that the packages don't contain any
8793: trojan horses etc. This is not to annoy anyone but rather to
8794: protect our users! You're still free to put up your home-made
8795: binary packages and tell the world where to get them. NetBSD
8796: developers doing bulk builds and wanting to upload them please
1.154 rillig 8797: 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 8798: builds)</i></a>.</p>
1.1 dsieger 8799: </div>
1.41 asau 8800: <div class="sect1">
1.1 dsieger 8801: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8802: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 8803: <p>First, check that your package is complete, compiles and
1.154 rillig 8804: 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 8805: 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 8806: archive that contains all files that make up the package.
8807: Finally, send this package to the pkgsrc bug tracking system,
1.167 leot 8808: 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 8809: that, go to the web page
1.10 hubertf 8810: <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 8811: which contains some instructions and a link to a form where you
8812: can submit packages. The
1.137 leot 8813: <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 8814: also available as a substitute for either of the above two tools.
8815: </p>
1.1 dsieger 8816: <p>In the form of the problem report, the category should be
1.23 wiz 8817: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 8818: and version number, and the description field should contain a
8819: short description of your package (contents of the COMMENT
8820: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 8821: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 8822: <p>If you want to submit several packages, please send a
8823: separate PR for each one, it's easier for us to track things
8824: that way.</p>
8825: <p>Alternatively, you can also import new packages into
1.23 wiz 8826: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.105 wiz 8827: homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1 dsieger 8828: for details.</p>
8829: </div>
1.41 asau 8830: <div class="sect1">
1.1 dsieger 8831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8832: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 8833: <p>Please note all package additions, updates, moves, and
8834: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
8835: important to keep this file up to date and conforming to the
8836: existing format, because it will be used by scripts to
1.10 hubertf 8837: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 8838: sites. Additionally, check the
8839: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
8840: for the package you updated or removed, in case it was mentioned
8841: there.</p>
8842: <p>When the <code class="varname">PKGREVISION</code> of a package is
8843: bumped, the change should appear in
8844: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
8845: related or otherwise relevant. Mass bumps that result from a
8846: dependency being updated should not be mentioned. In all other
8847: cases it's the developer's decision.</p>
8848: <p>There is a make target that helps in creating proper
1.10 hubertf 8849: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 8850: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
8851: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
8852: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
8853: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 8854: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
8855: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 8856: For new packages, or package moves or removals, set the
8857: <code class="varname">CTYPE</code> variable on the command line to "Added",
8858: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 8859: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 8860: not the same as your NetBSD login name. The target also automatically
8861: removes possibly existing entries for the package in the
8862: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 8863: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 8864: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
8865: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
8866: makes the cvs commands use the main repository.
8867: </p>
1.1 dsieger 8868: </div>
1.41 asau 8869: <div class="sect1">
1.1 dsieger 8870: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8871: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 8872: <p>For several years, there have been mirrors of pkgsrc in
8873: fossil, git, and hg. Standard practise when using these tools is to
8874: make the first line of a commit message function as a summary that
8875: can be read without the rest, such as is commonly done with "git log
8876: --oneline". For this reason, we have the following guidelines for
8877: pkgsrc commit messages:</p>
8878: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8879: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 8880: big picture in 65 characters or less. When a commit is for one
1.130 wiz 8881: package, include the name of the package. For updates, include the
8882: version to which it is updated.</p></li>
8883: <li class="listitem"><p>Leave the next line empty.</p></li>
8884: <li class="listitem"><p>Then come the details for the commit (changes in that
8885: package, reason for a change) and any relevant PRs. Wrap this
8886: section.</p></li>
8887: </ul></div>
8888: <p>Here is an example:
8889: </p>
8890: <pre class="programlisting">
8891: libxslt: update to 1.0.30
8892:
8893: Changes since 1.0.29:
8894: ...
8895: </pre>
8896: <p>
8897: </p>
8898: <p>Here is another example:
8899: </p>
8900: <pre class="programlisting">
8901: mk/bsd.pkg.mk: enable SSP by default on NetBSD
8902:
8903: (rationale)
8904: </pre>
8905: <p>
8906: </p>
8907: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
8908: allowed on the pkgsrc repository to change commit messages.</p>
8909: </div>
8910: <div class="sect1">
8911: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8912: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 8913: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 8914: access to the pkgsrc repository.</p>
8915: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
8916: Start by adding the directory and then files in the directory. Don't
8917: forget to add the new package to the category's
8918: <code class="filename">Makefile</code>. Make sure you don't forget any files;
8919: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
8920: <pre class="programlisting">
8921: <code class="prompt">$</code> cd .../pkgsrc/category
8922: <code class="prompt">$</code> cvs add pkgname
8923: <code class="prompt">$</code> cd pkgname
8924: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8925: <code class="prompt">$</code> cvs add patches/p*
8926: <code class="prompt">$</code> cvs status | less
1.34 wiz 8927: <code class="prompt">$</code> cvs commit
1.33 wiz 8928: <code class="prompt">$</code> cd ..
8929: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 8930: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 8931: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 8932: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 8933: </pre>
1.1 dsieger 8934: <p>The commit message of the initial import should include part of the
8935: <code class="filename">DESCR</code> file, so people reading the mailing lists know
8936: what the package is/does.</p>
1.33 wiz 8937: <p>Also mention the new package in
8938: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
8939: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
8940: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 8941: </div>
1.41 asau 8942: <div class="sect1">
1.1 dsieger 8943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8944: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 8945: <p>Please always put a concise, appropriate and relevant summary of the
8946: changes between old and new versions into the commit log when updating
8947: a package. There are various reasons for this:</p>
1.41 asau 8948: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8949: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 8950: or its information may be overwritten by newer information.</p></li>
1.23 wiz 8951: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8952: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 8953: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8954: repository is very useful for people who read the pkgsrc-changes mailing
8955: list, so that they can make tactical decisions about when to upgrade
8956: the package.</p></li>
8957: </ul></div>
8958: <p>Please also recognize that, just because a new version of a package
8959: has been released, it should not automatically be upgraded in the CVS
8960: repository. We prefer to be conservative in the packages that are
8961: included in pkgsrc - development or beta packages are not really the
8962: best thing for most places in which pkgsrc is used. Please use your
8963: judgement about what should go into pkgsrc, and bear in mind that
8964: stability is to be preferred above new and possibly untested features.</p>
8965: </div>
1.41 asau 8966: <div class="sect1">
1.1 dsieger 8967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8968: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 8969: <p>Renaming packages is not recommended.</p>
8970: <p>When renaming packages, be sure to fix any references to old name
8971: in other Makefiles, options, buildlink files, etc.</p>
1.167 leot 8972: <p>
8973: Also when renaming a package, please add
8974: the package name and version pattern(s) of the previous package
8975: to <code class="varname">SUPERSEDES</code>.
1.20 snj 8976: This may be repeated for multiple renames.
8977: The new package would be an exact replacement.
1.167 leot 8978: Example:
1.20 snj 8979: </p>
1.167 leot 8980: <pre class="programlisting">
8981: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
8982: SUPERSEDES+= optcomp-[0-9]*
8983: </pre>
1.23 wiz 8984: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 8985: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
8986: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
8987: not be an exact replacement but is a suggestion for the replaced
8988: functionality.</p>
8989: </div>
1.41 asau 8990: <div class="sect1">
1.20 snj 8991: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8992: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 8993: <p>It is preferred that packages are not renamed or moved, but if needed
8994: please follow these steps.
8995: </p>
1.23 wiz 8996: <div class="orderedlist"><ol class="orderedlist" type="1">
8997: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
8998: <li class="listitem">
1.1 dsieger 8999: <p>Remove all CVS dirs.</p>
9000: <p>Alternatively to the first two steps you can also do:</p>
9001: <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>
9002: <p>and use that for further work.</p>
9003: </li>
1.23 wiz 9004: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9005: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9006: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9007: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 9008: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9009: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9010: for doing an update using pkgsrc building; for example, it can
1.167 leot 9011: 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 9012: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9013: new <code class="varname">PKGPATH</code> for that moved package. Note that
9014: it may have multiple matches, so the tool should also check on the
9015: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9016: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9017: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 9018: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9019: place.</p></li>
1.23 wiz 9020: <li class="listitem">
1.1 dsieger 9021: <p>Check if any package depends on it:
9022: </p>
9023: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9024: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9025: </li>
1.23 wiz 9026: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9027: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9028: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9029: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9030: <li class="listitem">
1.1 dsieger 9031: <p>Commit the changed and removed files:</p>
9032: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9033: <p>(and any packages from step 5, of course).</p>
9034: </li>
9035: </ol></div>
9036: </div>
9037: </div>
1.41 asau 9038: <div class="chapter">
1.1 dsieger 9039: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9040: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9041: <p>This section contains the answers to questions that may
9042: arise when you are writing a package. If you don't find your
9043: question answered here, first have a look in the other chapters,
9044: and if you still don't have the answer, ask on the
9045: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9046: <div class="qandaset">
1.170 ! rillig 9047: <a name="idm81678864"></a><dl>
1.154 rillig 9048: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9049: MAKEFLAGS, .MAKEFLAGS and
9050: MAKE_FLAGS?</a>
9051: </dt>
1.154 rillig 9052: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9053: MAKE, GMAKE and
9054: MAKE_PROGRAM?</a>
9055: </dt>
1.154 rillig 9056: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9057: CC, PKG_CC and
9058: PKGSRC_COMPILER?</a>
9059: </dt>
1.154 rillig 9060: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9061: BUILDLINK_LDFLAGS,
9062: BUILDLINK_LDADD and
9063: BUILDLINK_LIBS?</a>
9064: </dt>
1.154 rillig 9065: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9066: VARNAME=BUILDLINK_PREFIX.foo
9067: say it's empty?</a>
9068: </dt>
1.154 rillig 9069: <dt>24.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9070: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9071: don't understand the := inside
9072: it.</a>
9073: </dt>
1.154 rillig 9074: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9075: developers?</a>
9076: </dt>
1.154 rillig 9077: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9078: documentation?</a>
9079: </dt>
1.154 rillig 9080: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9081: do?</a>
9082: </dt>
9083: </dl>
1.41 asau 9084: <table border="0" style="width: 100%;">
9085: <colgroup>
1.1 dsieger 9086: <col align="left" width="1%">
1.23 wiz 9087: <col>
1.41 asau 9088: </colgroup>
1.1 dsieger 9089: <tbody>
1.41 asau 9090: <tr class="question">
1.1 dsieger 9091: <td align="left" valign="top">
1.170 ! rillig 9092: <a name="devfaq.makeflags"></a><a name="idm81678480"></a><p><b>24.1.</b></p>
1.1 dsieger 9093: </td>
9094: <td align="left" valign="top"><p>What is the difference between
9095: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9096: <code class="varname">MAKE_FLAGS</code>?</p></td>
9097: </tr>
9098: <tr class="answer">
9099: <td align="left" valign="top"></td>
9100: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.167 leot 9101: 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 9102: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9103: the <code class="varname">MAKE_PROGRAM</code> when building the
9104: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9105: </tr>
1.41 asau 9106: <tr class="question">
1.1 dsieger 9107: <td align="left" valign="top">
1.170 ! rillig 9108: <a name="devfaq.make"></a><a name="idm81674512"></a><p><b>24.2.</b></p>
1.1 dsieger 9109: </td>
9110: <td align="left" valign="top"><p>What is the difference between
9111: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9112: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9113: </tr>
9114: <tr class="answer">
9115: <td align="left" valign="top"></td>
9116: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.167 leot 9117: <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 9118: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9119: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9120: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9121: Make program that is used for building the
9122: package.</p></td>
9123: </tr>
1.41 asau 9124: <tr class="question">
1.1 dsieger 9125: <td align="left" valign="top">
1.170 ! rillig 9126: <a name="devfaq.cc"></a><a name="idm81670032"></a><p><b>24.3.</b></p>
1.1 dsieger 9127: </td>
9128: <td align="left" valign="top"><p>What is the difference between
9129: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9130: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9131: </tr>
9132: <tr class="answer">
9133: <td align="left" valign="top"></td>
9134: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9135: compiler, which can be configured by the pkgsrc user.
9136: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9137: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9138: path to a compiler, but the type of compiler that should be
9139: used. See <code class="filename">mk/compiler.mk</code> for more
9140: information about the latter variable.</p></td>
9141: </tr>
1.41 asau 9142: <tr class="question">
1.1 dsieger 9143: <td align="left" valign="top">
1.170 ! rillig 9144: <a name="devfaq.bl3flags"></a><a name="idm81665936"></a><p><b>24.4.</b></p>
1.1 dsieger 9145: </td>
9146: <td align="left" valign="top"><p>What is the difference between
9147: <code class="varname">BUILDLINK_LDFLAGS</code>,
9148: <code class="varname">BUILDLINK_LDADD</code> and
9149: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9150: </tr>
9151: <tr class="answer">
9152: <td align="left" valign="top"></td>
9153: <td align="left" valign="top"><p>[FIXME]</p></td>
9154: </tr>
1.41 asau 9155: <tr class="question">
1.1 dsieger 9156: <td align="left" valign="top">
1.170 ! rillig 9157: <a name="devfaq.bl3prefix"></a><a name="idm81663632"></a><p><b>24.5.</b></p>
1.1 dsieger 9158: </td>
1.10 hubertf 9159: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9160: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9161: say it's empty?</p></td>
9162: </tr>
9163: <tr class="answer">
9164: <td align="left" valign="top"></td>
9165: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 9166: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9167: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 9168: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 9169: command.</p></td>
9170: </tr>
1.41 asau 9171: <tr class="question">
1.1 dsieger 9172: <td align="left" valign="top">
1.170 ! rillig 9173: <a name="devfaq.master_sites"></a><a name="idm81660560"></a><p><b>24.6.</b></p>
1.1 dsieger 9174: </td>
9175: <td align="left" valign="top"><p>What does
1.108 rillig 9176: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9177: don't understand the <code class="code">:=</code> inside
1.1 dsieger 9178: it.</p></td>
9179: </tr>
9180: <tr class="answer">
9181: <td align="left" valign="top"></td>
1.108 rillig 9182: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
9183: assignment operator, although it looks like it.
1.1 dsieger 9184: Instead, it is a degenerate form of
1.108 rillig 9185: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.167 leot 9186: 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 9187: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 9188: case of <code class="varname">MASTER_SITE_*</code>,
9189: <em class="replaceable"><code>old_string</code></em> is the empty string and
9190: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 9191: <code class="code">package/</code>. That's where the
9192: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 9193: together.</p></td>
9194: </tr>
1.41 asau 9195: <tr class="question">
1.1 dsieger 9196: <td align="left" valign="top">
1.170 ! rillig 9197: <a name="devfaq.mailinglists"></a><a name="idm81653648"></a><p><b>24.7.</b></p>
1.1 dsieger 9198: </td>
9199: <td align="left" valign="top"><p>Which mailing lists are there for package
9200: developers?</p></td>
9201: </tr>
9202: <tr class="answer">
9203: <td align="left" valign="top"></td>
1.41 asau 9204: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 9205: <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 9206: <dd><p>This is a list for technical discussions related
9207: to pkgsrc development, e.g. soliciting feedback for changes to
9208: pkgsrc infrastructure, proposed new features, questions related
9209: to porting pkgsrc to a new platform, advice for maintaining a
9210: package, patches that affect many packages, help requests moved
9211: from pkgsrc-users when an infrastructure bug is found,
9212: etc.</p></dd>
1.10 hubertf 9213: <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 9214: <dd><p>All bug reports in category "pkg" sent with
1.167 leot 9215: <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 9216: directly; use one of the other mailing
9217: lists.</p></dd>
9218: </dl></div></td>
9219: </tr>
1.41 asau 9220: <tr class="question">
1.1 dsieger 9221: <td align="left" valign="top">
1.170 ! rillig 9222: <a name="devfaq.documentation"></a><a name="idm81649936"></a><p><b>24.8.</b></p>
1.1 dsieger 9223: </td>
9224: <td align="left" valign="top"><p>Where is the pkgsrc
9225: documentation?</p></td>
9226: </tr>
9227: <tr class="answer">
9228: <td align="left" valign="top"></td>
9229: <td align="left" valign="top">
9230: <p>There are many places where you can find
9231: documentation about pkgsrc:</p>
1.41 asau 9232: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9233: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9234: of chapters that explain large parts of pkgsrc, but some
9235: chapters tend to be outdated. Which ones they are is hard to
9236: say.</p></li>
1.23 wiz 9237: <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 9238: about certain features, announcements of new parts of the pkgsrc
9239: infrastructure and sometimes even announcements that a certain
9240: feature has been marked as obsolete. The benefit here is that
9241: each message has a date appended to it.</p></li>
1.23 wiz 9242: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9243: <code class="filename">mk/</code> directory start with a comment that
9244: describes the purpose of the file and how it can be used by the
9245: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9246: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9247: help</strong></span>.</p></li>
1.23 wiz 9248: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9249: information, but they tend to be highly abbreviated, especially
9250: for actions that occur often. Some contain a detailed
9251: description of what has changed, but they are geared towards the
9252: other pkgsrc developers, not towards an average pkgsrc user.
9253: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9254: don't know what has been before, these messages may not be worth
9255: too much to you.</p></li>
1.23 wiz 9256: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9257: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9258: mind of the developer who wrote the code. To get this
1.10 hubertf 9259: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9260: to see who has written it and ask on the
9261: <code class="literal">tech-pkg</code> mailing list, so that others can
9262: find your questions later (see above). To be sure that the
9263: developer in charge reads the mail, you may CC him or
9264: her.</p></li>
9265: </ul></div>
9266: </td>
9267: </tr>
1.41 asau 9268: <tr class="question">
1.1 dsieger 9269: <td align="left" valign="top">
1.170 ! rillig 9270: <a name="devfaq.too-much-time"></a><a name="idm81635216"></a><p><b>24.9.</b></p>
1.1 dsieger 9271: </td>
9272: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9273: do?</p></td>
9274: </tr>
9275: <tr class="answer">
9276: <td align="left" valign="top"></td>
9277: <td align="left" valign="top">
9278: <p>This is not really an FAQ yet, but here's the answer
9279: anyway.</p>
1.41 asau 9280: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9281: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.137 leot 9282: <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 9283: will tell you about newer versions of installed packages that are
9284: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9285: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9286: — it contains a list of suggested new packages and a list of
1.1 dsieger 9287: cleanups and enhancements for pkgsrc that would be nice to
9288: have.</p></li>
1.23 wiz 9289: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9290: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9291: mailing list.</p></li>
9292: </ul></div>
9293: </td>
9294: </tr>
9295: </tbody>
9296: </table>
9297: </div>
9298: </div>
1.41 asau 9299: <div class="chapter">
1.1 dsieger 9300: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9301: <a name="gnome"></a>Chapter 25. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9302: <div class="toc">
9303: <p><b>Table of Contents</b></p>
1.100 leot 9304: <dl class="toc">
1.154 rillig 9305: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
9306: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
9307: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
9308: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1 dsieger 9309: </dl>
9310: </div>
1.10 hubertf 9311: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9312: site</a>:</p>
9313: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9314: environment, an intuitive and attractive desktop for users, and the
9315: GNOME development platform, an extensive framework for building
9316: applications that integrate into the rest of the desktop.</p></blockquote></div>
9317: <p>pkgsrc provides a seamless way to automatically build and install
9318: a complete GNOME environment <span class="emphasis"><em>under many different
9319: platforms</em></span>. We can say with confidence that pkgsrc is one of
9320: the most advanced build and packaging systems for GNOME due to its
9321: included technologies buildlink3, the wrappers and tools framework and
9322: automatic configuration file management. Lots of efforts are put into
9323: achieving a completely clean deinstallation of installed software
9324: components.</p>
1.10 hubertf 9325: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9326: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9327: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9328: pkgsrc as its preferred packaging system, contributing lots of
9329: portability fixes to make GNOME build and install under it.</p>
9330: <p>This chapter is aimed at pkgsrc developers and other people
9331: interested in helping our GNOME porting and packaging efforts. It
9332: provides instructions on how to manage the existing packages and some
9333: important information regarding their internals.</p>
1.41 asau 9334: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9335: <h3 class="title">We need your help!</h3>
9336: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9337: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9338: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9339: work</a> list! There is still a long way to go to get a
9340: fully-functional GNOME desktop under NetBSD and we need your help to
9341: achieve it!</p>
9342: </div>
1.41 asau 9343: <div class="sect1">
1.1 dsieger 9344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9345: <a name="meta-packages"></a>25.1. Meta packages</h2></div></div></div>
1.1 dsieger 9346: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9347: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 9348: <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 9349: the core GNOME desktop environment. It only includes the necessary
9350: bits to get it to boot correctly, although it may lack important
9351: functionality for daily operation. The idea behind this package is
9352: to let end users build their own configurations on top of this one,
9353: first installing this meta package to achieve a functional setup and
9354: then adding individual applications.</p></li>
1.137 leot 9355: <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 9356: complete installation of the GNOME platform and desktop as defined
9357: by the GNOME project; this is based on the components distributed in
9358: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9359: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9360: official FTP server. Developer-only tools found in those
9361: directories are not installed unless required by some other
9362: component to work properly. Similarly, packages from the bindings
9363: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9364: in unless required as a dependency for an end-user component. This
1.137 leot 9365: 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>
9366: <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 9367: Installs all the tools required to build a GNOME component when
9368: fetched from the CVS repository. These are required to let the
1.10 hubertf 9369: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9370: </ul></div>
9371: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9372: sorted in a way that eases updates: a package may depend on other
9373: packages listed before it but not on any listed after it. It is very
9374: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9375: change it to alphabetical sorting!</em></span></p>
9376: </div>
1.41 asau 9377: <div class="sect1">
1.1 dsieger 9378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9379: <a name="new-package"></a>25.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9380: <p>Almost all GNOME applications are written in C and use a common
9381: set of tools as their build system. Things get different with the new
9382: bindings to other languages (such as Python), but the following will
9383: give you a general idea on the minimum required tools:</p>
1.41 asau 9384: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9385: <li class="listitem">
1.1 dsieger 9386: <p>Almost all GNOME applications use the GNU Autotools as their
9387: build system. As a general rule you will need to tell this to your
9388: package:</p>
9389: <pre class="programlisting">
9390: GNU_CONFIGURE=yes
9391: USE_LIBTOOL=yes
9392: USE_TOOLS+=gmake
9393: </pre>
9394: </li>
1.23 wiz 9395: <li class="listitem">
1.1 dsieger 9396: <p>If the package uses pkg-config to detect dependencies, add this
9397: tool to the list of required utilities:</p>
1.111 sevan 9398: <pre class="programlisting">
9399: USE_TOOLS+=pkg-config
9400: </pre>
1.137 leot 9401: <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 9402: the end of the build process to ensure that you did not miss to
9403: specify any dependency in your package and that the version
9404: requirements are all correct.</p>
9405: </li>
1.23 wiz 9406: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9407: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9408: to handle dependencies and to force the package to use the latest
9409: available version.</p></li>
1.23 wiz 9410: <li class="listitem">
1.1 dsieger 9411: <p>If the package uses gtk-doc (a documentation generation
9412: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9413: tool is rather big and the distfile should come with pregenerated
9414: documentation anyway; if it does not, it is a bug that you ought to
9415: report. For such packages you should disable gtk-doc (unless it is
9416: the default):</p>
1.111 sevan 9417: <pre class="programlisting">
9418: CONFIGURE_ARGS+=--disable-gtk-doc
9419: </pre>
1.1 dsieger 9420: <p>The default location of installed HTML files
9421: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9422: and should not be changed unless the package insists on installing
9423: them somewhere else. Otherwise programs as
1.10 hubertf 9424: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9425: do that with an entry similar to:</p>
1.111 sevan 9426: <pre class="programlisting">
9427: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9428: </pre>
1.1 dsieger 9429: </li>
9430: </ul></div>
9431: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9432: files under the installation prefix to maintain databases. In this
9433: context, shared means that those exact same directories and files are
9434: used among several different packages, leading to conflicts in the
9435: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9436: handle the most common cases, so you have to forget about using
9437: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9438: omitting shared files from them. If you find yourself doing those,
9439: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9440: <p>The following table lists the common situations that result in
9441: using shared directories or files. For each of them, the appropriate
9442: solution is given. After applying the solution be sure to
9443: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9444: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9445: <div class="table">
1.154 rillig 9446: <a name="plist-handling"></a><p class="title"><b>Table 25.1. PLIST handling for GNOME packages</b></p>
1.106 tnn 9447: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1 dsieger 9448: <colgroup>
9449: <col>
9450: <col>
9451: </colgroup>
9452: <thead><tr>
9453: <th>If the package...</th>
9454: <th>Then...</th>
9455: </tr></thead>
9456: <tbody>
9457: <tr>
9458: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.154 rillig 9459: <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 9460: </tr>
9461: <tr>
9462: <td>Installs icons under the
9463: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9464: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.154 rillig 9465: <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 9466: </tr>
9467: <tr>
9468: <td>Installs files under
9469: <code class="filename">share/mime/packages</code>.</td>
1.154 rillig 9470: <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 9471: </tr>
9472: <tr>
9473: <td>Installs <code class="filename">.desktop</code> files under
9474: <code class="filename">share/applications</code> and these include MIME
9475: information.</td>
1.154 rillig 9476: <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 9477: </tr>
9478: </tbody>
9479: </table></div>
9480: </div>
9481: <br class="table-break">
9482: </div>
1.41 asau 9483: <div class="sect1">
1.1 dsieger 9484: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9485: <a name="full-update"></a>25.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9486: <p>When seeing GNOME as a whole, there are two kinds of
9487: updates:</p>
1.41 asau 9488: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9489: <dt><span class="term">Major update</span></dt>
9490: <dd>
9491: <p>Given that there is still a very long way for GNOME 3 (if it
9492: ever appears), we consider a major update one that goes from a
9493: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9494: where <code class="literal">Y</code> is even and greater than
9495: <code class="literal">X</code>. These are hard to achieve because they
9496: introduce lots of changes in the components' code and almost all
9497: GNOME distfiles are updated to newer versions. Some of them can
9498: even break API and ABI compatibility with the previous major
9499: version series. As a result, the update needs to be done all at
9500: once to minimize breakage.</p>
9501: <p>A major update typically consists of around 80 package
9502: updates and the addition of some new ones.</p>
9503: </dd>
9504: <dt><span class="term">Minor update</span></dt>
9505: <dd>
9506: <p>We consider a minor update one that goes from a
9507: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9508: one where <code class="literal">Y</code> is greater than
9509: <code class="literal">X</code>. These are easy to achieve because they do
9510: not update all GNOME components, can be done in an incremental way
9511: and do not break API nor ABI compatibility.</p>
9512: <p>A minor update typically consists of around 50 package
9513: updates, although the numbers here may vary a lot.</p>
9514: </dd>
9515: </dl></div>
9516: <p>In order to update the GNOME components in pkgsrc to a new stable
9517: release (either major or minor), the following steps should be
9518: followed:</p>
1.23 wiz 9519: <div class="orderedlist"><ol class="orderedlist" type="1">
9520: <li class="listitem">
1.1 dsieger 9521: <p>Get a list of all the tarballs that form the new release by
9522: using the following commands. These will leave the full list of the
1.18 snj 9523: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 9524: file:</p>
9525: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9526: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9527: awk '{ print $9 }' >list.txt</code></strong>
9528: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9529: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9530: awk '{ print $9 }' >>list.txt</code></strong></pre>
9531: </li>
1.23 wiz 9532: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 9533: bump their version to the release you are updating them to. The
9534: three meta packages should be always consistent with versioning.
9535: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9536: in them.</p></li>
1.23 wiz 9537: <li class="listitem">
1.1 dsieger 9538: <p>For each meta package, update all its
9539: <code class="varname">DEPENDS</code> lines to match the latest versions as
9540: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9541: newer version (even if found in the FTP) because the meta packages
9542: are supposed to list the exact versions that form a specific GNOME
9543: release. Exceptions are permitted here if a newer version solves a
9544: serious issue in the overall desktop experience; these typically
9545: come in the form of a revision bump in pkgsrc, not in newer versions
9546: from the developers.</p>
9547: <p>Packages not listed in the <code class="filename">list.txt</code> file
9548: should be updated to the latest version available (if found in
9549: pkgsrc). This is the case, for example, of the dependencies on the
1.137 leot 9550: 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 9551: </li>
1.23 wiz 9552: <li class="listitem">
1.1 dsieger 9553: <p>Generate a patch from the modified meta packages and extract the
9554: list of "new" lines. This will provide you an outline on what
9555: packages need to be updated in pkgsrc and in what order:</p>
9556: <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>
9557: </li>
1.23 wiz 9558: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 9559: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 9560: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 9561: of <code class="filename">todo.txt</code> and update the packages listed in
9562: it in order. For major desktop updates none of these should be
9563: committed until the entire set is completed because there are chances
9564: of breaking not-yet-updated packages.</p></li>
1.23 wiz 9565: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 9566: the tree one by one with appropriate log messages. At the end,
9567: commit the three meta package updates and all the corresponding
9568: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9569: <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>
9570: </ol></div>
9571: </div>
1.41 asau 9572: <div class="sect1">
1.1 dsieger 9573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9574: <a name="patching"></a>25.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9575: <p>GNOME is a very big component in pkgsrc which approaches 100
9576: packages. Please, it is very important that you always, always,
9577: <span class="strong"><strong>always</strong></span> feed back any portability
1.154 rillig 9578: 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 9579: their attention on portability issues and to ensure that future versions
9580: can be built out-of-the box on NetBSD. The less custom patches in
9581: pkgsrc, the easier further updates are. Those developers in charge of
9582: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9583: <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 9584: Bugzilla</a>. Not all components use these to track bugs, but most
9585: of them do. Do not be short on your reports: always provide detailed
9586: explanations of the current failure, how it can be improved to achieve
9587: maximum portability and, if at all possible, provide a patch against CVS
9588: head. The more verbose you are, the higher chances of your patch being
9589: accepted.</p>
9590: <p>Also, please avoid using preprocessor magic to fix portability
9591: issues. While the FreeBSD GNOME people are doing a great job in porting
9592: GNOME to their operating system, the official GNOME sources are now
9593: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9594: and similar macros. This hurts portability. Please see our patching
1.154 rillig 9595: 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 9596: details.</p>
9597: </div>
9598: </div>
9599: </div>
1.41 asau 9600: <div class="part">
1.1 dsieger 9601: <div class="titlepage"><div><div><h1 class="title">
9602: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 9603: <div class="partintro">
1.1 dsieger 9604: <div></div>
9605: <p>This part of the guide deals with everything
9606: from the infrastructure that is behind the interfaces described
9607: in the developer's guide. A casual package maintainer should not
9608: need anything from this part.</p>
9609: <div class="toc">
9610: <p><b>Table of Contents</b></p>
1.100 leot 9611: <dl class="toc">
1.154 rillig 9612: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 9613: <dd><dl>
1.154 rillig 9614: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
9615: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
9616: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 9617: <dd><dl>
1.154 rillig 9618: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
9619: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 9620: </dl></dd>
1.154 rillig 9621: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
9622: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9623: <dd><dl>
1.154 rillig 9624: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
9625: <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 9626: </dl></dd>
1.154 rillig 9627: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9628: <dd><dl>
1.154 rillig 9629: <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>
9630: <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 9631: </dl></dd>
9632: </dl></dd>
1.154 rillig 9633: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1 dsieger 9634: <dd><dl>
1.154 rillig 9635: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
9636: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9637: <dd><dl>
1.154 rillig 9638: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
9639: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 9640: </dl></dd>
9641: </dl></dd>
1.154 rillig 9642: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
9643: <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 9644: </dl>
9645: </div>
9646: </div>
1.41 asau 9647: <div class="chapter">
1.1 dsieger 9648: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9649: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 9650: <div class="toc">
9651: <p><b>Table of Contents</b></p>
1.100 leot 9652: <dl class="toc">
1.154 rillig 9653: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
9654: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
9655: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 9656: <dd><dl>
1.154 rillig 9657: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
9658: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 9659: </dl></dd>
1.154 rillig 9660: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
9661: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9662: <dd><dl>
1.154 rillig 9663: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
9664: <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 9665: </dl></dd>
1.154 rillig 9666: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9667: <dd><dl>
1.154 rillig 9668: <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>
9669: <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 9670: </dl></dd>
9671: </dl>
9672: </div>
9673: <p>The pkgsrc infrastructure consists of many small Makefile
9674: fragments. Each such fragment needs a properly specified
9675: interface. This chapter explains how such an interface looks
9676: like.</p>
1.41 asau 9677: <div class="sect1">
1.1 dsieger 9678: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9679: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 9680: <p>Whenever a variable is defined in the pkgsrc
9681: infrastructure, the location and the way of definition provide
9682: much information about the intended use of that variable.
9683: Additionally, more documentation may be found in a header
9684: comment or in this pkgsrc guide.</p>
9685: <p>A special file is
9686: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9687: variables that are intended to be user-defined. They are either
9688: defined using the <code class="literal">?=</code> operator or they are
9689: left undefined because defining them to anything would
1.23 wiz 9690: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 9691: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9692: file.</p>
9693: <p>Outside this file, the following conventions apply:
9694: Variables that are defined using the <code class="literal">?=</code>
9695: operator may be overridden by a package.</p>
9696: <p>Variables that are defined using the <code class="literal">=</code>
9697: operator may be used read-only at run-time.</p>
9698: <p>Variables whose name starts with an underscore must not be
9699: accessed outside the pkgsrc infrastructure at all. They may
9700: change without further notice.</p>
1.41 asau 9701: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9702: <h3 class="title">Note</h3>
9703: <p>These conventions are currently not applied
9704: consistently to the complete pkgsrc
9705: infrastructure.</p>
9706: </div>
9707: </div>
1.41 asau 9708: <div class="sect1">
1.1 dsieger 9709: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9710: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 9711: <p>All variables that contain lists of things should default
9712: to being empty. Two examples that do not follow this rule are
9713: <code class="varname">USE_LANGUAGES</code> and
9714: <code class="varname">DISTFILES</code>. These variables cannot simply be
9715: modified using the <code class="literal">+=</code> operator in package
9716: <code class="filename">Makefile</code>s (or other files included by
9717: them), since there is no guarantee whether the variable is
9718: already set or not, and what its value is. In the case of
1.23 wiz 9719: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 9720: the default value and just define it as in the following
9721: example.</p>
9722: <pre class="programlisting">
9723: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
9724: </pre>
9725: <p>Because of the selection of this default value, the same
9726: value appears in many package Makefiles. Similarly for
9727: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 9728: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 9729: doesn't stand out. Nevertheless it is mentioned in many
9730: files.</p>
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="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.41 asau 9735: <div class="sect2">
1.1 dsieger 9736: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9737: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.1 dsieger 9738: <p>Variable evaluation takes place either at load time or at
9739: runtime, depending on the context in which they occur. The
9740: contexts where variables are evaluated at load time are:</p>
1.41 asau 9741: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9742: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 9743: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 9744: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 9745: <code class="literal">.for</code>,</p></li>
1.23 wiz 9746: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 9747: </ul></div>
9748: <p>A special exception are references to the iteration
9749: variables of <code class="literal">.for</code> loops, which are expanded
9750: inline, no matter in which context they appear.</p>
9751: <p>As the values of variables may change during load time,
9752: care must be taken not to evaluate them by accident. Typical
9753: examples for variables that should not be evaluated at load time
9754: are <code class="varname">DEPENDS</code> and
9755: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9756: clear, here is an example:</p>
9757: <pre class="programlisting">
9758: CONFIGURE_ARGS= # none
9759: CFLAGS= -O
9760: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
9761:
9762: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
9763:
9764: CFLAGS+= -Wall
1.111 sevan 9765: </pre>
1.1 dsieger 9766: <p>This code shows how the use of the <code class="literal">:=</code>
9767: operator can quickly lead to unexpected results. The first
9768: paragraph is fairly common code. The second paragraph evaluates
9769: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9770: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9771: <code class="literal">-Wall</code> is appended to the
9772: <code class="varname">CFLAGS</code>, but this addition will not appear in
9773: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9774: paragraphs from above typically occur in completely unrelated
9775: files.</p>
9776: </div>
1.41 asau 9777: <div class="sect2">
1.1 dsieger 9778: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9779: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.1 dsieger 9780: <p>After all the files have been loaded, the values of the
9781: variables cannot be changed anymore. Variables that are used in
9782: the shell commands are expanded at this point.</p>
9783: </div>
9784: </div>
1.41 asau 9785: <div class="sect1">
1.1 dsieger 9786: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9787: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 9788: <p>There are many ways in which the definition and use of a
1.108 rillig 9789: variable can be restricted in order to detect bugs and violations
9790: of the (mostly unwritten) policies. A package can be checked with
9791: <code class="literal">pkglint -Wall</code> to see whether it meets these
9792: rules.</p>
1.1 dsieger 9793: </div>
1.41 asau 9794: <div class="sect1">
1.1 dsieger 9795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9796: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 9797: <p>Most of the <code class="filename">.mk</code> files fall into one
9798: of the following classes. Cases where a file falls into more
9799: than one class should be avoided as it often leads to subtle
9800: bugs.</p>
1.41 asau 9801: <div class="sect2">
1.1 dsieger 9802: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9803: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 9804: <p>In a traditional imperative programming language some of
9805: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 9806: procedures. They take some input parameters and—after
9807: inclusion—provide a result in output parameters. Since all
1.1 dsieger 9808: variables in <code class="filename">Makefile</code>s have global scope
9809: care must be taken not to use parameter names that have already
9810: another meaning. For example, <code class="varname">PKGNAME</code> is a
9811: bad choice for a parameter name.</p>
9812: <p>Procedures are completely evaluated at preprocessing time.
9813: That is, when calling a procedure all input parameters must be
9814: completely resolvable. For example,
9815: <code class="varname">CONFIGURE_ARGS</code> should never be an input
9816: parameter since it is very likely that further text will be
9817: added after calling the procedure, which would effectively apply
9818: the procedure to only a part of the variable. Also, references
1.108 rillig 9819: to other variables will be modified after calling the
1.1 dsieger 9820: procedure.</p>
9821: <p>A procedure can declare its output parameters either as
9822: suitable for use in preprocessing directives or as only
9823: available at runtime. The latter alternative is for variables
9824: that contain references to other runtime variables.</p>
9825: <p>Procedures shall be written such that it is possible to
9826: call the procedure more than once. That is, the file must not
9827: contain multiple-inclusion guards.</p>
9828: <p>Examples for procedures are
9829: <code class="filename">mk/bsd.options.mk</code> and
9830: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
9831: that the parameters are evaluated at load time, they should be
9832: assigned using the <code class="literal">:=</code> operator, which should
9833: be used only for this purpose.</p>
9834: </div>
1.41 asau 9835: <div class="sect2">
1.1 dsieger 9836: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9837: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 9838: <p>Action files take some input parameters and may define
9839: runtime variables. They shall not define loadtime variables.
9840: There are action files that are included implicitly by the
9841: pkgsrc infrastructure, while other must be included
9842: explicitly.</p>
9843: <p>An example for action files is
9844: <code class="filename">mk/subst.mk</code>.</p>
9845: </div>
9846: </div>
1.41 asau 9847: <div class="sect1">
1.1 dsieger 9848: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9849: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 9850: <p>Package <code class="filename">Makefile</code>s usually consist of
9851: a set of variable definitions, and include the file
9852: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
9853: Before that, they may also include various other
9854: <code class="filename">*.mk</code> files if they need to query the
9855: availability of certain features like the type of compiler or
9856: the X11 implementation. Due to the heavy use of preprocessor
9857: directives like <code class="literal">.if</code> and
9858: <code class="literal">.for</code>, the order in which the files are loaded
9859: matters.</p>
9860: <p>This section describes at which point the various files
9861: are loaded and gives reasons for that order.</p>
1.41 asau 9862: <div class="sect2">
1.1 dsieger 9863: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9864: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 9865: </h3></div></div></div>
9866: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
9867: is to define some essential variables like
9868: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
9869: <code class="varname">MACHINE_ARCH</code>.</p>
9870: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 9871: 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 9872: After that, those variables
1.1 dsieger 9873: that have not been overridden by the user are loaded from
9874: <code class="filename">mk/defaults/mk.conf</code>.</p>
9875: <p>After the user settings, the system settings and platform
9876: settings are loaded, which may override the user
9877: settings.</p>
9878: <p>Then, the tool definitions are loaded. The tool wrappers
9879: are not yet in effect. This only happens when building a
9880: package, so the proper variables must be used instead of the
9881: direct tool names.</p>
9882: <p>As the last steps, some essential variables from the
9883: wrapper and the package system flavor are loaded, as well as the
9884: variables that have been cached in earlier phases of a package
9885: build.</p>
9886: </div>
1.41 asau 9887: <div class="sect2">
1.1 dsieger 9888: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9889: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 9890: </h3></div></div></div>
9891: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
9892: <p>Then, the various <code class="filename">*-vars.mk</code> files are
9893: loaded, which fill default values for those variables that have
9894: not been defined by the package. These variables may later
9895: be used even in unrelated files.</p>
9896: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
9897: provides the target <code class="literal">error-check</code> that is added
9898: as a special dependency to all other targets that use
9899: <code class="varname">DELAYED_ERROR_MSG</code> or
9900: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
9901: <p>Then, the package-specific hacks from
9902: <code class="filename">hacks.mk</code> are included.</p>
9903: <p>Then, various other files follow. Most of them don't have
9904: any dependencies on what they need to have included before or
9905: after them, though some do.</p>
9906: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
9907: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
9908: restricts the use of these variables to all the files that have
9909: been included before. Appearances in later files will be
9910: silently ignored.</p>
9911: <p>Then, the files for the main targets are included, in the
9912: order of later execution, though the actual order should not
9913: matter.</p>
9914: <p>At last, some more files are included that don't set any
9915: interesting variables but rather just define make targets to be
9916: executed.</p>
9917: </div>
9918: </div>
9919: </div>
1.41 asau 9920: <div class="chapter">
1.1 dsieger 9921: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9922: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.1 dsieger 9923: <div class="toc">
9924: <p><b>Table of Contents</b></p>
1.100 leot 9925: <dl class="toc">
1.154 rillig 9926: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
9927: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9928: <dd><dl>
1.154 rillig 9929: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
9930: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 9931: </dl></dd>
9932: </dl>
9933: </div>
9934: <p>The pkgsrc infrastructure consists of a large codebase,
9935: and there are many corners where every little bit of a file is
9936: well thought out, making pkgsrc likely to fail as soon as
9937: anything is changed near those parts. To prevent most changes
9938: from breaking anything, a suite of regression tests should go
9939: along with every important part of the pkgsrc infrastructure.
9940: This chapter describes how regression tests work in pkgsrc and
9941: how you can add new tests.</p>
1.41 asau 9942: <div class="sect1">
1.1 dsieger 9943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9944: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.137 leot 9945: <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 9946: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 9947: can simply run that command, which will run all tests in the
1.168 rillig 9948: <code class="filename">regress/</code> directory.</p>
1.1 dsieger 9949: </div>
1.41 asau 9950: <div class="sect1">
1.1 dsieger 9951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9952: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.168 rillig 9953: <p>Every directory in the <code class="filename">regress/</code>
9954: directory that contains a file called <code class="filename">spec</code>
1.1 dsieger 9955: is considered a regression test. This file is a shell program
1.10 hubertf 9956: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 9957: The following functions can be overridden to suit your
9958: needs.</p>
1.41 asau 9959: <div class="sect2">
1.1 dsieger 9960: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9961: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 9962: <p>These functions do not take any parameters. Although they
9963: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.168 rillig 9964: first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108 rillig 9965: question</a> for details.</p>
1.41 asau 9966: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9967: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 9968: <dd><p>This function prepares the environment for the
9969: test. By default it does nothing.</p></dd>
1.108 rillig 9970: <dt><span class="term"><code class="varname">do_test</code></span></dt>
9971: <dd>
9972: <p>This function runs the actual test. By default,
1.1 dsieger 9973: it calls <code class="varname">TEST_MAKE</code> with the arguments
9974: <code class="varname">MAKEARGS_TEST</code> and writes its output including
9975: error messages into the file
1.108 rillig 9976: <code class="varname">TEST_OUTFILE</code>.</p>
9977: <p>When defining this function, make sure that all output that
9978: needs to be checked is written to the correct output file.
9979: Example:</p>
9980: <pre class="programlisting">
9981: do_test() {
1.112 rillig 9982: echo "Example output"
1.108 rillig 9983: } 1>$TEST_OUTFILE 2>&1
9984: </pre>
9985: </dd>
9986: <dt><span class="term"><code class="varname">check_result</code></span></dt>
9987: <dd>
9988: <p>This function is run after the test and is
1.1 dsieger 9989: typically used to compare the actual output from the one that is
9990: expected. It can make use of the various helper functions from
1.108 rillig 9991: the next section. Example:</p>
9992: <pre class="programlisting">
9993: check_result() {
1.112 rillig 9994: exit_status 0
9995: output_require "Example"
9996: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9997: output_prohibit "no such file or directory"
1.168 rillig 9998: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 9999: }
10000: </pre>
10001: </dd>
10002: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 10003: <dd><p>This function cleans everything up after the
10004: test has been run. By default it does nothing.</p></dd>
10005: </dl></div>
10006: </div>
1.41 asau 10007: <div class="sect2">
1.1 dsieger 10008: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10009: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.41 asau 10010: <div class="variablelist"><dl class="variablelist">
1.168 rillig 10011: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10012: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108 rillig 10013: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 10014: <dd><p>This function compares the exitcode of the
1.108 rillig 10015: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 10016: If they differ, the test will fail.</p></dd>
1.108 rillig 10017: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10018: <dd>
10019: <p>This function checks for each of its parameters
10020: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 10021: extended regular expression. If it does not, the test will
1.108 rillig 10022: fail. Example:</p>
10023: <pre class="programlisting">
10024: output_require "looks fine"
10025: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10026: </pre>
10027: </dd>
1.1 dsieger 10028: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10029: <dd><p>This function checks for each of its parameters
1.10 hubertf 10030: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10031: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10032: If any of the regular expressions matches, the test will
10033: fail.</p></dd>
10034: </dl></div>
10035: </div>
10036: </div>
10037: </div>
1.41 asau 10038: <div class="chapter">
1.1 dsieger 10039: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 10040: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10041: <div class="toc">
10042: <p><b>Table of Contents</b></p>
1.154 rillig 10043: <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 10044: </div>
10045: <p>The pkgsrc system has already been ported to many
10046: operating systems, hardware architectures and compilers. This
10047: chapter explains the necessary steps to make pkgsrc even more
10048: portable.</p>
1.41 asau 10049: <div class="sect1">
1.1 dsieger 10050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10051: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10052: <p>To port pkgsrc to a new operating system (called
10053: <code class="literal">MyOS</code> in this example), you need to touch the
10054: following files:</p>
1.41 asau 10055: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10056: <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>
10057: <dd><p>This file contains some basic definitions, for
10058: example the name of the C
10059: compiler.</p></dd>
10060: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10061: <dd><p>Insert code that defines the variables
10062: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10063: <code class="varname">LOWER_OS_VERSION</code>,
10064: <code class="varname">LOWER_VENDOR</code>,
10065: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10066: <code class="varname">APPEND_ELF</code>, and the other variables that
10067: appear in this file.</p></dd>
10068: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10069: <dd><p>This file contains the platform-specific
10070: definitions that are used by pkgsrc. Start by copying one of the
10071: other files and edit it to your
10072: needs.</p></dd>
10073: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10074: <dd><p>This file defines the paths to all the tools
10075: that are needed by one or the other package in pkgsrc, as well
10076: as by pkgsrc itself. Find out where these tools are on your
10077: platform and add them.</p></dd>
10078: </dl></div>
10079: <p>Now, you should be able to build some basic packages, like
1.137 leot 10080: <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 10081: </div>
10082: </div>
10083: </div>
1.41 asau 10084: <div class="appendix">
10085: <div class="titlepage"><div><div><h1 class="title">
10086: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10087: <div class="toc">
10088: <p><b>Table of Contents</b></p>
1.100 leot 10089: <dl class="toc">
1.1 dsieger 10090: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10091: <dd><dl>
10092: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10093: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10094: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 10095: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1 dsieger 10096: </dl></dd>
10097: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10098: </dl>
10099: </div>
10100: <p>We checked to find a piece of software that wasn't in the packages
10101: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10102: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10103: present in the tree is beyond us, but it's useful for the purposes of
10104: this exercise.</p>
1.41 asau 10105: <div class="sect1">
1.1 dsieger 10106: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10107: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10108: <div class="sect2">
1.1 dsieger 10109: <div class="titlepage"><div><div><h3 class="title">
10110: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10111: <pre class="programlisting">
10112: # $NetBSD$
10113: #
10114:
10115: DISTNAME= bison-1.25
10116: CATEGORIES= devel
10117: MASTER_SITES= ${MASTER_SITE_GNU}
10118:
1.29 dholland 10119: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 10120: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10121: COMMENT= GNU yacc clone
10122:
10123: GNU_CONFIGURE= yes
1.46 wiz 10124: INFO_FILES= yes
1.1 dsieger 10125:
10126: .include "../../mk/bsd.pkg.mk"
10127: </pre>
10128: </div>
1.41 asau 10129: <div class="sect2">
1.1 dsieger 10130: <div class="titlepage"><div><div><h3 class="title">
10131: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10132: <pre class="programlisting">
10133: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.167 leot 10134: 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 10135: of the NetBSD source tree is beyond me.
10136: </pre>
10137: </div>
1.41 asau 10138: <div class="sect2">
1.1 dsieger 10139: <div class="titlepage"><div><div><h3 class="title">
10140: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10141: <pre class="programlisting">
10142: @comment $NetBSD$
10143: bin/bison
10144: man/man1/bison.1.gz
10145: share/bison.simple
10146: share/bison.hairy
10147: </pre>
10148: </div>
1.41 asau 10149: <div class="sect2">
1.1 dsieger 10150: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 10151: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 10152: </h3></div></div></div>
10153: <p>The NetBSD package system comes with
1.137 leot 10154: <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 10155: which helps to check the contents of these
10156: files. After installation it is quite easy to use, just change to the
10157: directory of the package you wish to examine and execute
1.10 hubertf 10158: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10159: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10160: looks fine.</pre>
10161: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170 ! rillig 10162: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1 dsieger 10163: -Wall</strong></span> for a very thorough check.</p>
10164: </div>
10165: </div>
1.41 asau 10166: <div class="sect1">
1.1 dsieger 10167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10168: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10169: <p>Create the directory where the package lives,
10170: plus any auxiliary directories:</p>
10171: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10172: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10173: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10174: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10175: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.154 rillig 10176: <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 10177: then continue with fetching the distfile:</p>
10178: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10179: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10180: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10181: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10182: ftp: Error retrieving file: 500 Internal error
10183:
10184: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10185: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10186: ftp: Error retrieving file: 500 Internal error
10187:
10188: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10189: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10190: Successfully retrieved file.</pre>
10191: <p>Generate the checksum of the distfile into
10192: <code class="filename">distinfo</code>:</p>
10193: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10194: <p>Now compile:</p>
10195: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10196: >> Checksum OK for bison-1.25.tar.gz.
10197: ===> Extracting for bison-1.25
10198: ===> Patching for bison-1.25
10199: ===> Ignoring empty patch directory
10200: ===> Configuring for bison-1.25
10201: creating cache ./config.cache
10202: checking for gcc... cc
10203: checking whether we are using GNU C... yes
10204: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10205: checking how to run the C preprocessor... cc -E
10206: checking for minix/config.h... no
10207: checking for POSIXized ISC... no
10208: checking whether cross-compiling... no
10209: checking for ANSI C header files... yes
10210: checking for string.h... yes
10211: checking for stdlib.h... yes
10212: checking for memory.h... yes
10213: checking for working const... yes
10214: checking for working alloca.h... no
10215: checking for alloca... yes
10216: checking for strerror... yes
10217: updating cache ./config.cache
10218: creating ./config.status
10219: creating Makefile
10220: ===> Building for bison-1.25
10221: 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
10222: 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
10223: 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
10224: 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
10225: 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
10226: 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
10227: 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
10228: 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
10229: 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
10230: 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
10231: 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
10232: 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
10233: 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
10234: 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
10235: 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
10236: 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
10237: 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
10238: 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
10239: 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
10240: 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
10241: 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
10242: 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
10243: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10244: rm -f bison.s1
10245: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10246: <p>Everything seems OK, so install the files:</p>
10247: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10248: >> Checksum OK for bison-1.25.tar.gz.
10249: ===> Installing for bison-1.25
10250: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10251: rm -f /usr/pkg/bin/bison
10252: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10253: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10254: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10255: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10256: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10257: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10258: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10259: ===> Registering installation for bison-1.25</pre>
10260: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10261: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10262: binary package, do this now:</p>
10263: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10264: >> Checksum OK for bison-1.25.tar.gz.
10265: ===> Building package for bison-1.25
10266: Creating package bison-1.25.tgz
10267: Registering depends:.
10268: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10269: <p>Now that you don't need the source and object files
10270: any more, clean up:</p>
10271: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10272: ===> Cleaning for bison-1.25</pre>
10273: </div>
10274: </div>
1.41 asau 10275: <div class="appendix">
10276: <div class="titlepage"><div><div><h1 class="title">
10277: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10278: <div class="toc">
10279: <p><b>Table of Contents</b></p>
1.100 leot 10280: <dl class="toc">
1.1 dsieger 10281: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10282: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10283: </dl>
10284: </div>
1.41 asau 10285: <div class="sect1">
1.1 dsieger 10286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10287: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10288: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10289: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10290: => figlet221.tar.gz doesn't seem to exist on this system.
10291: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10292: => [172219 bytes]
10293: Connected to ftp.plig.net.
10294: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10295: 331 Guest login ok, send your complete e-mail address as password.
10296: 230-You are user #5 of 500 simultaneous users allowed.
10297: 230-
10298: 230- ___ _ _ _
10299: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10300: 230- | _| _| . |_| . | | | . |_| . | _| . |
10301: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10302: 230- |_| |_| |___| |___|
10303: 230-
10304: 230-** Welcome to ftp.plig.org **
10305: 230-
10306: 230-Please note that all transfers from this FTP site are logged. If you
10307: 230-do not like this, please disconnect now.
10308: 230-
1.18 snj 10309: 230-This archive is available via
1.1 dsieger 10310: 230-
10311: 230-HTTP: http://ftp.plig.org/
10312: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10313: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10314: 230-
10315: 230-Please email comments, bug reports and requests for packages to be
10316: 230-mirrored to ftp-admin@plig.org.
10317: 230-
10318: 230-
10319: 230 Logged in anonymously.
10320: Remote system type is UNIX.
10321: Using binary mode to transfer files.
10322: 200 Type okay.
10323: 250 "/pub" is new cwd.
10324: 250-"/pub/figlet" is new cwd.
10325: 250-
10326: 250-Welcome to the figlet archive at ftp.figlet.org
10327: 250-
10328: 250- ftp://ftp.figlet.org/pub/figlet/
10329: 250-
10330: 250-The official FIGlet web page is:
10331: 250- http://www.figlet.org/
10332: 250-
10333: 250-If you have questions, please mailto:info@figlet.org. If you want to
10334: 250-contribute a font or something else, you can email us.
10335: 250
10336: 250 "/pub/figlet/program" is new cwd.
10337: 250 "/pub/figlet/program/unix" is new cwd.
10338: local: figlet221.tar.gz remote: figlet221.tar.gz
10339: 502 Unimplemented command.
10340: 227 Entering Passive Mode (195,40,6,41,246,104)
10341: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10342: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10343: 226 Transfer completed.
10344: 172219 bytes received in 00:02 (75.99 KB/s)
10345: 221 Goodbye.
10346: => Checksum OK for figlet221.tar.gz.
10347: ===> Extracting for figlet-2.2.1nb2
10348: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10349: ===> Patching for figlet-2.2.1nb2
10350: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10351: ===> Overriding tools for figlet-2.2.1nb2
10352: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10353: ===> Configuring for figlet-2.2.1nb2
10354: ===> Building for figlet-2.2.1nb2
10355: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10356: chmod a+x figlet
10357: gcc -O2 -o chkfont chkfont.c
10358: => Unwrapping files-to-be-installed.
10359: <code class="prompt">#</code>
10360: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10361: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10362: ===> Installing for figlet-2.2.1nb2
10363: install -d -o root -g wheel -m 755 /usr/pkg/bin
10364: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10365: mkdir -p /usr/pkg/share/figlet
10366: cp figlet /usr/pkg/bin
10367: cp chkfont /usr/pkg/bin
10368: chmod 555 figlist showfigfonts
10369: cp figlist /usr/pkg/bin
10370: cp showfigfonts /usr/pkg/bin
10371: cp fonts/*.flf /usr/pkg/share/figlet
10372: cp fonts/*.flc /usr/pkg/share/figlet
10373: cp figlet.6 /usr/pkg/man/man6
10374: ===> Registering installation for figlet-2.2.1nb2
10375: <code class="prompt">#</code></pre>
10376: </div>
1.41 asau 10377: <div class="sect1">
1.1 dsieger 10378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10379: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10380: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10381: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10382: ===> Packaging figlet-2.2.1nb2
10383: ===> Building binary package for figlet-2.2.1nb2
10384: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10385: Using SrcDir value of /usr/pkg
10386: Registering depends:.
10387: <code class="prompt">#</code></pre>
10388: </div>
10389: </div>
1.41 asau 10390: <div class="appendix">
10391: <div class="titlepage"><div><div><h1 class="title">
10392: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10393: <div class="toc">
10394: <p><b>Table of Contents</b></p>
1.100 leot 10395: <dl class="toc">
1.23 wiz 10396: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10397: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10398: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10399: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10400: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148 leot 10401: <code class="filename">stable</code>,
1.23 wiz 10402: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10403: source packages</a></span></dt>
10404: </dl>
10405: </div>
10406: <p>As in other big projects, the directory layout of pkgsrc
10407: is quite complex for newbies. This chapter explains where you
10408: find things on the FTP server. The base directory on
1.10 hubertf 10409: <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 10410: On other servers it may be different, but inside this directory,
10411: everything should look the same, no matter on which server you
10412: are. This directory contains some subdirectories, which are
10413: explained below.</p>
1.41 asau 10414: <div class="sect1">
1.1 dsieger 10415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10416: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10417: <p>The directory <code class="filename">distfiles</code> contains lots
10418: of archive files from all pkgsrc packages, which are mirrored
10419: here. The subdirectories are called after their package names
10420: and are used when the distributed files have names that don't
10421: explicitly contain a version number or are otherwise too generic
10422: (for example <code class="filename">release.tar.gz</code>).</p>
10423: </div>
1.41 asau 10424: <div class="sect1">
1.1 dsieger 10425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10426: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10427: <p>This directory contains things that individual pkgsrc
10428: developers find worth publishing.</p>
10429: </div>
1.41 asau 10430: <div class="sect1">
1.1 dsieger 10431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10432: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10433: <p>This directory contains binary packages for the various
10434: platforms that are supported by pkgsrc.
10435: 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 10436: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10437: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10438: operating system for which the packages have been built. The
1.10 hubertf 10439: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10440: command, so it may differ from the one you are used to
10441: hear.</p></li>
1.23 wiz 10442: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10443: architecture of the platform for which the packages have been
1.10 hubertf 10444: built. It also includes the <code class="varname">ABI</code> (Application
10445: Binary Interface) for platforms that have several of
10446: them.</p></li>
1.23 wiz 10447: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10448: the operating system. For version numbers that change often (for
10449: example NetBSD-current), the often-changing part should be
10450: replaced with an <code class="literal">x</code>, for example
10451: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10452: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10453: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10454: for a stable branch, or <code class="literal">head</code> for packages
10455: built from the HEAD branch. The latter should only be used when
10456: the packages are updated on a regular basis. Otherwise the date
10457: from checking out pkgsrc should be appended, for example
10458: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10459: </ul></div>
10460: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10461: can quickly click through the directories on the
10462: server and find the best binary packages for their machines. Since they
10463: usually know the operating system and the hardware architecture, OPSYS
10464: and ARCH are placed first. After these choices, they can select the
10465: best combination of OSVERSION and TAG together, since it is usually the
10466: case that packages stay compatible between different version of the
10467: operating system.</p>
10468: <p>In each of these directories, there is a
10469: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10470: <code class="filename">All</code> which contains all binary packages.
10471: Besides that, there are various category directories that
10472: contain symbolic links to the real binary packages.</p>
10473: </div>
1.41 asau 10474: <div class="sect1">
1.1 dsieger 10475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10476: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10477: <p>Here are the reports from bulk builds, for those who want
10478: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10479: 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 10480: </div>
1.41 asau 10481: <div class="sect1">
1.8 rillig 10482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10483: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.148 leot 10484: <code class="filename">stable</code>,
1.22 jakllsch 10485: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10486: source packages</h2></div></div></div>
1.23 wiz 10487: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10488: that is the files that define how to create binary packages from
10489: source archives.</p>
1.149 leot 10490: <p>Each of the <code class="filename">current</code>,
10491: <code class="filename">stable</code> and
10492: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
10493: directories share the same structure. They each contain a
10494: <code class="filename">pkgsrc</code> directory and
10495: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 10496: <p>The directory <code class="filename">pkgsrc</code> contains a
10497: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 10498: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
10499: as the directory, ready to be downloaded as a whole.</p>
10500: <p>The <code class="filename">current</code> directory contains files
10501: related to the HEAD branch of the CVS repository.
10502: In this directory there is an additional file called
10503: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
10504: all pkgsrc <code class="filename">README</code>s with information about
10505: categories and packages.
10506: </p>
10507: <p>The <code class="filename">stable</code> directory is a symlink to
10508: the latest
10509: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
10510: </p>
10511: <p>The
10512: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
10513: directories contain files related to the
10514: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
10515: stable branch of the CVS repository. In these directories there is
10516: an additional file called
10517: <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 10518: which contains the state of pkgsrc when it was branched.</p>
10519: </div>
10520: </div>
1.41 asau 10521: <div class="appendix">
10522: <div class="titlepage"><div><div><h1 class="title">
1.154 rillig 10523: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
10524: <p>
10525: The following list contains all help topics that are available
10526: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
10527: </p>
1.156 leot 10528: <table border="0" summary="Simple list" class="simplelist">
10529: <tr>
10530: <td>#!</td>
10531: <td>-lintl</td>
10532: </tr>
10533: <tr>
10534: <td>64bit</td>
10535: <td>ABI</td>
10536: </tr>
10537: <tr>
10538: <td>ACCEPTABLE_LICENSES</td>
10539: <td>ACROREAD_FONTPATH</td>
10540: </tr>
10541: <tr>
10542: <td>ADDITIONAL</td>
10543: <td>AFAIK</td>
10544: </tr>
10545: <tr>
10546: <td>AIX</td>
10547: <td>ALLOW_VULNERABLE_PACKAGES</td>
10548: </tr>
10549: <tr>
10550: <td>ALL_ENV</td>
1.161 leot 10551: <td>ALSA_PC</td>
10552: </tr>
10553: <tr>
1.160 brook 10554: <td>ALTERNATIVES_SRC</td>
1.161 leot 10555: <td>AMANDA_TMP</td>
1.159 rillig 10556: </tr>
10557: <tr>
1.160 brook 10558: <td>AMANDA_USER</td>
1.161 leot 10559: <td>AMANDA_VAR</td>
1.156 leot 10560: </tr>
10561: <tr>
1.160 brook 10562: <td>APACHE_GROUP</td>
1.161 leot 10563: <td>APACHE_MODULE_NAME</td>
1.156 leot 10564: </tr>
10565: <tr>
1.160 brook 10566: <td>APACHE_MODULE_SRC</td>
1.161 leot 10567: <td>APACHE_MODULE_SRCDIR</td>
1.156 leot 10568: </tr>
10569: <tr>
1.160 brook 10570: <td>APACHE_PKG_PREFIX</td>
1.161 leot 10571: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.156 leot 10572: </tr>
10573: <tr>
1.160 brook 10574: <td>APACHE_SUEXEC_DOCROOT</td>
1.161 leot 10575: <td>APACHE_USER</td>
1.156 leot 10576: </tr>
10577: <tr>
1.160 brook 10578: <td>APPEND_ABI</td>
1.161 leot 10579: <td>APPEND_ELF</td>
1.156 leot 10580: </tr>
10581: <tr>
1.160 brook 10582: <td>ARLA_CACHE</td>
1.161 leot 10583: <td>AUDIT_PACKAGES_FLAGS</td>
1.156 leot 10584: </tr>
10585: <tr>
1.160 brook 10586: <td>AUTOCONF_REQD</td>
1.161 leot 10587: <td>AUTOMAKE_OVERRIDE</td>
1.156 leot 10588: </tr>
10589: <tr>
1.160 brook 10590: <td>AUTOMAKE_REQD</td>
1.161 leot 10591: <td>AUTO_MKDIRS</td>
1.156 leot 10592: </tr>
10593: <tr>
1.160 brook 10594: <td>BDB185_DEFAULT</td>
1.161 leot 10595: <td>BDBBASE</td>
1.156 leot 10596: </tr>
10597: <tr>
1.160 brook 10598: <td>BDB_ACCEPTED</td>
1.161 leot 10599: <td>BDB_DEFAULT</td>
1.156 leot 10600: </tr>
10601: <tr>
1.160 brook 10602: <td>BDB_LIBS</td>
1.161 leot 10603: <td>BDB_TYPE</td>
1.156 leot 10604: </tr>
10605: <tr>
1.160 brook 10606: <td>BIND_DIR</td>
1.161 leot 10607: <td>BIND_GROUP</td>
1.156 leot 10608: </tr>
10609: <tr>
1.160 brook 10610: <td>BIND_USER</td>
1.161 leot 10611: <td>BINPKG_SITES</td>
1.156 leot 10612: </tr>
10613: <tr>
1.160 brook 10614: <td>BIN_INSTALL_FLAGS</td>
1.161 leot 10615: <td>BISON_PKGDATADIR</td>
10616: </tr>
10617: <tr>
10618: <td>BLAS_ACCEPTED</td>
10619: <td>BLAS_LIBS</td>
1.156 leot 10620: </tr>
10621: <tr>
1.161 leot 10622: <td>BLAS_TYPE</td>
1.156 leot 10623: <td>BOOTSTRAP_DEPENDS</td>
10624: </tr>
10625: <tr>
10626: <td>BOOTSTRAP_SETUPTOOLS</td>
10627: <td>BROKEN</td>
10628: </tr>
10629: <tr>
10630: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
10631: <td>BROKEN_ON_PLATFORM</td>
10632: </tr>
10633: <tr>
10634: <td>BSDSRCDIR</td>
10635: <td>BSDXSRCDIR</td>
10636: </tr>
10637: <tr>
10638: <td>BSD_MAKE_ENV</td>
10639: <td>BUILDLINK_AUTO_DIRS</td>
10640: </tr>
10641: <tr>
10642: <td>BUILDLINK_AUTO_VARS</td>
10643: <td>BUILDLINK_CFLAGS</td>
10644: </tr>
10645: <tr>
10646: <td>BUILDLINK_CONTENTS_FILTER</td>
10647: <td>BUILDLINK_CPPFLAGS</td>
10648: </tr>
10649: <tr>
10650: <td>BUILDLINK_DEPMETHOD</td>
10651: <td>BUILDLINK_FILES</td>
10652: </tr>
10653: <tr>
10654: <td>BUILDLINK_FILES_CMD</td>
10655: <td>BUILDLINK_FNAME_TRANSFORM</td>
10656: </tr>
10657: <tr>
10658: <td>BUILDLINK_LDFLAGS</td>
10659: <td>BUILDLINK_LIBS</td>
10660: </tr>
10661: <tr>
10662: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
10663: <td>BUILDLINK_PKGNAME</td>
10664: </tr>
10665: <tr>
10666: <td>BUILDLINK_PREFIX</td>
10667: <td>BUILDLINK_RPATHDIRS</td>
10668: </tr>
10669: <tr>
10670: <td>BUILDLINK_TREE</td>
10671: <td>BUILD_DEFS</td>
10672: </tr>
10673: <tr>
10674: <td>BUILD_DEFS_EFFECTS</td>
10675: <td>BUILD_DEPENDS</td>
10676: </tr>
10677: <tr>
10678: <td>BUILD_DIRS</td>
10679: <td>BUILD_ENV_SHELL</td>
10680: </tr>
10681: <tr>
10682: <td>BUILD_MAKE_CMD</td>
10683: <td>BUILD_MAKE_FLAGS</td>
10684: </tr>
10685: <tr>
10686: <td>BUILD_TARGET</td>
10687: <td>BUILTIN_FIND_FILES</td>
10688: </tr>
10689: <tr>
10690: <td>BUILTIN_FIND_FILES_VAR</td>
10691: <td>BUILTIN_FIND_GREP</td>
10692: </tr>
10693: <tr>
10694: <td>BUILTIN_FIND_HEADERS</td>
10695: <td>BUILTIN_FIND_HEADERS_VAR</td>
10696: </tr>
10697: <tr>
10698: <td>BUILTIN_PKG</td>
10699: <td>BUILTIN_TEST_CURSES_DEFINES</td>
10700: </tr>
10701: <tr>
10702: <td>BUILTIN_TEST_CURSES_FUNCS</td>
10703: <td>BUILTIN_VERSION_SCRIPT</td>
10704: </tr>
10705: <tr>
10706: <td>BUILTIN_X11_TYPE</td>
10707: <td>BUILTIN_X11_VERSION</td>
10708: </tr>
10709: <tr>
10710: <td>CACTI_GROUP</td>
10711: <td>CACTI_USER</td>
10712: </tr>
10713: <tr>
10714: <td>CANNA_GROUP</td>
10715: <td>CANNA_USER</td>
10716: </tr>
10717: <tr>
10718: <td>CAT</td>
10719: <td>CCACHE_BASE</td>
10720: </tr>
10721: <tr>
10722: <td>CCACHE_DIR</td>
10723: <td>CCACHE_LOGFILE</td>
10724: </tr>
10725: <tr>
10726: <td>CC_VERSION</td>
10727: <td>CC_VERSION_STRING</td>
10728: </tr>
10729: <tr>
10730: <td>CDRECORD_CONF</td>
10731: <td>CDROM_PKG_URL_DIR</td>
10732: </tr>
10733: <tr>
10734: <td>CDROM_PKG_URL_HOST</td>
1.161 leot 10735: <td>CHECKOUT_DATE</td>
10736: </tr>
10737: <tr>
1.160 brook 10738: <td>CHECK_FAKEHOME</td>
1.161 leot 10739: <td>CHECK_FILES</td>
1.159 rillig 10740: </tr>
10741: <tr>
1.160 brook 10742: <td>CHECK_FILES_SKIP</td>
1.161 leot 10743: <td>CHECK_FILES_STRICT</td>
1.156 leot 10744: </tr>
10745: <tr>
1.160 brook 10746: <td>CHECK_HEADERS</td>
1.161 leot 10747: <td>CHECK_HEADERS_SKIP</td>
1.156 leot 10748: </tr>
10749: <tr>
1.160 brook 10750: <td>CHECK_INTERPRETER</td>
1.161 leot 10751: <td>CHECK_INTERPRETER_SKIP</td>
1.156 leot 10752: </tr>
10753: <tr>
1.160 brook 10754: <td>CHECK_PERMS</td>
1.161 leot 10755: <td>CHECK_PERMS_AUTOFIX</td>
1.156 leot 10756: </tr>
10757: <tr>
1.160 brook 10758: <td>CHECK_PERMS_SKIP</td>
1.161 leot 10759: <td>CHECK_PORTABILITY</td>
1.156 leot 10760: </tr>
10761: <tr>
1.160 brook 10762: <td>CHECK_PORTABILITY_SKIP</td>
1.161 leot 10763: <td>CHECK_RELRO</td>
1.156 leot 10764: </tr>
10765: <tr>
1.160 brook 10766: <td>CHECK_RELRO_SKIP</td>
1.161 leot 10767: <td>CHECK_RELRO_SUPPORTED</td>
1.156 leot 10768: </tr>
10769: <tr>
1.160 brook 10770: <td>CHECK_SHLIBS</td>
1.161 leot 10771: <td>CHECK_SHLIBS_BLACKLIST</td>
1.156 leot 10772: </tr>
10773: <tr>
1.160 brook 10774: <td>CHECK_SHLIBS_SKIP</td>
1.161 leot 10775: <td>CHECK_SHLIBS_SUPPORTED</td>
1.156 leot 10776: </tr>
10777: <tr>
1.160 brook 10778: <td>CHECK_SSP</td>
1.161 leot 10779: <td>CHECK_SSP_SKIP</td>
1.156 leot 10780: </tr>
10781: <tr>
1.160 brook 10782: <td>CHECK_SSP_SUPPORTED</td>
1.161 leot 10783: <td>CHECK_STRIPPED</td>
1.156 leot 10784: </tr>
10785: <tr>
1.160 brook 10786: <td>CHECK_STRIPPED_SKIP</td>
1.161 leot 10787: <td>CHECK_WRKREF</td>
1.156 leot 10788: </tr>
10789: <tr>
1.160 brook 10790: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.161 leot 10791: <td>CHECK_WRKREF_SKIP</td>
1.156 leot 10792: </tr>
10793: <tr>
1.160 brook 10794: <td>CLAMAV_DBDIR</td>
1.161 leot 10795: <td>CLAMAV_GROUP</td>
1.156 leot 10796: </tr>
10797: <tr>
1.160 brook 10798: <td>CLAMAV_USER</td>
1.161 leot 10799: <td>CLANGBASE</td>
1.156 leot 10800: </tr>
10801: <tr>
1.160 brook 10802: <td>CLEANDEPENDS</td>
1.161 leot 10803: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.156 leot 10804: </tr>
10805: <tr>
1.160 brook 10806: <td>CMAKE_INSTALL_PREFIX</td>
1.161 leot 10807: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.156 leot 10808: </tr>
10809: <tr>
1.160 brook 10810: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.161 leot 10811: <td>CMAKE_PREFIX_PATH</td>
1.156 leot 10812: </tr>
10813: <tr>
10814: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.161 leot 10815: <td>COMMON_LISP_DOCFILES</td>
10816: </tr>
10817: <tr>
10818: <td>COMMON_LISP_EXAMPLES</td>
10819: <td>COMMON_LISP_EXTRAFILES</td>
10820: </tr>
10821: <tr>
10822: <td>COMMON_LISP_PACKAGES</td>
10823: <td>COMMON_LISP_SYSTEM</td>
1.156 leot 10824: </tr>
10825: <tr>
10826: <td>COMPILER_RPATH_FLAG</td>
10827: <td>COMPILER_USE_SYMLINKS</td>
10828: </tr>
10829: <tr>
10830: <td>CONFIGURE_ARGS</td>
10831: <td>CONFIGURE_DIRS</td>
10832: </tr>
10833: <tr>
10834: <td>CONFIGURE_ENV</td>
10835: <td>CONFIGURE_HAS_INFODIR</td>
10836: </tr>
10837: <tr>
10838: <td>CONFIGURE_HAS_MANDIR</td>
10839: <td>CONFIGURE_SCRIPT</td>
10840: </tr>
10841: <tr>
10842: <td>CONFIG_SHELL</td>
10843: <td>CONFIG_SHELL_FLAGS</td>
10844: </tr>
10845: <tr>
10846: <td>CONF_FILES</td>
10847: <td>CONF_FILES_MODE</td>
10848: </tr>
10849: <tr>
10850: <td>CONF_FILES_PERMS</td>
10851: <td>CONSERVER_DEFAULTHOST</td>
10852: </tr>
10853: <tr>
10854: <td>CONSERVER_DEFAULTPORT</td>
10855: <td>CP</td>
10856: </tr>
10857: <tr>
10858: <td>CPP</td>
10859: <td>CPP_PRECOMP_FLAGS</td>
10860: </tr>
10861: <tr>
10862: <td>CREATE_WRKDIR_SYMLINK</td>
10863: <td>CROSSBASE</td>
10864: </tr>
10865: <tr>
10866: <td>CTFCONVERT</td>
10867: <td>CTF_FILES_SKIP</td>
10868: </tr>
10869: <tr>
10870: <td>CTF_SUPPORTED</td>
10871: <td>CTYPE</td>
10872: </tr>
10873: <tr>
10874: <td>CUPS_GROUP</td>
10875: <td>CUPS_SYSTEM_GROUPS</td>
10876: </tr>
10877: <tr>
10878: <td>CUPS_USER</td>
10879: <td>CURSES_DEFAULT</td>
10880: </tr>
10881: <tr>
10882: <td>CURSES_TYPE</td>
1.161 leot 10883: <td>CVS_EXTRACTDIR</td>
10884: </tr>
10885: <tr>
10886: <td>CVS_MODULE</td>
10887: <td>CVS_PROJECT</td>
10888: </tr>
10889: <tr>
10890: <td>CVS_REPOSITORIES</td>
10891: <td>CVS_ROOT</td>
10892: </tr>
10893: <tr>
10894: <td>CVS_ROOT_GNU</td>
10895: <td>CVS_ROOT_NONGNU</td>
10896: </tr>
10897: <tr>
10898: <td>CVS_ROOT_SOURCEFORGE</td>
10899: <td>CVS_TAG</td>
10900: </tr>
10901: <tr>
1.160 brook 10902: <td>CXX</td>
1.161 leot 10903: <td>CYRUS_GROUP</td>
1.159 rillig 10904: </tr>
10905: <tr>
1.160 brook 10906: <td>CYRUS_IDLE</td>
1.161 leot 10907: <td>CYRUS_USER</td>
1.156 leot 10908: </tr>
10909: <tr>
1.160 brook 10910: <td>DAEMONTOOLS_GROUP</td>
1.161 leot 10911: <td>DAEMONTOOLS_LOG_USER</td>
1.156 leot 10912: </tr>
10913: <tr>
1.160 brook 10914: <td>DBUS_GROUP</td>
1.161 leot 10915: <td>DBUS_USER</td>
1.156 leot 10916: </tr>
10917: <tr>
1.160 brook 10918: <td>DEFANG_GROUP</td>
1.161 leot 10919: <td>DEFANG_USER</td>
1.156 leot 10920: </tr>
10921: <tr>
1.160 brook 10922: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.161 leot 10923: <td>DEFAULT_DISTFILES</td>
1.156 leot 10924: </tr>
10925: <tr>
1.160 brook 10926: <td>DEFAULT_IRC_SERVER</td>
1.161 leot 10927: <td>DEFAULT_SERIAL_DEVICE</td>
1.156 leot 10928: </tr>
10929: <tr>
1.160 brook 10930: <td>DEF_UMASK</td>
1.161 leot 10931: <td>DEINSTALLDEPENDS</td>
1.156 leot 10932: </tr>
10933: <tr>
1.160 brook 10934: <td>DEINSTALL_SRC</td>
1.161 leot 10935: <td>DEINSTALL_TEMPLATES</td>
1.156 leot 10936: </tr>
10937: <tr>
1.160 brook 10938: <td>DELAYED_ERROR_MSG</td>
1.161 leot 10939: <td>DELAYED_WARNING_MSG</td>
1.156 leot 10940: </tr>
10941: <tr>
1.160 brook 10942: <td>DEPENDS</td>
1.161 leot 10943: <td>DEPENDS_TARGET</td>
1.156 leot 10944: </tr>
10945: <tr>
1.160 brook 10946: <td>DEPENDS_TYPE</td>
1.161 leot 10947: <td>DESTDIR</td>
1.156 leot 10948: </tr>
10949: <tr>
1.160 brook 10950: <td>DESTDIR_VARNAME</td>
1.161 leot 10951: <td>DIALER_GROUP</td>
1.156 leot 10952: </tr>
10953: <tr>
1.160 brook 10954: <td>DIGEST_REQD</td>
1.161 leot 10955: <td>DISTDIR</td>
1.156 leot 10956: </tr>
10957: <tr>
1.160 brook 10958: <td>DISTFILES</td>
1.161 leot 10959: <td>DISTINFO_FILE</td>
1.156 leot 10960: </tr>
10961: <tr>
1.160 brook 10962: <td>DISTNAME</td>
1.161 leot 10963: <td>DIST_PATH</td>
1.156 leot 10964: </tr>
10965: <tr>
1.160 brook 10966: <td>DIST_SUBDIR</td>
1.161 leot 10967: <td>DJBDNS_AXFR_USER</td>
1.156 leot 10968: </tr>
10969: <tr>
1.160 brook 10970: <td>DJBDNS_CACHE_USER</td>
1.161 leot 10971: <td>DJBDNS_DJBDNS_GROUP</td>
1.156 leot 10972: </tr>
10973: <tr>
1.160 brook 10974: <td>DJBDNS_LOG_USER</td>
1.161 leot 10975: <td>DJBDNS_RBL_USER</td>
1.156 leot 10976: </tr>
10977: <tr>
1.160 brook 10978: <td>DJBDNS_TINY_USER</td>
1.161 leot 10979: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.156 leot 10980: </tr>
10981: <tr>
1.160 brook 10982: <td>DL_AUTO_VARS</td>
1.161 leot 10983: <td>DL_CFLAGS</td>
1.156 leot 10984: </tr>
10985: <tr>
1.160 brook 10986: <td>DL_LDFLAGS</td>
1.161 leot 10987: <td>DL_LIBS</td>
1.156 leot 10988: </tr>
10989: <tr>
1.160 brook 10990: <td>DNS</td>
1.161 leot 10991: <td>DOWNLOADED_DISTFILE</td>
1.156 leot 10992: </tr>
10993: <tr>
1.160 brook 10994: <td>DT_LAYOUT</td>
1.161 leot 10995: <td>DYNAMIC_SITES_CMD</td>
1.156 leot 10996: </tr>
10997: <tr>
1.160 brook 10998: <td>DYNAMIC_SITES_SCRIPT</td>
1.161 leot 10999: <td>ECHO</td>
1.156 leot 11000: </tr>
11001: <tr>
1.160 brook 11002: <td>ECHO_N</td>
1.161 leot 11003: <td>ELK_GUI</td>
1.156 leot 11004: </tr>
11005: <tr>
1.160 brook 11006: <td>EMACS_TYPE</td>
1.161 leot 11007: <td>EMULDIR</td>
1.156 leot 11008: </tr>
11009: <tr>
1.160 brook 11010: <td>EMULSUBDIR</td>
1.161 leot 11011: <td>EMULSUBDIRSLASH</td>
1.156 leot 11012: </tr>
11013: <tr>
1.160 brook 11014: <td>EMUL_ARCH</td>
1.161 leot 11015: <td>EMUL_DISTRO</td>
1.156 leot 11016: </tr>
11017: <tr>
1.160 brook 11018: <td>EMUL_EXEC_FMT</td>
1.161 leot 11019: <td>EMUL_IS_NATIVE</td>
1.156 leot 11020: </tr>
11021: <tr>
1.160 brook 11022: <td>EMUL_MODULES</td>
1.161 leot 11023: <td>EMUL_OPSYS</td>
1.156 leot 11024: </tr>
11025: <tr>
1.160 brook 11026: <td>EMUL_PKG_FMT</td>
1.161 leot 11027: <td>EMUL_PLATFORM</td>
1.156 leot 11028: </tr>
11029: <tr>
1.160 brook 11030: <td>EMUL_PLATFORMS</td>
1.161 leot 11031: <td>EMUL_PREFER</td>
1.156 leot 11032: </tr>
11033: <tr>
1.160 brook 11034: <td>EMUL_REQD</td>
1.161 leot 11035: <td>EMUL_TYPE</td>
1.156 leot 11036: </tr>
11037: <tr>
1.160 brook 11038: <td>ERROR_MSG</td>
1.161 leot 11039: <td>EXIM_GROUP</td>
1.156 leot 11040: </tr>
11041: <tr>
1.160 brook 11042: <td>EXIM_USER</td>
1.161 leot 11043: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.156 leot 11044: </tr>
11045: <tr>
1.160 brook 11046: <td>EXTRACTOR</td>
1.161 leot 11047: <td>EXTRACT_CMD</td>
1.156 leot 11048: </tr>
11049: <tr>
1.160 brook 11050: <td>EXTRACT_CMD_DEFAULT</td>
1.161 leot 11051: <td>EXTRACT_DIR</td>
1.156 leot 11052: </tr>
11053: <tr>
1.160 brook 11054: <td>EXTRACT_ELEMENTS</td>
1.161 leot 11055: <td>EXTRACT_ENV</td>
1.156 leot 11056: </tr>
11057: <tr>
1.160 brook 11058: <td>EXTRACT_ONLY</td>
1.161 leot 11059: <td>EXTRACT_OPTS</td>
1.156 leot 11060: </tr>
11061: <tr>
1.160 brook 11062: <td>EXTRACT_SUFX</td>
1.161 leot 11063: <td>EXTRACT_USING</td>
1.156 leot 11064: </tr>
11065: <tr>
1.160 brook 11066: <td>FAILOVER_FETCH</td>
1.161 leot 11067: <td>FAIL_MSG</td>
1.156 leot 11068: </tr>
11069: <tr>
1.160 brook 11070: <td>FAKE_NCURSES</td>
1.161 leot 11071: <td>FAM</td>
1.156 leot 11072: </tr>
11073: <tr>
1.160 brook 11074: <td>FAM_ACCEPTED</td>
1.161 leot 11075: <td>FAM_DEFAULT</td>
1.156 leot 11076: </tr>
11077: <tr>
1.160 brook 11078: <td>FAM_SERVER</td>
1.161 leot 11079: <td>FCPATH</td>
1.156 leot 11080: </tr>
11081: <tr>
1.160 brook 11082: <td>FEATURE_CPPFLAGS</td>
1.161 leot 11083: <td>FEATURE_LDFLAGS</td>
1.156 leot 11084: </tr>
11085: <tr>
1.160 brook 11086: <td>FEATURE_LIBS</td>
1.161 leot 11087: <td>FETCH_AFTER_ARGS</td>
1.156 leot 11088: </tr>
11089: <tr>
1.160 brook 11090: <td>FETCH_BEFORE_ARGS</td>
1.161 leot 11091: <td>FETCH_CMD</td>
1.156 leot 11092: </tr>
11093: <tr>
1.160 brook 11094: <td>FETCH_OUTPUT_ARGS</td>
1.161 leot 11095: <td>FETCH_PROXY</td>
1.156 leot 11096: </tr>
11097: <tr>
1.160 brook 11098: <td>FETCH_RESUME_ARGS</td>
1.161 leot 11099: <td>FETCH_USING</td>
1.156 leot 11100: </tr>
11101: <tr>
1.160 brook 11102: <td>FILES_SUBST</td>
1.161 leot 11103: <td>FILES_SUBST_SED</td>
1.156 leot 11104: </tr>
11105: <tr>
1.160 brook 11106: <td>FIX_SYSTEM_HEADERS</td>
1.161 leot 11107: <td>FLUXBOX_USE_GNOME</td>
1.156 leot 11108: </tr>
11109: <tr>
1.160 brook 11110: <td>FLUXBOX_USE_KDE</td>
1.161 leot 11111: <td>FLUXBOX_USE_XFT</td>
1.156 leot 11112: </tr>
11113: <tr>
11114: <td>FLUXBOX_USE_XINERAMA</td>
1.161 leot 11115: <td>FONTDIR</td>
1.156 leot 11116: </tr>
11117: <tr>
11118: <td>FONTS_DIRS</td>
11119: <td>FONTS_VERBOSE</td>
11120: </tr>
11121: <tr>
11122: <td>FOO_HACKS_MK</td>
1.161 leot 11123: <td>FOSSIL_EXTRACTDIR</td>
11124: </tr>
11125: <tr>
11126: <td>FOSSIL_REPO</td>
11127: <td>FOSSIL_REPOSITORIES</td>
11128: </tr>
11129: <tr>
11130: <td>FOSSIL_VERSION</td>
1.156 leot 11131: <td>FOX_USE_XUNICODE</td>
11132: </tr>
11133: <tr>
11134: <td>FREEWNN_GROUP</td>
11135: <td>FREEWNN_USER</td>
11136: </tr>
11137: <tr>
11138: <td>FTP_PKG_URL_DIR</td>
11139: <td>FTP_PKG_URL_HOST</td>
11140: </tr>
11141: <tr>
11142: <td>GAMEDATAMODE</td>
11143: <td>GAMEDATA_PERMS</td>
11144: </tr>
11145: <tr>
11146: <td>GAMEDIRMODE</td>
11147: <td>GAMEDIR_PERMS</td>
11148: </tr>
11149: <tr>
11150: <td>GAMEGRP</td>
11151: <td>GAMEMODE</td>
11152: </tr>
11153: <tr>
11154: <td>GAMEOWN</td>
11155: <td>GAMES_GROUP</td>
11156: </tr>
11157: <tr>
11158: <td>GAMES_USER</td>
11159: <td>GCC</td>
11160: </tr>
11161: <tr>
11162: <td>GCCBASE</td>
11163: <td>GCC_REQD</td>
11164: </tr>
11165: <tr>
11166: <td>GCC_VERSION_SUFFIX</td>
11167: <td>GEM_BUILD</td>
11168: </tr>
11169: <tr>
11170: <td>GEM_CLEANBUILD</td>
11171: <td>GEM_CLEANBUILD_EXTENSIONS</td>
11172: </tr>
11173: <tr>
11174: <td>GEM_DOCDIR</td>
11175: <td>GEM_EXTSDIR</td>
11176: </tr>
11177: <tr>
11178: <td>GEM_HOME</td>
11179: <td>GEM_LIBDIR</td>
11180: </tr>
11181: <tr>
11182: <td>GEM_NAME</td>
11183: <td>GEM_PATH</td>
11184: </tr>
11185: <tr>
11186: <td>GEM_SPECFILE</td>
11187: <td>GENERATE_PLIST</td>
11188: </tr>
11189: <tr>
11190: <td>GHOSTSCRIPT_REQD</td>
11191: <td>GITHUB_PROJECT</td>
11192: </tr>
11193: <tr>
11194: <td>GITHUB_RELEASE</td>
11195: <td>GITHUB_TAG</td>
11196: </tr>
11197: <tr>
11198: <td>GITHUB_TYPE</td>
1.161 leot 11199: <td>GIT_BRANCH</td>
11200: </tr>
11201: <tr>
11202: <td>GIT_ENV</td>
11203: <td>GIT_EXTRACTDIR</td>
11204: </tr>
11205: <tr>
11206: <td>GIT_REPO</td>
11207: <td>GIT_REPOSITORIES</td>
11208: </tr>
11209: <tr>
11210: <td>GIT_REVISION</td>
11211: <td>GIT_TAG</td>
11212: </tr>
11213: <tr>
1.160 brook 11214: <td>GNU</td>
1.161 leot 11215: <td>GNU_CONFIGURE</td>
1.159 rillig 11216: </tr>
11217: <tr>
1.160 brook 11218: <td>GNU_CONFIGURE_INFODIR</td>
1.161 leot 11219: <td>GNU_CONFIGURE_MANDIR</td>
1.156 leot 11220: </tr>
11221: <tr>
1.160 brook 11222: <td>GNU_CONFIGURE_STRICT</td>
1.161 leot 11223: <td>GODEP_REDIRECTS</td>
1.156 leot 11224: </tr>
11225: <tr>
1.160 brook 11226: <td>GO_BUILD_PATTERN</td>
1.161 leot 11227: <td>GO_DEPS</td>
1.156 leot 11228: </tr>
11229: <tr>
1.160 brook 11230: <td>GO_DIST_BASE</td>
1.161 leot 11231: <td>GO_SRCPATH</td>
1.156 leot 11232: </tr>
11233: <tr>
1.161 leot 11234: <td>GO_VERSION_DEFAULT</td>
1.160 brook 11235: <td>GROUP_SPECIFIC_PKGS</td>
1.156 leot 11236: </tr>
11237: <tr>
1.159 rillig 11238: <td>GRUB_NETWORK_CARDS</td>
1.160 brook 11239: <td>GRUB_PRESET_COMMAND</td>
1.156 leot 11240: </tr>
11241: <tr>
1.159 rillig 11242: <td>GRUB_SCAN_ARGS</td>
1.160 brook 11243: <td>GZIP</td>
1.156 leot 11244: </tr>
11245: <tr>
1.159 rillig 11246: <td>HASKELL_COMPILER</td>
1.160 brook 11247: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.156 leot 11248: </tr>
11249: <tr>
1.159 rillig 11250: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.160 brook 11251: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.156 leot 11252: </tr>
11253: <tr>
1.169 rillig 11254: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.159 rillig 11255: <td>HAS_CONFIGURE</td>
1.156 leot 11256: </tr>
11257: <tr>
1.169 rillig 11258: <td>HEADER_TEMPLATES</td>
1.161 leot 11259: <td>HG_REPO</td>
11260: </tr>
11261: <tr>
1.169 rillig 11262: <td>HG_REPOSITORIES</td>
1.161 leot 11263: <td>HG_TAG</td>
11264: </tr>
11265: <tr>
1.169 rillig 11266: <td>HOST_PKGTOOLS_ARGS</td>
1.156 leot 11267: <td>HOST_SPECIFIC_PKGS</td>
11268: </tr>
11269: <tr>
1.169 rillig 11270: <td>HOWL_GROUP</td>
1.156 leot 11271: <td>HOWL_USER</td>
11272: </tr>
11273: <tr>
1.169 rillig 11274: <td>ICCBASE</td>
1.156 leot 11275: <td>ICECAST_CHROOTDIR</td>
11276: </tr>
11277: <tr>
1.169 rillig 11278: <td>ICON_THEMES</td>
1.156 leot 11279: <td>IDOBASE</td>
11280: </tr>
11281: <tr>
1.169 rillig 11282: <td>IGNORE_CCACHE</td>
1.156 leot 11283: <td>IGNORE_INFO_DIRS</td>
11284: </tr>
11285: <tr>
1.169 rillig 11286: <td>IGNORE_INTERACTIVE_FETCH</td>
1.156 leot 11287: <td>IMAKE</td>
11288: </tr>
11289: <tr>
1.169 rillig 11290: <td>IMAKEOPTS</td>
1.156 leot 11291: <td>IMAKE_MAKE</td>
11292: </tr>
11293: <tr>
1.169 rillig 11294: <td>IMAKE_MANINSTALL</td>
1.156 leot 11295: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
11296: </tr>
11297: <tr>
1.169 rillig 11298: <td>IMDICTDIR</td>
1.156 leot 11299: <td>INCOMPAT_CURSES</td>
11300: </tr>
11301: <tr>
1.169 rillig 11302: <td>INFO_DIR</td>
1.156 leot 11303: <td>INFO_FILES</td>
11304: </tr>
11305: <tr>
1.169 rillig 11306: <td>INFO_FILES_VERBOSE</td>
1.156 leot 11307: <td>INFO_MSG</td>
11308: </tr>
11309: <tr>
1.169 rillig 11310: <td>INIT_SYSTEM</td>
1.156 leot 11311: <td>INN_DATA_DIR</td>
11312: </tr>
11313: <tr>
1.169 rillig 11314: <td>INN_GROUP</td>
1.156 leot 11315: <td>INN_USER</td>
11316: </tr>
11317: <tr>
1.169 rillig 11318: <td>INSTALLATION_DIRS</td>
1.156 leot 11319: <td>INSTALLATION_DIRS_FROM_PLIST</td>
11320: </tr>
11321: <tr>
1.169 rillig 11322: <td>INSTALL_ENV</td>
1.156 leot 11323: <td>INSTALL_SH_OVERRIDE</td>
11324: </tr>
11325: <tr>
1.169 rillig 11326: <td>INSTALL_SRC</td>
1.156 leot 11327: <td>INSTALL_TEMPLATES</td>
11328: </tr>
11329: <tr>
1.169 rillig 11330: <td>INSTALL_UNSTRIPPED</td>
1.156 leot 11331: <td>IRCD_HYBRID_IRC_GROUP</td>
11332: </tr>
11333: <tr>
1.169 rillig 11334: <td>IRCD_HYBRID_IRC_USER</td>
1.156 leot 11335: <td>IRCD_HYBRID_MAXCONN</td>
11336: </tr>
11337: <tr>
1.169 rillig 11338: <td>IRCD_HYBRID_NICLEN</td>
1.156 leot 11339: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
11340: </tr>
11341: <tr>
1.169 rillig 11342: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.156 leot 11343: <td>IRCD_HYBRID_TOPICLEN</td>
11344: </tr>
11345: <tr>
1.169 rillig 11346: <td>IRIX</td>
1.156 leot 11347: <td>IRRD_USE_PGP</td>
11348: </tr>
11349: <tr>
1.169 rillig 11350: <td>JABBERD_GROUP</td>
1.156 leot 11351: <td>JABBERD_LOGDIR</td>
11352: </tr>
11353: <tr>
1.169 rillig 11354: <td>JABBERD_PIDDIR</td>
1.156 leot 11355: <td>JABBERD_SPOOLDIR</td>
11356: </tr>
11357: <tr>
1.169 rillig 11358: <td>JABBERD_USER</td>
1.156 leot 11359: <td>JAKARTA_HOME</td>
11360: </tr>
11361: <tr>
1.169 rillig 11362: <td>JAVA_APP_PATH</td>
1.161 leot 11363: <td>JAVA_APP_TARGETS</td>
11364: </tr>
11365: <tr>
1.169 rillig 11366: <td>JAVA_BINPREFIX</td>
1.156 leot 11367: <td>JAVA_CLASSPATH</td>
11368: </tr>
11369: <tr>
1.169 rillig 11370: <td>JAVA_HOME</td>
1.156 leot 11371: <td>JAVA_LD_LIBRARY_PATH</td>
11372: </tr>
11373: <tr>
1.169 rillig 11374: <td>JAVA_NAME</td>
1.156 leot 11375: <td>JAVA_UNLIMIT</td>
11376: </tr>
11377: <tr>
1.169 rillig 11378: <td>JAVA_WRAPPERS</td>
1.156 leot 11379: <td>JPEG_ACCEPTED</td>
11380: </tr>
11381: <tr>
1.169 rillig 11382: <td>JPEG_DEFAULT</td>
1.156 leot 11383: <td>KERBEROS</td>
11384: </tr>
11385: <tr>
1.169 rillig 11386: <td>KERMIT_SUID_UUCP</td>
1.156 leot 11387: <td>KJS_USE_PCRE</td>
11388: </tr>
11389: <tr>
1.169 rillig 11390: <td>KNEWS_DOMAIN_FILE</td>
1.156 leot 11391: <td>KNEWS_DOMAIN_NAME</td>
11392: </tr>
11393: <tr>
1.169 rillig 11394: <td>KRB5_ACCEPTED</td>
1.156 leot 11395: <td>KRB5_DEFAULT</td>
11396: </tr>
11397: <tr>
1.169 rillig 11398: <td>LANGUAGES</td>
1.161 leot 11399: <td>LAPACK_LIBS</td>
1.156 leot 11400: </tr>
11401: <tr>
1.169 rillig 11402: <td>LATEX2HTML_ICONPATH</td>
1.156 leot 11403: <td>LDCONFIG_ADD_CMD</td>
11404: </tr>
11405: <tr>
1.169 rillig 11406: <td>LDCONFIG_REMOVE_CMD</td>
1.156 leot 11407: <td>LEAFNODE_DATA_DIR</td>
11408: </tr>
11409: <tr>
1.169 rillig 11410: <td>LEAFNODE_GROUP</td>
1.156 leot 11411: <td>LEAFNODE_USER</td>
11412: </tr>
11413: <tr>
1.169 rillig 11414: <td>LIBDVDCSS_HOMEPAGE</td>
1.156 leot 11415: <td>LIBDVDCSS_MASTER_SITES</td>
1.157 leot 11416: </tr>
11417: <tr>
1.169 rillig 11418: <td>LIBRSVG_TYPE</td>
1.156 leot 11419: <td>LIBTOOL</td>
11420: </tr>
11421: <tr>
1.169 rillig 11422: <td>LIBTOOLIZE_PLIST</td>
1.156 leot 11423: <td>LIBTOOL_M4_OVERRIDE</td>
11424: </tr>
11425: <tr>
1.169 rillig 11426: <td>LIBUSB_TYPE</td>
1.156 leot 11427: <td>LICENSE</td>
11428: </tr>
11429: <tr>
1.169 rillig 11430: <td>LINKER_RPATH_FLAG</td>
1.156 leot 11431: <td>LINK_RPATH_FLAG</td>
1.161 leot 11432: </tr>
11433: <tr>
1.169 rillig 11434: <td>LINUX_BASE_NODEPS</td>
1.161 leot 11435: <td>LINUX_BASE_PREFERRED</td>
11436: </tr>
11437: <tr>
1.169 rillig 11438: <td>LINUX_BASE_REQUIRED</td>
1.159 rillig 11439: <td>LINUX_LOCALES</td>
1.156 leot 11440: </tr>
11441: <tr>
1.169 rillig 11442: <td>LOCALBASE</td>
1.158 brook 11443: <td>LOCALBASE_LOCKTYPE</td>
1.156 leot 11444: </tr>
11445: <tr>
1.169 rillig 11446: <td>LOCALPATCHES</td>
1.158 brook 11447: <td>LOVE_DATA</td>
1.156 leot 11448: </tr>
11449: <tr>
1.169 rillig 11450: <td>LOVE_GAME</td>
1.158 brook 11451: <td>LOVE_VERSION</td>
1.156 leot 11452: </tr>
11453: <tr>
1.169 rillig 11454: <td>LP64PLATFORMS</td>
1.158 brook 11455: <td>MACHINE_PLATFORM</td>
1.156 leot 11456: </tr>
11457: <tr>
1.169 rillig 11458: <td>MAILAGENT_DOMAIN</td>
1.158 brook 11459: <td>MAILAGENT_EMAIL</td>
1.156 leot 11460: </tr>
11461: <tr>
1.169 rillig 11462: <td>MAILAGENT_FQDN</td>
1.158 brook 11463: <td>MAILAGENT_ORGANIZATION</td>
1.156 leot 11464: </tr>
11465: <tr>
1.169 rillig 11466: <td>MAJORDOMO_HOMEDIR</td>
1.161 leot 11467: <td>MAJOR_OS_VERSION</td>
1.159 rillig 11468: </tr>
11469: <tr>
1.169 rillig 11470: <td>MAKEINFO_ARGS</td>
1.159 rillig 11471: <td>MAKE_DIRS</td>
1.156 leot 11472: </tr>
11473: <tr>
1.169 rillig 11474: <td>MAKE_DIRS_PERMS</td>
1.159 rillig 11475: <td>MAKE_ENV</td>
1.156 leot 11476: </tr>
11477: <tr>
1.169 rillig 11478: <td>MAKE_FILE</td>
1.159 rillig 11479: <td>MAKE_FLAGS</td>
1.156 leot 11480: </tr>
11481: <tr>
1.169 rillig 11482: <td>MAKE_JOBS</td>
1.159 rillig 11483: <td>MAKE_JOBS_SAFE</td>
1.156 leot 11484: </tr>
11485: <tr>
1.169 rillig 11486: <td>MAKE_PROGRAM</td>
1.159 rillig 11487: <td>MANINSTALL</td>
1.156 leot 11488: </tr>
11489: <tr>
1.169 rillig 11490: <td>MANZ</td>
1.159 rillig 11491: <td>MASTER_SITES</td>
1.156 leot 11492: </tr>
11493: <tr>
1.169 rillig 11494: <td>MASTER_SITE_BACKUP</td>
1.159 rillig 11495: <td>MASTER_SITE_CYGWIN</td>
1.156 leot 11496: </tr>
11497: <tr>
1.169 rillig 11498: <td>MASTER_SITE_GNOME</td>
1.159 rillig 11499: <td>MASTER_SITE_GNU</td>
1.156 leot 11500: </tr>
11501: <tr>
1.169 rillig 11502: <td>MASTER_SITE_LOCAL</td>
1.159 rillig 11503: <td>MASTER_SITE_MOZILLA</td>
1.156 leot 11504: </tr>
11505: <tr>
1.169 rillig 11506: <td>MASTER_SITE_OPENOFFICE</td>
1.159 rillig 11507: <td>MASTER_SITE_OVERRIDE</td>
1.156 leot 11508: </tr>
11509: <tr>
1.169 rillig 11510: <td>MASTER_SITE_PERL_CPAN</td>
1.159 rillig 11511: <td>MASTER_SITE_SUNSITE</td>
1.156 leot 11512: </tr>
11513: <tr>
1.169 rillig 11514: <td>MASTER_SITE_SUSE</td>
1.159 rillig 11515: <td>MASTER_SITE_TEX_CTAN</td>
1.156 leot 11516: </tr>
11517: <tr>
1.169 rillig 11518: <td>MASTER_SITE_XCONTRIB</td>
1.159 rillig 11519: <td>MASTER_SITE_XEMACS</td>
1.156 leot 11520: </tr>
11521: <tr>
1.169 rillig 11522: <td>MASTER_SORT</td>
1.159 rillig 11523: <td>MASTER_SORT_RANDOM</td>
1.156 leot 11524: </tr>
11525: <tr>
1.169 rillig 11526: <td>MASTER_SORT_REGEX</td>
1.159 rillig 11527: <td>MECAB_CHARSET</td>
1.156 leot 11528: </tr>
11529: <tr>
1.169 rillig 11530: <td>MEDIATOMB_GROUP</td>
1.159 rillig 11531: <td>MEDIATOMB_USER</td>
1.156 leot 11532: </tr>
11533: <tr>
1.169 rillig 11534: <td>MIPSPROBASE</td>
1.159 rillig 11535: <td>MIREDO_GROUP</td>
1.156 leot 11536: </tr>
11537: <tr>
1.169 rillig 11538: <td>MIREDO_USER</td>
1.159 rillig 11539: <td>MISSING_FEATURES</td>
1.156 leot 11540: </tr>
11541: <tr>
1.169 rillig 11542: <td>MKDIR</td>
1.159 rillig 11543: <td>MLDONKEY_GROUP</td>
1.156 leot 11544: </tr>
11545: <tr>
1.169 rillig 11546: <td>MLDONKEY_HOME</td>
1.159 rillig 11547: <td>MLDONKEY_USER</td>
1.156 leot 11548: </tr>
11549: <tr>
1.169 rillig 11550: <td>MONOTONE_GROUP</td>
1.159 rillig 11551: <td>MONOTONE_USER</td>
1.156 leot 11552: </tr>
11553: <tr>
1.169 rillig 11554: <td>MOTIFBASE</td>
1.159 rillig 11555: <td>MOTIF_TYPE</td>
1.156 leot 11556: </tr>
11557: <tr>
1.169 rillig 11558: <td>MOTIF_TYPE_DEFAULT</td>
1.159 rillig 11559: <td>MPI_TYPE</td>
1.156 leot 11560: </tr>
11561: <tr>
1.169 rillig 11562: <td>MSGFMT_STRIP_MSGCTXT</td>
1.159 rillig 11563: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.156 leot 11564: </tr>
11565: <tr>
1.169 rillig 11566: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.159 rillig 11567: <td>MUST</td>
1.156 leot 11568: </tr>
11569: <tr>
1.169 rillig 11570: <td>MV</td>
1.159 rillig 11571: <td>MYSQL_CHARSET</td>
1.156 leot 11572: </tr>
11573: <tr>
1.169 rillig 11574: <td>MYSQL_DATADIR</td>
1.159 rillig 11575: <td>MYSQL_EXTRA_CHARSET</td>
1.156 leot 11576: </tr>
11577: <tr>
1.169 rillig 11578: <td>MYSQL_GROUP</td>
1.159 rillig 11579: <td>MYSQL_PKGSRCDIR</td>
1.156 leot 11580: </tr>
11581: <tr>
1.169 rillig 11582: <td>MYSQL_USER</td>
1.159 rillig 11583: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.156 leot 11584: </tr>
11585: <tr>
1.169 rillig 11586: <td>MYSQL_VERSION_DEFAULT</td>
1.159 rillig 11587: <td>NAGIOSCMD_GROUP</td>
1.156 leot 11588: </tr>
11589: <tr>
1.169 rillig 11590: <td>NAGIOSDIR</td>
1.159 rillig 11591: <td>NAGIOS_GROUP</td>
1.156 leot 11592: </tr>
11593: <tr>
1.169 rillig 11594: <td>NAGIOS_USER</td>
1.159 rillig 11595: <td>NATIVE_APPEND_ABI</td>
1.156 leot 11596: </tr>
11597: <tr>
1.169 rillig 11598: <td>NATIVE_APPEND_ELF</td>
1.159 rillig 11599: <td>NATIVE_EXEC_FMT</td>
1.156 leot 11600: </tr>
11601: <tr>
1.169 rillig 11602: <td>NATIVE_MACHINE_PLATFORM</td>
1.159 rillig 11603: <td>NATIVE_OBJECT_FMT</td>
1.156 leot 11604: </tr>
11605: <tr>
1.169 rillig 11606: <td>NBPAX_PROGRAM_PREFIX</td>
1.159 rillig 11607: <td>NETBSD_LOGIN_NAME</td>
1.156 leot 11608: </tr>
11609: <tr>
1.169 rillig 11610: <td>NMH_EDITOR</td>
1.159 rillig 11611: <td>NMH_MTA</td>
1.156 leot 11612: </tr>
11613: <tr>
1.169 rillig 11614: <td>NMH_PAGER</td>
1.159 rillig 11615: <td>NOLOGIN</td>
1.156 leot 11616: </tr>
11617: <tr>
1.169 rillig 11618: <td>NONZERO_FILESIZE_P</td>
1.159 rillig 11619: <td>NOTE</td>
1.156 leot 11620: </tr>
11621: <tr>
1.169 rillig 11622: <td>NOT_FOR_PLATFORM</td>
1.159 rillig 11623: <td>NOT_PAX_ASLR_SAFE</td>
1.156 leot 11624: </tr>
11625: <tr>
1.169 rillig 11626: <td>NOT_PAX_MPROTECT_SAFE</td>
1.159 rillig 11627: <td>NO_BUILD</td>
1.156 leot 11628: </tr>
11629: <tr>
1.169 rillig 11630: <td>NO_CHECKSUM</td>
1.159 rillig 11631: <td>NO_CONFIGURE</td>
1.156 leot 11632: </tr>
11633: <tr>
1.169 rillig 11634: <td>NO_SKIP</td>
1.159 rillig 11635: <td>NS_PREFERRED</td>
1.156 leot 11636: </tr>
11637: <tr>
1.169 rillig 11638: <td>NULLMAILER_GROUP</td>
1.159 rillig 11639: <td>NULLMAILER_USER</td>
1.156 leot 11640: </tr>
11641: <tr>
1.169 rillig 11642: <td>OASIS</td>
1.159 rillig 11643: <td>OASIS_BUILD_ARGS</td>
1.156 leot 11644: </tr>
11645: <tr>
1.169 rillig 11646: <td>OBJHOSTNAME</td>
1.159 rillig 11647: <td>OBJMACHINE</td>
1.156 leot 11648: </tr>
11649: <tr>
1.169 rillig 11650: <td>OCAML_FINDLIB_DIRS</td>
1.159 rillig 11651: <td>OCAML_FINDLIB_REGISTER</td>
1.156 leot 11652: </tr>
11653: <tr>
1.169 rillig 11654: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.159 rillig 11655: <td>OCAML_SITELIBDIR</td>
1.156 leot 11656: </tr>
11657: <tr>
1.169 rillig 11658: <td>OCAML_TOPKG_DOCDIR</td>
1.159 rillig 11659: <td>OCAML_USE_DUNE</td>
1.156 leot 11660: </tr>
11661: <tr>
1.169 rillig 11662: <td>OCAML_USE_FINDLIB</td>
1.159 rillig 11663: <td>OCAML_USE_JBUILDER</td>
1.156 leot 11664: </tr>
11665: <tr>
1.169 rillig 11666: <td>OCAML_USE_OASIS</td>
1.159 rillig 11667: <td>OCAML_USE_OASIS_DYNRUN</td>
1.156 leot 11668: </tr>
11669: <tr>
1.169 rillig 11670: <td>OCAML_USE_OPAM</td>
1.159 rillig 11671: <td>OCAML_USE_OPT_COMPILER</td>
1.156 leot 11672: </tr>
11673: <tr>
1.169 rillig 11674: <td>OCAML_USE_TOPKG</td>
1.159 rillig 11675: <td>OMF</td>
1.156 leot 11676: </tr>
11677: <tr>
1.169 rillig 11678: <td>ONLY_FOR_COMPILER</td>
1.159 rillig 11679: <td>ONLY_FOR_PLATFORM</td>
1.156 leot 11680: </tr>
11681: <tr>
1.169 rillig 11682: <td>OPENSSH_CHROOT</td>
1.159 rillig 11683: <td>OPENSSH_GROUP</td>
1.156 leot 11684: </tr>
11685: <tr>
1.169 rillig 11686: <td>OPENSSH_USER</td>
1.159 rillig 11687: <td>OPSYS</td>
1.156 leot 11688: </tr>
11689: <tr>
1.169 rillig 11690: <td>OPSYS_EMULDIR</td>
1.159 rillig 11691: <td>OSS_TYPE</td>
1.156 leot 11692: </tr>
11693: <tr>
1.169 rillig 11694: <td>OSX</td>
1.159 rillig 11695: <td>OSX_TOLERATE_SDK_SKEW</td>
1.161 leot 11696: </tr>
11697: <tr>
1.169 rillig 11698: <td>OS_HAVE_ALSA</td>
1.161 leot 11699: <td>OS_HAVE_RCD</td>
1.159 rillig 11700: </tr>
11701: <tr>
1.169 rillig 11702: <td>OS_VARIANT</td>
1.159 rillig 11703: <td>OS_VERSION</td>
1.156 leot 11704: </tr>
11705: <tr>
1.169 rillig 11706: <td>OTF_FONTS_DIR</td>
1.159 rillig 11707: <td>OVERRIDE_DIRDEPTH</td>
1.156 leot 11708: </tr>
11709: <tr>
1.169 rillig 11710: <td>OVERRIDE_GEMSPEC</td>
1.159 rillig 11711: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.161 leot 11712: </tr>
11713: <tr>
1.169 rillig 11714: <td>OVERRIDE_ROCKSPEC</td>
1.158 brook 11715: <td>OWN_DIRS</td>
1.156 leot 11716: </tr>
11717: <tr>
1.169 rillig 11718: <td>OWN_DIRS_PERMS</td>
1.158 brook 11719: <td>P4GROUP</td>
1.156 leot 11720: </tr>
11721: <tr>
1.169 rillig 11722: <td>P4PORT</td>
1.158 brook 11723: <td>P4ROOT</td>
1.156 leot 11724: </tr>
11725: <tr>
1.169 rillig 11726: <td>P4USER</td>
1.158 brook 11727: <td>PACKAGES</td>
1.156 leot 11728: </tr>
11729: <tr>
1.169 rillig 11730: <td>PALMOS_DEFAULT_SDK</td>
1.158 brook 11731: <td>PAMBASE</td>
1.156 leot 11732: </tr>
11733: <tr>
1.169 rillig 11734: <td>PAM_DEFAULT</td>
1.158 brook 11735: <td>PAPERSIZE</td>
1.156 leot 11736: </tr>
11737: <tr>
1.169 rillig 11738: <td>PASSIVE_FETCH</td>
1.158 brook 11739: <td>PATCHDIR</td>
1.156 leot 11740: </tr>
11741: <tr>
1.169 rillig 11742: <td>PATCHFILES</td>
1.158 brook 11743: <td>PATCH_ARGS</td>
1.169 rillig 11744: </tr>
11745: <tr>
1.161 leot 11746: <td>PATCH_DEBUG</td>
1.169 rillig 11747: <td>PATCH_DIST_ARGS</td>
1.156 leot 11748: </tr>
11749: <tr>
1.161 leot 11750: <td>PATCH_DIST_CAT</td>
1.169 rillig 11751: <td>PATCH_DIST_STRIP</td>
1.156 leot 11752: </tr>
11753: <tr>
1.161 leot 11754: <td>PATCH_FUZZ_FACTOR</td>
1.169 rillig 11755: <td>PATCH_STRIP</td>
1.156 leot 11756: </tr>
11757: <tr>
1.161 leot 11758: <td>PATH</td>
1.169 rillig 11759: <td>PCCBASE</td>
1.156 leot 11760: </tr>
11761: <tr>
1.161 leot 11762: <td>PEAR</td>
1.169 rillig 11763: <td>PEAR_CHANNEL</td>
1.156 leot 11764: </tr>
11765: <tr>
1.161 leot 11766: <td>PEAR_CHANNEL_ALIAS</td>
1.169 rillig 11767: <td>PEAR_CHANNEL_VERSION</td>
1.161 leot 11768: </tr>
11769: <tr>
1.157 leot 11770: <td>PEAR_CMD</td>
1.169 rillig 11771: <td>PEAR_LIB</td>
1.161 leot 11772: </tr>
11773: <tr>
11774: <td>PEAR_PACKAGE_XML</td>
1.169 rillig 11775: <td>PERL5</td>
1.156 leot 11776: </tr>
11777: <tr>
1.161 leot 11778: <td>PERL5_CONFIGURE</td>
1.169 rillig 11779: <td>PERL5_CONFIGURE_DIRS</td>
1.156 leot 11780: </tr>
11781: <tr>
1.161 leot 11782: <td>PERL5_LDFLAGS</td>
1.169 rillig 11783: <td>PERL5_LICENSE</td>
1.156 leot 11784: </tr>
11785: <tr>
1.161 leot 11786: <td>PERL5_MODULE_TYPE</td>
1.169 rillig 11787: <td>PERL5_PACKLIST</td>
1.156 leot 11788: </tr>
11789: <tr>
1.161 leot 11790: <td>PERL5_PACKLIST_DIR</td>
1.169 rillig 11791: <td>PERL5_PERLBASE</td>
1.156 leot 11792: </tr>
11793: <tr>
1.161 leot 11794: <td>PERL5_SITEBASE</td>
1.169 rillig 11795: <td>PERL5_USE_PACKLIST</td>
1.156 leot 11796: </tr>
11797: <tr>
1.161 leot 11798: <td>PERL5_VENDORBASE</td>
1.169 rillig 11799: <td>PFCTL</td>
1.156 leot 11800: </tr>
11801: <tr>
1.161 leot 11802: <td>PFVAR_H</td>
1.169 rillig 11803: <td>PF_VERSION</td>
1.156 leot 11804: </tr>
11805: <tr>
1.161 leot 11806: <td>PGGROUP</td>
1.169 rillig 11807: <td>PGHOME</td>
1.156 leot 11808: </tr>
11809: <tr>
1.161 leot 11810: <td>PGPKGSRCDIR</td>
1.169 rillig 11811: <td>PGSQL_TYPE</td>
1.156 leot 11812: </tr>
11813: <tr>
1.161 leot 11814: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.169 rillig 11815: <td>PGSQL_VERSION_DEFAULT</td>
1.156 leot 11816: </tr>
11817: <tr>
1.161 leot 11818: <td>PGUSER</td>
1.169 rillig 11819: <td>PG_LIB_EXT</td>
1.156 leot 11820: </tr>
11821: <tr>
1.161 leot 11822: <td>PHP</td>
1.169 rillig 11823: <td>PHPCOMMON_MK</td>
1.156 leot 11824: </tr>
11825: <tr>
1.161 leot 11826: <td>PHPPKGSRCDIR</td>
1.169 rillig 11827: <td>PHP_BASE_VERS</td>
1.156 leot 11828: </tr>
11829: <tr>
1.161 leot 11830: <td>PHP_CHECK_INSTALLED</td>
1.169 rillig 11831: <td>PHP_EXTENSION_DIR</td>
1.156 leot 11832: </tr>
11833: <tr>
1.161 leot 11834: <td>PHP_INITIAL_TEENY</td>
1.169 rillig 11835: <td>PHP_PKG_PREFIX</td>
1.156 leot 11836: </tr>
11837: <tr>
1.161 leot 11838: <td>PHP_VERSION</td>
1.169 rillig 11839: <td>PHP_VERSIONS_ACCEPTED</td>
1.156 leot 11840: </tr>
11841: <tr>
1.161 leot 11842: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.169 rillig 11843: <td>PHP_VERSION_DEFAULT</td>
1.156 leot 11844: </tr>
11845: <tr>
1.161 leot 11846: <td>PHP_VERSION_REQD</td>
1.169 rillig 11847: <td>PILRC_USE_GTK</td>
1.156 leot 11848: </tr>
11849: <tr>
1.161 leot 11850: <td>PKGCONFIG_BASE</td>
1.169 rillig 11851: <td>PKGCONFIG_FILE</td>
1.156 leot 11852: </tr>
11853: <tr>
1.161 leot 11854: <td>PKGCONFIG_OVERRIDE</td>
1.169 rillig 11855: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.156 leot 11856: </tr>
11857: <tr>
1.161 leot 11858: <td>PKGDIR</td>
1.169 rillig 11859: <td>PKGGNUDIR</td>
1.156 leot 11860: </tr>
11861: <tr>
1.161 leot 11862: <td>PKGINFODIR</td>
1.169 rillig 11863: <td>PKGLOCALEDIR</td>
1.156 leot 11864: </tr>
11865: <tr>
1.161 leot 11866: <td>PKGMANDIR</td>
1.169 rillig 11867: <td>PKGNAME</td>
1.156 leot 11868: </tr>
11869: <tr>
1.161 leot 11870: <td>PKGNAME_REQD</td>
1.169 rillig 11871: <td>PKGPATH</td>
1.156 leot 11872: </tr>
11873: <tr>
1.161 leot 11874: <td>PKGREVISION</td>
1.169 rillig 11875: <td>PKGSRC_BLAS_TYPES</td>
1.156 leot 11876: </tr>
11877: <tr>
1.160 brook 11878: <td>PKGSRC_CHANGES</td>
1.169 rillig 11879: <td>PKGSRC_COMPILER</td>
1.159 rillig 11880: </tr>
11881: <tr>
1.160 brook 11882: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.169 rillig 11883: <td>PKGSRC_LOCKTYPE</td>
1.156 leot 11884: </tr>
11885: <tr>
1.160 brook 11886: <td>PKGSRC_MAKE_ENV</td>
1.169 rillig 11887: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.156 leot 11888: </tr>
11889: <tr>
1.160 brook 11890: <td>PKGSRC_MKPIE</td>
1.169 rillig 11891: <td>PKGSRC_MKREPRO</td>
1.156 leot 11892: </tr>
11893: <tr>
1.160 brook 11894: <td>PKGSRC_RUN_TEST</td>
1.169 rillig 11895: <td>PKGSRC_SETENV</td>
1.156 leot 11896: </tr>
11897: <tr>
1.160 brook 11898: <td>PKGSRC_SLEEPSECS</td>
1.169 rillig 11899: <td>PKGSRC_TODO</td>
1.156 leot 11900: </tr>
11901: <tr>
1.160 brook 11902: <td>PKGSRC_USE_CTF</td>
1.169 rillig 11903: <td>PKGSRC_USE_FORTIFY</td>
1.156 leot 11904: </tr>
11905: <tr>
1.160 brook 11906: <td>PKGSRC_USE_RELRO</td>
1.169 rillig 11907: <td>PKGSRC_USE_SSP</td>
1.156 leot 11908: </tr>
11909: <tr>
1.160 brook 11910: <td>PKGSRC_USE_STACK_CHECK</td>
1.169 rillig 11911: <td>PKGTASKS_DATAFILE</td>
1.156 leot 11912: </tr>
11913: <tr>
1.160 brook 11914: <td>PKGTOOLS_ARGS</td>
1.169 rillig 11915: <td>PKGTOOLS_ENV</td>
1.156 leot 11916: </tr>
11917: <tr>
1.160 brook 11918: <td>PKG_ALTERNATIVES</td>
1.169 rillig 11919: <td>PKG_APACHE</td>
1.156 leot 11920: </tr>
11921: <tr>
1.160 brook 11922: <td>PKG_APACHE_ACCEPTED</td>
1.169 rillig 11923: <td>PKG_APACHE_DEFAULT</td>
1.156 leot 11924: </tr>
11925: <tr>
1.160 brook 11926: <td>PKG_BEST_EXISTS</td>
1.169 rillig 11927: <td>PKG_BUILD_OPTIONS</td>
1.156 leot 11928: </tr>
11929: <tr>
1.160 brook 11930: <td>PKG_COMPRESSION</td>
1.169 rillig 11931: <td>PKG_CONFIG</td>
1.156 leot 11932: </tr>
11933: <tr>
1.160 brook 11934: <td>PKG_CONFIG_PERMS</td>
1.169 rillig 11935: <td>PKG_CREATE_USERGROUP</td>
1.156 leot 11936: </tr>
11937: <tr>
1.160 brook 11938: <td>PKG_DB_TMPDIR</td>
1.169 rillig 11939: <td>PKG_DEBUG_LEVEL</td>
1.156 leot 11940: </tr>
11941: <tr>
1.160 brook 11942: <td>PKG_DEFAULT_OPTIONS</td>
1.169 rillig 11943: <td>PKG_DESTDIR_SUPPORT</td>
1.156 leot 11944: </tr>
11945: <tr>
1.160 brook 11946: <td>PKG_DEVELOPER</td>
1.169 rillig 11947: <td>PKG_DISABLED_OPTIONS</td>
1.156 leot 11948: </tr>
11949: <tr>
1.160 brook 11950: <td>PKG_FATAL_ERRORS</td>
1.169 rillig 11951: <td>PKG_FC</td>
1.156 leot 11952: </tr>
11953: <tr>
1.160 brook 11954: <td>PKG_FILELIST_CMD</td>
1.169 rillig 11955: <td>PKG_GECOS</td>
1.156 leot 11956: </tr>
11957: <tr>
1.160 brook 11958: <td>PKG_GID</td>
1.169 rillig 11959: <td>PKG_GROUPS</td>
1.156 leot 11960: </tr>
11961: <tr>
1.160 brook 11962: <td>PKG_GROUPS_VARS</td>
1.169 rillig 11963: <td>PKG_HOME</td>
1.156 leot 11964: </tr>
11965: <tr>
1.160 brook 11966: <td>PKG_INIT_SCRIPTS</td>
1.169 rillig 11967: <td>PKG_JAVA_HOME</td>
1.156 leot 11968: </tr>
11969: <tr>
1.160 brook 11970: <td>PKG_JVM</td>
1.169 rillig 11971: <td>PKG_JVMS_ACCEPTED</td>
1.156 leot 11972: </tr>
11973: <tr>
1.160 brook 11974: <td>PKG_JVM_DEFAULT</td>
1.169 rillig 11975: <td>PKG_LEGACY_OPTIONS</td>
1.156 leot 11976: </tr>
11977: <tr>
1.160 brook 11978: <td>PKG_LIBTOOL</td>
1.169 rillig 11979: <td>PKG_OPTIONS</td>
1.156 leot 11980: </tr>
11981: <tr>
1.160 brook 11982: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.169 rillig 11983: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.156 leot 11984: </tr>
11985: <tr>
1.160 brook 11986: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.169 rillig 11987: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.156 leot 11988: </tr>
11989: <tr>
1.160 brook 11990: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.169 rillig 11991: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.156 leot 11992: </tr>
11993: <tr>
1.160 brook 11994: <td>PKG_OPTIONS_VAR</td>
1.169 rillig 11995: <td>PKG_PHP</td>
1.156 leot 11996: </tr>
11997: <tr>
1.160 brook 11998: <td>PKG_PHP_MAJOR_VERS</td>
1.169 rillig 11999: <td>PKG_PHP_VERSION</td>
1.156 leot 12000: </tr>
12001: <tr>
1.160 brook 12002: <td>PKG_RCD_SCRIPTS</td>
1.169 rillig 12003: <td>PKG_REFCOUNT_DBDIR</td>
1.156 leot 12004: </tr>
12005: <tr>
1.160 brook 12006: <td>PKG_REGISTER_SHELLS</td>
1.169 rillig 12007: <td>PKG_RESUME_TRANSFERS</td>
1.156 leot 12008: </tr>
12009: <tr>
1.160 brook 12010: <td>PKG_SHELL</td>
1.169 rillig 12011: <td>PKG_SUGGESTED_OPTIONS</td>
1.156 leot 12012: </tr>
12013: <tr>
1.160 brook 12014: <td>PKG_SUPPORTED_OPTIONS</td>
1.169 rillig 12015: <td>PKG_SYSCONFBASE</td>
1.156 leot 12016: </tr>
12017: <tr>
1.160 brook 12018: <td>PKG_SYSCONFBASEDIR</td>
1.169 rillig 12019: <td>PKG_SYSCONFDIR</td>
1.156 leot 12020: </tr>
12021: <tr>
1.160 brook 12022: <td>PKG_SYSCONFDIR_PERMS</td>
1.169 rillig 12023: <td>PKG_SYSCONFSUBDIR</td>
1.156 leot 12024: </tr>
12025: <tr>
1.160 brook 12026: <td>PKG_SYSCONFVAR</td>
1.169 rillig 12027: <td>PKG_TOOLS_BIN</td>
1.156 leot 12028: </tr>
12029: <tr>
1.160 brook 12030: <td>PKG_UID</td>
1.169 rillig 12031: <td>PKG_UPDATE_FONTS_DB</td>
1.156 leot 12032: </tr>
12033: <tr>
1.160 brook 12034: <td>PKG_USERS</td>
1.169 rillig 12035: <td>PKG_USERS_VARS</td>
1.156 leot 12036: </tr>
12037: <tr>
1.160 brook 12038: <td>PKG_VERBOSE</td>
1.169 rillig 12039: <td>PLIST</td>
1.156 leot 12040: </tr>
12041: <tr>
1.160 brook 12042: <td>PLIST_AWK</td>
1.169 rillig 12043: <td>PLIST_AWK_ENV</td>
1.156 leot 12044: </tr>
12045: <tr>
1.160 brook 12046: <td>PLIST_SRC</td>
1.169 rillig 12047: <td>PLIST_SUBST</td>
1.156 leot 12048: </tr>
12049: <tr>
1.160 brook 12050: <td>PLIST_TYPE</td>
1.169 rillig 12051: <td>PLIST_VARS</td>
1.156 leot 12052: </tr>
12053: <tr>
1.160 brook 12054: <td>POPTOP_USE_MPPE</td>
1.169 rillig 12055: <td>POST_FETCH_HOOK</td>
1.156 leot 12056: </tr>
12057: <tr>
1.160 brook 12058: <td>PREFER</td>
1.169 rillig 12059: <td>PREFER_NATIVE</td>
1.156 leot 12060: </tr>
12061: <tr>
1.160 brook 12062: <td>PREFER_NATIVE_PTHREADS</td>
1.169 rillig 12063: <td>PREFER_PKGSRC</td>
1.156 leot 12064: </tr>
12065: <tr>
1.160 brook 12066: <td>PREFIX</td>
1.169 rillig 12067: <td>PREPEND_PATH</td>
1.156 leot 12068: </tr>
12069: <tr>
1.160 brook 12070: <td>PRE_ROOT_CMD</td>
1.169 rillig 12071: <td>PRIVILEGED_STAGES</td>
1.156 leot 12072: </tr>
12073: <tr>
1.160 brook 12074: <td>PS</td>
1.169 rillig 12075: <td>PTHREAD_AUTO_VARS</td>
1.156 leot 12076: </tr>
12077: <tr>
1.160 brook 12078: <td>PTHREAD_CFLAGS</td>
1.169 rillig 12079: <td>PTHREAD_LDFLAGS</td>
1.156 leot 12080: </tr>
12081: <tr>
1.160 brook 12082: <td>PTHREAD_LIBS</td>
1.169 rillig 12083: <td>PTHREAD_OPTS</td>
1.156 leot 12084: </tr>
12085: <tr>
1.160 brook 12086: <td>PTHREAD_TYPE</td>
1.169 rillig 12087: <td>PVM_SSH</td>
1.156 leot 12088: </tr>
12089: <tr>
1.160 brook 12090: <td>PYPKGPREFIX</td>
1.169 rillig 12091: <td>PYTHON_FOR_BUILD_ONLY</td>
1.156 leot 12092: </tr>
12093: <tr>
1.160 brook 12094: <td>PYTHON_SELF_CONFLICT</td>
1.169 rillig 12095: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.156 leot 12096: </tr>
12097: <tr>
1.160 brook 12098: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.169 rillig 12099: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.156 leot 12100: </tr>
12101: <tr>
1.160 brook 12102: <td>PYTHON_VERSION_DEFAULT</td>
1.169 rillig 12103: <td>PYTHON_VERSION_REQD</td>
1.156 leot 12104: </tr>
12105: <tr>
1.160 brook 12106: <td>PYVERSSUFFIX</td>
1.169 rillig 12107: <td>PY_NO_EGG</td>
1.156 leot 12108: </tr>
12109: <tr>
1.160 brook 12110: <td>QMAILDIR</td>
1.169 rillig 12111: <td>QMAIL_ALIAS_USER</td>
1.156 leot 12112: </tr>
12113: <tr>
1.160 brook 12114: <td>QMAIL_DAEMON_USER</td>
1.169 rillig 12115: <td>QMAIL_LOG_USER</td>
1.156 leot 12116: </tr>
12117: <tr>
1.160 brook 12118: <td>QMAIL_NOFILES_GROUP</td>
1.169 rillig 12119: <td>QMAIL_PASSWD_USER</td>
1.156 leot 12120: </tr>
12121: <tr>
1.160 brook 12122: <td>QMAIL_QMAIL_GROUP</td>
1.169 rillig 12123: <td>QMAIL_QUEUE_DIR</td>
1.156 leot 12124: </tr>
12125: <tr>
1.160 brook 12126: <td>QMAIL_QUEUE_EXTRA</td>
1.169 rillig 12127: <td>QMAIL_QUEUE_USER</td>
1.156 leot 12128: </tr>
12129: <tr>
1.160 brook 12130: <td>QMAIL_REMOTE_USER</td>
1.169 rillig 12131: <td>QMAIL_ROOT_USER</td>
1.156 leot 12132: </tr>
12133: <tr>
1.160 brook 12134: <td>QMAIL_SEND_USER</td>
1.169 rillig 12135: <td>QPOPPER_FAC</td>
1.156 leot 12136: </tr>
12137: <tr>
1.160 brook 12138: <td>QPOPPER_SPOOL_DIR</td>
1.169 rillig 12139: <td>QPOPPER_USER</td>
1.156 leot 12140: </tr>
12141: <tr>
1.160 brook 12142: <td>RAKE_NAME</td>
1.169 rillig 12143: <td>RASMOL_DEPTH</td>
1.156 leot 12144: </tr>
12145: <tr>
1.161 leot 12146: <td>RCD_DIR</td>
1.169 rillig 12147: <td>RCD_ORDER</td>
1.161 leot 12148: </tr>
12149: <tr>
1.160 brook 12150: <td>RCD_SCRIPTS</td>
1.169 rillig 12151: <td>RCD_SCRIPTS_DIR</td>
1.159 rillig 12152: </tr>
12153: <tr>
1.160 brook 12154: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.169 rillig 12155: <td>RCD_SCRIPTS_MODE</td>
1.156 leot 12156: </tr>
12157: <tr>
1.160 brook 12158: <td>RCD_SCRIPTS_SHELL</td>
1.169 rillig 12159: <td>RCD_SCRIPT_SRC</td>
1.156 leot 12160: </tr>
12161: <tr>
1.161 leot 12162: <td>RCD_SUBR</td>
1.169 rillig 12163: <td>RDOC</td>
1.161 leot 12164: </tr>
12165: <tr>
12166: <td>READLINE_DEFAULT</td>
1.169 rillig 12167: <td>READLINE_TYPE</td>
1.156 leot 12168: </tr>
12169: <tr>
1.161 leot 12170: <td>REAL_ROOT_GROUP</td>
1.169 rillig 12171: <td>REAL_ROOT_USER</td>
1.156 leot 12172: </tr>
12173: <tr>
1.161 leot 12174: <td>RECURSIVE_MAKE</td>
1.169 rillig 12175: <td>RELAY_CTRL_DIR</td>
1.156 leot 12176: </tr>
12177: <tr>
1.161 leot 12178: <td>REPLACE_AWK</td>
1.169 rillig 12179: <td>REPLACE_BASH</td>
1.156 leot 12180: </tr>
12181: <tr>
1.161 leot 12182: <td>REPLACE_CSH</td>
1.169 rillig 12183: <td>REPLACE_KSH</td>
1.156 leot 12184: </tr>
12185: <tr>
1.161 leot 12186: <td>REPLACE_PERL</td>
1.169 rillig 12187: <td>REPLACE_PERL6</td>
1.156 leot 12188: </tr>
12189: <tr>
1.166 leot 12190: <td>REPLACE_PHP</td>
1.169 rillig 12191: <td>REPLACE_PYTHON</td>
1.166 leot 12192: </tr>
12193: <tr>
12194: <td>REPLACE_RUBY</td>
1.169 rillig 12195: <td>REPLACE_RUBY_DIRS</td>
1.156 leot 12196: </tr>
12197: <tr>
1.166 leot 12198: <td>REPLACE_RUBY_PAT</td>
1.169 rillig 12199: <td>REPLACE_SH</td>
1.156 leot 12200: </tr>
12201: <tr>
1.166 leot 12202: <td>REPLACE_TEXLUA</td>
1.169 rillig 12203: <td>REQD_DIRS</td>
1.156 leot 12204: </tr>
12205: <tr>
1.166 leot 12206: <td>REQD_DIRS_PERMS</td>
1.169 rillig 12207: <td>REQD_FILES</td>
1.156 leot 12208: </tr>
12209: <tr>
1.166 leot 12210: <td>REQD_FILES_MODE</td>
1.169 rillig 12211: <td>REQD_FILES_PERMS</td>
1.156 leot 12212: </tr>
12213: <tr>
1.166 leot 12214: <td>RESOLV_AUTO_VARS</td>
1.169 rillig 12215: <td>RESOLV_LDFLAGS</td>
1.156 leot 12216: </tr>
12217: <tr>
1.166 leot 12218: <td>RESOLV_LIBS</td>
1.169 rillig 12219: <td>RM</td>
1.156 leot 12220: </tr>
12221: <tr>
1.166 leot 12222: <td>ROCKSPEC_NAME</td>
1.169 rillig 12223: <td>ROCKSPEC_SPECFILE</td>
1.161 leot 12224: </tr>
12225: <tr>
1.166 leot 12226: <td>ROOT_CMD</td>
1.169 rillig 12227: <td>ROOT_GROUP</td>
1.156 leot 12228: </tr>
12229: <tr>
1.166 leot 12230: <td>ROOT_USER</td>
1.169 rillig 12231: <td>RPCGEN</td>
1.156 leot 12232: </tr>
12233: <tr>
1.166 leot 12234: <td>RPM</td>
1.169 rillig 12235: <td>RPM2PKG_PLIST</td>
1.156 leot 12236: </tr>
12237: <tr>
1.166 leot 12238: <td>RPM2PKG_PREFIX</td>
1.169 rillig 12239: <td>RPM2PKG_STAGE</td>
1.156 leot 12240: </tr>
12241: <tr>
1.166 leot 12242: <td>RPM2PKG_STRIP</td>
1.169 rillig 12243: <td>RPM2PKG_SUBPREFIX</td>
1.156 leot 12244: </tr>
12245: <tr>
1.166 leot 12246: <td>RPMFILES</td>
1.169 rillig 12247: <td>RPMIGNOREPATH</td>
1.156 leot 12248: </tr>
12249: <tr>
1.166 leot 12250: <td>RPM_DB_PREFIX</td>
1.169 rillig 12251: <td>RSSH_CVS_PATH</td>
1.156 leot 12252: </tr>
12253: <tr>
1.166 leot 12254: <td>RSSH_RDIST_PATH</td>
1.169 rillig 12255: <td>RSSH_RSYNC_PATH</td>
1.156 leot 12256: </tr>
12257: <tr>
1.166 leot 12258: <td>RSSH_SCP_PATH</td>
1.169 rillig 12259: <td>RSSH_SFTP_SERVER_PATH</td>
1.156 leot 12260: </tr>
12261: <tr>
1.166 leot 12262: <td>RUBY</td>
1.169 rillig 12263: <td>RUBYGEM</td>
1.156 leot 12264: </tr>
12265: <tr>
1.166 leot 12266: <td>RUBYGEM_NAME</td>
1.169 rillig 12267: <td>RUBYGEM_OPTIONS</td>
1.156 leot 12268: </tr>
12269: <tr>
1.166 leot 12270: <td>RUBY_ABI_VERSION</td>
1.169 rillig 12271: <td>RUBY_ARCH</td>
1.156 leot 12272: </tr>
12273: <tr>
1.166 leot 12274: <td>RUBY_ARCHINC</td>
1.169 rillig 12275: <td>RUBY_ARCHLIB</td>
1.156 leot 12276: </tr>
12277: <tr>
1.166 leot 12278: <td>RUBY_BASE</td>
1.169 rillig 12279: <td>RUBY_BASERIDIR</td>
1.156 leot 12280: </tr>
12281: <tr>
1.166 leot 12282: <td>RUBY_BUILD_DOCUMENT</td>
1.169 rillig 12283: <td>RUBY_DLEXT</td>
1.156 leot 12284: </tr>
12285: <tr>
1.166 leot 12286: <td>RUBY_DOC</td>
1.169 rillig 12287: <td>RUBY_DYNAMIC_DIRS</td>
1.156 leot 12288: </tr>
12289: <tr>
1.166 leot 12290: <td>RUBY_EG</td>
1.169 rillig 12291: <td>RUBY_ENCODING_ARG</td>
1.156 leot 12292: </tr>
12293: <tr>
1.166 leot 12294: <td>RUBY_EXTCONF</td>
1.169 rillig 12295: <td>RUBY_EXTCONF_CHECK</td>
1.156 leot 12296: </tr>
12297: <tr>
1.166 leot 12298: <td>RUBY_EXTCONF_DEBUG</td>
1.169 rillig 12299: <td>RUBY_EXTCONF_MAKEFILE</td>
1.156 leot 12300: </tr>
12301: <tr>
1.166 leot 12302: <td>RUBY_GEM_BASE</td>
1.169 rillig 12303: <td>RUBY_INC</td>
1.156 leot 12304: </tr>
12305: <tr>
1.166 leot 12306: <td>RUBY_LIB</td>
1.169 rillig 12307: <td>RUBY_LIB_BASE</td>
1.156 leot 12308: </tr>
12309: <tr>
1.166 leot 12310: <td>RUBY_NAME</td>
1.169 rillig 12311: <td>RUBY_NOVERSION</td>
1.156 leot 12312: </tr>
12313: <tr>
1.166 leot 12314: <td>RUBY_PKGPREFIX</td>
1.169 rillig 12315: <td>RUBY_RAILS</td>
1.156 leot 12316: </tr>
12317: <tr>
1.166 leot 12318: <td>RUBY_RAILS42_VERSION</td>
1.169 rillig 12319: <td>RUBY_RAILS51_VERSION</td>
1.156 leot 12320: </tr>
12321: <tr>
1.166 leot 12322: <td>RUBY_RAILS52_VERSION</td>
1.169 rillig 12323: <td>RUBY_RAILS_ACCEPTED</td>
1.156 leot 12324: </tr>
12325: <tr>
1.166 leot 12326: <td>RUBY_RAILS_DEFAULT</td>
1.169 rillig 12327: <td>RUBY_RAILS_REQD</td>
1.156 leot 12328: </tr>
12329: <tr>
1.166 leot 12330: <td>RUBY_RAILS_STRICT_DEP</td>
1.169 rillig 12331: <td>RUBY_RIDIR</td>
1.156 leot 12332: </tr>
12333: <tr>
1.166 leot 12334: <td>RUBY_SETUP</td>
1.169 rillig 12335: <td>RUBY_SHLIB</td>
1.156 leot 12336: </tr>
12337: <tr>
1.166 leot 12338: <td>RUBY_SHLIBALIAS</td>
1.169 rillig 12339: <td>RUBY_SHLIBVER</td>
1.156 leot 12340: </tr>
12341: <tr>
1.166 leot 12342: <td>RUBY_SIMPLE_INSTALL</td>
1.169 rillig 12343: <td>RUBY_SITEARCHLIB</td>
1.156 leot 12344: </tr>
12345: <tr>
1.166 leot 12346: <td>RUBY_SITELIB</td>
1.169 rillig 12347: <td>RUBY_SITELIB_BASE</td>
1.156 leot 12348: </tr>
12349: <tr>
1.166 leot 12350: <td>RUBY_SITERIDIR</td>
1.169 rillig 12351: <td>RUBY_SLEXT</td>
1.156 leot 12352: </tr>
12353: <tr>
1.166 leot 12354: <td>RUBY_SRCDIR</td>
1.169 rillig 12355: <td>RUBY_STATICLIB</td>
1.156 leot 12356: </tr>
12357: <tr>
1.166 leot 12358: <td>RUBY_SUFFIX</td>
1.169 rillig 12359: <td>RUBY_SYSRIDIR</td>
1.156 leot 12360: </tr>
12361: <tr>
1.166 leot 12362: <td>RUBY_USE_PTHREAD</td>
1.169 rillig 12363: <td>RUBY_VENDORARCHLIB</td>
1.156 leot 12364: </tr>
12365: <tr>
1.166 leot 12366: <td>RUBY_VENDORLIB</td>
1.169 rillig 12367: <td>RUBY_VENDORLIB_BASE</td>
1.156 leot 12368: </tr>
12369: <tr>
1.166 leot 12370: <td>RUBY_VER</td>
1.169 rillig 12371: <td>RUBY_VERSION</td>
1.156 leot 12372: </tr>
12373: <tr>
1.166 leot 12374: <td>RUBY_VERSIONS_ACCEPTED</td>
1.169 rillig 12375: <td>RUBY_VERSION_DEFAULT</td>
1.156 leot 12376: </tr>
12377: <tr>
1.166 leot 12378: <td>RUBY_VERSION_REQD</td>
1.169 rillig 12379: <td>RUBY_VER_DIR</td>
1.156 leot 12380: </tr>
12381: <tr>
1.166 leot 12382: <td>RUN</td>
1.169 rillig 12383: <td>RUN_LDCONFIG</td>
1.156 leot 12384: </tr>
12385: <tr>
1.166 leot 12386: <td>SAWFISH_THEMES</td>
1.169 rillig 12387: <td>SCO</td>
1.156 leot 12388: </tr>
12389: <tr>
1.166 leot 12390: <td>SCREWS_GROUP</td>
1.169 rillig 12391: <td>SCREWS_USER</td>
1.156 leot 12392: </tr>
12393: <tr>
1.166 leot 12394: <td>SCRIPTS_ENV</td>
1.169 rillig 12395: <td>SCROLLKEEPER_DATADIR</td>
1.156 leot 12396: </tr>
12397: <tr>
1.166 leot 12398: <td>SCROLLKEEPER_REBUILDDB</td>
1.169 rillig 12399: <td>SCROLLKEEPER_UPDATEDB</td>
1.156 leot 12400: </tr>
12401: <tr>
1.166 leot 12402: <td>SDIST_PAWD</td>
1.169 rillig 12403: <td>SERIAL_DEVICES</td>
1.156 leot 12404: </tr>
12405: <tr>
1.166 leot 12406: <td>SETGIDGAME</td>
1.169 rillig 12407: <td>SETGID_GAMES_PERMS</td>
1.156 leot 12408: </tr>
12409: <tr>
1.166 leot 12410: <td>SETUID_ROOT_PERMS</td>
1.169 rillig 12411: <td>SH</td>
1.156 leot 12412: </tr>
12413: <tr>
1.166 leot 12414: <td>SHLIB</td>
1.169 rillig 12415: <td>SHORTNAME</td>
1.156 leot 12416: </tr>
12417: <tr>
1.166 leot 12418: <td>SIGN_PACKAGES</td>
1.169 rillig 12419: <td>SILC_CLIENT_WITH_PERL</td>
1.156 leot 12420: </tr>
12421: <tr>
1.166 leot 12422: <td>SITE_SPECIFIC_PKGS</td>
1.169 rillig 12423: <td>SKIP_DEPENDS</td>
1.159 rillig 12424: </tr>
12425: <tr>
1.166 leot 12426: <td>SMF_INSTANCES</td>
1.169 rillig 12427: <td>SMF_MANIFEST</td>
1.156 leot 12428: </tr>
12429: <tr>
1.166 leot 12430: <td>SMF_METHODS</td>
1.169 rillig 12431: <td>SMF_METHOD_SHELL</td>
1.156 leot 12432: </tr>
12433: <tr>
1.166 leot 12434: <td>SMF_METHOD_SRC</td>
1.169 rillig 12435: <td>SMF_NAME</td>
1.156 leot 12436: </tr>
12437: <tr>
1.166 leot 12438: <td>SMF_PREFIX</td>
1.169 rillig 12439: <td>SMF_SRCDIR</td>
1.156 leot 12440: </tr>
12441: <tr>
1.166 leot 12442: <td>SNIPROXY_GROUP</td>
1.169 rillig 12443: <td>SNIPROXY_USER</td>
1.156 leot 12444: </tr>
12445: <tr>
1.166 leot 12446: <td>SOURCE_BUFFSIZE</td>
1.169 rillig 12447: <td>SPECIAL_PERMS</td>
1.156 leot 12448: </tr>
12449: <tr>
1.166 leot 12450: <td>SPECIFIC_PKGS</td>
1.169 rillig 12451: <td>SSH_SUID</td>
1.156 leot 12452: </tr>
12453: <tr>
1.166 leot 12454: <td>SSP_SUPPORTED</td>
1.169 rillig 12455: <td>SSYNC_PAWD</td>
1.156 leot 12456: </tr>
12457: <tr>
1.160 brook 12458: <td>STEP_MSG</td>
1.169 rillig 12459: <td>STRIP</td>
1.156 leot 12460: </tr>
12461: <tr>
1.160 brook 12462: <td>STRIP_DBG</td>
1.169 rillig 12463: <td>STRIP_DEBUG</td>
1.156 leot 12464: </tr>
12465: <tr>
1.160 brook 12466: <td>STRIP_DEBUG_SUPPORTED</td>
1.169 rillig 12467: <td>STRIP_FILES_SKIP</td>
1.156 leot 12468: </tr>
12469: <tr>
1.160 brook 12470: <td>SU</td>
1.169 rillig 12471: <td>SUBDIR</td>
1.156 leot 12472: </tr>
12473: <tr>
1.160 brook 12474: <td>SUBST_CLASSES</td>
1.169 rillig 12475: <td>SUBST_FILES</td>
1.156 leot 12476: </tr>
12477: <tr>
1.160 brook 12478: <td>SUBST_FILTER_CMD</td>
1.169 rillig 12479: <td>SUBST_MESSAGE</td>
1.156 leot 12480: </tr>
12481: <tr>
1.160 brook 12482: <td>SUBST_SED</td>
1.169 rillig 12483: <td>SUBST_SHOW_DIFF</td>
1.156 leot 12484: </tr>
12485: <tr>
1.160 brook 12486: <td>SUBST_SKIP_TEXT_CHECK</td>
1.169 rillig 12487: <td>SUBST_STAGE</td>
1.156 leot 12488: </tr>
12489: <tr>
1.160 brook 12490: <td>SUBST_VARS</td>
1.169 rillig 12491: <td>SUNWSPROBASE</td>
1.156 leot 12492: </tr>
12493: <tr>
1.160 brook 12494: <td>SUSE_PREFER</td>
1.169 rillig 12495: <td>SU_CMD</td>
1.156 leot 12496: </tr>
12497: <tr>
1.161 leot 12498: <td>SVN_EXTRACTDIR</td>
1.169 rillig 12499: <td>SVN_REPO</td>
1.161 leot 12500: </tr>
12501: <tr>
12502: <td>SVN_REPOSITORIES</td>
1.169 rillig 12503: <td>SVN_REVISION</td>
1.161 leot 12504: </tr>
12505: <tr>
1.160 brook 12506: <td>TERMCAP_TYPE</td>
1.169 rillig 12507: <td>TERMINFO_DEFAULT</td>
1.159 rillig 12508: </tr>
12509: <tr>
1.160 brook 12510: <td>TERMINFO_TYPE</td>
1.169 rillig 12511: <td>TEST</td>
1.156 leot 12512: </tr>
12513: <tr>
1.160 brook 12514: <td>TEST_DEPENDS</td>
1.169 rillig 12515: <td>TEST_DIRS</td>
1.156 leot 12516: </tr>
12517: <tr>
1.160 brook 12518: <td>TEST_ENV</td>
1.169 rillig 12519: <td>TEST_MAKE_CMD</td>
1.156 leot 12520: </tr>
12521: <tr>
1.160 brook 12522: <td>TEST_MAKE_FLAGS</td>
1.169 rillig 12523: <td>TEST_TARGET</td>
1.156 leot 12524: </tr>
12525: <tr>
1.160 brook 12526: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.169 rillig 12527: <td>TEXLIVE_REV</td>
1.156 leot 12528: </tr>
12529: <tr>
1.166 leot 12530: <td>TEXLIVE_UNVERSIONED</td>
1.169 rillig 12531: <td>TEXMFSITE</td>
1.156 leot 12532: </tr>
12533: <tr>
1.159 rillig 12534: <td>TEX_FORMATS</td>
1.169 rillig 12535: <td>TEX_HYPHEN_DAT</td>
1.156 leot 12536: </tr>
12537: <tr>
1.159 rillig 12538: <td>TEX_HYPHEN_DEF</td>
1.169 rillig 12539: <td>TEX_TEXMF_DIRS</td>
1.156 leot 12540: </tr>
12541: <tr>
1.159 rillig 12542: <td>THTTPD_LOG_FACILITY</td>
1.169 rillig 12543: <td>TO</td>
1.156 leot 12544: </tr>
12545: <tr>
1.159 rillig 12546: <td>TOOLS_ALIASES</td>
1.169 rillig 12547: <td>TOOLS_ARGS</td>
1.156 leot 12548: </tr>
12549: <tr>
1.159 rillig 12550: <td>TOOLS_BROKEN</td>
1.169 rillig 12551: <td>TOOLS_CMD</td>
1.156 leot 12552: </tr>
12553: <tr>
1.159 rillig 12554: <td>TOOLS_CREATE</td>
1.169 rillig 12555: <td>TOOLS_DIR</td>
1.156 leot 12556: </tr>
12557: <tr>
1.159 rillig 12558: <td>TOOLS_FAIL</td>
1.169 rillig 12559: <td>TOOLS_GNU_MISSING</td>
1.156 leot 12560: </tr>
12561: <tr>
1.159 rillig 12562: <td>TOOLS_LDCONFIG</td>
1.169 rillig 12563: <td>TOOLS_NOOP</td>
1.156 leot 12564: </tr>
12565: <tr>
1.159 rillig 12566: <td>TOOLS_PATH</td>
1.169 rillig 12567: <td>TOOLS_SCRIPT</td>
1.156 leot 12568: </tr>
12569: <tr>
1.159 rillig 12570: <td>TOOL_DEPENDS</td>
1.169 rillig 12571: <td>TTF_FONTDIR</td>
1.161 leot 12572: </tr>
12573: <tr>
1.157 leot 12574: <td>TTF_FONTS_DIR</td>
1.169 rillig 12575: <td>TYPE</td>
1.156 leot 12576: </tr>
12577: <tr>
1.157 leot 12578: <td>UAC_REQD_EXECS</td>
1.169 rillig 12579: <td>UCSPI_SSL_GROUP</td>
1.156 leot 12580: </tr>
12581: <tr>
1.157 leot 12582: <td>UCSPI_SSL_USER</td>
1.169 rillig 12583: <td>UNLIMIT_RESOURCES</td>
1.156 leot 12584: </tr>
12585: <tr>
1.157 leot 12586: <td>UNPRIVILEGED</td>
1.169 rillig 12587: <td>UNPRIVILEGED_GROUP</td>
1.156 leot 12588: </tr>
12589: <tr>
1.157 leot 12590: <td>UNPRIVILEGED_GROUPS</td>
1.169 rillig 12591: <td>UNPRIVILEGED_USER</td>
1.156 leot 12592: </tr>
12593: <tr>
1.157 leot 12594: <td>UNWRAP_FILES</td>
1.169 rillig 12595: <td>UNWRAP_PATTERNS</td>
1.156 leot 12596: </tr>
12597: <tr>
1.157 leot 12598: <td>UPDATE_GEMSPEC</td>
1.169 rillig 12599: <td>UPDATE_TARGET</td>
1.156 leot 12600: </tr>
12601: <tr>
1.157 leot 12602: <td>URI</td>
1.169 rillig 12603: <td>USA</td>
1.156 leot 12604: </tr>
12605: <tr>
1.157 leot 12606: <td>USERGROUP_PHASE</td>
1.169 rillig 12607: <td>USERPPP_GROUP</td>
1.156 leot 12608: </tr>
12609: <tr>
1.157 leot 12610: <td>USER_SPECIFIC_PKGS</td>
1.169 rillig 12611: <td>USE_ABI_DEPENDS</td>
1.156 leot 12612: </tr>
12613: <tr>
1.157 leot 12614: <td>USE_APR</td>
1.169 rillig 12615: <td>USE_BSD_MAKEFILE</td>
1.156 leot 12616: </tr>
12617: <tr>
1.157 leot 12618: <td>USE_BUILTIN</td>
1.169 rillig 12619: <td>USE_CROSS_COMPILE</td>
1.156 leot 12620: </tr>
12621: <tr>
1.157 leot 12622: <td>USE_CURSES</td>
1.169 rillig 12623: <td>USE_CWRAPPERS</td>
1.156 leot 12624: </tr>
12625: <tr>
1.157 leot 12626: <td>USE_DB185</td>
1.169 rillig 12627: <td>USE_FEATURES</td>
1.156 leot 12628: </tr>
12629: <tr>
1.157 leot 12630: <td>USE_GAMESGROUP</td>
1.169 rillig 12631: <td>USE_GCC_RUNTIME</td>
1.156 leot 12632: </tr>
12633: <tr>
1.157 leot 12634: <td>USE_IMAKE</td>
1.169 rillig 12635: <td>USE_JAVA</td>
1.156 leot 12636: </tr>
12637: <tr>
1.157 leot 12638: <td>USE_JAVA2</td>
1.169 rillig 12639: <td>USE_LANGUAGES</td>
1.156 leot 12640: </tr>
12641: <tr>
1.157 leot 12642: <td>USE_LIBTOOL</td>
1.169 rillig 12643: <td>USE_NATIVE_GCC</td>
1.156 leot 12644: </tr>
12645: <tr>
1.157 leot 12646: <td>USE_NETBSD_REPO</td>
1.169 rillig 12647: <td>USE_PKGSRC_GCC</td>
1.156 leot 12648: </tr>
12649: <tr>
1.157 leot 12650: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.169 rillig 12651: <td>USE_PKGTASKS</td>
1.156 leot 12652: </tr>
12653: <tr>
1.169 rillig 12654: <td>USE_PKG_ADMIN_DIGEST</td>
1.157 leot 12655: <td>USE_RUBY_EXTCONF</td>
1.156 leot 12656: </tr>
12657: <tr>
1.166 leot 12658: <td>USE_RUBY_INSTALL</td>
1.157 leot 12659: <td>USE_RUBY_SETUP</td>
1.156 leot 12660: </tr>
12661: <tr>
1.166 leot 12662: <td>USE_RUBY_SETUP_PKG</td>
1.157 leot 12663: <td>USE_TOOLS</td>
1.156 leot 12664: </tr>
12665: <tr>
1.166 leot 12666: <td>UUCP_GROUP</td>
1.157 leot 12667: <td>UUCP_USER</td>
1.156 leot 12668: </tr>
12669: <tr>
1.166 leot 12670: <td>VARBASE</td>
1.157 leot 12671: <td>VARNAME</td>
1.156 leot 12672: </tr>
12673: <tr>
1.166 leot 12674: <td>VIM_EXTRA_OPTS</td>
1.157 leot 12675: <td>WARNING_MSG</td>
1.156 leot 12676: </tr>
12677: <tr>
1.166 leot 12678: <td>WCALC_CGIDIR</td>
1.157 leot 12679: <td>WCALC_CGIPATH</td>
1.156 leot 12680: </tr>
12681: <tr>
1.166 leot 12682: <td>WCALC_HTMLDIR</td>
1.157 leot 12683: <td>WCALC_HTMLPATH</td>
1.156 leot 12684: </tr>
12685: <tr>
1.166 leot 12686: <td>WDM_MANAGERS</td>
1.157 leot 12687: <td>WRAPPER_REORDER_CMDS</td>
1.156 leot 12688: </tr>
12689: <tr>
1.166 leot 12690: <td>WRKDIR</td>
1.157 leot 12691: <td>WRKDIR_BASENAME</td>
1.156 leot 12692: </tr>
12693: <tr>
1.166 leot 12694: <td>WRKDIR_LOCKTYPE</td>
1.157 leot 12695: <td>WRKLOG</td>
1.156 leot 12696: </tr>
12697: <tr>
1.166 leot 12698: <td>WRKOBJDIR</td>
1.157 leot 12699: <td>WRKSRC</td>
1.156 leot 12700: </tr>
12701: <tr>
1.166 leot 12702: <td>WXGTK_ACCEPTED</td>
1.157 leot 12703: <td>WXGTK_DEFAULT</td>
1.156 leot 12704: </tr>
12705: <tr>
1.166 leot 12706: <td>X10_PORT</td>
1.157 leot 12707: <td>X11</td>
1.156 leot 12708: </tr>
12709: <tr>
1.166 leot 12710: <td>X11BASE</td>
1.157 leot 12711: <td>X11_PKGSRCDIR</td>
1.156 leot 12712: </tr>
12713: <tr>
1.166 leot 12714: <td>X11_TYPE</td>
1.157 leot 12715: <td>X509_CERTIFICATE</td>
1.156 leot 12716: </tr>
12717: <tr>
1.166 leot 12718: <td>X509_KEY</td>
1.157 leot 12719: <td>XAW_TYPE</td>
1.156 leot 12720: </tr>
12721: <tr>
1.166 leot 12722: <td>XLOCK_DEFAULT_MODE</td>
1.157 leot 12723: <td>XMKMF_FLAGS</td>
1.156 leot 12724: </tr>
12725: <tr>
1.166 leot 12726: <td>XXX</td>
1.161 leot 12727: <td>XXXX</td>
1.159 rillig 12728: </tr>
12729: <tr>
1.166 leot 12730: <td>YES</td>
1.159 rillig 12731: <td>ZERO_FILESIZE_P</td>
1.156 leot 12732: </tr>
12733: <tr>
1.166 leot 12734: <td>ZSH_STATIC</td>
1.159 rillig 12735: <td>__stdc__</td>
1.156 leot 12736: </tr>
12737: <tr>
1.166 leot 12738: <td>_vargroups</td>
1.159 rillig 12739: <td>add</td>
1.156 leot 12740: </tr>
12741: <tr>
1.166 leot 12742: <td>all</td>
1.159 rillig 12743: <td>alternatives</td>
1.156 leot 12744: </tr>
12745: <tr>
1.166 leot 12746: <td>aslr</td>
1.159 rillig 12747: <td>asprintf</td>
1.161 leot 12748: </tr>
12749: <tr>
1.166 leot 12750: <td>atlas</td>
1.158 brook 12751: <td>autoconf</td>
1.156 leot 12752: </tr>
12753: <tr>
1.166 leot 12754: <td>automake</td>
1.158 brook 12755: <td>autoreconf</td>
1.156 leot 12756: </tr>
12757: <tr>
1.166 leot 12758: <td>awk</td>
1.158 brook 12759: <td>bash</td>
1.156 leot 12760: </tr>
12761: <tr>
1.166 leot 12762: <td>big-endian</td>
1.158 brook 12763: <td>bin-install</td>
1.156 leot 12764: </tr>
12765: <tr>
1.166 leot 12766: <td>binpkg-list</td>
1.161 leot 12767: <td>blas</td>
1.159 rillig 12768: </tr>
12769: <tr>
1.166 leot 12770: <td>bootstrap-depends</td>
1.159 rillig 12771: <td>broken</td>
1.156 leot 12772: </tr>
12773: <tr>
1.166 leot 12774: <td>broken_on_platform</td>
1.159 rillig 12775: <td>build</td>
1.156 leot 12776: </tr>
12777: <tr>
1.166 leot 12778: <td>build-env</td>
1.159 rillig 12779: <td>buildlink-directories</td>
1.156 leot 12780: </tr>
12781: <tr>
1.166 leot 12782: <td>buildlink-oss-soundcard-h</td>
1.159 rillig 12783: <td>c</td>
1.156 leot 12784: </tr>
12785: <tr>
1.166 leot 12786: <td>c++</td>
1.159 rillig 12787: <td>ccache</td>
1.156 leot 12788: </tr>
12789: <tr>
1.166 leot 12790: <td>cce</td>
1.159 rillig 12791: <td>cdefs</td>
1.156 leot 12792: </tr>
12793: <tr>
1.166 leot 12794: <td>changes</td>
1.159 rillig 12795: <td>changes-entry</td>
1.156 leot 12796: </tr>
12797: <tr>
1.166 leot 12798: <td>changes-entry-noupdate</td>
1.159 rillig 12799: <td>check</td>
1.156 leot 12800: </tr>
12801: <tr>
1.166 leot 12802: <td>check-clean</td>
1.159 rillig 12803: <td>check-files</td>
1.156 leot 12804: </tr>
12805: <tr>
1.166 leot 12806: <td>check-files-clean</td>
1.159 rillig 12807: <td>check-vulnerable</td>
1.156 leot 12808: </tr>
12809: <tr>
1.166 leot 12810: <td>checksum</td>
1.159 rillig 12811: <td>checksum-phase</td>
1.156 leot 12812: </tr>
12813: <tr>
1.166 leot 12814: <td>clean</td>
1.159 rillig 12815: <td>clean-depends</td>
1.156 leot 12816: </tr>
12817: <tr>
1.166 leot 12818: <td>cleandir</td>
1.159 rillig 12819: <td>commit</td>
1.156 leot 12820: </tr>
12821: <tr>
1.166 leot 12822: <td>commit-changes-entry</td>
1.159 rillig 12823: <td>compact</td>
1.156 leot 12824: </tr>
12825: <tr>
1.166 leot 12826: <td>compiler</td>
1.159 rillig 12827: <td>conf</td>
1.156 leot 12828: </tr>
12829: <tr>
1.166 leot 12830: <td>config.guess</td>
1.159 rillig 12831: <td>config.sub</td>
1.156 leot 12832: </tr>
12833: <tr>
1.166 leot 12834: <td>configuration</td>
1.159 rillig 12835: <td>configure</td>
1.156 leot 12836: </tr>
12837: <tr>
1.166 leot 12838: <td>configure-help</td>
1.159 rillig 12839: <td>configure_args</td>
1.156 leot 12840: </tr>
12841: <tr>
1.166 leot 12842: <td>cputime</td>
1.159 rillig 12843: <td>create-usergroup</td>
1.156 leot 12844: </tr>
12845: <tr>
1.166 leot 12846: <td>csh</td>
1.159 rillig 12847: <td>ctf</td>
1.161 leot 12848: </tr>
12849: <tr>
1.166 leot 12850: <td>cvs</td>
1.157 leot 12851: <td>debug</td>
1.156 leot 12852: </tr>
12853: <tr>
1.166 leot 12854: <td>declaration</td>
1.157 leot 12855: <td>declare</td>
1.156 leot 12856: </tr>
12857: <tr>
1.166 leot 12858: <td>defined</td>
1.157 leot 12859: <td>depend</td>
1.156 leot 12860: </tr>
12861: <tr>
1.166 leot 12862: <td>dependencies</td>
1.157 leot 12863: <td>depends</td>
1.156 leot 12864: </tr>
12865: <tr>
1.166 leot 12866: <td>depends-checksum</td>
1.157 leot 12867: <td>depends-fetch</td>
1.156 leot 12868: </tr>
12869: <tr>
1.166 leot 12870: <td>deps</td>
1.157 leot 12871: <td>describe</td>
1.156 leot 12872: </tr>
12873: <tr>
1.166 leot 12874: <td>destdir</td>
1.162 rillig 12875: <td>disable</td>
12876: </tr>
12877: <tr>
1.166 leot 12878: <td>distclean</td>
1.161 leot 12879: <td>distinfo</td>
1.156 leot 12880: </tr>
12881: <tr>
1.166 leot 12882: <td>dl</td>
1.161 leot 12883: <td>dlopen</td>
1.156 leot 12884: </tr>
12885: <tr>
1.166 leot 12886: <td>do-build</td>
1.161 leot 12887: <td>do-buildlink</td>
1.156 leot 12888: </tr>
12889: <tr>
1.166 leot 12890: <td>do-clean</td>
1.170 ! rillig 12891: <td>do-configure</td>
! 12892: </tr>
! 12893: <tr>
1.161 leot 12894: <td>do-configure-post-hook</td>
1.170 ! rillig 12895: <td>do-extract</td>
1.156 leot 12896: </tr>
12897: <tr>
1.161 leot 12898: <td>do-fetch</td>
1.170 ! rillig 12899: <td>do-install</td>
1.156 leot 12900: </tr>
12901: <tr>
1.160 brook 12902: <td>emul</td>
1.170 ! rillig 12903: <td>emulation</td>
1.159 rillig 12904: </tr>
12905: <tr>
1.160 brook 12906: <td>emulator</td>
1.170 ! rillig 12907: <td>enable</td>
1.156 leot 12908: </tr>
12909: <tr>
1.159 rillig 12910: <td>endian</td>
1.170 ! rillig 12911: <td>enomem</td>
1.156 leot 12912: </tr>
12913: <tr>
1.159 rillig 12914: <td>err</td>
1.170 ! rillig 12915: <td>errx</td>
1.156 leot 12916: </tr>
12917: <tr>
1.159 rillig 12918: <td>etc</td>
1.170 ! rillig 12919: <td>feature</td>
1.156 leot 12920: </tr>
12921: <tr>
1.159 rillig 12922: <td>features</td>
1.170 ! rillig 12923: <td>fetch</td>
1.156 leot 12924: </tr>
12925: <tr>
1.159 rillig 12926: <td>fetch-list</td>
1.170 ! rillig 12927: <td>follows</td>
1.156 leot 12928: </tr>
12929: <tr>
1.159 rillig 12930: <td>forbids</td>
1.170 ! rillig 12931: <td>form</td>
1.156 leot 12932: </tr>
12933: <tr>
1.159 rillig 12934: <td>format</td>
1.170 ! rillig 12935: <td>fortify</td>
1.156 leot 12936: </tr>
12937: <tr>
1.159 rillig 12938: <td>fortify_source</td>
1.170 ! rillig 12939: <td>fossil</td>
1.161 leot 12940: </tr>
12941: <tr>
1.157 leot 12942: <td>friend</td>
1.170 ! rillig 12943: <td>from</td>
1.156 leot 12944: </tr>
12945: <tr>
1.157 leot 12946: <td>fts</td>
1.170 ! rillig 12947: <td>fts_close</td>
1.156 leot 12948: </tr>
12949: <tr>
1.157 leot 12950: <td>fts_open</td>
1.170 ! rillig 12951: <td>fts_read</td>
1.156 leot 12952: </tr>
12953: <tr>
1.157 leot 12954: <td>fts_set</td>
1.170 ! rillig 12955: <td>full</td>
1.156 leot 12956: </tr>
12957: <tr>
1.157 leot 12958: <td>gcc</td>
1.170 ! rillig 12959: <td>getopt_long</td>
1.156 leot 12960: </tr>
12961: <tr>
1.157 leot 12962: <td>getprogname</td>
1.170 ! rillig 12963: <td>gettext</td>
1.156 leot 12964: </tr>
12965: <tr>
1.161 leot 12966: <td>git</td>
1.170 ! rillig 12967: <td>github</td>
1.159 rillig 12968: </tr>
12969: <tr>
12970: <td>glob</td>
1.170 ! rillig 12971: <td>gnu</td>
1.156 leot 12972: </tr>
12973: <tr>
1.159 rillig 12974: <td>gnu_configure_strict</td>
1.170 ! rillig 12975: <td>go</td>
1.156 leot 12976: </tr>
12977: <tr>
1.159 rillig 12978: <td>go-deps</td>
1.170 ! rillig 12979: <td>golang</td>
1.156 leot 12980: </tr>
12981: <tr>
1.159 rillig 12982: <td>guess-license</td>
1.170 ! rillig 12983: <td>hashbang</td>
1.156 leot 12984: </tr>
12985: <tr>
1.159 rillig 12986: <td>heimdal</td>
1.170 ! rillig 12987: <td>help</td>
1.156 leot 12988: </tr>
12989: <tr>
1.161 leot 12990: <td>hg</td>
1.170 ! rillig 12991: <td>imake</td>
1.161 leot 12992: </tr>
12993: <tr>
1.157 leot 12994: <td>increment</td>
1.170 ! rillig 12995: <td>interp</td>
1.156 leot 12996: </tr>
12997: <tr>
1.157 leot 12998: <td>interpreter</td>
1.170 ! rillig 12999: <td>intl</td>
1.156 leot 13000: </tr>
13001: <tr>
1.157 leot 13002: <td>iso</td>
1.170 ! rillig 13003: <td>kerberos</td>
1.156 leot 13004: </tr>
13005: <tr>
1.157 leot 13006: <td>krb</td>
1.170 ! rillig 13007: <td>krb5</td>
1.156 leot 13008: </tr>
13009: <tr>
1.157 leot 13010: <td>ksh</td>
1.170 ! rillig 13011: <td>lapack</td>
1.156 leot 13012: </tr>
13013: <tr>
13014: <td>latex</td>
1.170 ! rillig 13015: <td>libnbcompat</td>
1.159 rillig 13016: </tr>
13017: <tr>
13018: <td>libs</td>
1.170 ! rillig 13019: <td>libtool</td>
1.156 leot 13020: </tr>
13021: <tr>
1.159 rillig 13022: <td>licence</td>
1.170 ! rillig 13023: <td>license</td>
1.156 leot 13024: </tr>
13025: <tr>
1.159 rillig 13026: <td>lintl</td>
1.170 ! rillig 13027: <td>little-endian</td>
1.156 leot 13028: </tr>
13029: <tr>
1.159 rillig 13030: <td>lock</td>
1.170 ! rillig 13031: <td>locking</td>
1.156 leot 13032: </tr>
13033: <tr>
1.159 rillig 13034: <td>lvalue</td>
1.170 ! rillig 13035: <td>make</td>
1.156 leot 13036: </tr>
13037: <tr>
1.159 rillig 13038: <td>makesum</td>
1.170 ! rillig 13039: <td>memory</td>
1.156 leot 13040: </tr>
13041: <tr>
1.161 leot 13042: <td>mercurial</td>
1.170 ! rillig 13043: <td>meta</td>
1.161 leot 13044: </tr>
13045: <tr>
1.158 brook 13046: <td>meta-package</td>
1.170 ! rillig 13047: <td>meta_package</td>
1.156 leot 13048: </tr>
13049: <tr>
1.158 brook 13050: <td>mit-krb5</td>
1.170 ! rillig 13051: <td>mk.conf</td>
1.156 leot 13052: </tr>
13053: <tr>
1.161 leot 13054: <td>mkl</td>
1.170 ! rillig 13055: <td>mount</td>
1.159 rillig 13056: </tr>
13057: <tr>
13058: <td>mprotect</td>
1.170 ! rillig 13059: <td>mremap</td>
1.156 leot 13060: </tr>
13061: <tr>
1.159 rillig 13062: <td>nb</td>
1.170 ! rillig 13063: <td>nbcompat</td>
1.156 leot 13064: </tr>
13065: <tr>
1.159 rillig 13066: <td>no</td>
1.170 ! rillig 13067: <td>obstack</td>
1.156 leot 13068: </tr>
13069: <tr>
1.159 rillig 13070: <td>obstack_ptr_grow</td>
1.170 ! rillig 13071: <td>occurs</td>
1.156 leot 13072: </tr>
13073: <tr>
1.159 rillig 13074: <td>only</td>
1.170 ! rillig 13075: <td>openblas</td>
1.161 leot 13076: </tr>
13077: <tr>
1.158 brook 13078: <td>options</td>
1.170 ! rillig 13079: <td>options.mk</td>
1.156 leot 13080: </tr>
13081: <tr>
1.158 brook 13082: <td>order</td>
1.170 ! rillig 13083: <td>override</td>
1.156 leot 13084: </tr>
13085: <tr>
1.158 brook 13086: <td>override-intltool</td>
1.170 ! rillig 13087: <td>override-message-intltool</td>
1.156 leot 13088: </tr>
13089: <tr>
1.158 brook 13090: <td>package</td>
1.170 ! rillig 13091: <td>parallel</td>
1.156 leot 13092: </tr>
13093: <tr>
1.158 brook 13094: <td>partial</td>
1.170 ! rillig 13095: <td>path</td>
1.156 leot 13096: </tr>
13097: <tr>
1.158 brook 13098: <td>pax</td>
1.170 ! rillig 13099: <td>paxctl</td>
1.156 leot 13100: </tr>
13101: <tr>
1.158 brook 13102: <td>pbulk-index</td>
1.170 ! rillig 13103: <td>pc</td>
1.156 leot 13104: </tr>
13105: <tr>
1.158 brook 13106: <td>perl</td>
1.170 ! rillig 13107: <td>perl5</td>
1.156 leot 13108: </tr>
13109: <tr>
1.158 brook 13110: <td>perms</td>
1.170 ! rillig 13111: <td>php</td>
1.156 leot 13112: </tr>
13113: <tr>
1.158 brook 13114: <td>pkg-build-options</td>
1.170 ! rillig 13115: <td>pkg-config</td>
1.156 leot 13116: </tr>
13117: <tr>
1.158 brook 13118: <td>pkg_build_options</td>
1.170 ! rillig 13119: <td>platform</td>
1.156 leot 13120: </tr>
13121: <tr>
1.158 brook 13122: <td>plist</td>
1.170 ! rillig 13123: <td>post-extract</td>
1.156 leot 13124: </tr>
13125: <tr>
1.158 brook 13126: <td>post-fetch</td>
1.170 ! rillig 13127: <td>post-wrapper</td>
1.156 leot 13128: </tr>
13129: <tr>
1.158 brook 13130: <td>pre-configure</td>
1.170 ! rillig 13131: <td>pre-extract</td>
1.156 leot 13132: </tr>
13133: <tr>
1.158 brook 13134: <td>pre-fetch</td>
1.170 ! rillig 13135: <td>print-go-deps</td>
1.156 leot 13136: </tr>
13137: <tr>
1.158 brook 13138: <td>print-plist</td>
1.170 ! rillig 13139: <td>print-summary-data</td>
1.156 leot 13140: </tr>
13141: <tr>
1.158 brook 13142: <td>privileged-install-hook</td>
1.170 ! rillig 13143: <td>pypi</td>
1.156 leot 13144: </tr>
13145: <tr>
1.158 brook 13146: <td>python</td>
1.170 ! rillig 13147: <td>readme-all</td>
1.156 leot 13148: </tr>
13149: <tr>
1.158 brook 13150: <td>regcomp</td>
1.170 ! rillig 13151: <td>relro</td>
1.156 leot 13152: </tr>
13153: <tr>
1.158 brook 13154: <td>rename</td>
1.170 ! rillig 13155: <td>reorder</td>
1.156 leot 13156: </tr>
13157: <tr>
1.158 brook 13158: <td>replace</td>
1.170 ! rillig 13159: <td>replace_interpreter</td>
1.156 leot 13160: </tr>
13161: <tr>
1.158 brook 13162: <td>reproducible</td>
1.170 ! rillig 13163: <td>resolv</td>
1.156 leot 13164: </tr>
13165: <tr>
1.158 brook 13166: <td>root</td>
1.170 ! rillig 13167: <td>ruby</td>
1.156 leot 13168: </tr>
13169: <tr>
1.158 brook 13170: <td>setenv</td>
1.170 ! rillig 13171: <td>setgid</td>
1.156 leot 13172: </tr>
13173: <tr>
1.158 brook 13174: <td>setprogname</td>
1.170 ! rillig 13175: <td>setuid</td>
1.156 leot 13176: </tr>
13177: <tr>
1.158 brook 13178: <td>sh</td>
1.170 ! rillig 13179: <td>show</td>
1.156 leot 13180: </tr>
13181: <tr>
1.158 brook 13182: <td>show-all</td>
1.170 ! rillig 13183: <td>show-build-defs</td>
1.156 leot 13184: </tr>
13185: <tr>
1.158 brook 13186: <td>show-depends</td>
1.170 ! rillig 13187: <td>show-deps</td>
1.156 leot 13188: </tr>
13189: <tr>
1.158 brook 13190: <td>show-distfiles</td>
1.170 ! rillig 13191: <td>show-downlevel</td>
1.156 leot 13192: </tr>
13193: <tr>
1.158 brook 13194: <td>show-subdir-var</td>
1.170 ! rillig 13195: <td>show-tools</td>
1.156 leot 13196: </tr>
13197: <tr>
1.158 brook 13198: <td>show-var</td>
1.170 ! rillig 13199: <td>show-vars</td>
1.156 leot 13200: </tr>
13201: <tr>
1.158 brook 13202: <td>snprintf</td>
1.170 ! rillig 13203: <td>ssp</td>
1.156 leot 13204: </tr>
13205: <tr>
1.158 brook 13206: <td>st_mode</td>
1.170 ! rillig 13207: <td>stage-install</td>
1.156 leot 13208: </tr>
13209: <tr>
1.162 rillig 13210: <td>strict</td>
1.170 ! rillig 13211: <td>strip</td>
1.162 rillig 13212: </tr>
13213: <tr>
1.161 leot 13214: <td>strnlen</td>
1.170 ! rillig 13215: <td>strong</td>
1.156 leot 13216: </tr>
13217: <tr>
1.161 leot 13218: <td>subst</td>
1.170 ! rillig 13219: <td>subversion</td>
1.156 leot 13220: </tr>
13221: <tr>
1.160 brook 13222: <td>sun</td>
1.170 ! rillig 13223: <td>sunpro</td>
1.159 rillig 13224: </tr>
13225: <tr>
1.156 leot 13226: <td>sunwspro</td>
1.170 ! rillig 13227: <td>svn</td>
1.156 leot 13228: </tr>
13229: <tr>
1.161 leot 13230: <td>symlink</td>
1.170 ! rillig 13231: <td>test</td>
1.161 leot 13232: </tr>
13233: <tr>
1.157 leot 13234: <td>tex</td>
1.170 ! rillig 13235: <td>texlive</td>
1.156 leot 13236: </tr>
13237: <tr>
1.157 leot 13238: <td>tmp</td>
1.170 ! rillig 13239: <td>tool</td>
1.156 leot 13240: </tr>
13241: <tr>
1.157 leot 13242: <td>tools</td>
1.170 ! rillig 13243: <td>tools-libtool-m4-override</td>
1.156 leot 13244: </tr>
13245: <tr>
1.157 leot 13246: <td>type</td>
1.170 ! rillig 13247: <td>ulimit</td>
1.156 leot 13248: </tr>
13249: <tr>
1.157 leot 13250: <td>undefined</td>
1.170 ! rillig 13251: <td>undo-replace</td>
1.156 leot 13252: </tr>
13253: <tr>
1.157 leot 13254: <td>unlimit</td>
1.170 ! rillig 13255: <td>unprivileged</td>
1.156 leot 13256: </tr>
13257: <tr>
1.157 leot 13258: <td>unprivileged-install-hook</td>
1.170 ! rillig 13259: <td>unstripped</td>
1.156 leot 13260: </tr>
13261: <tr>
1.157 leot 13262: <td>update</td>
1.170 ! rillig 13263: <td>upload</td>
1.156 leot 13264: </tr>
13265: <tr>
1.157 leot 13266: <td>upload-distfiles</td>
1.170 ! rillig 13267: <td>usage</td>
1.156 leot 13268: </tr>
13269: <tr>
1.157 leot 13270: <td>use_tools</td>
1.170 ! rillig 13271: <td>user</td>
1.156 leot 13272: </tr>
13273: <tr>
1.157 leot 13274: <td>utimes</td>
1.170 ! rillig 13275: <td>vasprintf</td>
1.156 leot 13276: </tr>
13277: <tr>
1.157 leot 13278: <td>verbose</td>
1.170 ! rillig 13279: <td>vsnprintf</td>
1.156 leot 13280: </tr>
13281: <tr>
1.157 leot 13282: <td>warn</td>
1.170 ! rillig 13283: <td>warning</td>
1.156 leot 13284: </tr>
13285: <tr>
1.157 leot 13286: <td>warnings</td>
1.170 ! rillig 13287: <td>warnx</td>
1.156 leot 13288: </tr>
13289: <tr>
1.157 leot 13290: <td>weak</td>
1.170 ! rillig 13291: <td>work</td>
1.156 leot 13292: </tr>
13293: <tr>
1.157 leot 13294: <td>wrapper</td>
1.170 ! rillig 13295: <td>wrkdir</td>
1.156 leot 13296: </tr>
13297: <tr>
13298: <td>yes</td>
1.170 ! rillig 13299: <td> </td>
1.156 leot 13300: </tr>
13301: </table>
1.154 rillig 13302: </div>
13303: <div class="appendix">
13304: <div class="titlepage"><div><div><h1 class="title">
13305: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 13306: <div class="toc">
13307: <p><b>Table of Contents</b></p>
1.100 leot 13308: <dl class="toc">
1.154 rillig 13309: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
13310: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1 dsieger 13311: </dl>
13312: </div>
13313: <p>This section contains information on editing the pkgsrc
13314: guide itself.</p>
1.41 asau 13315: <div class="sect1">
1.1 dsieger 13316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 13317: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.1 dsieger 13318: <p>The pkgsrc guide's source code is stored in
13319: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
13320: are created from it:</p>
1.41 asau 13321: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 13322: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
13323: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
13324: <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>
13325: <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 13326: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 13327: <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 13328: PostScript version of the pkgsrc guide.</p></li>
13329: </ul></div>
13330: </div>
1.41 asau 13331: <div class="sect1">
1.1 dsieger 13332: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 13333: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.1 dsieger 13334: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 13335: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 13336: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 13337: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 13338: documentation) installed. These are automatically installed when
1.137 leot 13339: 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 13340: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 13341: right directory. All further steps will take place
13342: here.</p></li>
1.41 asau 13343: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 13344: <code class="filename">files/</code>.</p></li>
1.41 asau 13345: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 13346: guide for valid XML and to build the final output files. If you
13347: get any errors at this stage, you can just edit the files, as
13348: there are only symbolic links in the working directory, pointing
13349: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 13350: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 13351: commit)</strong></span></p></li>
1.41 asau 13352: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 13353: regenerate the output files with the proper RCS
13354: Ids.</p></li>
1.41 asau 13355: <li class="step">
1.10 hubertf 13356: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 13357: commit the files in both <code class="filename">pkgsrc/doc</code> and
13358: <code class="filename">htdocs</code>.</p>
1.41 asau 13359: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 13360: <h3 class="title">Note</h3>
13361: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 13362: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
13363: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 13364: directory.</p>
13365: </div>
13366: </li>
13367: </ol></div>
13368: </div>
13369: </div>
13370: </div></body>
13371: </html>
CVSweb <webmaster@jp.NetBSD.org>