Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.161
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.146 jnemeth 33: <div><p class="copyright">Copyright © 1994-2019 The NetBSD Foundation, Inc</p></div>
1.155 sevan 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.35 2019/04/28 15:22:24 rillig 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>
922: The pkgsrc-users mailing list, to which
923: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
924: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
925: questions</a>.</p></li>
926: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
927: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
928: or by using a specialized chat program such as
929: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
930: Pick any user name and join the channel #pkgsrc.</p></li>
931: </ul></div>
932: </div>
933: <div class="chapter">
934: <div class="titlepage"><div><div><h2 class="title">
935: <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 936: <div class="toc">
937: <p><b>Table of Contents</b></p>
1.100 leot 938: <dl class="toc">
1.154 rillig 939: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 940: <dd><dl>
1.154 rillig 941: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
942: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 943: </dl></dd>
1.154 rillig 944: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 945: <dd><dl>
1.154 rillig 946: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
947: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 948: </dl></dd>
949: </dl>
950: </div>
951: <p>Before you download and extract the files, you need to decide
952: where you want to extract them. When using pkgsrc as root user, pkgsrc
953: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
954: free to install the sources and binary packages wherever you want in
955: your filesystem, provided that the pathname does not contain white-space
956: or other characters that are interpreted specially by the shell and some
957: other programs. A safe bet is to use only letters, digits, underscores
958: and dashes.</p>
1.41 asau 959: <div class="sect1">
1.1 dsieger 960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 961: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 962: <p>Before you download any pkgsrc files, you should decide
963: whether you want the <span class="emphasis"><em>current</em></span> branch or the
964: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
965: quarterly basis from the current branch and only gets modified
966: for security updates. The names of the stable branches are built
967: from the year and the quarter, for example
1.161 ! leot 968: <code class="literal">2019Q3</code>.</p>
1.1 dsieger 969: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 970: want to download pkgsrc. You can get it as a tar file or via CVS.
971: Both ways are described here.</p>
1.51 asau 972: <p>Note that tar archive contains CVS working copy.
973: Thus you can switch to using CVS at any later time.</p>
1.41 asau 974: <div class="sect2">
1.1 dsieger 975: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 976: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 977: <p>The primary download location for all pkgsrc files is
1.151 sevan 978: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 979: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
980: (it points to the same location).
981: There are a number of subdirectories for different purposes,
982: 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>
983: <p>The tar archive for the current branch is in the directory
1.151 sevan 984: <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 985: It is autogenerated weekly.</p>
1.51 asau 986: <p>To save download time we provide bzip2- and
987: xz-compressed archives which are published at
1.151 sevan 988: <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 989: and
1.151 sevan 990: <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 991: respectively.
992: </p>
993: <p>You can fetch the same files using FTP.</p>
1.161 ! leot 994: <p>The tar file for the stable branch 2019Q3 is in the
! 995: directory <code class="filename">pkgsrc-2019Q3</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q3/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136 leot 996: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 997: <pre class="screen">
1.161 ! leot 998: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q3/pkgsrc.tar.gz</code></strong></pre>
1.78 snj 999: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1000: or your web browser.</p>
1.12 weinem 1001: <p>Then, extract it with:</p>
1.78 snj 1002: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1003: <p>This will create the directory <code class="filename">pkgsrc/</code>
1004: in <code class="filename">/usr/</code> and all the package source will be
1005: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1006: <p>To download pkgsrc-current, run:</p>
1007: <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 1008: </div>
1.41 asau 1009: <div class="sect2">
1.1 dsieger 1010: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1011: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1012: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.161 ! leot 1013: <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-2019Q3 -P pkgsrc</code></strong>
1.23 wiz 1014: </pre>
1015: <p>This will create the directory <code class="filename">pkgsrc/</code>
1016: in your <code class="filename">/usr/</code> directory and all the package source
1017: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1018: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1019: <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 1020: </pre>
1.78 snj 1021: <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 1022: <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 1023: <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 1024: </pre>
1025: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1026: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1027: or better globally in <code class="filename">/etc/profile</code>:</p>
1028: <pre class="programlisting">
1029: # set CVS remote shell command
1030: CVS_RSH=ssh
1031: export CVS_RSH
1032: </pre>
1033: <p>By default, CVS doesn't do things like most people would expect it to do.
1034: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1035: in your home directory and saving the following lines to it.
1036: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1037: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1038: <pre class="programlisting">
1039: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1040: cvs -q
1.2 rillig 1041: checkout -P
1.4 rillig 1042: update -dP
1043: diff -upN
1.2 rillig 1044: rdiff -u
1.23 wiz 1045: release -d
1.2 rillig 1046: </pre>
1.1 dsieger 1047: </div>
1048: </div>
1.41 asau 1049: <div class="sect1">
1.1 dsieger 1050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1051: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1052: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1053: (which also works if you have first installed it via a tar
1054: file). It saves bandwidth and hard disk activity, compared to
1055: downloading the tar file again.</p>
1.41 asau 1056: <div class="sect2">
1.1 dsieger 1057: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1058: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1059: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1060: <h3 class="title">Warning</h3>
1061: <p>When updating from a tar file, you first need to
1062: completely remove the old pkgsrc directory. Otherwise those
1063: files that have been removed from pkgsrc in the mean time will
1064: not be removed on your local disk, resulting in inconsistencies.
1065: When removing the old files, any changes that you have done to
1066: the pkgsrc files will be lost after updating. Therefore updating
1067: via CVS is strongly recommended.</p>
1068: </div>
1069: <p>Note that by default the distfiles and the binary packages
1070: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1071: before updating. You can also configure pkgsrc to store distfiles
1072: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1073: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154 rillig 1074: 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 1075: <p>To update pkgsrc from a tar file, download the tar file as
1076: explained above. Then, make sure that you have not made any
1077: changes to the files in the pkgsrc directory. Remove the pkgsrc
1078: directory and extract the new tar file. Done.</p>
1079: </div>
1.41 asau 1080: <div class="sect2">
1.1 dsieger 1081: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1082: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1083: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1084: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1085: </pre>
1086: <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>
1087: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1088: </pre>
1.41 asau 1089: <div class="sect3">
1.1 dsieger 1090: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1091: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1092: <p>When updating pkgsrc, the CVS program keeps track of the
1093: branch you selected. But if you, for whatever reason, want to
1094: switch from the stable branch to the current one, you can do it
1.23 wiz 1095: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1096: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1097: back to the stable branch, add the
1.161 ! leot 1098: <span class="quote">“<span class="quote">-rpkgsrc-2019Q3</span>”</span> option.</p>
1.1 dsieger 1099: </div>
1.41 asau 1100: <div class="sect3">
1.1 dsieger 1101: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1102: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1103: <p>When you update pkgsrc, the CVS program will only touch
1104: those files that are registered in the CVS repository. That
1105: means that any packages that you created on your own will stay
1106: unmodified. If you change files that are managed by CVS, later
1107: updates will try to merge your changes with those that have been
1108: done by others. See the CVS manual, chapter
1.23 wiz 1109: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1110: </div>
1111: </div>
1112: </div>
1113: </div>
1.41 asau 1114: <div class="chapter">
1.1 dsieger 1115: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1116: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1117: <div class="toc">
1118: <p><b>Table of Contents</b></p>
1.100 leot 1119: <dl class="toc">
1.154 rillig 1120: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1121: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1122: </dl>
1123: </div>
1.41 asau 1124: <div class="sect1">
1.1 dsieger 1125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1126: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1127: <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 1128: </div>
1.41 asau 1129: <div class="sect1">
1.1 dsieger 1130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1131: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1132: <p>pkgsrc can be bootstrapped for use in two different modes:
1133: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1134: to privileged one all programs are installed under one particular user
1.43 asau 1135: and cannot utilise privileged operations (packages don't create
1136: special users and all special file permissions like setuid are ignored).
1137: </p>
1.1 dsieger 1138: <p>Installing the bootstrap kit from source should be as simple as:</p>
1139: <pre class="screen">
1.60 asau 1140: <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 1141: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1142: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1143: </pre>
1.43 asau 1144: <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>
1145: <p>By default, in privileged mode pkgsrc uses
1146: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1147: where programs will be installed in,
1.118 sevan 1148: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1149: directory where pkgsrc will do its internal bookkeeping,
1150: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1151: where packages install their persistent data.
1152: In unprivileged mode pkgsrc uses
1153: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1154: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1155: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1156: </p>
1157: <p>You can change default layout using command-line arguments.
1158: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1159: </p>
1.41 asau 1160: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1161: <h3 class="title">Note</h3>
1.10 hubertf 1162: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1163: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1164: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1165: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1166: </div>
1.43 asau 1167: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1168: <h3 class="title">Note</h3>
1169: <p>It is possible to bootstrap multiple instances of pkgsrc
1170: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1171: corresponding to the installation you're working with to build
1172: and install packages.
1173: </p>
1174: </div>
1.1 dsieger 1175: </div>
1176: </div>
1.41 asau 1177: <div class="chapter">
1.1 dsieger 1178: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1179: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1180: <div class="toc">
1181: <p><b>Table of Contents</b></p>
1.100 leot 1182: <dl class="toc">
1.154 rillig 1183: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1184: <dd><dl>
1.154 rillig 1185: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1186: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1187: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
1188: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
1189: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1190: <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>
1191: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1192: </dl></dd>
1193: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1194: <dd><dl>
1195: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1196: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1197: <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 1198: </dl></dd>
1199: </dl>
1200: </div>
1201: <p>Basically, there are two ways of using pkgsrc. The first
1202: is to only install the package tools and to use binary packages
1.23 wiz 1203: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1204: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1205: of pkgsrc, too. Then you are able to build your own packages,
1206: and you can still use binary packages from someone else.</p>
1.41 asau 1207: <div class="sect1">
1.1 dsieger 1208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1209: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.151 sevan 1210: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1211: site and mirrors, there are collections of binary packages,
1.9 rillig 1212: ready to be installed. These binary packages have been built using the
1213: default settings for the directories, that is:</p>
1.41 asau 1214: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1215: <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>
1216: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1217: <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 1218: </ul></div>
1219: <p>If you cannot use these directories for whatever reasons (maybe
1220: because you're not root), you cannot use these binary packages, but
1.154 rillig 1221: 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 1222: <div class="sect2">
1.1 dsieger 1223: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1224: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1225: <p>To install binary packages, you first need to know from where
1226: to get them. The first place where you should look is on the main
1.151 sevan 1227: 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 1228: <p>This directory contains binary packages for multiple
1229: platforms. First, select your operating system. (Ignore the
1230: directories with version numbers attached to it, they just exist for
1231: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1232: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1233: <p>In this directory, you often find a file called
1234: <code class="filename">bootstrap.tar.gz</code> which contains the package
1235: management tools. If the file is missing, it is likely that your
1236: operating system already provides those tools. Download the file and
1237: extract it in the <code class="filename">/</code> directory. It will create
1238: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1239: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1240: </div>
1.41 asau 1241: <div class="sect2">
1.1 dsieger 1242: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1243: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1244: <p>In the directory from the last section, there is a
1.85 wiz 1245: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1246: binary packages that are available for the platform, excluding those
1247: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1248: medium you are using).</p>
1.9 rillig 1249: <p>To install packages directly from an FTP or HTTP server, run
1250: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1251: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1252: <pre class="screen">
1253: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.151 sevan 1254: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages/<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 1255: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1256: </pre>
1257: <p>Instead of URLs, you can also use local paths, for example if
1258: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1259: repository. If you want to install packages from multiple sources,
1260: you can separate them by a semicolon in
1261: <code class="varname">PKG_PATH</code>.</p>
1262: <p>After these preparations, installing a package is very
1263: easy:</p>
1264: <pre class="screen">
1.118 sevan 1265: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
1266: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.9 rillig 1267: </pre>
1.1 dsieger 1268: <p>Note that any prerequisite packages needed to run the
1269: package in question will be installed, too, assuming they are
1270: present where you install from.</p>
1.23 wiz 1271: <p>Adding packages might install vulnerable packages.
1272: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1273: regularly, especially after installing new packages, and verify
1274: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1275: <p>After you've installed packages, be sure to have
1276: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1277: <code class="varname">PATH</code> so you can actually start the just
1278: installed program.</p>
1279: </div>
1.41 asau 1280: <div class="sect2">
1.1 dsieger 1281: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1282: <a name="using.pkg_delete"></a>5.1.3. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1283: <p>To deinstall a package, it does not matter whether it was
1284: installed from source code or from a binary package. The
1.10 hubertf 1285: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1286: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1287: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1288: name can be given with or without version number. Wildcards can
1289: also be used to deinstall a set of packages, for example
1290: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1291: so that the shell does not expand them before
1292: <code class="literal">pkg_delete</code> sees them.</p>
1293: <p>The <code class="option">-r</code> option is very powerful: it
1294: removes all the packages that require the package in question
1295: and then removes the package itself. For example:
1296:
1297: </p>
1298: <pre class="screen">
1299: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1300: </pre>
1301: <p>
1302:
1303: will remove jpeg and all the packages that used it; this allows
1304: upgrading the jpeg package.</p>
1305: </div>
1.41 asau 1306: <div class="sect2">
1.1 dsieger 1307: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1308: <a name="using.pkg_info"></a>5.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1309: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1310: installed packages or binary package files.</p>
1311: </div>
1.41 asau 1312: <div class="sect2">
1.1 dsieger 1313: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1314: <a name="vulnerabilities"></a>5.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1315: <p>
1316: The NetBSD Security-Officer and Packages Groups maintain a list of
1317: known security vulnerabilities to packages which are (or have been)
1318: included in pkgsrc. The list is available from the NetBSD
1.151 sevan 1319: FTP site at <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.1 dsieger 1320: </p>
1321: <p>
1.22 jakllsch 1322: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1323: this list can be downloaded
1324: automatically, and a security audit of all packages installed on a system
1325: can take place.
1326: </p>
1327: <p>
1.22 jakllsch 1328: There are two components to auditing. The first
1329: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1330: is for downloading
1.1 dsieger 1331: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1332: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1333: installed packages are vulnerable. If a package is vulnerable, you
1334: will see output similar to the following:
1335: </p>
1336: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1337: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1338: <p>
1.22 jakllsch 1339: You may wish to have the
1.151 sevan 1340: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1341: file downloaded daily so that
1342: it remains current. This may be done by adding an appropriate entry
1.157 leot 1343: to the root users <a class="citerefentry" href="http://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 1344: </p>
1345: <pre class="screen">
1.121 sevan 1346: # Download vulnerabilities file
1.118 sevan 1347: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1348: # Audit the installed packages and email results to root
1349: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1350: root >/dev/null 2>&1
1.22 jakllsch 1351: </pre>
1352: <p>
1.118 sevan 1353: will update the vulnerability list every day at 3AM, followed by an audit
1354: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1355:
1.118 sevan 1356: On NetBSD this may be accomplished instead by adding the following
1357: line to <code class="filename">/etc/daily.conf</code>:
1358: </p>
1359: <pre class="screen">
1360: fetch_pkg_vulnerabilities=YES
1361: </pre>
1362: <p>
1363: to fetch the vulnerability list from the daily security script. The system
1364: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1365: desired (not required), by adding the following line to
1.118 sevan 1366: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1367: </p>
1368: <pre class="screen">
1.118 sevan 1369: check_pkg_vulnerabilities=YES
1.22 jakllsch 1370: </pre>
1371: <p>
1.157 leot 1372: see <a class="citerefentry" href="http://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="http://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 1373: </p>
1374: </div>
1.41 asau 1375: <div class="sect2">
1.1 dsieger 1376: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1377: <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 1378: <p>
1.137 leot 1379: 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 1380: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1381: argument to check if your packages are up-to-date, e.g.
1382: </p>
1383: <pre class="screen">
1384: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1385: ...
1386: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1387: </pre>
1.10 hubertf 1388: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1389: package on your system and rebuild any dependencies.
1390: </p>
1391: </div>
1.41 asau 1392: <div class="sect2">
1.1 dsieger 1393: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1394: <a name="using.pkg_admin"></a>5.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1395: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1396: administrative functions on the package system.</p>
1397: </div>
1398: </div>
1.41 asau 1399: <div class="sect1">
1.1 dsieger 1400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1401: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1 dsieger 1402: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1403: directory now contains a set of packages, organized into
1404: categories. You can browse the online index of packages, or run
1.10 hubertf 1405: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1406: directory to build local <code class="filename">README.html</code> files for
1.137 leot 1407: 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 1408: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1409: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1410: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1411: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1412: different <code class="varname">LOCALBASE</code> definitions on the same
1413: system (inside a chroot is an exception). </p>
1414: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1415: 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 1416: instructions how to create your own packages.</p>
1.41 asau 1417: <div class="sect2">
1.1 dsieger 1418: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1419: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1 dsieger 1420: <p>To build packages from source, you need a working C
1421: compiler. On NetBSD, you need to install the
1.23 wiz 1422: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1423: sets. If you want to build X11-related packages, the
1.23 wiz 1424: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1425: sets are required, too.</p>
1426: </div>
1.41 asau 1427: <div class="sect2">
1.1 dsieger 1428: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1429: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1 dsieger 1430: <p>The first step for building a package is downloading the
1431: distfiles (i.e. the unmodified source). If they have not yet been
1432: downloaded, pkgsrc will fetch them automatically.</p>
1433: <p>If you have all files that you need in the
1434: <code class="filename">distfiles</code> directory,
1435: you don't need to connect. If the distfiles are on CD-ROM, you can
1436: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1437: </p>
1438: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1439: <p>
1.10 hubertf 1440: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1441: <p>By default a list of distribution sites will be randomly
1442: intermixed to prevent huge load on servers which holding popular
1443: packages (for example, SourceForge.net mirrors). Thus, every
1444: time when you need to fetch yet another distfile all the mirrors
1445: will be tried in new (random) order. You can turn this feature
1446: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1447: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1448: <p>You can overwrite some of the major distribution sites to
1449: fit to sites that are close to your own. By setting one or two
1450: variables you can modify the order in which the master sites are
1451: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1452: delimited list of domain suffixes.
1453: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1454: contains a whitespace delimited list of regular expressions. It
1455: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1456: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1457: some examples. This may save some of your bandwidth and
1458: time.</p>
1459: <p>You can change these settings either in your shell's environment, or,
1460: if you want to keep the settings, by editing the
1.10 hubertf 1461: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1462: and adding the definitions there.</p>
1463: <p>
1464: If a package depends on many other packages (such as
1.137 leot 1465: <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 1466: alternate between periods of
1467: downloading source, and compiling. To ensure you have all the source
1468: downloaded initially you can run the command:
1469: </p>
1470: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1471: <p>
1472: which will output and run a set of shell commands to fetch the
1473: necessary files into the <code class="filename">distfiles</code> directory. You can
1474: also choose to download the files manually.
1475: </p>
1476: </div>
1.41 asau 1477: <div class="sect2">
1.1 dsieger 1478: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1479: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1 dsieger 1480: <p>
1481: Once the software has downloaded, any patches will be applied, then it
1482: will be compiled for you. This may take some time depending on your
1483: computer, and how many other packages the software depends on and their
1484: compile time.
1485: </p>
1.41 asau 1486: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1487: <h3 class="title">Note</h3>
1488: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1489: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1490: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1491: </div>
1492: <p>For example, type</p>
1493: <pre class="screen">
1494: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1495: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1496: </pre>
1497: <p>at the shell prompt to build the various components of the
1498: package.</p>
1499: <p>The next stage is to actually install the newly compiled
1500: program onto your system. Do this by entering:
1501:
1502: </p>
1503: <pre class="screen">
1504: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1505: </pre>
1506: <p>
1507:
1508: while you are still in the directory for whatever package you
1509: are installing.</p>
1510: <p>Installing the package on your system may require you to
1511: be root. However, pkgsrc has a
1512: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1513: to only become root for the actual installation step.</p>
1514: <p>That's it, the software should now be installed and setup for use.
1515: You can now enter:
1516:
1517: </p>
1518: <pre class="screen">
1519: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1520: </pre>
1521: <p>
1522:
1523: to remove the compiled files in the work directory, as you shouldn't need
1524: them any more. If other packages were also added to your system
1525: (dependencies) to allow your program to compile, you can tidy these up
1526: also with the command:</p>
1527: <pre class="screen">
1528: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1529: </pre>
1530: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 1531: 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 1532: <p>The program is installed under the default root of the
1533: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1534: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1535: variable in your environment, and it will use that value as the
1536: root of your packages tree. So, to use
1537: <code class="filename">/usr/local</code>, set
1538: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1539: Please note that you should use a directory which is dedicated to
1540: packages and not shared with other programs (i.e., do not try and
1541: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1542: to add any of your own files or directories (such as
1543: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1544: <code class="filename">pkgsrc/</code>) below the
1545: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1546: conflicts between programs and other files installed by the
1547: package system and whatever else may have been installed
1548: there.</p>
1.10 hubertf 1549: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1550: alter some configuration options at build time. Have a look at
1551: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1552: of what will be set there by default. Environment variables such
1553: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1554: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1555: set them each time you want to use pkgsrc.</p>
1.23 wiz 1556: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1557: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1558: or being installed. This may be for debugging purposes, or out of
1559: simple curiosity. A number of utility values have been added to
1560: help with this.</p>
1.23 wiz 1561: <div class="orderedlist"><ol class="orderedlist" type="1">
1562: <li class="listitem">
1.157 leot 1563: <p>If you invoke the <a class="citerefentry" href="http://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 1564: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1565: information will be displayed. For example,</p>
1566: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1567: <p>will show all the commands that are invoked, up to and
1.23 wiz 1568: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1569: </li>
1.23 wiz 1570: <li class="listitem">
1.157 leot 1571: <p>If you want to know the value of a certain <a class="citerefentry" href="http://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 1572: definition, then the <code class="varname">VARNAME</code> definition
1573: should be used, in conjunction with the show-var
1.157 leot 1574: target. e.g. to show the expansion of the <a class="citerefentry" href="http://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 1575: variable <code class="varname">LOCALBASE</code>:</p>
1576: <pre class="screen">
1577: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1578: /usr/pkg
1579: <code class="prompt">%</code>
1580: </pre>
1581: </li>
1582: </ol></div>
1583: <p>If you want to install a binary package that you've either
1584: created yourself (see next section), that you put into
1585: pkgsrc/packages manually or that is located on a remote FTP
1586: server, you can use the "bin-install" target. This target will
1.157 leot 1587: install a binary package - if available - via <a class="citerefentry" href="http://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 1588: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1589: sites searched is kept in the variable
1590: <code class="varname">BINPKG_SITES</code>, which defaults to
1.157 leot 1591: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://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 1592: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1593: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1594: details.</p>
1595: <p>A final word of warning: If you set up a system that has a
1596: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1597: set that before any packages are installed, as you cannot use
1598: several directories for the same purpose. Doing so will result in
1599: pkgsrc not being able to properly detect your installed packages,
1600: and fail miserably. Note also that precompiled binary packages are
1601: usually built with the default <code class="varname">LOCALBASE</code> of
1602: <code class="filename">/usr/pkg</code>, and that you should
1603: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1604: <code class="varname">LOCALBASE</code>.</p>
1605: </div>
1606: </div>
1607: </div>
1.41 asau 1608: <div class="chapter">
1.1 dsieger 1609: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1610: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1 dsieger 1611: <div class="toc">
1612: <p><b>Table of Contents</b></p>
1.100 leot 1613: <dl class="toc">
1.154 rillig 1614: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1615: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1616: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
1617: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1618: <dd><dl>
1619: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
1620: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1621: <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 1622: </dl></dd>
1.154 rillig 1623: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
1624: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 1625: </dl>
1626: </div>
1.4 rillig 1627: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1628: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1629: that file depends on the installation. On NetBSD, when you use
1.157 leot 1630: <a class="citerefentry" href="http://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 1631: <code class="filename">/etc/</code>. In all other cases the default location is
1632: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1633: bootstrap program to install the binary packages.</p>
1634: <p>The format of the configuration file is that of the usual
1635: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1636: is done by setting variables in this file. Note that you can define all
1637: kinds of variables, and no special error checking (for example for
1.112 rillig 1638: spelling mistakes) takes place.</p>
1.41 asau 1639: <div class="sect1">
1.1 dsieger 1640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1641: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112 rillig 1642: <p>The following variables apply to all
1.1 dsieger 1643: pkgsrc packages. A complete list of the variables that can be
1644: configured by the user is available in
1645: <code class="filename">mk/defaults/mk.conf</code>, together with some
1646: comments that describe each variable's intent.</p>
1.41 asau 1647: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1648: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1649: packages will be installed. The default is
1650: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1651: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1652: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1653: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1654: installed. The default is
1655: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1656: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1657: X11 is installed on the system. The default is
1.84 wiz 1658: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1659: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1660: downloaded copies of the original source distributions used
1661: for building pkgsrc packages. The default is
1662: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1663: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1664: database about installed packages is stored. The default is
1.118 sevan 1665: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1666: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1667: If set, override the packages'
1668: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1669: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1670: Backup location(s) for distribution files and patch files
1671: if not found locally or in
1672: <code class="filename">${MASTER_SITES}</code> or
1673: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1674: The defaults is
1675: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1676: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1677: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1678: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1679: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1680: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1681: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1682: List of acceptable licenses. License names are case-sensitive.
1683: Whenever you try to build a package whose license is not in this
1684: list, you will get an error message. If the license condition is
1685: simple enough, the error message will include specific
1686: instructions on how to change this variable.</p></li>
1.1 dsieger 1687: </ul></div>
1688: </div>
1.41 asau 1689: <div class="sect1">
1.1 dsieger 1690: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1691: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1692: <p>
1.1 dsieger 1693: </p>
1.41 asau 1694: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1695: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1696: directory for the binary packages. The default is
1697: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1698: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1699: The top level directory where, if defined, the separate
1700: working directories will get created, and symbolically
1701: linked to from <code class="filename">${WRKDIR}</code> (see below).
1702: This is useful for building packages on several
1703: architectures, then <code class="filename">${PKGSRCDIR}</code>
1704: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1705: is local to every architecture. (It should be noted that
1706: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1707: — it is an internal definition which refers to the
1.1 dsieger 1708: root of the pkgsrc tree. It is possible to have many
1709: pkgsrc tree instances.)</p></li>
1.23 wiz 1710: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1711: Directory for local patches that aren't part of pkgsrc.
1.154 rillig 1712: 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 1713: information.</p></li>
1.23 wiz 1714: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1715: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1716: BSD-style Makefile. If this is not set,
1717: <code class="varname">MAKECONF</code> is set to
1718: <code class="filename">/dev/null</code> to avoid picking up
1719: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1720: </ul></div>
1721: </div>
1.41 asau 1722: <div class="sect1">
1.1 dsieger 1723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1724: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.143 maya 1725: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
1726: By default, binary packages of built packages are
1.150 leot 1727: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143 maya 1728: this variable to "no" prevents this.</p></li></ul></div>
1.107 jnemeth 1729: <p>Packages have to support installation into a
1.4 rillig 1730: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1731: to be built, before the actual filesystem is touched. DESTDIR
1732: support exists in two variations:</p>
1.41 asau 1733: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1734: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1735: installation and packaging is still run as root.</p></li>
1736: <li class="listitem"><p>Full DESTDIR support can run the complete
1737: build, installation and packaging as normal user. Root
1738: privileges are only needed to add packages.</p></li>
1739: </ul></div>
1.4 rillig 1740: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1741: clean</code></strong> needs to be run as root.</p>
1.17 imil 1742: <p>Considering the <code class="filename">foo/bar</code> package,
1743: DESTDIR full support can be tested using the following commands
1744:
1745: </p>
1746: <pre class="programlisting">
1747: <code class="prompt">$</code> id
1748: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1749: <code class="prompt">$</code> mkdir $HOME/packages
1750: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1751: </pre>
1752: <p>
1753:
1754: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1755: should be needed
1756:
1757: </p>
1758: <pre class="programlisting">
1.66 asau 1759: <code class="prompt">$</code> make stage-install
1.17 imil 1760: </pre>
1761: <p>
1762:
1763: Create a package without root privileges
1764:
1765: </p>
1766: <pre class="programlisting">
1.66 asau 1767: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1768: </pre>
1769: <p>
1770:
1771: For the following command, you must be able to gain root
1.157 leot 1772: privileges using <a class="citerefentry" href="http://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 1773:
1774: </p>
1775: <pre class="programlisting">
1.66 asau 1776: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1777: </pre>
1778: <p>
1779:
1780: Then, as a simple user
1781:
1782: </p>
1783: <pre class="programlisting">
1784: <code class="prompt">$</code> make clean
1785: </pre>
1786: <p>
1787:
1788: </p>
1.4 rillig 1789: </div>
1.41 asau 1790: <div class="sect1">
1.4 rillig 1791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1792: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1793: <div class="sect2">
1.1 dsieger 1794: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1795: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1796: <p>By default, pkgsrc will use GCC to build packages. This may be
1797: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1798: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1799: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1800: <dd>
1801: <p>This is a list of values specifying the chain of
1802: compilers to invoke when building packages. Valid values
1803: are:</p>
1.41 asau 1804: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1805: <li class="listitem"><p><code class="varname">ccc</code>:
1806: Compaq C Compilers (Tru64)</p></li>
1807: <li class="listitem"><p><code class="varname">ccache</code>:
1808: compiler cache (chainable)</p></li>
1809: <li class="listitem"><p><code class="varname">clang</code>:
1810: Clang C and Objective-C compiler</p></li>
1.23 wiz 1811: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1812: distributed C/C++ (chainable)</p></li>
1.66 asau 1813: <li class="listitem"><p><code class="varname">f2c</code>:
1814: Fortran 77 to C compiler (chainable)</p></li>
1815: <li class="listitem"><p><code class="varname">icc</code>:
1816: Intel C++ Compiler (Linux)</p></li>
1817: <li class="listitem"><p><code class="varname">ido</code>:
1818: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1819: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1820: GNU C/C++ Compiler</p></li>
1.66 asau 1821: <li class="listitem"><p><code class="varname">hp</code>:
1822: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1823: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1824: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1825: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1826: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1827: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1828: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1829: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1830: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1831: </ul></div>
1832: <p>The default is
1.23 wiz 1833: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1834: <code class="varname">ccache</code> and/or
1835: <code class="varname">distcc</code> with an appropriate
1836: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1837: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1838: variable should always be terminated with a value for
1839: a real compiler. Note that only one real compiler
1.23 wiz 1840: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1841: is not allowed).</p>
1842: </dd>
1843: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1844: <dd><p>This specifies the minimum version of GCC to use
1845: when building packages. If the system GCC doesn't
1846: satisfy this requirement, then pkgsrc will build and
1847: install one of the GCC packages to use instead.</p></dd>
1.153 leot 1848: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114 maya 1849: <dd><p>Specifies which version of python to use when several
1850: options are available.</p></dd>
1851: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1852: <dd><p>Specifies the fortran compiler to use.
1853: The default is <code class="varname">g95</code>, and
1854: <code class="varname">gfortran</code> is an alternative.</p></dd>
1855: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1856: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1857: <code class="varname">gfortran</code> is used, this option specifies which
1858: version to use.</p></dd>
1.1 dsieger 1859: </dl></div>
1860: </div>
1.41 asau 1861: <div class="sect2">
1.1 dsieger 1862: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1863: <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 1864: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1865: please make sure to use the <code class="literal">+=</code> operator
1866: instead of the <code class="literal">=</code> operator:</p>
1867: <pre class="programlisting">
1868: CFLAGS+= -your -flags
1869: </pre>
1870: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1871: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1872: need to add their own flags. You may want to take a look
1.137 leot 1873: 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 1874: package if you're interested in optimization specifically
1875: for the current CPU. </p>
1.1 dsieger 1876: </div>
1.41 asau 1877: <div class="sect2">
1.1 dsieger 1878: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1879: <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 1880: <p>If you want to pass flags to the linker, both in the configure
1881: step and the build step, you can do this in two ways. Either set
1882: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1883: between the two is that <code class="varname">LIBS</code> will be appended to
1884: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1885: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1886: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1887: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1888: <code class="varname">CFLAGS</code>, if you do not wish to override these
1889: settings, use the <code class="literal">+=</code> operator:</p>
1890: <pre class="programlisting">
1891: LDFLAGS+= -your -linkerflags
1892: </pre>
1893: </div>
1894: </div>
1.41 asau 1895: <div class="sect1">
1.1 dsieger 1896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1897: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1898: <p>
1.1 dsieger 1899: </p>
1.41 asau 1900: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1901: <li class="listitem">
1.1 dsieger 1902: <p><code class="varname">PKG_DEVELOPER</code>:
1903: Run some sanity checks that package developers want:
1904: </p>
1.41 asau 1905: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1906: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 1907: fuzz</p></li>
1.23 wiz 1908: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 1909: binaries will find their shared libs.</p></li>
1910: </ul></div>
1911: <p>
1912: </p>
1913: </li>
1.23 wiz 1914: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 1915: of debugging output which is displayed whilst making and
1916: installing the package. The default value for this is 0,
1917: which will not display the commands as they are executed
1918: (normal, default, quiet operation); the value 1 will display
1919: all shell commands before their invocation, and the value 2
1920: will display both the shell commands before their invocation,
1.112 rillig 1921: as well as their actual execution progress with <span class="command"><strong>set
1922: -x</strong></span>.</p></li>
1.1 dsieger 1923: </ul></div>
1924: <p>
1925: </p>
1926: </div>
1.41 asau 1927: <div class="sect1">
1.1 dsieger 1928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1929: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1930: <p>Some packages have build time options, usually to select
1931: between different dependencies, enable optional support for big
1932: dependencies or enable experimental features.</p>
1933: <p>To see which options, if any, a package supports, and which
1.10 hubertf 1934: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 1935: show-options</strong></span>, for example:</p>
1936: <pre class="programlisting">
1937: The following options are supported by this package:
1938: ssl Enable SSL support.
1939: Exactly one of the following gecko options is required:
1940: firefox Use firefox as gecko rendering engine.
1941: mozilla Use mozilla as gecko rendering engine.
1942: At most one of the following database options may be selected:
1943: mysql Enable support for MySQL database.
1944: pgsql Enable support for PostgreSQL database.
1945:
1946: These options are enabled by default: firefox
1947: These options are currently enabled: mozilla ssl
1948: </pre>
1949: <p>The following variables can be defined in
1.10 hubertf 1950: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 1951: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1952: which can be used to select or disable options for all packages
1953: that support them, and
1954: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1955: which can be used to select or disable options specifically for
1956: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 1957: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 1958: are disabled. A few examples:</p>
1959: <pre class="screen">
1.10 hubertf 1960: <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 1961: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1962: PKG_OPTIONS.kdebase= debug -sasl
1963: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 1964: <p>It is important to note that options that were specifically
1.18 snj 1965: suggested by the package maintainer must be explicitly removed if
1.11 rillig 1966: you do not wish to include the option. If you are unsure you can view
1967: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 1968: <p>The following settings are consulted in the order given, and
1969: the last setting that selects or disables an option is
1970: used:</p>
1.23 wiz 1971: <div class="orderedlist"><ol class="orderedlist" type="1">
1972: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 1973: maintainer</p></li>
1.23 wiz 1974: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 1975: variables (see below)</p></li>
1.23 wiz 1976: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
1977: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 1978: </ol></div>
1979: <p>For groups of mutually exclusive options, the last option
1980: selected is used, all others are automatically disabled. If an
1981: option of the group is explicitly disabled, the previously
1982: selected option, if any, is used. It is an error if no option
1983: from a required group of options is selected, and building the
1984: package will fail.</p>
1985: <p>Before the options framework was introduced, build options
1986: were selected by setting a variable (often named
1987: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 1988: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 1989: transition to the options framework for the user, these legacy
1990: variables are converted to the appropriate options setting
1991: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
1992: automatically. A warning is issued to prompt the user to update
1.10 hubertf 1993: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 1994: directly. Support for the legacy variables will be removed
1995: eventually.</p>
1996: </div>
1997: </div>
1.41 asau 1998: <div class="chapter">
1.1 dsieger 1999: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2000: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1 dsieger 2001: <div class="toc">
2002: <p><b>Table of Contents</b></p>
1.100 leot 2003: <dl class="toc">
1.154 rillig 2004: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2005: <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 2006: </dl>
2007: </div>
1.41 asau 2008: <div class="sect1">
1.1 dsieger 2009: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2010: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1 dsieger 2011: <p>Once you have built and installed a package, you can create
2012: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.157 leot 2013: another system with <a class="citerefentry" href="http://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 2014: the same package on a group of hosts and wasting CPU time. It also
2015: provides a simple means for others to install your package, should
2016: you distribute it.</p>
2017: <p>To create a binary package, change into the appropriate
1.10 hubertf 2018: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2019: package</strong></span>:</p>
2020: <pre class="screen">
1.112 rillig 2021: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2022: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2023: </pre>
1.1 dsieger 2024: <p>This will build and install your package (if not already done),
2025: and then build a binary package from what was installed. You can
1.10 hubertf 2026: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2027: it. Binary packages are created by default in
2028: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2029: 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 2030: 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 2031: <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 2032: such a binary package.</p>
2033: </div>
1.41 asau 2034: <div class="sect1">
1.1 dsieger 2035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2036: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
2037: <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 2038: </div>
2039: </div>
1.41 asau 2040: <div class="chapter">
1.6 rillig 2041: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2042: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 2043: builds)</h2></div></div></div>
2044: <div class="toc">
2045: <p><b>Table of Contents</b></p>
1.100 leot 2046: <dl class="toc">
1.154 rillig 2047: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
2048: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
2049: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2050: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
2051: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2052: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2053: </dl>
2054: </div>
1.71 wiz 2055: <p>For a number of reasons you may want to build binary packages
2056: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
2057: For instance, when you have multiple machines that should run the same software,
2058: it is wasted time if they all build their packages themselves from source.
2059: Or you may want to build a list of packages you want and check them before
2060: deploying onto production system.
2061: There is a way of getting a set of binary packages:
1.112 rillig 2062: The bulk build system, or pbulk ("p" stands for "parallel").
2063: This chapter describes how to set it up.</p>
1.41 asau 2064: <div class="sect1">
1.6 rillig 2065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2066: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71 wiz 2067: <p>First of all, you have to decide whether you build all packages
2068: or a limited set of them. Full bulk builds usually consume a lot more resources,
2069: both space and time, than builds for some practical sets of packages.
2070: There exists a number of particularly heavy packages that are not actually
2071: interesting to a wide audience.
2072:
2073: For a limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2074: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2075: </p>
2076: <p>During bulk builds various packages are installed and deinstalled
2077: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2078: so make sure that you don't need any package during the builds.
1.112 rillig 2079: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2080: or something even more restrictive, depending on what the operating system provides,
2081: or dedicate the whole physical machine.
2082: As a useful side effect this makes sure that bulk builds cannot
2083: break anything in your system. There have been numerous cases where
1.6 rillig 2084: certain packages tried to install files outside the
2085: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2086: <code class="filename">/etc</code>.
2087: </p>
1.6 rillig 2088: </div>
1.41 asau 2089: <div class="sect1">
1.6 rillig 2090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2091: <a name="bulk.pbulk"></a>8.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2092: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2093: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2094: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2095: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2096: </ul></div>
1.41 asau 2097: <div class="sect2">
1.15 rillig 2098: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2099: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112 rillig 2100: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2101: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2102: Configure network access to fetch distribution files.
1.112 rillig 2103: Create a user with name "pbulk".</p>
1.68 asau 2104: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2105: <pre class="screen">
1.151 sevan 2106: <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>
2107: <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 2108: <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 2109: </pre>
2110: <p>Or any other way that fits (e.g., curl, wget).</p>
2111: <p>Deploy and configure pbulk tools, e.g.:</p>
2112: <pre class="screen">
1.118 sevan 2113: <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 2114: <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>
2115: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2116: </pre>
2117: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2118: <h3 class="title">Note</h3>
2119: <p><code class="filename">mk.conf.frag</code> is a fragment of
2120: <code class="filename">mk.conf</code> that contains settings you want to
2121: apply to packages you build. For instance,</p>
2122: <pre class="programlisting">
1.112 rillig 2123: PKG_DEVELOPER= yes # perform more checks
2124: X11_TYPE= modular # use pkgsrc X11
2125: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2126: # when building all packages)
1.68 asau 2127: </pre>
2128: </div>
2129: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2130: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2131: <pre class="programlisting">
2132: www/firefox
2133: mail/thunderbird
2134: misc/libreoffice4
2135: </pre>
1.69 asau 2136: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2137: and make final amendments, if wanted.</p>
1.68 asau 2138: <p>Start it:</p>
2139: <pre class="screen">
2140: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2141: </pre>
2142: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2143: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2144: </p>
2145: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2146: <h3 class="title">Note</h3>
2147: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2148: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2149: The script is kept small enough for better understanding.</p>
2150: </div>
2151: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2152: <h3 class="title">Note</h3>
2153: <p>The <code class="filename">pbulk.sh</code> script supports running
2154: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2155: </div>
1.6 rillig 2156: </div>
2157: </div>
1.41 asau 2158: <div class="sect1">
1.6 rillig 2159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2160: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71 wiz 2161: <p>A complete bulk build requires lots of disk space. Some of the
2162: disk space can be read-only, some other must be writable. Some can be on
2163: remote filesystems (such as NFS) and some should be local. Some can be
2164: temporary filesystems, others must survive a sudden reboot.</p>
2165: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2166: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2167: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2168: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2169: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2170: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2171: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2172: </ul></div>
2173: </div>
2174: <div class="sect1">
2175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2176: <a name="creating-cdroms"></a>8.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2177: <p>After your pkgsrc bulk-build has completed, you may wish to
2178: create a CD-ROM set of the resulting binary packages to assist
2179: in installing packages on other machines. The
1.137 leot 2180: <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 2181: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2182: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2183: way that keeps all the dependencies for a given package on the same
2184: CD as that package.</p>
1.41 asau 2185: <div class="sect2">
1.1 dsieger 2186: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2187: <a name="cdpack-example"></a>8.4.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2188: <p>Complete documentation for cdpack is found in the cdpack(1)
2189: man page. The following short example assumes that the binary
2190: packages are left in
2191: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2192: sufficient disk space exists in <code class="filename">/u2</code> to
2193: hold the ISO 9660 images.</p>
2194: <pre class="screen">
2195: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2196: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2197: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2198: </pre>
2199: <p>If you wish to include a common set of files
2200: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2201: etc.) on each CD in the collection, then you need to create a
2202: directory which contains these files. e.g.</p>
2203: <pre class="screen">
2204: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2205: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2206: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2207: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2208: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2209: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2210: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2211: </pre>
2212: <p>Now create the images:</p>
2213: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2214: <p>Each image will contain <code class="filename">README</code>,
2215: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2216: in their root directories.</p>
2217: </div>
2218: </div>
2219: </div>
1.41 asau 2220: <div class="chapter">
1.1 dsieger 2221: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2222: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2223: <div class="toc">
2224: <p><b>Table of Contents</b></p>
1.100 leot 2225: <dl class="toc">
1.154 rillig 2226: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2227: <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 2228: </dl>
2229: </div>
2230: <p>The files that are installed by pkgsrc are organized in a way that
2231: is similar to what you find in the <code class="filename">/usr</code> directory
2232: of the base system. But some details are different. This is because
2233: pkgsrc initially came from FreeBSD and had adopted its file system
2234: hierarchy. Later it was largely influenced by NetBSD. But no matter
2235: which operating system you are using pkgsrc with, you can expect the
2236: same layout for pkgsrc.</p>
2237: <p>There are mainly four root directories for pkgsrc, which are all
2238: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2239: When pkgsrc has been installed as root, the default locations
2240: are:</p>
2241: <pre class="programlisting">
2242: LOCALBASE= /usr/pkg
2243: PKG_SYSCONFBASE= /usr/pkg/etc
2244: VARBASE= /var
1.119 sevan 2245: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2246: </pre>
2247: <p>In unprivileged mode (when pkgsrc has been installed as any other
2248: user), the default locations are:</p>
2249: <pre class="programlisting">
2250: LOCALBASE= ${HOME}/pkg
2251: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2252: VARBASE= ${HOME}/pkg/var
1.119 sevan 2253: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2254: </pre>
2255: <p>What these four directories are for, and what they look like is
2256: explained below.</p>
1.41 asau 2257: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2258: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2259: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2260: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2261: the well-known subdirectories like <code class="filename">bin</code>,
2262: <code class="filename">include</code>, <code class="filename">lib</code>,
2263: <code class="filename">share</code> and
2264: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2265: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2266: <code class="filename">/var</code> in the base system. Some programs (especially
2267: games, network daemons) need write access to it during normal
2268: operation.</p></li>
1.23 wiz 2269: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2270: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2271: 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 2272: itself.</p></li>
2273: </ul></div>
1.41 asau 2274: <div class="sect1">
1.1 dsieger 2275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2276: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2277: </h2></div></div></div>
2278: <p>The following directories exist in a typical pkgsrc installation
2279: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2280: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2281: <dt><span class="term"><code class="filename">bin</code></span></dt>
2282: <dd><p>Contains executable programs that are intended to be
2283: directly used by the end user.</p></dd>
2284: <dt><span class="term"><code class="filename">emul</code></span></dt>
2285: <dd><p>Contains files for the emulation layers of various other
2286: operating systems, especially for
2287: NetBSD.</p></dd>
2288: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2289: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2290: <dd><p>Contains
2291: the configuration files.</p></dd>
2292: <dt><span class="term"><code class="filename">include</code></span></dt>
2293: <dd><p>Contains headers for the C and C++ programming
2294: languages.</p></dd>
2295: <dt><span class="term"><code class="filename">info</code></span></dt>
2296: <dd><p>Contains GNU info files of various
2297: packages.</p></dd>
2298: <dt><span class="term"><code class="filename">lib</code></span></dt>
2299: <dd><p>Contains shared and static
2300: libraries.</p></dd>
2301: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2302: <dd><p>Contains data files that don't change after
2303: installation. Other data files belong into
2304: <code class="filename">${VARBASE}</code>.</p></dd>
2305: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2306: <dd><p>Contains programs that are not intended to be used by
2307: end users, such as helper programs or network
2308: daemons.</p></dd>
2309: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2310: <dd><p>Contains programs that are intended to be executed as
2311: CGI scripts by a web server.</p></dd>
2312: <dt><span class="term"><code class="filename">man</code> (the usual value of
2313: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2314: <dd><p>Contains brief
2315: documentation in form of manual pages.</p></dd>
2316: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2317: <dd><p>Contains programs that are intended to be used only by
2318: the super-user.</p></dd>
2319: <dt><span class="term"><code class="filename">share</code></span></dt>
2320: <dd><p>Contains platform-independent data files that don't
2321: change after installation.</p></dd>
2322: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2323: <dd><p>Contains documentation files provided by the
2324: packages.</p></dd>
2325: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2326: <dd><p>Contains example files provided by the packages. Among
2327: others, the original configuration files are saved here and copied to
2328: <code class="filename">${PKG_SYSCONFDIR}</code> during
2329: installation.</p></dd>
2330: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2331: <dd><p>Contains the original files for rc.d
2332: scripts.</p></dd>
2333: <dt><span class="term"><code class="filename">var</code> (the usual location of
2334: <code class="filename">${VARBASE}</code>)</span></dt>
2335: <dd><p>Contains files
2336: that may be modified after
2337: installation.</p></dd>
2338: </dl></div>
2339: </div>
1.41 asau 2340: <div class="sect1">
1.1 dsieger 2341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2342: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2343: </h2></div></div></div>
1.41 asau 2344: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2345: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2346: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2347: <dd><p>Contains
2348: information about the currently installed
2349: packages.</p></dd>
2350: <dt><span class="term"><code class="filename">games</code></span></dt>
2351: <dd><p>Contains highscore
2352: files.</p></dd>
2353: <dt><span class="term"><code class="filename">log</code></span></dt>
2354: <dd><p>Contains log files.</p></dd>
2355: <dt><span class="term"><code class="filename">run</code></span></dt>
2356: <dd><p>Contains informational files about daemons that are
2357: currently running.</p></dd>
2358: </dl></div>
2359: </div>
2360: </div>
1.41 asau 2361: <div class="chapter">
1.1 dsieger 2362: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2363: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2364: <div class="toc">
2365: <p><b>Table of Contents</b></p>
1.100 leot 2366: <dl class="toc">
1.154 rillig 2367: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2368: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2369: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2370: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2371: <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>
2372: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2373: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2374: <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>
2375: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2376: <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 2377: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 2378: <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>
2379: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
2380: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2381: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2382: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2383: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2384: <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 2385: </dl>
2386: </div>
2387: <p>This section contains hints, tips & tricks on special things in
2388: pkgsrc that we didn't find a better place for in the previous chapters, and
2389: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2390: <div class="sect1">
1.1 dsieger 2391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2392: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2393: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2394: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2395: <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 2396: This is a general purpose list for most issues regarding
2397: pkgsrc, regardless of platform, e.g. soliciting user help
2398: for pkgsrc configuration, unexpected build failures, using
2399: particular packages, upgrading pkgsrc installations,
2400: questions regarding the pkgsrc release branches, etc. General announcements or
2401: proposals for changes that impact the pkgsrc user community,
2402: e.g. major infrastructure changes, new features, package
2403: removals, etc., may also be posted.</p></li>
1.23 wiz 2404: <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 2405: A list where the results of pkgsrc bulk builds are sent and
2406: discussed.</p></li>
1.23 wiz 2407: <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 2408: This list is for those who are interested in getting a
2409: commit message for every change committed to pkgsrc. It is
2410: also available in digest form, meaning one daily message
2411: containing all commit messages for changes to the package
2412: source tree in that 24 hour period.</p></li>
2413: </ul></div>
2414: <p>To subscribe, do:</p>
2415: <pre class="programlisting">
2416: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2417: </pre>
2418: <p>Archives for all these mailing lists are available from
1.10 hubertf 2419: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2420: </div>
1.41 asau 2421: <div class="sect1">
1.1 dsieger 2422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2423: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2424: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2425: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2426: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2427: they might be useful, and not to duplicate the documentation that comes
2428: with each package.</p>
2429: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.137 leot 2430: <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 2431: Symlinks for use by buildlink.</p></li></ul></div>
2432: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2433: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2434: <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 2435: Calculates various kinds of checksums (including SHA3).</p></li>
1.137 leot 2436: <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 2437: Compatibility library for pkgsrc tools.</p></li>
1.137 leot 2438: <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 2439: non-BSD systems due to lack of native mtree.</p></li>
1.137 leot 2440: <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 2441: Up-to-date replacement for
2442: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2443: systems where pkg_install is not present.</p></li>
2444: </ul></div>
2445: <p>Utilities used by pkgsrc (not automatically installed):</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/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1 dsieger 2448: Create a binary package from an
1.10 hubertf 2449: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2450: save the old package.</p></li>
1.137 leot 2451: <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 2452: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2453: from multiple locations. It currently supports the following
2454: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.137 leot 2455: <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 2456: the best compiler flags to optimise code for your current
1.23 wiz 2457: CPU and compiler. </p></li>
1.1 dsieger 2458: </ul></div>
2459: <p>Utilities for keeping track of installed packages, being up to date,
2460: etc:</p>
1.41 asau 2461: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2462: <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 2463: update tool similar to apt(1). Download, install, and upgrade
2464: binary packages easily.</p></li>
1.137 leot 2465: <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 2466: packages whose installed versions do not match the latest pkgsrc
2467: entries.</p></li>
1.137 leot 2468: <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 2469: dependency graphs of packages, to aid in choosing a strategy for
2470: updating.</p></li>
1.137 leot 2471: <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
2472: 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>
2473: <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 2474: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.137 leot 2475: <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 2476: does various checks on the complete pkgsrc system.</p></li>
1.137 leot 2477: <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 2478: packages you have installed.</p></li>
2479: </ul></div>
2480: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2481: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2482: <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 2483: making and maintaining patches for a package (includes pkgdiff,
2484: pkgvi, mkpatches, etc.).</p></li>
1.137 leot 2485: <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 2486: converting to pkgsrc.</p></li>
2487: </ul></div>
2488: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2489: utilities)</p>
1.41 asau 2490: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2491: <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 2492: packages in a chrooted area.</p></li>
1.137 leot 2493: <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 2494: kernel version for chrooted cross builds.</p></li>
2495: </ul></div>
2496: </div>
1.41 asau 2497: <div class="sect1">
1.1 dsieger 2498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2499: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2500: <p>To install packages from source as a non-root user, download
1.154 rillig 2501: 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 2502: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2503: --unprivileged</strong></span>.</p>
2504: <p>This will install the binary part of pkgsrc to
2505: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2506: into <code class="filename">~/pkg/etc</code>.</p>
2507: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2508: </div>
1.41 asau 2509: <div class="sect1">
1.1 dsieger 2510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2511: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2512: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2513: enable this feature by adding the option
2514: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2515: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2516: distfile is found, pkgsrc will try to resume it.</p>
2517: <p>You can also
1.61 wiz 2518: use a different program than the platform default program by changing the
1.16 jnemeth 2519: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2520: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2521: by using the value manual. A value of custom disables the system defaults
2522: and dependency tracking for the fetch program. In that case you have to
2523: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2524: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2525: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2526: <p>For example, if you want to use
1.16 jnemeth 2527: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2528: like:</p>
2529: <pre class="programlisting">
1.112 rillig 2530: FETCH_USING= wget
1.1 dsieger 2531: </pre>
2532: </div>
1.41 asau 2533: <div class="sect1">
1.1 dsieger 2534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2535: <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 2536: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2537: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2538: you will have to add the following line into
1.10 hubertf 2539: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2540: <pre class="programlisting">
1.4 rillig 2541: X11_TYPE=modular
1.1 dsieger 2542: </pre>
2543: </div>
1.41 asau 2544: <div class="sect1">
1.1 dsieger 2545: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2546: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2547: <p>If you are sitting behind a firewall which does not allow direct
2548: connections to Internet hosts (i.e. non-NAT), you may specify the
2549: relevant proxy hosts. This is done using an environment variable in the
2550: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2551: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2552: port 80 as the proxy port number. So the proxy environment variables
2553: are:</p>
2554: <pre class="programlisting">
2555: ftp_proxy=ftp://orpheus.amdahl.com:80/
2556: http_proxy=http://orpheus.amdahl.com:80/
2557: </pre>
2558: </div>
1.41 asau 2559: <div class="sect1">
1.1 dsieger 2560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2561: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2562: <p>Some fetch tools are not prepared to support HTTPS by default
2563: (for example, the one in NetBSD 6.0), or the one installed by the
2564: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2565: dependency graph).</p>
2566: <p>Usually you won't notice, because distribution files are
2567: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2568: be often enough if you are following pkgsrc-current. In that case, set
2569: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2570: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2571: with HTTPS support by default. Of course, these tools need to be
2572: installed before you can use them this way.</p>
2573: </div>
2574: <div class="sect1">
2575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2576: <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 2577: <p>This depends on which utility is used to retrieve distfiles. From
2578: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2579: the first available command from the following list:</p>
1.41 asau 2580: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2581: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2582: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2583: </ul></div>
2584: <p>On a default NetBSD installation, this will be
2585: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2586: connections first, and falls back to active connections if the server
2587: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2588: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2589: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2590: <p>Having that option present will prevent
2591: <code class="filename">/usr/bin/ftp</code> from falling back to active
2592: transfers.</p>
2593: </div>
1.41 asau 2594: <div class="sect1">
1.1 dsieger 2595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2596: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2597: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2598: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2599: 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 2600: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2601: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2602: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2603: resulting list to your machine at work/school and use it there. If you
1.157 leot 2604: don't have a NetBSD-compatible <a class="citerefentry" href="http://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 2605: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2606: URL:</p>
2607: <p>At home:</p>
2608: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2609: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2610: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2611: <p>At work:</p>
2612: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2613: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2614: home.</p>
2615: <p>If you have a machine running NetBSD, and you want to get
2616: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2617: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2618: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2619: directly by running:</p>
2620: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2621: <p>If you even decide to ignore
2622: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2623: by running:</p>
2624: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2625: </div>
1.41 asau 2626: <div class="sect1">
1.1 dsieger 2627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2628: <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 2629: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.137 leot 2630: <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 2631: package, you get the error from make that it doesn't know how to make
2632: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2633: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2634: the NetBSD base distribution on your machine. It is recommended to do
2635: that to format man pages.</p>
1.137 leot 2636: <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 2637: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2638: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2639: </div>
1.41 asau 2640: <div class="sect1">
1.1 dsieger 2641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2642: <a name="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 2643: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2644: when you installed your NetBSD machine. Please get and install it, by
2645: extracting it in <code class="filename">/</code>:</p>
2646: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2647: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2648: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2649: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2650: -r</strong></span>).</p>
2651: </div>
1.41 asau 2652: <div class="sect1">
1.1 dsieger 2653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2654: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 2655: <p>When installing packages as non-root user and using the just-in-time
1.157 leot 2656: <a class="citerefentry" href="http://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 2657: password for each required package installed. To avoid this, the sudo
2658: package can be used, which does password caching over a limited time. To
2659: use it, install sudo (either as binary package or from
1.137 leot 2660: <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 2661: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2662: <span class="emphasis"><em>after</em></span> the definition of the
2663: <code class="varname">LOCALBASE</code> variable:</p>
2664: <pre class="programlisting">
2665: .if exists(${LOCALBASE}/bin/sudo)
2666: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2667: .endif
2668: </pre>
2669: </div>
1.41 asau 2670: <div class="sect1">
1.1 dsieger 2671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2672: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 2673: <p>As the system administrator, you can choose where configuration files
2674: are installed. The default settings make all these files go into
2675: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
2676: be suboptimal depending on your expectations (e.g., a read-only,
2677: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2678: configuration of the provided packages).</p>
2679: <p>In order to change the defaults, you can modify the
2680: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 2681: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 2682: directory; some common examples include <code class="filename">/etc</code> or
2683: <code class="filename">/etc/pkg</code>.</p>
2684: <p>Furthermore, you can change this value on a per-package basis by
2685: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2686: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2687: package you would like to modify, that is, the contents of
2688: <code class="varname">PKGBASE</code>.</p>
2689: <p>Note that after changing these settings, you must rebuild and
2690: reinstall any affected packages.</p>
2691: </div>
1.41 asau 2692: <div class="sect1">
1.1 dsieger 2693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2694: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1 dsieger 2695: <p>Please be aware that there can often be bugs in third-party software,
2696: and some of these bugs can leave a machine vulnerable to exploitation by
2697: attackers. In an effort to lessen the exposure, the NetBSD packages team
2698: maintains a database of known-exploits to packages which have at one time
2699: been included in pkgsrc. The database can be downloaded automatically, and
2700: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 2701: do this, refer to the following two tools (installed as part of the
1.137 leot 2702: <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 2703: <div class="orderedlist"><ol class="orderedlist" type="1">
2704: <li class="listitem">
1.20 snj 2705: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 2706: download a list of the security vulnerabilities information. This list
1.25 spz 2707: is kept up to date by the pkgsrc security team, and is distributed
2708: from the NetBSD ftp server:</p>
2709: <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 2710: </li>
1.23 wiz 2711: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
2712: current machine, checking each known vulnerability. If a
1.1 dsieger 2713: vulnerable package is installed, it will be shown by output to stdout,
2714: including a description of the type of vulnerability, and a URL
2715: containing more information.</p></li>
2716: </ol></div>
1.121 sevan 2717: <p>Use of these tools is strongly recommended!
1.154 rillig 2718: 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 2719: reporting.</p>
2720: <p>If this database is installed, pkgsrc builds will use it to
2721: perform a security check before building any package.</p>
1.1 dsieger 2722: </div>
1.41 asau 2723: <div class="sect1">
1.1 dsieger 2724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2725: <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 2726: <p>When you add your own preferences to the
2727: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 2728: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 2729: environment variables to the <code class="filename">./configure</code>
1.157 leot 2730: scripts and to <a class="citerefentry" href="http://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 2731: <code class="varname">CFLAGS</code> from the environment variable by
2732: overriding them in the <code class="filename">Makefile</code>s of their
2733: package.</p>
2734: <p>Currently there is no solution to this problem. If you
2735: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 2736: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 2737: directory and then inspect any <code class="filename">Makefile</code> and
2738: <code class="filename">Makefile.in</code> for whether they define
2739: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 2740: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 2741: programmers write so bad code that it only works for the
2742: specific combination of <code class="varname">CFLAGS</code> they have
2743: chosen.</p>
2744: </div>
1.41 asau 2745: <div class="sect1">
1.1 dsieger 2746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2747: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 2748: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 2749: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 2750: case that occurs often is that people only update pkgsrc in
2751: parts, because of performance reasons. Since pkgsrc is one large
2752: system, not a collection of many small systems, there are
2753: sometimes changes that only work when the whole pkgsrc tree is
2754: updated.</p></li>
1.41 asau 2755: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 2756: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
2757: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 2758: files.</p></li>
1.41 asau 2759: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 2760: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 2761: verify this.</p></li>
1.108 rillig 2762: <li class="step"><p>If you are a package developer who wants to invest
1.154 rillig 2763: 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 2764: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 2765: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2766: </ol></div>
2767: </div>
1.41 asau 2768: <div class="sect1">
1.1 dsieger 2769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2770: <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 2771: <p>You have modified a file from pkgsrc, and someone else has
2772: modified that same file afterwards in the CVS repository. Both changes
2773: are in the same region of the file, so when you updated pkgsrc, the
2774: <code class="literal">cvs</code> command marked the conflicting changes in the
2775: file. Because of these markers, the file is no longer a valid
2776: <code class="filename">Makefile</code>.</p>
2777: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 2778: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 2779: -dP</strong></span> in that directory to download the current version.</p>
2780: </div>
2781: </div>
2782: </div>
1.41 asau 2783: <div class="part">
1.1 dsieger 2784: <div class="titlepage"><div><div><h1 class="title">
2785: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 2786: <div class="partintro">
1.1 dsieger 2787: <div></div>
2788: <p>This part of the book deals with creating and
1.23 wiz 2789: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 2790: guide on creating a new package. The remaining chapters are more
2791: like a reference manual for pkgsrc.</p>
2792: <div class="toc">
2793: <p><b>Table of Contents</b></p>
1.100 leot 2794: <dl class="toc">
1.154 rillig 2795: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
2796: <dt><span class="chapter"><a href="#creating">12. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 2797: <dd><dl>
1.154 rillig 2798: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1 dsieger 2799: <dd><dl>
1.154 rillig 2800: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
2801: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160 brook 2802: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
2803: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1 dsieger 2804: </dl></dd>
1.154 rillig 2805: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
2806: <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 2807: </dl></dd>
1.154 rillig 2808: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.6 rillig 2809: <dd><dl>
1.154 rillig 2810: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
2811: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
2812: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 2813: <dd><dl>
1.154 rillig 2814: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
2815: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
2816: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
2817: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
2818: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
1.6 rillig 2819: </dl></dd>
1.154 rillig 2820: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
2821: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
1.6 rillig 2822: <dd><dl>
1.154 rillig 2823: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
2824: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
2825: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.6 rillig 2826: </dl></dd>
1.154 rillig 2827: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
2828: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 2829: </dl></dd>
1.154 rillig 2830: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 2831: <dd><dl>
1.154 rillig 2832: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
2833: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
2834: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
2835: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
1.6 rillig 2836: <dd><dl>
1.154 rillig 2837: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
2838: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
2839: <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>
2840: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 2841: </dl></dd>
2842: </dl></dd>
1.154 rillig 2843: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.6 rillig 2844: <dd><dl>
1.154 rillig 2845: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
2846: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
2847: <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>
2848: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
2849: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
2850: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
2851: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
2852: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
2853: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.6 rillig 2854: </dl></dd>
1.154 rillig 2855: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.6 rillig 2856: <dd><dl>
1.154 rillig 2857: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
2858: <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 2859: <dd><dl>
1.154 rillig 2860: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
2861: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26 wiz 2862: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2863: and
2864: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
2865: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 2866: </dl></dd>
1.154 rillig 2867: <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 2868: <dd><dl>
1.154 rillig 2869: <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>
2870: <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 2871: </dl></dd>
2872: </dl></dd>
1.154 rillig 2873: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.6 rillig 2874: <dd><dl>
1.154 rillig 2875: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
2876: <dd><dl>
2877: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
2878: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
2879: </dl></dd>
2880: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
2881: <dd><dl>
2882: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
2883: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
2884: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
2885: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
2886: </dl></dd>
2887: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
2888: <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>
2889: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
2890: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
2891: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
2892: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
2893: <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>
2894: </dl></dd>
2895: <dt><span class="chapter"><a href="#options">18. Options handling</a></span></dt>
2896: <dd><dl>
2897: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
2898: <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>
2899: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
2900: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
2901: </dl></dd>
2902: <dt><span class="chapter"><a href="#build">19. The build process</a></span></dt>
2903: <dd><dl>
2904: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
2905: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
2906: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
2907: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
2908: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
2909: <dd><dl>
2910: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
2911: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
2912: </dl></dd>
2913: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
2914: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
2915: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
2916: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
2917: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
2918: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2919: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2920: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
2921: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
2922: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
2923: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
2924: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
2925: </dl></dd>
2926: <dt><span class="chapter"><a href="#tools">20. Tools needed for building or running</a></span></dt>
2927: <dd><dl>
2928: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
2929: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
2930: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
2931: </dl></dd>
2932: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
2933: <dd><dl>
2934: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
2935: <dd><dl>
2936: <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>
2937: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
2938: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
2939: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
2940: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
2941: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
2942: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
2943: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
2944: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
2945: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
2946: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
2947: </dl></dd>
2948: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
2949: <dd><dl>
2950: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
2951: <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>
2952: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
2953: </dl></dd>
2954: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
2955: <dd><dl>
2956: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
2957: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
2958: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
2959: </dl></dd>
2960: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
2961: <dd><dl>
2962: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
2963: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
2964: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
2965: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
2966: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
2967: </dl></dd>
2968: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
2969: <dd><dl>
2970: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
2971: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
2972: <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>
2973: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
2974: </dl></dd>
2975: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
2976: <dd><dl>
2977: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
2978: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
2979: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
2980: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
2981: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
2982: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
2983: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
2984: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
2985: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
2986: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
2987: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
2988: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
2989: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
2990: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
2991: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
2992: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
2993: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
2994: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 2995: emulation</a></span></dt>
1.154 rillig 2996: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
2997: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 2998: </dl></dd>
1.154 rillig 2999: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3000: </dl></dd>
1.154 rillig 3001: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
3002: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3003: <dd><dl>
1.154 rillig 3004: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3005: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3006: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3007: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3008: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3009: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3010: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3011: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3012: </dl></dd>
3013: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
3014: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
3015: <dd><dl>
3016: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
3017: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
3018: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
3019: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1 dsieger 3020: </dl></dd>
3021: </dl>
3022: </div>
3023: </div>
1.41 asau 3024: <div class="chapter">
1.1 dsieger 3025: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3026: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3027: <p>
3028: To get help when developing pkgsrc, the definitive source is this
3029: document, the pkgsrc guide. If you don't find anything here,
3030: there are alternatives:
3031: </p>
3032: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3033: <li class="listitem">
3034: <p>
3035: The built-in pkgsrc help, which is available after bootstrapping
3036: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3037: help for any topic, such as a variable name like
3038: <code class="varname">BUILD_DEFS</code>, a make target like
3039: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3040: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
3041: <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>
3042: </li>
3043: <li class="listitem"><p>
3044: The tech-pkg mailing list, to which
3045: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3046: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3047: questions</a>.</p></li>
3048: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3049: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3050: or by using a specialized chat program such as
3051: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3052: Pick any user name and join the channel #pkgsrc.</p></li>
3053: </ul></div>
3054: </div>
3055: <div class="chapter">
3056: <div class="titlepage"><div><div><h2 class="title">
3057: <a name="creating"></a>Chapter 12. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3058: <div class="toc">
3059: <p><b>Table of Contents</b></p>
1.100 leot 3060: <dl class="toc">
1.154 rillig 3061: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1 dsieger 3062: <dd><dl>
1.154 rillig 3063: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
3064: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160 brook 3065: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
3066: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1 dsieger 3067: </dl></dd>
1.154 rillig 3068: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
3069: <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 3070: </dl>
3071: </div>
3072: <p>When you find a package that is not yet in pkgsrc, you
3073: most likely have a URL from where you can download the source
3074: code. Starting with this URL, creating a package involves only a
3075: few steps.</p>
1.23 wiz 3076: <div class="procedure"><ol class="procedure" type="1">
1.137 leot 3077: <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 3078: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3079: category in which you want to place your package. You can also create a
3080: directory of your own (maybe called <code class="filename">local</code>). In that
3081: category directory, create another directory for your package and change
3082: into it.</p></li>
1.41 asau 3083: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3084: you for a URL. Enter the URL of the distribution file (in most cases a
3085: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3086: of your package are created automatically. The distribution file is
3087: extracted automatically to fill in some details in the
3088: <code class="filename">Makefile</code> that would otherwise have to be done
3089: manually.</p></li>
1.41 asau 3090: <li class="step">
1.1 dsieger 3091: <p>Examine the extracted files to determine the dependencies of
3092: your package. Ideally, this is mentioned in some
3093: <code class="filename">README</code> file, but things may differ. For each of
3094: these dependencies, look where it exists in pkgsrc, and if there is a
3095: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3096: line to your package <code class="filename">Makefile</code> which includes that
3097: file just before the last line. If the
1.25 spz 3098: <code class="filename">buildlink3.mk</code> file does not exist, it must be
1.161 ! leot 3099: created first. The <code class="filename">buildlink3.mk</code> file makes sure
! 3100: that the package's include files and libraries are provided.</p>
1.25 spz 3101: <p>If you just need binaries from a package, add a
1.1 dsieger 3102: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3103: version of the dependency and where it can be found in pkgsrc. This line
3104: should be placed in the third paragraph. If the dependency is only
3105: needed for building the package, but not when using it, use
1.156 leot 3106: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
3107: instead of <code class="varname">DEPENDS</code>.
3108: The difference between <code class="varname">TOOL_DEPENDS</code> and
3109: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
3110: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
3111: packages, i.e. packages for the architecture where the package
3112: is built;
3113: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
3114: packages, i.e. packages for the architecture for which the package
3115: is built.
1.1 dsieger 3116: Your package may then look like this:</p>
3117: <pre class="programlisting">
3118: [...]
3119:
1.156 leot 3120: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3121: DEPENDS+= screen-[0-9]*:../../misc/screen
3122: DEPENDS+= screen>=4.0:../../misc/screen
3123:
3124: [...]
3125:
3126: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3127: .include "../../devel/glib2/buildlink3.mk"
3128: .include "../../mk/bsd.pkg.mk"
3129: </pre>
3130: </li>
1.41 asau 3131: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3132: 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 3133: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3134: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3135: -e</strong></span>, which outputs additional
3136: explanations.</p></li>
1.41 asau 3137: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.154 rillig 3138: 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 3139: over there, you can hopefully continue here.</p></li>
1.41 asau 3140: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3141: directory from the extracted files. Besides these files, a lot of cache
3142: files and other system information has been saved in the working
3143: directory, which may become wrong after you edited the
3144: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3145: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.154 rillig 3146: 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 3147: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3148: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3149: everything works.</p></li>
1.41 asau 3150: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3151: contains a list of the files that are installed by the package, is
1.10 hubertf 3152: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3153: >PLIST</strong></span> to generate a probably correct list. Check
3154: the file using your preferred text editor to see if the list of
3155: files looks plausible.</p></li>
1.41 asau 3156: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3157: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3158: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3159: has been registered in the database of installed files, but with an
1.10 hubertf 3160: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3161: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3162: registered with the list of files from
3163: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3164: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3165: package from the set of installed files.</p></li>
3166: </ol></div>
1.41 asau 3167: <div class="sect1">
1.1 dsieger 3168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3169: <a name="creating.common"></a>12.1. Common types of packages</h2></div></div></div>
1.41 asau 3170: <div class="sect2">
1.1 dsieger 3171: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3172: <a name="creating.perl-module"></a>12.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3173: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3174: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3175: </div>
1.41 asau 3176: <div class="sect2">
1.1 dsieger 3177: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3178: <a name="creating.python-module"></a>12.1.2. Python modules and programs</h3></div></div></div>
1.17 imil 3179: <p>Python modules and programs packages are easily created using a
3180: set of predefined variables.</p>
3181: <p>
1.63 wiz 3182: If some Python versions are not supported by the software, set the
3183: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3184: that are not supported, e.g.
1.17 imil 3185: </p>
3186: <pre class="programlisting">
1.93 sevan 3187: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3188: </pre>
3189: <p>
1.103 wiz 3190: If the packaged software is a Python module, include one of
3191: <code class="filename">../../lang/python/egg.mk</code>,
3192: <code class="filename">../../lang/python/distutils.mk</code>, or
3193: <code class="filename">../../lang/python/extension.mk</code>.</p>
3194: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3195: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3196: if the packaged software is using setuptools, you only need
3197: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3198: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3199: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3200: so pkgsrc will use this framework.
3201: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3202: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3203: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3204: to the name of the script.</p>
3205: <p>Either way, the package directory should be called
1.23 wiz 3206: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3207: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3208: </p>
3209: <pre class="programlisting">
3210: DISTNAME= foopymodule-1.2.10
3211: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3212: </pre>
1.63 wiz 3213: <p>If it is an application, include
3214: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3215: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3216: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3217: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3218: For example:
1.17 imil 3219: </p>
3220: <pre class="programlisting">
1.35 wiz 3221: REPLACE_PYTHON= *.py
1.17 imil 3222: </pre>
1.63 wiz 3223: <p>Some Python modules have separate distributions for Python-2.x
3224: and Python-3.x support. In pkgsrc this is handled by the
3225: <code class="filename">versioned_dependencies.mk</code> file. Set
3226: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3227: packages that should be depended upon and include
3228: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3229: then the pkgsrc infrastructure will depend on the appropriate package
3230: version. For example:
3231: </p>
3232: <pre class="programlisting">
1.135 wiz 3233: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.63 wiz 3234: </pre>
3235: <p>
3236: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3237: of supported packages.</p>
1.17 imil 3238: </div>
1.160 brook 3239: <div class="sect2">
3240: <div class="titlepage"><div><div><h3 class="title">
3241: <a name="creating.R-package"></a>12.1.3. R packages</h3></div></div></div>
3242: <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>
3243: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
3244: 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>.
3245: Individual packages (and optionally their dependencies) may be created
3246: and updated. R packages generally follow the same form, and most of
3247: the relevant information needed is contained in a
3248: <code class="filename">DESCRIPTION</code> file as part of each R package on
3249: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
3250: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
3251: creates or updates a package in the canonical form. The resulting
3252: package should be reviewed for correctness.</p>
3253: </div>
3254: <div class="sect2">
3255: <div class="titlepage"><div><div><h3 class="title">
3256: <a name="creating.TeX-package"></a>12.1.4. TeXlive packages</h3></div></div></div>
3257: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
3258: <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>
3259: <p>If the TeXlive package name is not known, it may be useful to
3260: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
3261: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
3262: 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
3263: archive</a>.</p>
3264: <p>If the TeXlive package name is known, download the files from
3265: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
3266: archive</a>. For package <code class="filename">foo</code>, you will need
3267: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
3268: also have associated documentation packages, so download
3269: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
3270: should be placed in the appropriate category directory, which is often
3271: but not always <code class="filename">print</code>. Then run the following
3272: command in the category directory.</p>
3273: <pre class="programlisting">
3274: texlive2pkg foo.tar.xz foo.doc.tar.xz
3275: </pre>
3276: <p>This will create two packages, <code class="filename">tex-foo</code> and
3277: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
3278: are correct.</p>
3279: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
3280: currently does not include version information in package filenames
3281: and changes their contents periodically when updates occur.
3282: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
3283: pkgsrc archives. For each new or updated TeXlive package, e.g., the
3284: main one and the corresponding documentation, upload the distfiles
3285: with the following command in each package directory.</p>
3286: <pre class="programlisting">
3287: make upload-distfiles
3288: </pre>
3289: </div>
1.1 dsieger 3290: </div>
1.41 asau 3291: <div class="sect1">
1.1 dsieger 3292: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3293: <a name="creating.examples"></a>12.2. Examples</h2></div></div></div>
1.41 asau 3294: <div class="sect2">
1.1 dsieger 3295: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3296: <a name="creating.nvu"></a>12.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3297: <div class="sect3">
1.1 dsieger 3298: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 3299: <a name="creating.nvu.init"></a>12.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3300: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3301: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3302: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3303: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3304: <pre class="programlisting">
3305: <code class="prompt">$</code> mkdir www/nvu
3306: <code class="prompt">$</code> cd www/nvu
3307: </pre>
3308: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3309: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3310: <pre class="programlisting">
3311: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3312: </pre>
3313: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3314: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3315: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3316: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3317: <code class="varname">COMMENT</code> fields. Then the package
3318: <code class="filename">Makefile</code> looked like that:</p>
3319: <pre class="programlisting">
1.121 sevan 3320: # $NetBSD $
1.1 dsieger 3321: #
3322:
3323: DISTNAME= nvu-1.0-sources
3324: PKGNAME= nvu-1.0
3325: CATEGORIES= www
3326: MASTER_SITES= http://cvs.nvu.com/download/
3327: EXTRACT_SUFX= .tar.bz2
3328:
3329: MAINTAINER= rillig@NetBSD.org
3330: HOMEPAGE= http://cvs.nvu.com/
3331: COMMENT= Web Authoring System
3332:
3333: # url2pkg-marker (please do not remove this line.)
3334: .include "../../mk/bsd.pkg.mk"
3335: </pre>
1.124 wiz 3336: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.121 sevan 3337: this is a workaround to prevent CVS expanding to the filename of the
3338: guide.</p>
1.1 dsieger 3339: <p>Then, I quit the editor and watched pkgsrc downloading a large
3340: source archive:</p>
3341: <pre class="programlisting">
3342: url2pkg> Running "make makesum" ...
3343: => Required installed package digest>=20010302: digest-20060826 found
3344: => Fetching nvu-1.0-sources.tar.bz2
3345: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3346: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3347: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3348: url2pkg> Running "make extract" ...
3349: => Required installed package digest>=20010302: digest-20060826 found
3350: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3351: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3352: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3353: ===> Installing dependencies for nvu-1.0
3354: ===> Overriding tools for nvu-1.0
3355: ===> Extracting for nvu-1.0
3356: url2pkg> Adjusting the Makefile.
3357:
3358: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3359:
3360: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3361: </pre>
3362: </div>
1.41 asau 3363: <div class="sect3">
1.1 dsieger 3364: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 3365: <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 3366: <p>Now that the package has been extracted, let's see what's inside
3367: it. The package has a <code class="filename">README.txt</code>, but that only
3368: says something about mozilla, so it's probably useless for seeing what
3369: dependencies this package has. But since there is a GNU configure script
3370: in the package, let's hope that it will complain about everything it
3371: needs.</p>
3372: <pre class="programlisting">
3373: <code class="prompt">$</code> bmake
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: ===> Patching for nvu-1.0
3378: ===> Creating toolchain wrappers for nvu-1.0
3379: ===> Configuring for nvu-1.0
3380: [...]
3381: configure: error: Perl 5.004 or higher is required.
3382: [...]
3383: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3384: [...]
3385: </pre>
3386: <p>That worked quite well. So I opened the package Makefile in my
3387: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3388: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3389: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3390: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3391: from scratch.</p>
3392: <pre class="programlisting">
3393: <code class="prompt">$</code> bmake clean
3394: ===> Cleaning for nvu-1.0
3395: <code class="prompt">$</code> bmake
3396: [...]
3397: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3398: GNU Make. You will not be able to build Mozilla without GNU Make.
3399: [...]
3400: </pre>
1.23 wiz 3401: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3402: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3403: <pre class="programlisting">
3404: [...]
3405: checking for GTK - version >= 1.2.0... no
3406: *** Could not run GTK test program, checking why...
3407: [...]
3408: </pre>
3409: <p>Now to the other dependencies. The first question is: Where is the
3410: GTK package hidden in pkgsrc?</p>
3411: <pre class="programlisting">
3412: <code class="prompt">$</code> echo ../../*/gtk*
3413: [many packages ...]
3414: <code class="prompt">$</code> echo ../../*/gtk
3415: ../../x11/gtk
3416: <code class="prompt">$</code> echo ../../*/gtk2
3417: ../../x11/gtk2
3418: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3419: ../../x11/gtk2/buildlink3.mk
3420: </pre>
3421: <p>The first try was definitely too broad. The second one had exactly
3422: one result, which is very good. But there is one pitfall with GNOME
3423: packages. Before GNOME 2 had been released, there were already many
3424: GNOME 1 packages in pkgsrc. To be able to continue to use these
3425: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3426: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3427: whether this was the case here, and indeed it was.</p>
3428: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3429: file, adding the dependency is very easy. I just inserted an
3430: <code class="literal">.include</code> line before the last line of the package
3431: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3432: <pre class="programlisting">
3433: [...]
3434: .include "../../x11/gtk2/buildlink3.mk"
3435: .include "../../mk/bsd.pkg.mk
3436: </pre>
1.10 hubertf 3437: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3438: was:</p>
3439: <pre class="programlisting">
3440: [...]
3441: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3442: checking for GTK - version >= 1.2.0... no
3443: *** Could not run GTK test program, checking why...
3444: *** The test program failed to compile or link. See the file config.log for the
3445: *** exact error that occured. This usually means GTK was incorrectly installed
3446: *** or that you have moved GTK since it was installed. In the latter case, you
3447: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3448: configure: error: Test for GTK failed.
3449: [...]
3450: </pre>
1.23 wiz 3451: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3452: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3453: told me that this package really wanted to have the GNOME 1 version of
3454: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3455: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3456: So I changed the <code class="literal">x11/gtk2</code> to
3457: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3458: and tried again.</p>
3459: <pre class="programlisting">
3460: [...]
1.59 jnemeth 3461: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3462: In file included from xpidl.c:42:
3463: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3464: In file included from xpidl.c:42:
3465: xpidl.h:132: error: parse error before "IDL_ns"
3466: [...]
3467: </pre>
3468: <p>The package still does not find all of its dependencies. Now the
3469: question is: Which package provides the
3470: <code class="filename">libIDL/IDL.h</code> header file?</p>
3471: <pre class="programlisting">
3472: <code class="prompt">$</code> echo ../../*/*idl*
3473: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3474: <code class="prompt">$</code> echo ../../*/*IDL*
3475: ../../net/libIDL
3476: </pre>
3477: <p>Let's take the one from the second try. So I included the
3478: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3479: again. But the error didn't change. After digging through some of the
3480: code, I concluded that the build process of the package was broken and
3481: couldn't have ever worked, but since the Mozilla source tree is quite
3482: large, I didn't want to fix it. So I added the following to the package
3483: <code class="filename">Makefile</code> and tried again:</p>
3484: <pre class="programlisting">
3485: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.139 leot 3486: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.1 dsieger 3487: </pre>
3488: <p>The latter line is needed because the package expects the library
3489: <code class="filename">libIDL.so</code>, but only
3490: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3491: wrapper to rewrite that on the fly.</p>
3492: <p>The next problem was related to a recent change of the FreeType
1.137 leot 3493: 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 3494: which patch files were relevant for this issue and copied them to the
3495: <code class="filename">patches</code> directory. Then I retried, fixed the
3496: patches so that they applied cleanly and retried again. This time,
3497: everything worked.</p>
3498: </div>
1.41 asau 3499: <div class="sect3">
1.1 dsieger 3500: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 3501: <a name="creating.nvu.inst"></a>12.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3502: <pre class="programlisting">
3503: <code class="prompt">$</code> bmake CHECK_FILES=no install
3504: [...]
3505: <code class="prompt">$</code> bmake print-PLIST >PLIST
3506: <code class="prompt">$</code> bmake deinstall
3507: <code class="prompt">$</code> bmake install
3508: </pre>
3509: </div>
3510: </div>
3511: </div>
3512: </div>
1.41 asau 3513: <div class="chapter">
1.1 dsieger 3514: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3515: <a name="components"></a>Chapter 13. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3516: <div class="toc">
3517: <p><b>Table of Contents</b></p>
1.100 leot 3518: <dl class="toc">
1.154 rillig 3519: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
3520: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
3521: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
3522: <dd><dl>
3523: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
3524: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
3525: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
3526: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
3527: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
3528: </dl></dd>
3529: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
3530: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
3531: <dd><dl>
3532: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
3533: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
3534: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3535: </dl></dd>
1.154 rillig 3536: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
3537: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3538: </dl>
3539: </div>
3540: <p>Whenever you're preparing a package, there are a number of
3541: files involved which are described in the following
3542: sections.</p>
1.41 asau 3543: <div class="sect1">
1.1 dsieger 3544: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3545: <a name="components.Makefile"></a>13.1. <code class="filename">Makefile</code>
1.1 dsieger 3546: </h2></div></div></div>
3547: <p>Building, installation and creation of a binary package are all
3548: controlled by the package's <code class="filename">Makefile</code>.
3549: The <code class="filename">Makefile</code> describes various things about
3550: a package, for example from where to get it, how to configure,
3551: build, and install it.</p>
3552: <p>A package <code class="filename">Makefile</code> contains several
3553: sections that describe the package.</p>
3554: <p>In the first section there are the following variables, which
3555: should appear exactly in the order given here. The order and
3556: grouping of the variables is mostly historical and has no further
3557: meaning.</p>
1.41 asau 3558: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3559: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3560: distribution file to be downloaded from the package's
3561: website.</p></li>
1.23 wiz 3562: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 3563: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3564: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 3565: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3566: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3567: directory name together with the version number. It must match the
3568: regular expression
3569: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3570: starts with a letter or digit, and contains only letters, digits,
3571: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3572: <li class="listitem">
1.1 dsieger 3573: <p><code class="varname">CATEGORIES</code> is a list of categories
3574: which the package fits in. You can choose any of the top-level
3575: directories of pkgsrc for it.</p>
3576: <p>Currently the following values are available for
3577: <code class="varname">CATEGORIES</code>. If more than
3578: one is used, they need to be separated by spaces:</p>
3579: <pre class="programlisting">
3580: archivers cross geography meta-pkgs security
3581: audio databases graphics misc shells
3582: benchmarks devel ham multimedia sysutils
3583: biology editors inputmethod net textproc
3584: cad emulators lang news time
3585: chat finance mail parallel wm
3586: comms fonts math pkgtools www
3587: converters games mbone print x11
3588: </pre>
3589: </li>
1.23 wiz 3590: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 3591: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3592: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3593: and <code class="varname">DISTFILES</code> are discussed in detail in
1.154 rillig 3594: <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 3595: </ul></div>
3596: <p>The second section contains information about separately
3597: downloaded patches, if any.
3598: </p>
1.41 asau 3599: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 3600: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 3601: Name(s) of additional files that contain distribution patches.
3602: There is no default. pkgsrc will look for them at
3603: <code class="varname">PATCH_SITES</code>.
3604: They will automatically be uncompressed before patching if
3605: the names end with <code class="filename">.gz</code> or
3606: <code class="filename">.Z</code>.</p></li>
1.23 wiz 3607: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 3608: Primary location(s) for distribution patch files (see
1.80 wiz 3609: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3610: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.157 leot 3611: an argument to <a class="citerefentry" href="http://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 3612: help find the correct files to patch. It defaults to
3613: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 3614: </ul></div>
3615: <p>The third section contains the following variables.
3616: </p>
1.41 asau 3617: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3618: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 3619: address of the person who feels responsible for this package,
3620: and who is most likely to look at problems or questions regarding
1.157 leot 3621: this package which have been reported with <a class="citerefentry" href="http://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 3622: Other developers may contact the <code class="varname">MAINTAINER</code>
3623: before making changes to the package, but are not required to
3624: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3625: to yourself. If you really can't maintain the package for future
3626: updates, set it to
1.10 hubertf 3627: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 3628: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 3629: of <code class="varname">MAINTAINER</code> when you do not want other
3630: developers to update or change the package without contacting
3631: you first. A package Makefile should contain one of
3632: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3633: not both. </p></li>
1.23 wiz 3634: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 3635: find more information about the package.</p></li>
1.23 wiz 3636: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 3637: description of the package (should not include the package
3638: name).</p></li>
1.122 leot 3639: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.154 rillig 3640: 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 3641: </ul></div>
3642: <p>Other variables that affect the build:
3643: </p>
1.41 asau 3644: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 3645: <p><code class="varname">WRKSRC</code>: The directory where the
3646: interesting distribution files of the package are found. The
3647: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3648: works for most packages.</p>
3649: <p>If a package doesn't create a subdirectory for itself
3650: (most GNU software does, for instance), but extracts itself in
3651: the current directory, you should set
3652: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3653: <p>If a package doesn't create a subdirectory with the
3654: name of <code class="varname">DISTNAME</code> but some different name,
3655: set <code class="varname">WRKSRC</code> to point to the proper name in
3656: <code class="filename">${WRKDIR}</code>, for example
3657: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.137 leot 3658: <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 3659: <p>The name of the working directory created by pkgsrc is
3660: taken from the <code class="varname">WRKDIR_BASENAME</code>
3661: variable. By default, its value is
3662: <code class="filename">work</code>. If you want to use the same
3663: pkgsrc tree for building different kinds of binary packages,
3664: you can change the variable according to your needs. Two
3665: other variables handle common cases of setting
3666: <code class="varname">WRKDIR_BASENAME</code> individually. If
3667: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 3668: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 3669: the host's name is attached to the directory name. If
3670: <code class="varname">OBJMACHINE</code> is defined, the platform name
3671: is attached, which might look like
3672: <code class="filename">work.i386</code> or
3673: <code class="filename">work.sparc</code>.</p>
3674: </li></ul></div>
3675: <p>Please pay attention to the following gotchas:</p>
1.41 asau 3676: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3677: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 3678: installed in compressed form by the package. For packages using
3679: BSD-style makefiles which honor MANZ, there is
3680: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 3681: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3682: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 3683: below).</p></li>
1.154 rillig 3684: <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 3685: </ul></div>
3686: </div>
1.41 asau 3687: <div class="sect1">
1.1 dsieger 3688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3689: <a name="components.distinfo"></a>13.2. <code class="filename">distinfo</code>
1.1 dsieger 3690: </h2></div></div></div>
3691: <p>The <code class="filename">distinfo</code> file contains the message
3692: digest, or checksum, of each distfile needed for the package. This
3693: ensures that the distfiles retrieved from the Internet have not been
3694: corrupted during transfer or altered by a malign force to introduce
1.108 rillig 3695: a security hole. To provide maximum security, all distfiles are
3696: protected using three different message digest algorithms (SHA1,
3697: RMD160, SHA512), as well as the file size.</p>
1.1 dsieger 3698: <p>The <code class="filename">distinfo</code> file also contains the
3699: checksums for all the patches found in the
1.154 rillig 3700: <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 3701: are only applied intentionally and that they don't accidentally change,
3702: e.g. when merging different changes together. They also make sure that
3703: new patches are actually added to CVS and old ones are removed.
3704: Too see whether the patches and the <code class="filename">distinfo</code> file
3705: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
1.1 dsieger 3706: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108 rillig 3707: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1 dsieger 3708: <p>Some packages have different sets of distfiles depending on
1.137 leot 3709: 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 3710: <code class="filename">distinfo</code> file and care should be taken when
3711: upgrading such a package to ensure distfile information is not
3712: lost.</p>
3713: </div>
1.41 asau 3714: <div class="sect1">
1.1 dsieger 3715: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3716: <a name="components.patches"></a>13.3. <code class="filename">patches/*</code>
1.108 rillig 3717: </h2></div></div></div>
3718: <p>Some packages don't work out-of-the box on the various
3719: platforms that are supported by pkgsrc. These packages need
3720: to be patched to make them work. The patch files can be
1.1 dsieger 3721: found in the <code class="filename">patches/</code> directory.</p>
3722: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3723: applied to the files in <code class="varname">WRKSRC</code> directory after
1.108 rillig 3724: extracting them, in alphabetic order.</p>
1.41 asau 3725: <div class="sect2">
1.1 dsieger 3726: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3727: <a name="components.patch.structure"></a>13.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 3728: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 3729: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 3730: problems. (To force patches to apply with fuzz you can set
3731: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3732: should contain only changes for a single file, and no file should be
3733: patched by more than one patch file. This helps to keep future
3734: modifications simple.</p>
3735: <p>Each patch file is structured as follows: In the first line,
3736: there is the RCS Id of the patch itself. The second line should be
3737: empty for aesthetic reasons. After that, there should be a comment for
3738: each change that the patch does. There are a number of standard
3739: cases:</p>
1.41 asau 3740: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3741: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 3742: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 3743: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 3744: platform and other environment (for example, the compiler) that the
3745: patch is needed for.</p></li>
3746: </ul></div>
1.108 rillig 3747: <p>The patch should be commented so that any
1.1 dsieger 3748: developer who knows the code of the application can make some use of
3749: the patch. Special care should be taken for the upstream developers,
3750: since we generally want that they accept our patches, so we have less
3751: work in the future.</p>
3752: </div>
1.41 asau 3753: <div class="sect2">
1.1 dsieger 3754: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3755: <a name="components.patches.caveats"></a>13.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 3756: <p>One important thing to mention is to pay attention that no RCS
3757: IDs get stored in the patch files, as these will cause problems when
3758: later checked into the NetBSD CVS tree. Use the
1.137 leot 3759: <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 3760: problems.</p>
3761: <p>For even more automation, we recommend using
1.10 hubertf 3762: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 3763: whole set of patches. You just have to backup files before you
3764: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 3765: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3766: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 3767: you upgrade a package this way, you can easily compare the new
3768: set of patches with the previously existing one with
1.24 wiz 3769: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3770: are replaced by new files, so carefully check if you want to take all
3771: the changes.</p>
1.1 dsieger 3772: <p>When you have finished a package, remember to generate
1.10 hubertf 3773: the checksums for the patch files by using the <span class="command"><strong>make
1.154 rillig 3774: 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 3775: <p>When adding a patch that corrects a problem in the
3776: distfile (rather than e.g. enforcing pkgsrc's view of where
3777: man pages should go), send the patch as a bug report to the
3778: maintainer. This benefits non-pkgsrc users of the package,
3779: and usually makes it possible to remove the patch in future
3780: version.</p>
1.2 rillig 3781: <p>The file names of the patch files are usually of the form
1.24 wiz 3782: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3783: Many packages still use the previous convention
3784: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3785: but new patches should be of the form containing the filename.
1.137 leot 3786: <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 3787: automatically.</p>
1.1 dsieger 3788: </div>
1.41 asau 3789: <div class="sect2">
1.1 dsieger 3790: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3791: <a name="components.patches.sources"></a>13.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 3792: <p>If you want to share patches between multiple packages
3793: in pkgsrc, e.g. because they use the same distfiles, set
3794: <code class="varname">PATCHDIR</code> to the path where the patch files
3795: can be found, e.g.:</p>
3796: <pre class="programlisting">
1.159 rillig 3797: PATCHDIR= ../../editors/xemacs/patches
1.1 dsieger 3798: </pre>
3799: <p>Patch files that are distributed by the author or other
3800: maintainers can be listed in
3801: <code class="varname">PATCHFILES</code>.</p>
3802: <p>If it is desired to store any patches that should not be
3803: committed into pkgsrc, they can be kept outside the pkgsrc
3804: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3805: directory tree there is expected to have the same
1.23 wiz 3806: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 3807: patches are expected to be stored inside these dirs (also
3808: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3809: example, if you want to keep a private patch for
3810: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3811: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3812: files in the named directory are expected to be patch files,
3813: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3814: applied</em></span>.</p>
3815: </div>
1.41 asau 3816: <div class="sect2">
1.1 dsieger 3817: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3818: <a name="components.patches.guidelines"></a>13.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 3819: <p>When fixing a portability issue in the code do not use
3820: preprocessor magic to check for the current operating system nor
3821: platform. Doing so hurts portability to other platforms because
3822: the OS-specific details are not abstracted appropriately.</p>
3823: <p>The general rule to follow is: instead of checking for the
3824: operating system the application is being built on, check for the
3825: specific <span class="emphasis"><em>features</em></span> you need. For example,
3826: instead of assuming that kqueue is available under NetBSD and
3827: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 3828: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 3829: yes, this generally involves patching the
1.10 hubertf 3830: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 3831: that prevents some OSes from adopting interfaces from other OSes
3832: (e.g. Linux implementing kqueue), something that the above checks
3833: cannot take into account.</p>
3834: <p>Of course, checking for features generally involves more
3835: work on the developer's side, but the resulting changes are
3836: cleaner and there are chances they will work on many other
3837: platforms. Not to mention that there are higher chances of being
3838: later integrated into the mainstream sources. Remember:
3839: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3840: <p>Some typical examples:</p>
3841: <div class="table">
1.154 rillig 3842: <a name="patch-examples"></a><p class="title"><b>Table 13.1. Patching examples</b></p>
1.106 tnn 3843: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1 dsieger 3844: <colgroup>
3845: <col>
3846: <col>
3847: <col>
3848: </colgroup>
3849: <thead><tr>
3850: <th>Where</th>
3851: <th>Incorrect</th>
3852: <th>Correct</th>
3853: </tr></thead>
3854: <tbody>
3855: <tr>
3856: <td>configure script</td>
3857: <td>
3858: <pre class="programlisting">
3859: case ${target_os} in
3860: netbsd*) have_kvm=yes ;;
3861: *) have_kvm=no ;;
3862: esac
3863: </pre>
3864: </td>
3865: <td>
3866: <pre class="programlisting">
3867: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
3868: </pre>
3869: </td>
3870: </tr>
3871: <tr>
3872: <td>C source file</td>
3873: <td>
3874: <pre class="programlisting">
3875: #if defined(__NetBSD__)
3876: # include <sys/event.h>
3877: #endif
3878: </pre>
3879: </td>
3880: <td>
3881: <pre class="programlisting">
3882: #if defined(HAVE_SYS_EVENT_H)
3883: # include <sys/event.h>
3884: #endif
3885: </pre>
3886: </td>
3887: </tr>
3888: <tr>
3889: <td>C source file</td>
3890: <td>
3891: <pre class="programlisting">
3892: int
3893: monitor_file(...)
3894: {
3895: #if defined(__NetBSD__)
3896: int fd = kqueue();
3897: ...
3898: #else
3899: ...
3900: #endif
3901: }
3902: </pre>
3903: </td>
3904: <td>
3905: <pre class="programlisting">
3906: int
3907: monitor_file(...)
3908: {
3909: #if defined(HAVE_KQUEUE)
3910: int fd = kqueue();
3911: ...
3912: #else
1.112 rillig 3913: ...
1.1 dsieger 3914: #endif
3915: }
3916: </pre>
3917: </td>
3918: </tr>
3919: </tbody>
3920: </table></div>
3921: </div>
1.141 maya 3922: <br class="table-break">
1.1 dsieger 3923: </div>
1.41 asau 3924: <div class="sect2">
1.1 dsieger 3925: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3926: <a name="components.patches.feedback"></a>13.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 3927: <p>Always, always, <span class="strong"><strong>always</strong></span>
3928: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3929: improvements you do to a package to the mainstream developers.
3930: This is the only way to get their attention on portability issues
3931: and to ensure that future versions can be built out-of-the box on
3932: NetBSD. Furthermore, any user that gets newer distfiles will get
3933: the fixes straight from the packaged code.</p>
3934: <p>This generally involves cleaning up the patches
3935: (because sometimes the patches that are
1.40 wiz 3936: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 3937: appropriate trackers for the projects and working with the
3938: mainstream authors to accept your changes. It is
3939: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3940: the packages in pkgsrc are kept simple and thus further changes
3941: can be done without much hassle.</p>
1.24 wiz 3942: <p>When you have done this, please add a URL to the upstream
3943: bug report to the patch comment.</p>
1.1 dsieger 3944: <p>Support the idea of free software!</p>
3945: </div>
3946: </div>
1.41 asau 3947: <div class="sect1">
1.1 dsieger 3948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3949: <a name="other-mandatory-files"></a>13.4. Other mandatory files</h2></div></div></div>
1.41 asau 3950: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3951: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3952: <dd><p>A multi-line description of the piece of software. This should include
3953: any credits where they are due. Please bear in mind that others do not
3954: share your sense of humour (or spelling idiosyncrasies), and that others
3955: will read everything that you write here.</p></dd>
3956: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3957: <dd><p>This file governs the files that are installed on your
3958: system: all the binaries, manual pages, etc. There are other
3959: directives which may be entered in this file, to control the
3960: creation and deletion of directories, and the location of
1.154 rillig 3961: 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 3962: information.</p></dd>
3963: </dl></div>
3964: </div>
1.41 asau 3965: <div class="sect1">
1.1 dsieger 3966: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3967: <a name="components.optional"></a>13.5. Optional files</h2></div></div></div>
1.41 asau 3968: <div class="sect2">
1.1 dsieger 3969: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3970: <a name="components.optional.bin"></a>13.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 3971: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3972: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 3973: <dd>
1.157 leot 3974: <p>This shell script is invoked twice by <a class="citerefentry" href="http://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 3975: First time after package extraction and before files are
3976: moved in place, the second time after the files to install
3977: are moved in place. This can be used to do any custom
3978: procedures not possible with @exec commands in
1.157 leot 3979: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://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
3980: <a class="citerefentry" href="http://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 3981: Please note that you can modify variables in it easily by using
3982: <code class="varname">FILES_SUBST</code> in the package's
3983: <code class="filename">Makefile</code>:</p>
3984: <pre class="programlisting">
3985: FILES_SUBST+= SOMEVAR="somevalue"
3986: </pre>
3987: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3988: <code class="filename">INSTALL</code>. By default, substitution is
3989: performed for <code class="varname">PREFIX</code>,
3990: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3991: <code class="varname">VARBASE</code>, and a few others, type
3992: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3993: complete list.</p>
3994: </dd>
1.1 dsieger 3995: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3996: <dd><p>This script is executed before and after any files are removed. It is
3997: this script's responsibility to clean up any additional messy details
3998: around the package's installation, since all pkg_delete knows is how to
3999: delete the files created in the original distribution.
1.157 leot 4000: See <a class="citerefentry" href="http://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>
4001: and <a class="citerefentry" href="http://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 4002: The same methods to replace variables can be used as for
4003: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 4004: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4005: <dd>
4006: <p>This file is displayed after installation of the package.
4007: Useful for things like legal notices on almost-free
4008: software and hints for updating config files after
4009: installing modules for apache, PHP etc.
4010: Please note that you can modify variables in it easily by using
4011: <code class="varname">MESSAGE_SUBST</code> in the package's
4012: <code class="filename">Makefile</code>:</p>
4013: <pre class="programlisting">
4014: MESSAGE_SUBST+= SOMEVAR="somevalue"
4015: </pre>
1.23 wiz 4016: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 4017: <code class="filename">MESSAGE</code>. By default, substitution is
4018: performed for <code class="varname">PKGNAME</code>,
4019: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99 sevan 4020: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 4021: <code class="varname">PKG_SYSCONFDIR</code>,
4022: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 4023: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 4024: <p>You can display a different or additional files by
4025: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4026: default is <code class="filename">MESSAGE</code>, if the file
4027: exists.</p>
4028: </dd>
4029: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 4030: <dd>
4031: <p>This file is used by the alternatives framework.
4032: It creates, configures, and destroys generic wrappers used to
4033: run programs with similar interfaces.
4034: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4035: for more information.</p>
4036: <p>Each line of the file contains two filenames, first
4037: the wrapper and then the alternative provided by the package.
4038: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4039: </dd>
1.1 dsieger 4040: </dl></div>
4041: </div>
1.41 asau 4042: <div class="sect2">
1.1 dsieger 4043: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4044: <a name="components.optional.build"></a>13.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 4045: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4046: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4047: <dd><p>This file contains arbitrary things that could
4048: also go into a <code class="filename">Makefile</code>, but its purpose is
4049: to be used by more than one package. This file should only be
4050: used when the packages that will use the file are known in
4051: advance. For other purposes it is often better to write a
4052: <code class="filename">*.mk</code> file and give it a good name that
4053: describes what it does.</p></dd>
4054: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4055: <dd><p>This file contains the dependency information
1.154 rillig 4056: 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 4057: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4058: <dd><p>This file contains workarounds for compiler bugs
4059: and similar things. It is included automatically by the pkgsrc
4060: infrastructure, so you don't need an extra
4061: <code class="literal">.include</code> line for
4062: it.</p></dd>
4063: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4064: <dd><p>This file contains the code for the
1.154 rillig 4065: 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 4066: selected by the user. If a package has only one or two options,
4067: it is equally acceptable to put the code directly into the
4068: <code class="filename">Makefile</code>.</p></dd>
4069: </dl></div>
4070: </div>
1.41 asau 4071: <div class="sect2">
1.1 dsieger 4072: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4073: <a name="components.optional.none"></a>13.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 4074: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4075: <dt><span class="term"><code class="filename">README*</code></span></dt>
4076: <dd><p>These files do not take place in the creation of
4077: a package and thus are purely informative to the package
4078: developer.</p></dd>
4079: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4080: <dd><p>This file contains things that need to be done
4081: to make the package even
4082: better.</p></dd>
4083: </dl></div>
4084: </div>
4085: </div>
1.41 asau 4086: <div class="sect1">
1.1 dsieger 4087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4088: <a name="work-dir"></a>13.6. <code class="filename">work*</code>
1.1 dsieger 4089: </h2></div></div></div>
1.10 hubertf 4090: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 4091: unpacked into the directory denoted by
4092: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 4093: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 4094: directory is also used to keep various timestamp files.
4095: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4096: The default is <code class="filename">${.CURDIR}/work</code>
4097: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4098: if <code class="varname">OBJMACHINE</code> is set.</p>
4099: </div>
1.41 asau 4100: <div class="sect1">
1.1 dsieger 4101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4102: <a name="files-dir"></a>13.7. <code class="filename">files/*</code>
1.1 dsieger 4103: </h2></div></div></div>
4104: <p>If you have any files that you wish to be placed in the package prior
4105: to configuration or building, you could place these files here and use
1.10 hubertf 4106: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 4107: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 4108: this. Alternatively, you could simply diff the file against
4109: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4110: the creation of this file.</p>
4111: <p>If you want to share files in this way with other
4112: packages, set the <code class="varname">FILESDIR</code> variable to point
4113: to the other package's <code class="filename">files</code> directory,
4114: e.g.:</p>
4115: <pre class="programlisting">
1.159 rillig 4116: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 4117: </pre>
4118: </div>
4119: </div>
1.41 asau 4120: <div class="chapter">
1.1 dsieger 4121: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 4122: <a name="makefile"></a>Chapter 14. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4123: <div class="toc">
4124: <p><b>Table of Contents</b></p>
1.100 leot 4125: <dl class="toc">
1.154 rillig 4126: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
4127: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
4128: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
4129: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
4130: <dd><dl>
4131: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
4132: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
4133: <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>
4134: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 4135: </dl></dd>
4136: </dl>
4137: </div>
4138: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4139: each of which forms a well-defined part of the pkgsrc system. Using
1.157 leot 4140: the <a class="citerefentry" href="http://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 4141: like pkgsrc requires some discipline to keep the code correct and
4142: understandable.</p>
4143: <p>The basic ingredients for <code class="filename">Makefile</code>
1.154 rillig 4144: programming are variables and shell
1.1 dsieger 4145: commands. Among these shell commands may even be more complex ones
1.157 leot 4146: like <a class="citerefentry" href="http://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 4147: as intended it is necessary to quote all variables correctly when they
4148: are used.</p>
1.154 rillig 4149: <p>This chapter describes some patterns that appear quite often in
1.1 dsieger 4150: <code class="filename">Makefile</code>s, including the pitfalls that come along
4151: with them.</p>
1.41 asau 4152: <div class="sect1">
1.1 dsieger 4153: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4154: <a name="makefile.style"></a>14.1. Caveats</h2></div></div></div>
1.41 asau 4155: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4156: <p>When you are creating a file as a
4157: target of a rule, always write the data to a temporary file first
4158: and finally rename that file. Otherwise there might occur an error
4159: in the middle of generating the file, and when the user runs
1.157 leot 4160: <a class="citerefentry" href="http://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 4161: regenerated properly. Example:</p>
4162: <pre class="programlisting">
4163: wrong:
4164: @echo "line 1" > ${.TARGET}
4165: @echo "line 2" >> ${.TARGET}
4166: @false
4167:
4168: correct:
4169: @echo "line 1" > ${.TARGET}.tmp
4170: @echo "line 2" >> ${.TARGET}.tmp
4171: @false
4172: @mv ${.TARGET}.tmp ${.TARGET}
4173: </pre>
1.10 hubertf 4174: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4175: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4176: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4177: correct</strong></span> gives an error message twice, as expected.</p>
1.157 leot 4178: <p>You might remember that <a class="citerefentry" href="http://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 4179: <code class="literal">${.TARGET}</code> in case of error, but this only
4180: happens when it is interrupted, for example by pressing
1.154 rillig 4181: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.157 leot 4182: when one of the commands fails (like <a class="citerefentry" href="http://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 4183: </li></ul></div>
4184: </div>
1.41 asau 4185: <div class="sect1">
1.1 dsieger 4186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4187: <a name="makefile.variables"></a>14.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4188: <p><code class="filename">Makefile</code> variables contain strings that
1.154 rillig 4189: can be processed using the five operators <code class="code">=</code>,
4190: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.157 leot 4191: <code class="code">!=</code>, which are described in the <a class="citerefentry" href="http://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 4192: page.</p>
4193: <p>When a variable's value is parsed from a
1.154 rillig 4194: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
4195: the backslash character <code class="code">\</code> are handled specially. If a
4196: backslash is the last character in a line, that backslash is removed
4197: from the line and the line continues with the next line of the file.</p>
4198: <p>The <code class="code">#</code> character starts a comment that reaches
4199: until the end of the line. To get an actual <code class="code">#</code> character,
4200: such as in a URL, write <code class="code">\#</code> instead.</p>
1.108 rillig 4201: <p>The evaluation of variables either happens immediately or lazy.
1.154 rillig 4202: It happens immediately when the variable occurs on the right-hand
4203: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
1.108 rillig 4204: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4205: In the other cases, it is evaluated lazily.</p>
1.1 dsieger 4206: <p>Some of the modifiers split the string into words and then
1.154 rillig 4207: operate on the words, others operate on the string as a whole. When a
4208: string is split into words, double quotes and single quotes are
1.157 leot 4209: interpreted as delimiters, just like in <a class="citerefentry" href="http://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 4210: <div class="sect2">
1.1 dsieger 4211: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4212: <a name="makefile.variables.names"></a>14.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4213: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4214: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4215: are reserved for use by the pkgsrc infrastructure. They shall
1.154 rillig 4216: not be used by packages.</p></li>
1.23 wiz 4217: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4218: lowercase variable names for the iteration
4219: variables.</p></li>
1.154 rillig 4220: <li class="listitem"><p>All list variables should have a plural name,
4221: such as <code class="varname">PKG_OPTIONS</code> or
1.1 dsieger 4222: <code class="varname">DISTFILES</code>.</p></li>
4223: </ul></div>
4224: </div>
4225: </div>
1.41 asau 4226: <div class="sect1">
1.1 dsieger 4227: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4228: <a name="makefile.code"></a>14.3. Code snippets</h2></div></div></div>
1.41 asau 4229: <div class="sect2">
1.1 dsieger 4230: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4231: <a name="adding-to-list"></a>14.3.1. Adding things to a list</h3></div></div></div>
1.108 rillig 4232: <p>When adding a string that possibly contains whitespace or quotes to
4233: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4234: modifier.</p>
4235: <p>When adding another list to a list (example 2), it must not be
4236: quoted, since its elements are already quoted.</p>
1.1 dsieger 4237: <pre class="programlisting">
1.108 rillig 4238: STRING= foo * bar `date`
4239: LIST= # empty
4240: ANOTHER_LIST= a=b c=d
4241:
4242: LIST+= ${STRING:Q} # 1
4243: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4244: </pre>
4245: </div>
1.41 asau 4246: <div class="sect2">
1.1 dsieger 4247: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4248: <a name="echo-literal"></a>14.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.108 rillig 4249: <p>Echoing a string containing special characters needs special
4250: work.</p>
1.1 dsieger 4251: <pre class="programlisting">
4252: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 4253: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4254:
4255: all:
4256: echo ${STRING} # 1
1.108 rillig 4257: echo ${STRING:Q} # 2
4258: printf '%s\n' ${STRING:Q}'' # 3
4259: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
4260: </pre>
4261: <p>Example 1 leads to a syntax error in the shell, as the characters
4262: are just copied.</p>
4263: <p>Example 2 quotes the string so that the shell interprets it
4264: correctly. But the echo command may additionally interpret strings with a
4265: leading dash or those containing backslashes.</p>
1.157 leot 4266: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="http://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 4267: interprets the format string, but not the next argument. The trailing
4268: single quotes handle the case when the string is empty. In that case, the
4269: :Q modifier would result in an empty string too, which would then be
1.157 leot 4270: skipped by the shell. For <a class="citerefentry" href="http://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 4271: but other programs may care.</p>
1.108 rillig 4272: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4273: need to be quoted because the quoting has already been done
4274: when adding elements to the list.</p>
1.1 dsieger 4275: </div>
1.41 asau 4276: <div class="sect2">
1.1 dsieger 4277: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4278: <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 4279: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4280: GNU-style configure script (especially those that call other configure
4281: scripts), it must not have leading or trailing whitespace, since
4282: otherwise the configure script gets confused. To trim leading and
4283: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4284: following example:</p>
1.1 dsieger 4285: <pre class="programlisting">
4286: CPPFLAGS= # empty
1.108 rillig 4287: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.1 dsieger 4288: CPPFLAGS+= ${MY_CPPFLAGS}
4289:
4290: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4291:
4292: all:
4293: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.108 rillig 4294: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4295: </pre>
1.108 rillig 4296: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4297: trailing whitespace because the <code class="code">+=</code> operator always adds a
4298: space.</p>
4299: </div>
4300: <div class="sect2">
4301: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4302: <a name="empty-variables"></a>14.3.4. Handling possibly empty variables</h3></div></div></div>
1.108 rillig 4303: <p>When a possibly empty variable is used in a shell program, it may
4304: lead to a syntax error.</p>
4305: <pre class="programlisting">
4306: EGFILES= # empty
4307:
4308: install-examples: # produces a syntax error in the shell
4309: for egfile in ${EGFILES}; do \
4310: echo "Installing $$egfile"; \
4311: done
4312: </pre>
4313: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.157 leot 4314: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="http://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 4315: To fix this syntax error, use one of the snippets below.</p>
4316: <pre class="programlisting">
4317: EMPTY= # empty
4318:
4319: install-examples:
4320: for egfile in ${EGFILES} ""; do \
4321: [ -n "$$egfile" ] || continue; \
4322: echo "Installing $$egfile"; \
1.1 dsieger 4323: done
1.108 rillig 4324: </pre>
4325: <p>In this case, an empty string is appended to the iteration list (to
4326: prevent the syntax error) and filtered out later.</p>
4327: <pre class="programlisting">
4328: EGFILES= # empty
1.1 dsieger 4329:
1.108 rillig 4330: install-examples:
4331: .for egfile in ${EGFILES}
4332: echo "Installing ${egfile}"
1.1 dsieger 4333: .endfor
4334: </pre>
1.154 rillig 4335: <p>If one of the filenames contains special characters, it should be
4336: enclosed in single or double quotes.</p>
1.108 rillig 4337: <p>To have a shell command test whether a make variable is empty, use
4338: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1 dsieger 4339: </div>
4340: </div>
4341: </div>
1.41 asau 4342: <div class="chapter">
1.1 dsieger 4343: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 4344: <a name="plist"></a>Chapter 15. PLIST issues</h2></div></div></div>
1.1 dsieger 4345: <div class="toc">
4346: <p><b>Table of Contents</b></p>
1.100 leot 4347: <dl class="toc">
1.154 rillig 4348: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
4349: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4350: <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>
4351: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
4352: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
4353: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
4354: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
4355: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
4356: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4357: </dl>
4358: </div>
4359: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4360: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4361: the package (relative to the <code class="filename">${PREFIX}</code>
4362: directory it's been installed in) plus some additional statements
1.157 leot 4363: - see the <a class="citerefentry" href="http://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 4364: This chapter addresses some issues that need attention when
4365: dealing with the <code class="filename">PLIST</code> file (or files, see
4366: below!).</p>
1.41 asau 4367: <div class="sect1">
1.1 dsieger 4368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4369: <a name="rcs-id"></a>15.1. RCS ID</h2></div></div></div>
1.1 dsieger 4370: <p>Be sure to add a RCS ID line as the first thing in any
4371: <code class="filename">PLIST</code> file you write:</p>
4372: <pre class="programlisting">
1.121 sevan 4373: @comment $NetBSD $
1.111 sevan 4374: </pre>
1.123 wiz 4375: <p>An artificial space has been added between NetBSD and $, this is a
1.121 sevan 4376: workaround here to prevent CVS expanding to the filename of the guide. When
1.125 leot 4377: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 4378: </div>
1.41 asau 4379: <div class="sect1">
1.1 dsieger 4380: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4381: <a name="automatic-plist-generation"></a>15.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4382: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4383: to output a PLIST that matches any new files since the package
1.154 rillig 4384: 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 4385: more information on this target.</p>
4386: </div>
1.41 asau 4387: <div class="sect1">
1.1 dsieger 4388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4389: <a name="print-PLIST"></a>15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4390: </h2></div></div></div>
4391: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4392: of AWK patterns and actions that are used to filter the output of
4393: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4394: scripting you like to it, but be careful with quoting.</p>
4395: <p>For example, to get all files inside the
4396: <code class="filename">libdata/foo</code> directory removed from the
4397: resulting PLIST:</p>
4398: <pre class="programlisting">
4399: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.111 sevan 4400: </pre>
1.1 dsieger 4401: </div>
1.41 asau 4402: <div class="sect1">
1.1 dsieger 4403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4404: <a name="plist.misc"></a>15.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4405: <p>A number of variables are substituted automatically in
4406: PLISTs when a package is installed on a system. This includes the
4407: following variables:</p>
1.41 asau 4408: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4409: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4410: <dd>
4411: <p>Some packages like emacs and perl embed information
4412: about which architecture they were built on into the
4413: pathnames where they install their files. To handle this
4414: case, PLIST will be preprocessed before actually used, and
4415: the symbol
1.23 wiz 4416: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4417: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4418: same is done if the string
4419: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4420: PLIST somewhere - use this on packages that have GNU
4421: autoconf-created configure scripts.</p>
1.41 asau 4422: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4423: <h3 class="title">Legacy note</h3>
4424: <p>There used to be a symbol
1.23 wiz 4425: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4426: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4427: -m</strong></span>, but that's no longer supported and has
4428: been removed.</p>
4429: </div>
4430: </dd>
4431: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4432: <dd>
4433: <p>Some packages want to embed the OS name and version
4434: into some paths. To do this, use these variables in the
4435: <code class="filename">PLIST</code>:
4436: </p>
1.41 asau 4437: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4438: <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>
4439: <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>
4440: <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 4441: </ul></div>
4442: </dd>
4443: </dl></div>
1.88 tnn 4444: <p>For a list of values which are replaced by
4445: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4446: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4447: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4448: <p>If you want to change other variables not listed above, you
4449: can add variables and their expansions to this variable in the
1.154 rillig 4450: 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 4451: <pre class="programlisting">
4452: PLIST_SUBST+= SOMEVAR="somevalue"
1.111 sevan 4453: </pre>
1.23 wiz 4454: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4455: in the <code class="filename">PLIST</code> with
1.23 wiz 4456: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4457: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4458: the common case of conditionally including some
4459: <code class="filename">PLIST</code> entries. It can be done by adding
4460: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4461: setting the corresponding <code class="varname">PLIST.foo</code> variable
4462: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4463: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4464: in the <code class="filename">PLIST</code> with either
1.23 wiz 4465: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4466: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 4467: For example, in <code class="filename">Makefile</code>:</p>
4468: <pre class="programlisting">
1.112 rillig 4469: PLIST_VARS+= foo
1.18 snj 4470: .if <em class="replaceable"><code>condition</code></em>
1.112 rillig 4471: PLIST.foo= yes
1.18 snj 4472: .else
1.111 sevan 4473: </pre>
1.18 snj 4474: <p>And then in <code class="filename">PLIST</code>:</p>
4475: <pre class="programlisting">
1.121 sevan 4476: @comment $NetBSD $
1.18 snj 4477: bin/bar
4478: man/man1/bar.1
4479: ${PLIST.foo}bin/foo
4480: ${PLIST.foo}man/man1/foo.1
4481: ${PLIST.foo}share/bar/foo.data
1.111 sevan 4482: </pre>
1.123 wiz 4483: <p>An artificial space has been added between NetBSD and $, this is a
1.121 sevan 4484: workaround here to prevent CVS expanding to the filename of the guide. When
4485: adding the RCS ID the space should be ommited.</p>
1.1 dsieger 4486: </div>
1.41 asau 4487: <div class="sect1">
1.1 dsieger 4488: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4489: <a name="manpage-compression"></a>15.5. Man page compression</h2></div></div></div>
1.1 dsieger 4490: <p>Man pages should be installed in compressed form if
4491: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4492: and uncompressed otherwise. To handle this in the
1.23 wiz 4493: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 4494: appended/removed automatically for man pages according to
4495: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4496: or not, see above for details. This modification of the
4497: <code class="filename">PLIST</code> file is done on a copy of it, not
4498: <code class="filename">PLIST</code> itself.</p>
4499: </div>
1.41 asau 4500: <div class="sect1">
1.1 dsieger 4501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4502: <a name="using-PLIST_SRC"></a>15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 4503: </h2></div></div></div>
4504: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
4505: in generating the binary package, set the variable
4506: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.157 leot 4507: The files are later concatenated using <a class="citerefentry" href="http://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 4508: important. The default for <code class="varname">PLIST_SRC</code> is
4509: <code class="filename">${PKGDIR}/PLIST</code>.</p>
4510: </div>
1.41 asau 4511: <div class="sect1">
1.1 dsieger 4512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4513: <a name="platform-specific-plist"></a>15.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 4514: <p>Some packages decide to install a different set of files based on
4515: the operating system being used. These differences can be
4516: automatically handled by using the following files:</p>
1.41 asau 4517: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4518: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4519: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4520: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4521: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4522: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 4523: </ul></div>
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="build-plist"></a>15.8. Build-specific PLISTs</h2></div></div></div>
1.86 wiz 4528: <p>Some packages decide to generate hard-to-guess file names
4529: during installation that are hard to wire down.</p>
4530: <p>In such cases, you can set the
4531: <code class="varname">GENERATE_PLIST</code> variable to shell code
4532: terminated (with a semicolon) that will output PLIST entries which
4533: will be appended to the PLIST</p>
4534: <p>You can find one example in editors/xemacs:</p>
4535: <pre class="programlisting">
1.111 sevan 4536: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4537: </pre>
1.86 wiz 4538: <p>which will append something like
4539: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4540: <code class="filename">PLIST</code>.
4541: </p>
4542: </div>
4543: <div class="sect1">
4544: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4545: <a name="faq.common-dirs"></a>15.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 4546: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 4547: multiple (and unrelated) packages install files. These
1.22 jakllsch 4548: directories were problematic because you had to add special
4549: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 4550: centralized package handle them.</p>
1.22 jakllsch 4551: <p>In pkgsrc, it is now easy: Each package should create
4552: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4553: will remove any directories left empty after uninstalling a
4554: package.</p>
4555: <p>If a package needs an empty directory to work, create
4556: the directory during installation as usual, and also add an
4557: entry to the PLIST:
1.111 sevan 4558:
4559: </p>
1.1 dsieger 4560: <pre class="programlisting">
1.22 jakllsch 4561: @pkgdir path/to/empty/directory
1.111 sevan 4562: </pre>
1.22 jakllsch 4563: <p>
1.111 sevan 4564:
1.86 wiz 4565: or take a look at <code class="varname">MAKE_DIRS</code> and
4566: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 4567: </p>
1.1 dsieger 4568: </div>
4569: </div>
1.41 asau 4570: <div class="chapter">
1.1 dsieger 4571: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 4572: <a name="buildlink"></a>Chapter 16. Buildlink methodology</h2></div></div></div>
1.1 dsieger 4573: <div class="toc">
4574: <p><b>Table of Contents</b></p>
1.100 leot 4575: <dl class="toc">
1.154 rillig 4576: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
4577: <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 4578: <dd><dl>
1.154 rillig 4579: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
4580: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26 wiz 4581: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4582: and
4583: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4584: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4585: </dl></dd>
1.154 rillig 4586: <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 4587: <dd><dl>
1.154 rillig 4588: <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>
4589: <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 4590: </dl></dd>
4591: </dl>
4592: </div>
4593: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
4594: are seen by a package's configure and build processes. This is implemented
4595: in a two step process:</p>
1.23 wiz 4596: <div class="orderedlist"><ol class="orderedlist" type="1">
4597: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 4598: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4599: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 4600: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 4601: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4602: <code class="option">-L${LOCALBASE}/lib</code> into references to
4603: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4604: native compiler on some operating systems look like GCC, so that
4605: packages that expect GCC won't require modifications to build with
4606: those native compilers.</p></li>
4607: </ol></div>
4608: <p>This normalizes the environment in which a package is built so that the
4609: package may be built consistently despite what other software may be
4610: installed. Please note that the normal system header and library paths,
4611: e.g. <code class="filename">/usr/include</code>,
4612: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4613: designed to insulate the package build from non-system-supplied
4614: software.</p>
1.41 asau 4615: <div class="sect1">
1.1 dsieger 4616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4617: <a name="converting-to-buildlink3"></a>16.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 4618: <p>The process of converting packages to use the buildlink3
1.23 wiz 4619: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 4620: The things to keep in mind are:</p>
1.23 wiz 4621: <div class="orderedlist"><ol class="orderedlist" type="1">
4622: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 4623: instead of the actual toolchain. Some packages are tricky,
4624: and the only way to know for sure is the check
4625: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4626: wrappers are being invoked.</p></li>
1.23 wiz 4627: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 4628: the package Makefile, e.g. Java VMs, standalone shells,
4629: etc., because the code to symlink files into
4630: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 4631: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 4632: </p></li>
1.23 wiz 4633: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 4634: <code class="filename">buildlink3.mk</code> files that you list in a
4635: package's Makefile are added as dependencies for that package.
4636: </p></li>
4637: </ol></div>
4638: <p>If a dependency on a particular package is required for its libraries and
4639: headers, then we replace:</p>
4640: <pre class="programlisting">
4641: DEPENDS+= foo>=1.1.0:../../category/foo
4642: </pre>
4643: <p>with</p>
4644: <pre class="programlisting">
4645: .include "../../category/foo/buildlink3.mk"
4646: </pre>
4647: <p>The buildlink3.mk files usually define the required dependencies.
4648: If you need a newer version of the dependency when using buildlink3.mk
4649: files, then you can define it in your Makefile; for example:</p>
4650: <pre class="programlisting">
4651: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4652: .include "../../category/foo/buildlink3.mk"
4653: </pre>
4654: <p>There are several <code class="filename">buildlink3.mk</code>
4655: files in <code class="filename">pkgsrc/mk</code>
4656: that handle special package issues:</p>
1.41 asau 4657: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4658: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 4659: the native or a pkgsrc Berkeley DB implementation based on
4660: the values of <code class="varname">BDB_ACCEPTED</code> and
4661: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 4662: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 4663: comes with neither Curses nor NCurses, this will take care
1.137 leot 4664: 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 4665: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 4666: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4667: adding a dependency on Heimdal or MIT-krb5 for packages that
4668: require a Kerberos 5 implementation.</p></li>
1.23 wiz 4669: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 4670: system-provided Motif installation or adds a dependency on
1.137 leot 4671: <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 4672: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.126 leot 4673: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
4674: to choose which Motif version will be used.</p></li>
1.55 ryoon 4675: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 4676: system-provided GNU readline or editline (libedit) installation,
1.137 leot 4677: 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>,
4678: <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 4679: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4680: If your package really needs GNU readline library, its Makefile
4681: should include <code class="filename">devel/readline/buildlink3.mk</code>
4682: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 4683: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 4684: variables that may be used by packages that use the
4685: Open Sound System (OSS) API.</p></li>
1.23 wiz 4686: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 4687: any of the Postgres versions in the variable
4688: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4689: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 4690: the file for more information.</p></li>
1.23 wiz 4691: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 4692: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.137 leot 4693: 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 4694: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 4695: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4696: library.</p></li>
4697: </ul></div>
4698: <p>The comments in those <code class="filename">buildlink3.mk</code>
4699: files provide a more complete
4700: description of how to use them properly.</p>
4701: </div>
1.41 asau 4702: <div class="sect1">
1.1 dsieger 4703: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4704: <a name="creating-buildlink3.mk"></a>16.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 4705: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 4706: included by Makefiles to indicate the need to compile and link
4707: against header files and libraries provided by the package. A
4708: <code class="filename">buildlink3.mk</code> file should always provide
4709: enough information to add the correct type of dependency
4710: relationship and include any other
4711: <code class="filename">buildlink3.mk</code> files that it needs to find
4712: headers and libraries that it needs in turn.</p>
4713: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.137 leot 4714: 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 4715: package is highly recommended. For most packages, the following
4716: command will generate a good starting point for
4717: <code class="filename">buildlink3.mk</code> files:</p>
4718: <pre class="screen">
4719: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4720: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4721: </pre>
1.41 asau 4722: <div class="sect2">
1.1 dsieger 4723: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4724: <a name="anatomy-of-bl3"></a>16.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 4725: <p>The following real-life example
4726: <code class="filename">buildlink3.mk</code> is taken
4727: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
4728: <pre class="programlisting">
1.18 snj 4729: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 4730:
1.112 rillig 4731: BUILDLINK_TREE+= tiff
1.1 dsieger 4732:
1.18 snj 4733: .if !defined(TIFF_BUILDLINK3_MK)
4734: TIFF_BUILDLINK3_MK:=
1.1 dsieger 4735:
1.112 rillig 4736: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4737: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
4738: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 4739:
4740: .include "../../devel/zlib/buildlink3.mk"
4741: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 4742: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 4743:
1.112 rillig 4744: BUILDLINK_TREE+= -tiff
1.1 dsieger 4745: </pre>
4746: <p>The header and footer manipulate
1.18 snj 4747: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 4748: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 4749: the dependency tree.</p>
4750: <p>The main section is protected from multiple inclusion
1.1 dsieger 4751: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4752: added. Several important variables are set in the section:</p>
1.41 asau 4753: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4754: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4755: is the actual dependency recorded in the installed
4756: package; this should always be set using
1.10 hubertf 4757: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 4758: we're appending to any pre-existing list of values. This
4759: variable should be set to the first version of the
1.26 wiz 4760: package that had an backwards-incompatible API change.
1.1 dsieger 4761: </p></li>
1.23 wiz 4762: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4763: is the location of the <em class="replaceable"><code>pkg</code></em>
4764: pkgsrc directory.</p></li>
1.23 wiz 4765: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4766: (not shown above) controls whether we use
4767: <code class="varname">BUILD_DEPENDS</code> or
4768: <code class="varname">DEPENDS</code> to add the dependency on
4769: <em class="replaceable"><code>pkg</code></em>. The build dependency is
4770: selected by setting
4771: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4772: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 4773: used.</p></li>
1.23 wiz 4774: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4775: and
4776: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
4777: (not shown above) are lists of subdirectories of
4778: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4779: to add to the header and library search paths. These
1.23 wiz 4780: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 4781: respectively.</p></li>
1.23 wiz 4782: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4783: (not shown above) is the list of preprocessor flags to add
4784: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 4785: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 4786: should be avoided and instead be handled using
4787: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
4788: above.</p></li>
4789: </ul></div>
4790: <p>The following variables are all optionally defined within
4791: this second section (protected against multiple inclusion) and
4792: control which package files are symlinked into
4793: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
4794: transformed during the symlinking:</p>
1.41 asau 4795: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4796: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4797: (not shown above) is a shell glob pattern relative to
4798: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
4799: to be symlinked into
4800: <code class="filename">${BUILDLINK_DIR}</code>,
4801: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 4802: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4803: (not shown above) is a shell pipeline that
4804: outputs to stdout a list of files relative to
4805: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
4806: The resulting files are to be symlinked
4807: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
4808: this takes the <code class="filename">+CONTENTS</code> of a
4809: <em class="replaceable"><code>pkg</code></em> and filters it through
4810: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 4811: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4812: (not shown above) is a filter command that filters
4813: <code class="filename">+CONTENTS</code> input into a list of files
4814: relative to
4815: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 4816: on stdout. By default,
1.1 dsieger 4817: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
4818: outputs the contents of the <code class="filename">include</code>
4819: and <code class="filename">lib</code> directories in the package
1.84 wiz 4820: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 4821: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 4822: (not shown above) is a list of sed arguments used to
4823: transform the name of the source filename into a
1.10 hubertf 4824: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 4825: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
4826: </ul></div>
1.18 snj 4827: <p>This section can additionally include any
1.1 dsieger 4828: <code class="filename">buildlink3.mk</code> needed for
4829: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
4830: Including these <code class="filename">buildlink3.mk</code> files
4831: means that the headers and libraries for these
4832: dependencies are also symlinked into
4833: <code class="filename">${BUILDLINK_DIR}</code>
4834: whenever the <em class="replaceable"><code>pkg</code></em>
4835: <code class="filename">buildlink3.mk</code>
1.18 snj 4836: file is included. Dependencies are only added for directly
4837: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 4838: <p>When providing a <code class="filename">buildlink3.mk</code> and
4839: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 4840: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 4841: header files are automatically exposed when the package is
4842: use.</p>
4843: <p>In particular, if only an executable
4844: (<code class="filename">bin/foo</code>) is linked against a library, that
4845: library does not need to be propagated in the
4846: <code class="filename">buildlink3.mk</code> file.</p>
4847: <p>The following steps should help you decide if a
4848: <code class="filename">buildlink3.mk</code> file needs to be included:
4849: </p>
4850: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4851: <li class="listitem"><p>Look at the installed header files: What
4852: headers do they include? The packages providing these files
4853: must be buildlinked.</p></li>
1.49 wiz 4854: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
4855: libraries and look against what other libraries they link.
4856: Some of the packages providing these probably need to be
4857: buildlinked; however, it's not automatic, since e.g. GTK on
4858: some systems pulls in the X libraries, so they will show up in
4859: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 4860: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 4861: used as a hint.</p></li>
1.47 wiz 4862: </ul></div>
4863: <p>
4864: </p>
1.1 dsieger 4865: </div>
1.41 asau 4866: <div class="sect2">
1.1 dsieger 4867: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4868: <a name="updating-buildlink-depends"></a>16.2.2. Updating
1.1 dsieger 4869: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4870: and
4871: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4872: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
4873: <p>These two variables differ in that one describes source
4874: compatibility (API) and the other binary compatibility (ABI).
4875: The difference is that a change in the API breaks compilation of
4876: programs while changes in the ABI stop compiled programs from
4877: running.</p>
4878: <p>Changes to the
1.27 wiz 4879: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 4880: variable in a <code class="filename">buildlink3.mk</code> file happen
4881: very rarely. One possible reason is that all packages depending
4882: on this already need a newer version. In case it is bumped see
4883: the description below.</p>
4884: <p>The most common example of an ABI change is that the major
4885: version of a shared library is increased. In this case,
4886: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4887: should be adjusted to require at least the new package version.
4888: Then the packages that depend on this package need their
4889: <code class="varname">PKGREVISION</code>s increased and, if they have
4890: <code class="filename">buildlink3.mk</code> files, their
4891: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4892: adjusted, too. This is needed so pkgsrc will require the correct
4893: package dependency and not settle for an older one when building
4894: the source.</p>
1.154 rillig 4895: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for
1.26 wiz 4896: more information about dependencies on other packages,
4897: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 4898: <code class="varname">ABI_DEPENDS</code> definitions.</p>
4899: <p>Please take careful consideration before adjusting
4900: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4901: or
4902: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4903: as we don't want to cause unneeded package deletions and
4904: rebuilds. In many cases, new versions of packages work just
4905: fine with older dependencies.</p>
4906: <p>Also it is not needed to set
1.26 wiz 4907: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4908: when it is identical to
1.1 dsieger 4909: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
4910: </div>
4911: </div>
1.41 asau 4912: <div class="sect1">
1.1 dsieger 4913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4914: <a name="writing-builtin.mk"></a>16.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 4915: <p>Some packages in pkgsrc install headers and libraries that
4916: coincide with headers and libraries present in the base system.
4917: Aside from a <code class="filename">buildlink3.mk</code> file, these
4918: packages should also include a <code class="filename">builtin.mk</code>
4919: file that includes the necessary checks to decide whether using
4920: the built-in software or the pkgsrc software is
4921: appropriate.</p>
4922: <p>The only requirements of a builtin.mk file for
4923: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 4924: <div class="orderedlist"><ol class="orderedlist" type="1">
4925: <li class="listitem"><p>It should set
1.1 dsieger 4926: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4927: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 4928: after it is included.</p></li>
1.23 wiz 4929: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 4930: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4931: which is already set before the
4932: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 4933: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 4934: is <span class="emphasis"><em>very</em></span> important and takes careful
4935: attention to <code class="filename">Makefile</code> coding.</p></li>
4936: </ol></div>
1.41 asau 4937: <div class="sect2">
1.1 dsieger 4938: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4939: <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 4940: <p>The following is the recommended template for builtin.mk
4941: files:</p>
4942: <pre class="programlisting">
4943: .if !defined(IS_BUILTIN.foo)
4944: #
4945: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4946: # genuinely exists in the system or not.
4947: #
4948: IS_BUILTIN.foo?= no
4949:
4950: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4951: # version can be determined.
4952: #
4953: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4954: BUILTIN_PKG.foo?= foo-1.0
4955: . endif
4956: .endif # IS_BUILTIN.foo
4957:
4958: .if !defined(USE_BUILTIN.foo)
4959: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4960: . if defined(BUILTIN_PKG.foo)
4961: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4962: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4963: USE_BUILTIN.foo!= \
4964: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4965: && ${ECHO} "yes" || ${ECHO} "no"
4966: . endif
4967: . endfor
4968: . endif
4969: .endif # USE_BUILTIN.foo
4970:
4971: CHECK_BUILTIN.foo?= no
4972: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4973: #
4974: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4975: # "yes" or "no".
4976: #
4977: .endif # CHECK_BUILTIN.foo
4978: </pre>
4979: <p>The first section sets
4980: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4981: depending on if <em class="replaceable"><code>pkg</code></em> really exists
4982: in the base system. This should not be a base system software
4983: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 4984: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 4985: included as part of the base system. This variable is only
4986: used internally within the <code class="filename">builtin.mk</code>
4987: file.</p>
4988: <p>The second section sets
4989: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4990: to the version of <em class="replaceable"><code>pkg</code></em> in the base
4991: system if it exists (if
4992: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 4993: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 4994: within the <code class="filename">builtin.mk</code> file.</p>
4995: <p>The third section sets
4996: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4997: and is <span class="emphasis"><em>required</em></span> in all
4998: <code class="filename">builtin.mk</code> files. The code in this
4999: section must make the determination whether the built-in
5000: software is adequate to satisfy the dependencies listed in
5001: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5002: This is typically done by comparing
5003: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5004: against each of the dependencies in
5005: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5006: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5007: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5008: end of the <code class="filename">builtin.mk</code> file. Note that
5009: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5010: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 5011: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5012: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 5013: that the built-in version of the software is similar enough to
5014: be used as a replacement.</p>
5015: <p>The last section is guarded by
5016: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5017: and includes code that uses the value of
5018: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5019: set in the previous section. This typically includes, e.g.,
5020: adding additional dependency restrictions and listing additional
5021: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5022: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5023: </div>
1.41 asau 5024: <div class="sect2">
1.1 dsieger 5025: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5026: <a name="native-or-pkgsrc-preference"></a>16.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5027: <p>When building packages, it's possible to choose whether to set
5028: a global preference for using either the built-in (native)
5029: version or the pkgsrc version of software to satisfy a
5030: dependency. This is controlled by setting
5031: <code class="varname">PREFER_PKGSRC</code> and
5032: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 5033: 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 5034: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5035: use the pkgsrc versions of software, while
5036: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5037: built-in versions. Preferences are determined by the most
5038: specific instance of the package in either
5039: <code class="varname">PREFER_PKGSRC</code> or
5040: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5041: in neither or in both variables, then
5042: <code class="varname">PREFER_PKGSRC</code> has precedence over
5043: <code class="varname">PREFER_NATIVE</code>. For example, to require
5044: using pkgsrc versions of software for all but the most basic
5045: bits on a NetBSD system, you can set:</p>
5046: <pre class="programlisting">
5047: PREFER_PKGSRC= yes
5048: PREFER_NATIVE= getopt skey tcp_wrappers
5049: </pre>
5050: <p>A package <span class="emphasis"><em>must</em></span> have a
5051: <code class="filename">builtin.mk</code>
5052: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5053: otherwise it is simply ignored in that list.</p>
1.117 sevan 5054: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
5055: straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
5056: bootstrap.
5057: Switching between settings globally at a later date can introduce
5058: complications with dependency resolution. This is caused by packages
5059: built with the opposite preference being installed alongside each other.</p>
5060: <pre class="screen">
5061: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
5062: </pre>
1.1 dsieger 5063: </div>
5064: </div>
5065: </div>
1.41 asau 5066: <div class="chapter">
1.1 dsieger 5067: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 5068: <a name="pkginstall"></a>Chapter 17. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5069: <div class="toc">
5070: <p><b>Table of Contents</b></p>
1.100 leot 5071: <dl class="toc">
1.154 rillig 5072: <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 5073: <dd><dl>
1.154 rillig 5074: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
5075: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
1.1 dsieger 5076: </dl></dd>
1.154 rillig 5077: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
1.1 dsieger 5078: <dd><dl>
1.154 rillig 5079: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5080: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
5081: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
5082: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
5083: </dl></dd>
5084: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
5085: <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>
5086: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
5087: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
5088: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
5089: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
5090: <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 5091: </dl>
5092: </div>
5093: <p>This chapter describes the framework known as
5094: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5095: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5096: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5097: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5098: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5099: provided that packages are correctly designed.</p></li>
1.23 wiz 5100: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5101: <li class="listitem"><p>Registration of system users and groups.</p></li>
5102: <li class="listitem"><p>Registration of system shells.</p></li>
5103: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5104: </ul></div>
5105: <p>The following sections inspect each of the above points in detail.</p>
5106: <p>You may be thinking that many of the things described here could be
5107: easily done with simple code in the package's post-installation target
5108: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5109: as the code in them is only executed when building from source. Machines
5110: using binary packages could not benefit from it at all (as the code itself
5111: could be unavailable). Therefore, the only way to achieve any of the items
5112: described above is by means of the installation scripts, which are
5113: automatically generated by pkginstall.</p>
1.41 asau 5114: <div class="sect1">
1.1 dsieger 5115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5116: <a name="files-and-dirs-outside-prefix"></a>17.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5117: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5118: of files and directories that belong to a package. The names used in it
5119: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5120: which means that it cannot register files outside this directory (absolute
5121: path names are not allowed). Despite this restriction, some packages need
5122: to install files outside this location; e.g., under
5123: <code class="filename">${VARBASE}</code> or
5124: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5125: is to create such files during installation time by using
5126: installation scripts.</p>
5127: <p>The generic installation scripts are shell scripts that can
5128: contain arbitrary code. The list of scripts to execute is taken from
5129: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5130: <code class="filename">INSTALL</code>. A similar variable exists for package
5131: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5132: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5133: commands, so they have the potential to create and manage files
5134: anywhere in the file system.</p>
5135: <p>Using these general installation files is not recommended, but
5136: may be needed in some special cases. One reason for avoiding them is
5137: that the user has to trust the packager that there is no unwanted or
5138: simply erroneous code included in the installation script. Also,
5139: previously there were many similar scripts for the same functionality,
5140: and fixing a common error involved finding and changing all of
5141: them.</p>
5142: <p>The pkginstall framework offers another, standardized way. It
5143: provides generic scripts to abstract the manipulation of such files
5144: and directories based on variables set in the package's
5145: <code class="filename">Makefile</code>. The rest of this section describes
5146: these variables.</p>
1.41 asau 5147: <div class="sect2">
1.1 dsieger 5148: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5149: <a name="dirs-outside-prefix"></a>17.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5150: <p>The following variables can be set to request the creation of
5151: directories anywhere in the file system:</p>
1.41 asau 5152: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108 rillig 5153: <li class="listitem">
5154: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5155: contain a list of directories that should be created and should attempt
5156: to be destroyed by the installation scripts. The difference between
5157: the two is that the latter prompts the administrator to remove any
5158: directories that may be left after deinstallation (because they were
1.108 rillig 5159: not empty), while the former does not. Example:</p>
5160: <pre class="programlisting">
5161: MAKE_DIRS+= ${VARBASE}/foo/private
5162: </pre>
5163: </li>
1.23 wiz 5164: <li class="listitem">
1.1 dsieger 5165: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5166: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5167: which directories should be created and should attempt to be destroyed
5168: by the installation scripts. Each tuple holds the following values,
5169: separated by spaces: the directory name, its owner, its group and its
5170: numerical mode. For example:</p>
5171: <pre class="programlisting">
1.108 rillig 5172: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5173: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5174: </pre>
5175: <p>The difference between the two is exactly the same as their
5176: non-<code class="varname">PERMS</code> counterparts.</p>
5177: </li>
5178: </ul></div>
5179: </div>
1.41 asau 5180: <div class="sect2">
1.1 dsieger 5181: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5182: <a name="files-outside-prefix"></a>17.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5183: <p>Creating non-empty files outside the installation prefix is tricky
5184: because the <code class="filename">PLIST</code> forces all files to be inside it.
5185: To overcome this problem, the only solution is to extract the file in the
5186: known place (i.e., inside the installation prefix) and copy it to the
5187: appropriate location during installation (done by the installation scripts
5188: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5189: file</em></span> in the following paragraphs, which describe the variables
5190: that can be used to automatically and consistently handle files outside the
5191: installation prefix:</p>
1.41 asau 5192: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5193: <li class="listitem">
1.1 dsieger 5194: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5195: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5196: During installation time, the master file is copied to the target one
5197: if and only if the latter does not exist. Upon deinstallation, the
5198: target file is removed provided that it was not modified by the
5199: installation.</p>
5200: <p>The difference between the two is that the latter prompts the
5201: administrator to remove any files that may be left after
5202: deinstallation (because they were not empty), while the former does
5203: not.</p>
5204: </li>
1.23 wiz 5205: <li class="listitem">
1.1 dsieger 5206: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5207: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5208: files as well as their target locations. For each of them, it also
5209: specifies their owner, their group and their numeric permissions, in
5210: this order. For example:</p>
5211: <pre class="programlisting">
1.108 rillig 5212: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5213: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5214: </pre>
5215: <p>The difference between the two is exactly the same as their
5216: non-<code class="varname">PERMS</code> counterparts.</p>
5217: </li>
5218: </ul></div>
5219: </div>
5220: </div>
1.41 asau 5221: <div class="sect1">
1.1 dsieger 5222: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5223: <a name="conf-files"></a>17.2. Configuration files</h2></div></div></div>
1.1 dsieger 5224: <p>Configuration files are special in the sense that they are installed
5225: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5226: need special treatment during installation (most of which is automated by
5227: pkginstall). The main concept you must bear in mind is that files marked
5228: as configuration files are automatically copied to the right place (somewhere
5229: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5230: and only if</em></span> they didn't exist before. Similarly, they will not
5231: be removed if they have local modifications. This ensures that
5232: administrators never lose any custom changes they may have made.</p>
1.41 asau 5233: <div class="sect2">
1.1 dsieger 5234: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5235: <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 5236: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5237: specifies where configuration files shall be installed. Its contents are
5238: set based upon the following variables:</p>
1.41 asau 5239: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5240: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5241: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5242: be overridden by the user to point to his preferred location (e.g.,
5243: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5244: Packages must not use it directly.</p></li>
1.23 wiz 5245: <li class="listitem">
1.1 dsieger 5246: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5247: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5248: for the package being built shall be installed. The definition of this
5249: variable only makes sense in the package's
5250: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5251: <p>As an example, consider the Apache package,
1.137 leot 5252: <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 5253: configuration files under the
5254: <code class="filename">httpd/</code> subdirectory of
5255: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5256: Makefile.</p>
5257: </li>
1.23 wiz 5258: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5259: variable that holds this package's configuration directory (if
5260: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5261: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5262: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5263: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5264: directory where the configuration files for the package identified by
5265: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5266: </ul></div>
5267: <p>Based on the above variables, pkginstall determines the value of
5268: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5269: variable that can be used within a package to refer to its configuration
5270: directory. The algorithm used to set its value is basically the
5271: following:</p>
1.23 wiz 5272: <div class="orderedlist"><ol class="orderedlist" type="1">
5273: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5274: its value is used.</p></li>
1.23 wiz 5275: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5276: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5277: <code class="filename">Makefile</code>, the resulting value is
5278: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5279: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5280: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5281: </ol></div>
5282: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.154 rillig 5283: 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 5284: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5285: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5286: </div>
1.41 asau 5287: <div class="sect2">
1.1 dsieger 5288: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5289: <a name="conf-files-configure"></a>17.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5290: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5291: known place, you need to teach each package where it shall install its
5292: files. In some cases you will have to patch the package Makefiles to
5293: achieve it. If you are lucky, though, it may be as easy as passing an
5294: extra flag to the configuration script; this is the case of GNU Autoconf-
5295: generated files:</p>
5296: <pre class="programlisting">
5297: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5298: </pre>
5299: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5300: for</em></span> its configuration files, not where they will be originally
5301: installed (although the difference is never explicit,
5302: unfortunately).</p>
5303: </div>
1.41 asau 5304: <div class="sect2">
1.1 dsieger 5305: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5306: <a name="conf-files-patching"></a>17.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5307: <p>As said before, pkginstall automatically handles configuration files.
5308: This means that <span class="strong"><strong>the packages themselves must not
5309: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5310: directly</strong></span>. Bad news is that many software installation scripts
5311: will, out of the box, mess with the contents of that directory. So what is
5312: the correct procedure to fix this issue?</p>
5313: <p>You must teach the package (usually by manually patching it) to
5314: install any configuration files under the examples hierarchy,
5315: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5316: <code class="filename">PLIST</code> registers them and the administrator always
5317: has the original copies available.</p>
5318: <p>Once the required configuration files are in place (i.e., under the
5319: examples hierarchy), the pkginstall framework can use them as master copies
5320: during the package installation to update what is in
5321: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5322: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.154 rillig 5323: 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 5324: about their syntax and their purpose. Here is an example, taken from the
1.137 leot 5325: <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 5326: <pre class="programlisting">
5327: EGDIR= ${PREFIX}/share/doc/mutt/samples
5328: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5329: </pre>
5330: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5331: package and has no meaning outside it.</p>
5332: </div>
1.41 asau 5333: <div class="sect2">
1.1 dsieger 5334: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5335: <a name="conf-files-disable"></a>17.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5336: <p>The automatic copying of config files can be toggled by setting the
5337: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5338: installation.</p>
5339: </div>
5340: </div>
1.41 asau 5341: <div class="sect1">
1.1 dsieger 5342: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5343: <a name="rcd-scripts"></a>17.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5344: <p>System startup scripts are special files because they must be
5345: installed in a place known by the underlying OS, usually outside the
1.154 rillig 5346: 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 5347: can be used. However, pkginstall provides a special mechanism to handle
5348: these files.</p>
5349: <p>In order to provide system startup scripts, the package has
5350: to:</p>
1.23 wiz 5351: <div class="orderedlist"><ol class="orderedlist" type="1">
5352: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5353: the <code class="literal">.sh</code> suffix appended. Considering the
1.137 leot 5354: <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 5355: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5356: <li class="listitem">
1.1 dsieger 5357: <p>Tell pkginstall to handle it, appending the name of the script,
5358: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5359: Continuing the previous example:</p>
5360: <pre class="programlisting">
5361: RCD_SCRIPTS+= cupsd
5362: </pre>
5363: </li>
5364: </ol></div>
5365: <p>Once this is done, pkginstall will do the following steps for each
5366: script in an automated fashion:</p>
1.23 wiz 5367: <div class="orderedlist"><ol class="orderedlist" type="1">
5368: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5369: substitutions described in the <code class="filename">FILES_SUBST</code>
5370: variable.</p></li>
1.23 wiz 5371: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5372: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5373: that this master file must be explicitly registered in the
5374: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5375: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5376: from the examples hierarchy into the system-wide startup scripts
5377: directory.</p></li>
5378: </ol></div>
1.41 asau 5379: <div class="sect2">
1.1 dsieger 5380: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5381: <a name="rcd-scripts-disable"></a>17.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5382: <p>The automatic copying of config files can be toggled by setting the
5383: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5384: installation. Note that the scripts will be always copied inside the
5385: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5386: matter what the value of this variable is.</p>
5387: </div>
5388: </div>
1.41 asau 5389: <div class="sect1">
1.1 dsieger 5390: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5391: <a name="users-and-groups"></a>17.4. System users and groups</h2></div></div></div>
1.1 dsieger 5392: <p>If a package needs to create special users and/or groups during
5393: installation, it can do so by using the pkginstall framework.</p>
5394: <p>Users can be created by adding entries to the
5395: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5396: syntax:</p>
5397: <pre class="programlisting">
5398: user:group
5399: </pre>
5400: <p>Further specification of user details may be done by setting
5401: per-user variables.
5402: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5403: numeric UID for the user.
5404: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5405: user's description or comment.
5406: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5407: user's home directory, and defaults to
5408: <code class="filename">/nonexistent</code> if not specified.
5409: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5410: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5411: not specified.</p>
5412: <p>Similarly, groups can be created by adding entries to the
5413: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5414: <pre class="programlisting">
5415: group
5416: </pre>
5417: <p>The numeric GID of the group may be set by defining
5418: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5419: <p>If a package needs to create the users and groups at an earlier
1.116 wiz 5420: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
5421: <code class="literal">configure</code>,<code class="literal">build</code>, or
5422: <code class="literal">pre-install</code> to indicate the phase before which the
5423: users and groups are created. In this case, the numeric UIDs and GIDs
5424: of the created users and groups are automatically hardcoded into the
5425: final installation scripts.</p>
1.1 dsieger 5426: </div>
1.41 asau 5427: <div class="sect1">
1.1 dsieger 5428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5429: <a name="shells"></a>17.5. System shells</h2></div></div></div>
1.1 dsieger 5430: <p>Packages that install system shells should register them in the shell
5431: database, <code class="filename">/etc/shells</code>, to make things easier to the
5432: administrator. This must be done from the installation scripts to keep
5433: binary packages working on any system. pkginstall provides an easy way to
5434: accomplish this task.</p>
5435: <p>When a package provides a shell interpreter, it has to set the
5436: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5437: add some hooks to the installation scripts to handle it. Consider the
1.137 leot 5438: 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 5439: <pre class="programlisting">
5440: PKG_SHELL= ${PREFIX}/bin/zsh
5441: </pre>
1.41 asau 5442: <div class="sect2">
1.1 dsieger 5443: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5444: <a name="shells-disable"></a>17.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5445: <p>The automatic registration of shell interpreters can be disabled by
5446: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5447: environment variable to <code class="literal">NO</code>.</p>
5448: </div>
5449: </div>
1.41 asau 5450: <div class="sect1">
1.1 dsieger 5451: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5452: <a name="fonts"></a>17.6. Fonts</h2></div></div></div>
1.1 dsieger 5453: <p>Packages that install X11 fonts should update the database files
5454: that index the fonts within each fonts directory. This can easily be
5455: accomplished within the pkginstall framework.</p>
5456: <p>When a package installs X11 fonts, it must list the directories in
5457: which fonts are installed in the
5458: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5459: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5460: <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 5461: installation scripts to run the appropriate commands to update the fonts
5462: database files within each of those directories. For convenience, if the
5463: directory path is relative, it is taken to be relative to the package's
1.137 leot 5464: 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 5465: <pre class="programlisting">
1.67 wiz 5466: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5467: </pre>
1.41 asau 5468: <div class="sect2">
1.1 dsieger 5469: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5470: <a name="fonts-disable"></a>17.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5471: <p>The automatic update of fonts databases can be disabled by
5472: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5473: environment variable to <code class="literal">NO</code>.</p>
5474: </div>
5475: </div>
5476: </div>
1.41 asau 5477: <div class="chapter">
1.1 dsieger 5478: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 5479: <a name="options"></a>Chapter 18. Options handling</h2></div></div></div>
1.1 dsieger 5480: <div class="toc">
5481: <p><b>Table of Contents</b></p>
1.100 leot 5482: <dl class="toc">
1.154 rillig 5483: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
5484: <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>
5485: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
5486: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5487: </dl>
5488: </div>
5489: <p>Many packages have the ability to be built to support different
5490: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5491: in pkgsrc that provides generic handling of those options that
5492: determine different ways in which the packages can be built. It's
5493: possible for the user to specify exactly which sets of options will be
5494: built into a package or to allow a set of global default options
5495: apply.</p>
1.7 rillig 5496: <p>There are two broad classes of behaviors that one might want to
5497: control via options. One is whether some particular feature is
5498: enabled in a program that will be built anyway, often by including or
5499: not including a dependency on some other package. The other is
5500: whether or not an additional program will be built as part of the
5501: package. Generally, it is better to make a split package for such
5502: additional programs instead of using options, because it enables
5503: binary packages to be built which can then be added separately. For
5504: example, the foo package might have minimal dependencies (those
5505: packages without which foo doesn't make sense), and then the foo-gfoo
5506: package might include the GTK frontend program gfoo. This is better
5507: than including a gtk option to foo that adds gfoo, because either that
5508: option is default, in which case binary users can't get foo without
5509: gfoo, or not default, in which case they can't get gfoo. With split
5510: packages, they can install foo without having GTK, and later decide to
5511: install gfoo (pulling in GTK at that time). This is an advantage to
5512: source users too, avoiding the need for rebuilds.</p>
5513: <p>Plugins with widely varying dependencies should usually be split
5514: instead of options.</p>
5515: <p>It is often more work to maintain split packages, especially if
5516: the upstream package does not support this. The decision of split
5517: vs. option should be made based on the likelihood that users will want
5518: or object to the various pieces, the size of the dependencies that are
5519: included, and the amount of work.</p>
5520: <p>A further consideration is licensing. Non-free parts, or parts
5521: that depend on non-free dependencies (especially plugins) should
5522: almost always be split if feasible.</p>
1.41 asau 5523: <div class="sect1">
1.1 dsieger 5524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5525: <a name="global-default-options"></a>18.1. Global default options</h2></div></div></div>
1.1 dsieger 5526: <p>Global default options are listed in
5527: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5528: that should be built into every package if that option is supported.
1.10 hubertf 5529: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5530: </div>
1.41 asau 5531: <div class="sect1">
1.1 dsieger 5532: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5533: <a name="converting-to-options"></a>18.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 5534: </h2></div></div></div>
5535: <p>The following example shows how
5536: <code class="filename">bsd.options.mk</code> should be used
5537: by the hypothetical ``wibble'' package, either in the package
5538: <code class="filename">Makefile</code>, or in a file,
5539: e.g. <code class="filename">options.mk</code>, that is included by the
5540: main package <code class="filename">Makefile</code>.</p>
5541: <pre class="programlisting">
5542: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5543: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5544: PKG_OPTIONS_OPTIONAL_GROUPS= database
5545: PKG_OPTIONS_GROUP.database= mysql pgsql
5546: PKG_SUGGESTED_OPTIONS= wibble-foo
5547: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5548: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5549:
5550: .include "../../mk/bsd.prefs.mk"
5551:
5552: # this package was previously named wibble2
5553: .if defined(PKG_OPTIONS.wibble2)
5554: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5555: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5556: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5557: .endif
5558:
5559: .include "../../mk/bsd.options.mk"
5560:
5561: # Package-specific option-handling
5562:
5563: ###
5564: ### FOO support
5565: ###
5566: .if !empty(PKG_OPTIONS:Mwibble-foo)
5567: CONFIGURE_ARGS+= --enable-foo
5568: .endif
5569:
5570: ###
5571: ### LDAP support
5572: ###
5573: .if !empty(PKG_OPTIONS:Mldap)
5574: . include "../../databases/openldap-client/buildlink3.mk"
5575: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5576: .endif
5577:
5578: ###
5579: ### database support
5580: ###
5581: .if !empty(PKG_OPTIONS:Mmysql)
5582: . include "../../mk/mysql.buildlink3.mk"
5583: .endif
5584: .if !empty(PKG_OPTIONS:Mpgsql)
5585: . include "../../mk/pgsql.buildlink3.mk"
5586: .endif
5587: </pre>
5588: <p>The first section contains the information about which build
5589: options are supported by the package, and any default options settings
5590: if needed.</p>
1.23 wiz 5591: <div class="orderedlist"><ol class="orderedlist" type="1">
5592: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.157 leot 5593: <a class="citerefentry" href="http://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 5594: options. It should be set to
5595: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5596: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5597: at the point where the options are processed.</p></li>
1.23 wiz 5598: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 5599: build options supported by the package.</p></li>
1.23 wiz 5600: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 5601: list of names of groups of mutually exclusive options. The options in
5602: each group are listed in
5603: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5604: The most specific setting of any option from the group takes
5605: precedence over all other options in the group. Options from the
5606: groups will be automatically added to
5607: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 5608: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 5609: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5610: packages will fail if no option from the group is
5611: selected.</p></li>
1.23 wiz 5612: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 5613: of names of sets of options. At least one option from each set must
5614: be selected. The options in each set are listed in
5615: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5616: Options from the sets will be automatically added to
5617: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5618: fail if no option from the set is selected.</p></li>
1.23 wiz 5619: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 5620: build options which are enabled by default.</p></li>
1.23 wiz 5621: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 5622: of
1.23 wiz 5623: <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 5624: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 5625: their option counterparts. Pairs should be added with
1.23 wiz 5626: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 5627: warning will be issued if the user uses a legacy
5628: variable.</p></li>
1.23 wiz 5629: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 5630: of
1.23 wiz 5631: <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 5632: pairs that map options that have been renamed to their new
1.23 wiz 5633: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 5634: the listing of global legacy options. A warning will be issued if
5635: the user uses a legacy option.</p></li>
1.23 wiz 5636: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 5637: options implied by deprecated variables used. This can be used for
5638: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5639: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5640: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 5641: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 5642: a list of warnings about deprecated variables or options used, and
5643: what to use instead.</p></li>
5644: </ol></div>
5645: <p>A package should never modify
5646: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5647: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5648: To suggest a default set of options, use
5649: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5650: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5651: including <code class="filename">bsd.options.mk</code>. If none of
5652: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5653: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5654: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5655: happen with platform-specific options if none of them is supported on
5656: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5657: empty list and the package is otherwise treated as not using the
5658: options framework.</p>
5659: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5660: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5661: build options, properly filtered to remove unsupported and duplicate
5662: options.</p>
5663: <p>The remaining sections contain the logic that is specific to
5664: each option. The correct way to check for an option is to check
5665: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5666: <pre class="programlisting">
5667: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
5668: </pre>
5669: </div>
1.41 asau 5670: <div class="sect1">
1.1 dsieger 5671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5672: <a name="option-names"></a>18.3. Option Names</h2></div></div></div>
1.1 dsieger 5673: <p>Options that enable similar features in different packages (like
5674: optional support for a library) should use a common name in all
5675: packages that support it (like the name of the library). If another
5676: package already has an option with the same meaning, use the same
5677: name.</p>
5678: <p>Options that enable features specific to one package, where it's
5679: unlikely that another (unrelated) package has the same (or a similar)
5680: optional feature, should use a name prefixed with
5681: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5682: <p>If a group of related packages share an optional feature
5683: specific to that group, prefix it with the name of the
1.23 wiz 5684: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 5685: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5686: <p>For new options, add a line to
5687: <code class="filename">mk/defaults/options.description</code>. Lines have two
5688: fields, separated by tab. The first field is the option name, the
5689: second its description. The description should be a whole sentence
5690: (starting with an uppercase letter and ending with a period) that
1.23 wiz 5691: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5692: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 5693: </div>
1.41 asau 5694: <div class="sect1">
1.7 rillig 5695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5696: <a name="option-build"></a>18.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 5697: <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 5698: different dependencies based on the options with which the package was
5699: built. For querying these options, the file
5700: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5701: typical example looks like this:</p>
5702: <pre class="programlisting">
5703: pkgbase := libpurple
5704: .include "../../mk/pkg-build-options.mk"
5705:
5706: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5707: ...
5708: .endif
5709: </pre>
5710: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5711: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5712: options of the libpurple package, which can then be queried like
5713: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5714: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5715: details.</p>
5716: </div>
1.1 dsieger 5717: </div>
1.41 asau 5718: <div class="chapter">
1.1 dsieger 5719: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 5720: <a name="build"></a>Chapter 19. The build process</h2></div></div></div>
1.1 dsieger 5721: <div class="toc">
5722: <p><b>Table of Contents</b></p>
1.100 leot 5723: <dl class="toc">
1.154 rillig 5724: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
5725: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
5726: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
5727: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
5728: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
5729: <dd><dl>
5730: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
5731: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
5732: </dl></dd>
5733: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5734: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5735: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5736: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5737: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5738: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5739: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5740: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5741: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5742: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
5743: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
5744: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
1.1 dsieger 5745: </dl>
5746: </div>
1.41 asau 5747: <div class="sect1">
1.1 dsieger 5748: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5749: <a name="build.intro"></a>19.1. Introduction</h2></div></div></div>
1.1 dsieger 5750: <p>This chapter gives a detailed description on how a package is
5751: built. Building a package is separated into different
5752: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5753: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 5754: described in the following sections. Each phase is split into
1.1 dsieger 5755: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
5756: containing phase, prefixed by one of <code class="varname">pre-</code>,
5757: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
5758: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
5759: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
5760: <p>Never override the regular targets (like
5761: <code class="varname">fetch</code>), if you have to, override the
5762: <code class="varname">do-*</code> ones instead.</p>
5763: <p>The basic steps for building a program are always the same. First
5764: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
5765: the local system and then extracted. After any pkgsrc-specific patches
5766: to compile properly are applied, the software can be configured, then
5767: built (usually by compiling), and finally the generated binaries, etc.
5768: can be put into place on the system.</p>
5769: <p>To get more details about what is happening at each step,
5770: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
5771: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
5772: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
5773: </div>
1.41 asau 5774: <div class="sect1">
1.1 dsieger 5775: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5776: <a name="build.prefix"></a>19.2. Program location</h2></div></div></div>
1.1 dsieger 5777: <p>Before outlining the process performed by the NetBSD package system in
5778: the next section, here's a brief discussion on where programs are
5779: installed, and which variables influence this.</p>
5780: <p>The automatic variable <code class="varname">PREFIX</code> indicates
5781: where all files of the final program shall be installed. It is
5782: usually set to <code class="varname">LOCALBASE</code>
5783: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
5784: for pkgs in the <code class="filename">cross</code> category. The value of
5785: <code class="varname">PREFIX</code> needs to be put
5786: into the various places in the program's source where paths to
1.154 rillig 5787: 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 5788: <p>When choosing which of these variables to use,
5789: follow the following rules:</p>
1.41 asau 5790: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5791: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 5792: where the current pkg will be installed. When referring to a
5793: pkg's own installation path, use
1.23 wiz 5794: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
5795: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 5796: are installed. If you need to construct a -I or -L argument
5797: to the compiler to find includes and libraries installed by
1.23 wiz 5798: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 5799: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
5800: installed all packages in <code class="filename">/usr/local</code>. As
5801: pkgsrc leaves <code class="filename">/usr/local</code> for the system
5802: administrator, this variable is a misnomer.</p></li>
1.23 wiz 5803: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 5804: distribution (from xsrc, etc.) is installed. When looking for
5805: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 5806: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.99 sevan 5807: <li class="listitem"><p>X11-based packages using imake must set
5808: <code class="varname">USE_IMAKE</code> to be installed correctly under
5809: <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5810: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.157 leot 5811: install files according to <a class="citerefentry" href="http://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 5812: manual pages go into <code class="filename">${PREFIX}/man</code>, not
5813: <code class="filename">${PREFIX}/share/man</code>.</p></li>
5814: </ul></div>
5815: </div>
1.41 asau 5816: <div class="sect1">
1.1 dsieger 5817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5818: <a name="build.builddirs"></a>19.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 5819: <p>When building a package, various directories are used to store
1.1 dsieger 5820: source files, temporary files, pkgsrc-internal files, and so on. These
5821: directories are explained here.</p>
5822: <p>Some of the directory variables contain relative pathnames. There
5823: are two common base directories for these relative directories:
5824: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
5825: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
5826: inside the package itself.</p>
1.41 asau 5827: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5828: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
5829: <dd><p>This is an absolute pathname that points to the pkgsrc
5830: root directory. Generally, you don't need
5831: it.</p></dd>
5832: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
5833: <dd><p>This is an absolute pathname that points to the
5834: current package.</p></dd>
5835: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
5836: <dd><p>This is a pathname relative to
5837: <code class="varname">PKGSRCDIR</code> that points to the current
5838: package.</p></dd>
5839: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
5840: <dd><p>This is an absolute pathname pointing to the directory
5841: where all work takes place. The distfiles are extracted to this
5842: directory. It also contains temporary directories and log files used by
5843: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
5844: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
5845: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
5846: <dd><p>This is an absolute pathname pointing to the directory
5847: where the distfiles are extracted. It is usually a direct subdirectory
5848: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
5849: that isn't hidden. This variable may be changed by a package
5850: <code class="filename">Makefile</code>.</p></dd>
5851: </dl></div>
1.14 jmcneill 5852: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
5853: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 5854: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 5855: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
5856: If users would like to have their pkgsrc trees behave in a
5857: read-only manner, then the value of
5858: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
5859: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 5860: </div>
1.41 asau 5861: <div class="sect1">
1.1 dsieger 5862: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5863: <a name="build.running"></a>19.4. Running a phase</h2></div></div></div>
1.10 hubertf 5864: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 5865: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
5866: phase. This will automatically run all phases that are required for this
5867: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 5868: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 5869: the package will be built, but not installed.</p>
5870: </div>
1.41 asau 5871: <div class="sect1">
1.1 dsieger 5872: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5873: <a name="build.fetch"></a>19.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 5874: <p>The first step in building a package is to fetch the
5875: distribution files (distfiles) from the sites that are providing
5876: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
5877: phase.</p>
1.41 asau 5878: <div class="sect2">
1.1 dsieger 5879: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5880: <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 5881: <p>In simple cases, <code class="varname">MASTER_SITES</code>
5882: defines all URLs from where the distfile, whose name is
5883: derived from the <code class="varname">DISTNAME</code> variable, is
5884: fetched. The more complicated cases are described
5885: below.</p>
5886: <p>The variable <code class="varname">DISTFILES</code> specifies
5887: the list of distfiles that have to be fetched. Its value
1.66 asau 5888: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
5889: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 5890: so that most packages don't need to define it at all.
5891: <code class="varname">EXTRACT_SUFX</code> is
5892: <code class="literal">.tar.gz</code> by default, but can be changed
5893: freely. Note that if your package requires additional
5894: distfiles to the default one, you cannot just append the
5895: additional filenames using the <code class="literal">+=</code>
5896: operator, but you have write for example:</p>
5897: <pre class="programlisting">
1.66 asau 5898: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 5899: </pre>
5900: <p>Each distfile is fetched from a list of sites, usually
5901: <code class="varname">MASTER_SITES</code>. If the package has multiple
5902: <code class="varname">DISTFILES</code> or multiple
5903: <code class="varname">PATCHFILES</code> from different sites, you can
5904: set
5905: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
5906: to the list of URLs where the file
5907: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
5908: (including the suffix) can be found.</p>
5909: <pre class="programlisting">
5910: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5911: DISTFILES+= foo-file.tar.gz
5912: SITES.foo-file.tar.gz= \
5913: http://www.somewhere.com/somehow/ \
5914: http://www.somewhereelse.com/mirror/somehow/
5915: </pre>
5916: <p>When actually fetching the distfiles, each item from
5917: <code class="varname">MASTER_SITES</code> or
5918: <code class="varname">SITES.*</code> gets the name of each distfile
5919: appended to it, without an intermediate slash. Therefore,
5920: all site values have to end with a slash or other separator
5921: character. This allows for example to set
5922: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
5923: that gets the name of the distfile as a parameter. In this
5924: case, the definition would look like:</p>
5925: <pre class="programlisting">
5926: MASTER_SITES= http://www.example.com/download.cgi?file=
5927: </pre>
1.22 jakllsch 5928: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 5929: In that case the URL is taken as is, fetched and the result
5930: stored under the name of the distfile. You can use this style
5931: for the case when the download URL style does not match the
5932: above common case. For example, if permanent download URL is a
5933: redirector to the real download URL, or the download file name
5934: is offered by an HTTP Content-Disposition header. In the
5935: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
5936: created instead of the default
5937: <code class="filename">v1.0.0.tar.gz</code>.</p>
5938: <pre class="programlisting">
5939: DISTNAME= foo-1.0.0
5940: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
5941: </pre>
1.1 dsieger 5942: <p>There are some predefined values for
5943: <code class="varname">MASTER_SITES</code>, which can be used in
5944: packages. The names of the variables should speak for
5945: themselves.</p>
1.156 leot 5946: <table border="0" summary="Simple list" class="simplelist">
5947: <tr>
5948: <td>MASTER_SITE_APACHE</td>
5949: <td>MASTER_SITE_BACKUP</td>
5950: </tr>
5951: <tr>
5952: <td>MASTER_SITE_CRATESIO</td>
5953: <td>MASTER_SITE_CYGWIN</td>
5954: </tr>
5955: <tr>
5956: <td>MASTER_SITE_DEBIAN</td>
5957: <td>MASTER_SITE_FREEBSD</td>
5958: </tr>
5959: <tr>
5960: <td>MASTER_SITE_FREEBSD_LOCAL</td>
5961: <td>MASTER_SITE_GENTOO</td>
5962: </tr>
5963: <tr>
5964: <td>MASTER_SITE_GITHUB</td>
5965: <td>MASTER_SITE_GNOME</td>
5966: </tr>
5967: <tr>
5968: <td>MASTER_SITE_GNU</td>
5969: <td>MASTER_SITE_GNUSTEP</td>
5970: </tr>
5971: <tr>
5972: <td>MASTER_SITE_HASKELL_HACKAGE</td>
5973: <td>MASTER_SITE_IFARCHIVE</td>
5974: </tr>
5975: <tr>
5976: <td>MASTER_SITE_KDE</td>
5977: <td>MASTER_SITE_MOZILLA</td>
5978: </tr>
5979: <tr>
5980: <td>MASTER_SITE_MOZILLA_ALL</td>
5981: <td>MASTER_SITE_MYSQL</td>
5982: </tr>
5983: <tr>
5984: <td>MASTER_SITE_NETLIB</td>
5985: <td>MASTER_SITE_OPENBSD</td>
5986: </tr>
5987: <tr>
5988: <td>MASTER_SITE_OPENOFFICE</td>
5989: <td>MASTER_SITE_OSDN</td>
5990: </tr>
5991: <tr>
5992: <td>MASTER_SITE_PERL_CPAN</td>
5993: <td>MASTER_SITE_PGSQL</td>
5994: </tr>
5995: <tr>
5996: <td>MASTER_SITE_PYPI</td>
5997: <td>MASTER_SITE_RUBYGEMS</td>
5998: </tr>
5999: <tr>
6000: <td>MASTER_SITE_R_CRAN</td>
6001: <td>MASTER_SITE_SOURCEFORGE</td>
6002: </tr>
6003: <tr>
6004: <td>MASTER_SITE_SUNSITE</td>
6005: <td>MASTER_SITE_SUSE</td>
6006: </tr>
6007: <tr>
6008: <td>MASTER_SITE_TEX_CTAN</td>
6009: <td>MASTER_SITE_XCONTRIB</td>
6010: </tr>
6011: <tr>
6012: <td>MASTER_SITE_XEMACS</td>
6013: <td>MASTER_SITE_XORG</td>
6014: </tr>
6015: </table>
1.1 dsieger 6016: <p>Some explanations for the less self-explaining ones:
6017: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 6018: 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 6019: 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 6020: <p>If you choose one of these predefined sites, you may
6021: want to specify a subdirectory of that site. Since these
6022: macros may expand to more than one actual site, you
6023: <span class="emphasis"><em>must</em></span> use the following construct to
6024: specify a subdirectory:</p>
6025: <pre class="programlisting">
6026: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6027: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6028: </pre>
6029: <p>Note the trailing slash after the subdirectory
6030: name.</p>
6031: </div>
1.41 asau 6032: <div class="sect2">
1.1 dsieger 6033: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 6034: <a name="build.fetch.how"></a>19.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6035: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6036: all the distfiles exist in a local directory
6037: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6038: user). If the files do not exist, they are fetched using
6039: commands of the form</p>
6040: <pre class="programlisting">
6041: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6042: </pre>
6043: <p>where <code class="literal">${site}</code> varies through
6044: several possibilities in turn: first,
6045: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6046: sites specified in either <code class="varname">SITES.file</code> if
6047: defined, else <code class="varname">MASTER_SITES</code> or
6048: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6049: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6050: all except the first and the last can be optionally sorted
6051: by the user, via setting either
6052: <code class="varname">MASTER_SORT_RANDOM</code>, and
6053: <code class="varname">MASTER_SORT_AWK</code> or
6054: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 6055: <p> The specific command and arguments used depend on the
6056: <code class="varname">FETCH_USING</code> parameter. The example above is
6057: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 6058: <p>The distfiles mirror run by the NetBSD Foundation uses the
6059: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6060: distfiles, if they are freely distributable. Packages setting
6061: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 6062: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 6063: mirrored.</p>
6064: </div>
6065: </div>
1.41 asau 6066: <div class="sect1">
1.1 dsieger 6067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6068: <a name="build.checksum"></a>19.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6069: <p>After the distfile(s) are fetched, their checksum is
6070: generated and compared with the checksums stored in the
6071: distinfo file. If the checksums don't match, the build is
6072: aborted. This is to ensure the same distfile is used for
6073: building, and that the distfile wasn't changed, e.g. by some
6074: malign force, deliberately changed distfiles on the master
6075: distribution site or network lossage.</p>
6076: </div>
1.41 asau 6077: <div class="sect1">
1.1 dsieger 6078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6079: <a name="build.extract"></a>19.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6080: <p>When the distfiles are present on the local system, they
6081: need to be extracted, as they usually come in the form of some
6082: compressed archive format.</p>
6083: <p>By default, all <code class="varname">DISTFILES</code> are
6084: extracted. If you only need some of them, you can set the
6085: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6086: files.</p>
6087: <p>Extracting the files is usually done by a little
6088: program, <code class="filename">mk/extract/extract</code>, which
6089: already knows how to extract various archive formats, so most
6090: likely you will not need to change anything here. But if you
6091: need, the following variables may help you:</p>
1.41 asau 6092: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6093: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6094: <dd><p>Use these variables to override the default
6095: options for an extract command, which are defined in
6096: <code class="filename">mk/extract/extract</code>.</p></dd>
6097: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6098: <dd><p>This variable can be set to
1.14 jmcneill 6099: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6100: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 6101: absolute pathname pointing to the command with which tar
1.14 jmcneill 6102: archives should be extracted. It is preferred to choose bsdtar over gtar
6103: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 6104: </dl></div>
6105: <p>If the <code class="filename">extract</code> program doesn't
6106: serve your needs, you can also override the
6107: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6108: command used for extracting the files. This command is
6109: executed in the <code class="filename">${WRKSRC}</code>
6110: directory. During execution of this command, the shell
6111: variable <code class="varname">extract_file</code> holds the absolute
6112: pathname of the file that is going to be extracted.</p>
6113: <p>And if that still does not suffice, you can override the
6114: <code class="varname">do-extract</code> target in the package
6115: Makefile.</p>
6116: </div>
1.41 asau 6117: <div class="sect1">
1.1 dsieger 6118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6119: <a name="build.patch"></a>19.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6120: <p>After extraction, all the patches named by the
6121: <code class="varname">PATCHFILES</code>, those present in the patches
6122: subdirectory of the package as well as in
6123: $LOCALPATCHES/$PKGPATH (e.g.
6124: <code class="filename">/usr/local/patches/graphics/png</code>) are
6125: applied. Patchfiles ending in <code class="filename">.Z</code> or
6126: <code class="filename">.gz</code> are uncompressed before they are
6127: applied, files ending in <code class="filename">.orig</code> or
6128: <code class="filename">.rej</code> are ignored. Any special options to
1.157 leot 6129: <a class="citerefentry" href="http://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 6130: <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.157 leot 6131: <p>By default <a class="citerefentry" href="http://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 6132: it fail if the patches apply with some lines of fuzz. Please
6133: fix (regen) the patches so that they apply cleanly. The
6134: rationale behind this is that patches that don't apply cleanly
6135: may end up being applied in the wrong place, and cause severe
6136: harm there.</p>
6137: </div>
1.41 asau 6138: <div class="sect1">
1.1 dsieger 6139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6140: <a name="build.tools"></a>19.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6141: <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 6142: </p>
6143: </div>
1.41 asau 6144: <div class="sect1">
1.1 dsieger 6145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6146: <a name="build.wrapper"></a>19.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6147: <p>This phase creates wrapper programs for the compilers and
6148: linkers. The following variables can be used to tweak the
6149: wrappers.</p>
1.41 asau 6150: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6151: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6152: <dd><p>The command used to print progress
6153: messages. Does nothing by default. Set to
6154: <code class="literal">${ECHO}</code> to see the progress
6155: messages.</p></dd>
6156: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6157: <dd><p>This variable can be set to
6158: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6159: depending on whether you want additional information in the
6160: wrapper log file.</p></dd>
6161: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6162: <dd><p>This variable can be set to
6163: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6164: on whether the wrapper should use its cache, which will
6165: improve the speed. The default value is
6166: <code class="literal">yes</code>, but is forced to
6167: <code class="literal">no</code> if the platform does not support
6168: it.</p></dd>
6169: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6170: <dd><p>A list of reordering commands. A reordering
6171: command has the form
6172: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6173: It ensures that that
6174: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6175: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6176: </p></dd>
6177: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6178: <dd><p>A list of transformation commands. [TODO:
6179: investigate further]</p></dd>
6180: </dl></div>
6181: </div>
1.41 asau 6182: <div class="sect1">
1.1 dsieger 6183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6184: <a name="build.configure"></a>19.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6185: <p>Most pieces of software need information on the header
6186: files, system calls, and library routines which are available
6187: on the platform they run on. The process of determining this
6188: information is known as configuration, and is usually
6189: automated. In most cases, a script is supplied with the
6190: distfiles, and its invocation results in generation of header
6191: files, Makefiles, etc.</p>
6192: <p>If the package contains a configure script, this can be
6193: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6194: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6195: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6196: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6197: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6198: <pre class="programlisting">
6199: .for d in ${CONFIGURE_DIRS}
6200: cd ${WRKSRC} \
6201: && cd ${d} \
6202: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6203: .endfor
6204: </pre>
6205: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6206: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6207: <code class="varname">WRKSRC</code>. In each of these directories, the
6208: configure script is run with the environment
6209: <code class="varname">CONFIGURE_ENV</code> and arguments
6210: <code class="varname">CONFIGURE_ARGS</code>. The variables
6211: <code class="varname">CONFIGURE_ENV</code>,
6212: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6213: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6214: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6215: package.</p>
1.37 wiz 6216: <p>If the program uses the Perl way of configuration (mainly Perl
6217: modules, but not only), i.e. a file called
6218: <code class="filename">Makefile.PL</code>, it should include
6219: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6220: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6221: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6222: <p>If the program uses an <code class="filename">Imakefile</code>
6223: for configuration, the appropriate steps can be invoked by
6224: setting <code class="varname">USE_IMAKE</code> to
1.99 sevan 6225: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6226: You can add variables to xmkmf's environment by adding them to the
1.1 dsieger 6227: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6228: <p>If the program uses <code class="filename">cmake</code>
6229: for configuration, the appropriate steps can be invoked by
1.23 wiz 6230: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6231: You can add variables to cmake's environment by adding them to the
6232: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6233: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6234: The top directory argument is given by the
6235: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6236: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6237: <p>If there is no configure step at all, set
1.23 wiz 6238: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6239: </div>
1.41 asau 6240: <div class="sect1">
1.1 dsieger 6241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6242: <a name="build.build"></a>19.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6243: <p>For building a package, a rough equivalent of the
6244: following code is executed.</p>
6245: <pre class="programlisting">
6246: .for d in ${BUILD_DIRS}
6247: cd ${WRKSRC} \
6248: && cd ${d} \
6249: && env ${MAKE_ENV} \
6250: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6251: -f ${MAKE_FILE} \
6252: ${BUILD_TARGET}
6253: .endfor
6254: </pre>
6255: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6256: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6257: <code class="varname">WRKSRC</code>. In each of these directories,
6258: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6259: <code class="varname">MAKE_ENV</code> and arguments
6260: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6261: <code class="varname">MAKE_ENV</code>,
6262: <code class="varname">BUILD_MAKE_FLAGS</code>,
6263: <code class="varname">MAKE_FILE</code> and
6264: <code class="varname">BUILD_TARGET</code> may all be changed by the
6265: package.</p>
6266: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6267: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6268: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6269: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6270: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6271: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6272: <p>If there is no build step at all, set
1.23 wiz 6273: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6274: </div>
1.41 asau 6275: <div class="sect1">
1.1 dsieger 6276: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6277: <a name="build.test"></a>19.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6278: <p>[TODO]</p>
6279: </div>
1.41 asau 6280: <div class="sect1">
1.1 dsieger 6281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6282: <a name="build.install"></a>19.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6283: <p>Once the build stage has completed, the final step is to
6284: install the software in public directories, so users can
6285: access the programs and files.</p>
6286: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6287: equivalent of the following code is executed. Additionally,
6288: before and after this code, much magic is performed to do
6289: consistency checks, registering the package, and so on.</p>
6290: <pre class="programlisting">
6291: .for d in ${INSTALL_DIRS}
6292: cd ${WRKSRC} \
6293: && cd ${d} \
6294: && env ${MAKE_ENV} \
6295: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6296: -f ${MAKE_FILE} \
6297: ${INSTALL_TARGET}
6298: .endfor
6299: </pre>
6300: <p>The variable's meanings are analogous to the ones in the
6301: <span class="emphasis"><em>build</em></span> phase.
6302: <code class="varname">INSTALL_DIRS</code> defaults to
6303: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6304: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6305: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6306: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6307: defined.</p>
6308: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6309: variables are useful. They are all variations of the
1.157 leot 6310: <a class="citerefentry" href="http://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 6311: permissions preset. <code class="varname">INSTALL</code> is the plain
6312: install command. The specialized variants, together with their
6313: intended use, are:</p>
1.41 asau 6314: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6315: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6316: <dd><p>directories that contain
6317: binaries</p></dd>
6318: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6319: <dd><p>directories that contain
6320: scripts</p></dd>
6321: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6322: <dd><p>directories that contain shared and static
6323: libraries</p></dd>
6324: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6325: <dd><p>directories that contain data
6326: files</p></dd>
6327: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6328: <dd><p>directories that contain man
6329: pages</p></dd>
1.100 leot 6330: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6331: <dd><p>directories that contain data files for games
6332: </p></dd>
1.1 dsieger 6333: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6334: <dd><p>binaries that can be stripped from debugging
6335: symbols</p></dd>
6336: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6337: <dd><p>binaries that cannot be
6338: stripped</p></dd>
6339: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6340: <dd><p>game
6341: binaries</p></dd>
6342: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6343: <dd><p>shared and static
6344: libraries</p></dd>
6345: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6346: <dd><p>data files</p></dd>
6347: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6348: <dd><p>data files for
6349: games</p></dd>
6350: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6351: <dd><p>man pages</p></dd>
6352: </dl></div>
6353: <p>Some other variables are:</p>
1.41 asau 6354: <div class="variablelist"><dl class="variablelist">
1.106 tnn 6355: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.157 leot 6356: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="http://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 6357: when installing binaries. Any debugging sections and symbols present in
6358: binaries will be preserved.
6359: </p></dd>
1.1 dsieger 6360: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6361: <dd><p>A list of directories relative to
6362: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6363: beginning of the <span class="emphasis"><em>install</em></span> phase.
6364: The package is supposed to create all needed directories itself
6365: before installing files to it and list all other directories here.
6366: </p></dd>
6367: </dl></div>
6368: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6369: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6370: mostly relevant for packages in the <code class="filename">regress</code>
6371: category.</p>
6372: </div>
1.41 asau 6373: <div class="sect1">
1.1 dsieger 6374: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6375: <a name="build.package"></a>19.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6376: <p>Once the install stage has completed, a binary package of
6377: the installed files can be built. These binary packages can be
6378: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6379: the <span class="command"><strong>make bin-install</strong></span> or by using
6380: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6381: <p>By default, the binary packages are created in
6382: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6383: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6384: one for each category in the <code class="varname">CATEGORIES</code>
6385: variable. <code class="varname">PACKAGES</code> defaults to
6386: <code class="filename">pkgsrc/packages</code>.</p>
6387: </div>
1.41 asau 6388: <div class="sect1">
1.1 dsieger 6389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6390: <a name="build.clean"></a>19.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6391: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6392: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6393: to clean the work directories of all dependencies too, use
1.10 hubertf 6394: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6395: </div>
1.41 asau 6396: <div class="sect1">
1.1 dsieger 6397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6398: <a name="build.helpful-targets"></a>19.17. Other helpful targets</h2></div></div></div>
1.41 asau 6399: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6400: <dt><span class="term">pre/post-*</span></dt>
6401: <dd><p>For any of the main targets described in the
6402: previous section, two auxiliary targets exist with
1.23 wiz 6403: <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 6404: prefix for the main target's name. These targets are
6405: invoked before and after the main target is called,
6406: allowing extra configuration or installation steps be
6407: performed from a package's Makefile, for example, which
6408: a program's configure script or install target
6409: omitted.</p></dd>
6410: <dt><span class="term">do-*</span></dt>
6411: <dd><p>Should one of the main targets do the wrong thing,
6412: and should there be no variable to fix this, you can
6413: redefine it with the do-* target. (Note that redefining
6414: the target itself instead of the do-* target is a bad
6415: idea, as the pre-* and post-* targets won't be called
6416: anymore, etc.) You will not usually need to do
6417: this.</p></dd>
6418: <dt><span class="term">reinstall</span></dt>
6419: <dd>
1.10 hubertf 6420: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6421: you noticed some file was not installed properly, you
6422: can repeat the installation with this target, which will
1.23 wiz 6423: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6424: <p>This is the default value of
6425: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6426: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6427: package</strong></span>, where the defaults are
1.23 wiz 6428: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6429: respectively.</p>
6430: </dd>
6431: <dt><span class="term">deinstall</span></dt>
6432: <dd>
1.157 leot 6433: <p>This target does a <a class="citerefentry" href="http://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 6434: current directory, effectively de-installing the
6435: package. The following variables can be used to tune the
6436: behaviour:</p>
1.41 asau 6437: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6438: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.157 leot 6439: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://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 6440: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6441: <dd><p>Remove all packages that require (depend on)
6442: the given package. This can be used to remove any
6443: packages that may have been pulled in by a given
1.10 hubertf 6444: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6445: DEINSTALLDEPENDS=1</strong></span> is done in
6446: <code class="filename">pkgsrc/x11/kde</code>, this is
6447: likely to remove whole KDE. Works by adding
1.157 leot 6448: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="http://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 6449: command line.</p></dd>
6450: </dl></div>
6451: </dd>
6452: <dt><span class="term">bin-install</span></dt>
6453: <dd><p>Install a binary package from local disk and via FTP
6454: from a list of sites (see the
6455: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6456: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6457: available anywhere. The arguments given to
1.10 hubertf 6458: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6459: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6460: operation, etc.</p></dd>
1.95 wiz 6461: <dt><span class="term">install-clean</span></dt>
6462: <dd><p>This target removes the state files for the "install" and later
6463: phases so that the "install" target may be re-invoked. This can be
6464: used after editing the PLIST to install the package without
6465: rebuilding it.</p></dd>
6466: <dt><span class="term">build-clean</span></dt>
6467: <dd><p>This target removes the state files for the "build" and later
6468: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 6469: <dt><span class="term">update</span></dt>
6470: <dd>
6471: <p>This target causes the current package to be
6472: updated to the latest version. The package and all
6473: depending packages first get de-installed, then current
6474: versions of the corresponding packages get compiled and
6475: installed. This is similar to manually noting which
6476: packages are currently installed, then performing a
1.10 hubertf 6477: series of <span class="command"><strong>make deinstall</strong></span> and
6478: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6479: <code class="varname">UPDATE_TARGET</code> is set to) for these
6480: packages.</p>
1.23 wiz 6481: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6482: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6483: update</strong></span> was interrupted for some reason.
6484: However, in this case, make sure you don't call
1.10 hubertf 6485: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6486: list of dependent packages in <code class="varname">WRKDIR</code>.
6487: Otherwise, you lose the ability to automatically update
6488: the current package along with the dependent packages
6489: you have installed.</p>
1.10 hubertf 6490: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6491: update</strong></span> will only work as long as the package
6492: tree remains unchanged. If the source code for one of
6493: the packages to be updated has been changed, resuming
1.10 hubertf 6494: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 6495: fail!</p>
6496: <p>The following variables can be used either on the
1.10 hubertf 6497: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6498: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 6499: update</strong></span>:</p>
1.41 asau 6500: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6501: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
6502: <dd><p>Install target to recursively use for the
6503: updated package and the dependent packages.
6504: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 6505: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 6506: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 6507: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6508: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6509: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 6510: endless loop!</p></dd>
6511: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
6512: <dd><p>Don't clean up after updating. Useful if
6513: you want to leave the work sources of the updated
6514: packages around for inspection or other purposes.
6515: Be sure you eventually clean up the source tree
1.23 wiz 6516: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 6517: or you may run into troubles with old source code
6518: still lying around on your next
1.10 hubertf 6519: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 6520: update</strong></span>.</p></dd>
6521: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
6522: <dd><p>Deinstall each package before installing
6523: (making <code class="varname">DEPENDS_TARGET</code>). This
6524: may be necessary if the
1.23 wiz 6525: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 6526: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 6527: update</strong></span>.</p></dd>
6528: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
6529: <dd><p>Allows you to disable recursion and hardcode
6530: the target for packages. The default is
1.23 wiz 6531: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 6532: facilitating a recursive update of prerequisite
6533: packages. Only set
6534: <code class="varname">DEPENDS_TARGET</code> if you want to
6535: disable recursive updates. Use
6536: <code class="varname">UPDATE_TARGET</code> instead to just
6537: set a specific target for each package to be
1.10 hubertf 6538: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 6539: (see above).</p></dd>
6540: </dl></div>
6541: </dd>
6542: <dt><span class="term">clean-update</span></dt>
6543: <dd>
6544: <p>Clean the source tree for all packages that would
1.10 hubertf 6545: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 6546: from the current directory. This target should not be
6547: used if the current package (or any of its depending
6548: packages) have already been de-installed (e.g., after
1.10 hubertf 6549: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 6550: some packages you intended to update. As a rule of
6551: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 6552: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 6553: and only if you have a dirty package tree (e.g., if you
6554: used <code class="varname">NOCLEAN</code>).</p>
6555: <p>If you are unsure about whether your tree is
1.10 hubertf 6556: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 6557: clean</strong></span> at the top of the tree, or use the
6558: following sequence of commands from the directory of the
6559: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 6560: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 6561: time, otherwise you lose all the packages you wanted to
6562: update!):</p>
6563: <pre class="screen">
6564: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
6565: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
6566: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6567: </pre>
6568: <p>The following variables can be used either on the
1.10 hubertf 6569: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6570: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 6571: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6572: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 6573: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 6574: reconstruct the list of directories to update for
1.10 hubertf 6575: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 6576: update</strong></span> successfully installed all
6577: packages you wanted to update. Normally, this is
1.10 hubertf 6578: done automatically on <span class="command"><strong>make
1.1 dsieger 6579: update</strong></span>, but may have been suppressed by
6580: the <code class="varname">NOCLEAN</code> variable (see
6581: above).</p></dd>
6582: </dl></div>
6583: </dd>
6584: <dt><span class="term">replace</span></dt>
6585: <dd>
6586: <p>Update the installation of the current package. This
6587: differs from update in that it does not replace dependent
1.137 leot 6588: 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 6589: target to work.</p>
6590: <p><span class="emphasis"><em>Be careful when using this
6591: target!</em></span> There are no guarantees that dependent
6592: packages will still work, in particular they will most
1.10 hubertf 6593: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 6594: library package whose shared library major version changed
6595: between your installed version and the new one. For this
6596: reason, this target is not officially supported and only
6597: recommended for advanced users.</p>
6598: </dd>
6599: <dt><span class="term">info</span></dt>
1.157 leot 6600: <dd><p>This target invokes <a class="citerefentry" href="http://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 6601: package. You can use this to check which version of a
6602: package is installed.</p></dd>
6603: <dt><span class="term">index</span></dt>
6604: <dd>
6605: <p>This is a top-level command, i.e. it should be used in
6606: the <code class="filename">pkgsrc</code> directory. It creates a
6607: database of all packages in the local pkgsrc tree, including
6608: dependencies, comment, maintainer, and some other useful
6609: information. Individual entries are created by running
1.10 hubertf 6610: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 6611: directories. This index file is saved as
6612: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 6613: verbose format by running <span class="command"><strong>make
1.1 dsieger 6614: print-index</strong></span>. You can search in it with
1.10 hubertf 6615: <span class="command"><strong>make search
1.1 dsieger 6616: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6617: extract a list of all packages that depend on a particular
1.10 hubertf 6618: one by running <span class="command"><strong>make show-deps
1.1 dsieger 6619: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6620: <p>Running this command takes a very long time, some
6621: hours even on fast machines!</p>
6622: </dd>
6623: <dt><span class="term">readme</span></dt>
6624: <dd>
6625: <p>This target generates a
6626: <code class="filename">README.html</code> file, which can be
1.137 leot 6627: 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 6628: contain references to any packages which are in the
6629: <code class="varname">PACKAGES</code> directory on the local
6630: host. The generated files can be made to refer to URLs
6631: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6632: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6633: wanted to generate <code class="filename">README.html</code>
6634: files which pointed to binary packages on the local
6635: machine, in the directory
6636: <code class="filename">/usr/packages</code>, set
6637: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6638: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6639: <code class="varname">${PACKAGES}</code> directory and its
6640: subdirectories will be searched for all the binary
6641: packages.</p>
6642: <p>The target can be run at the toplevel or in category
6643: directories, in which case it descends recursively.</p>
6644: </dd>
6645: <dt><span class="term">readme-all</span></dt>
6646: <dd><p>This is a top-level command, run it in
6647: <code class="filename">pkgsrc</code>. Use this target to create a
6648: file <code class="filename">README-all.html</code> which contains a
6649: list of all packages currently available in the NetBSD
6650: Packages Collection, together with the category they belong
6651: to and a short description. This file is compiled from the
6652: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 6653: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 6654: readme</strong></span>.</p></dd>
6655: <dt><span class="term">cdrom-readme</span></dt>
6656: <dd><p>This is very much the same as the
1.23 wiz 6657: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 6658: used when generating a pkgsrc tree to be written to a
6659: CD-ROM. This target also produces
6660: <code class="filename">README.html</code> files, and can be made
6661: to refer to URLs based on
6662: <code class="varname">CDROM_PKG_URL_HOST</code> and
6663: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
6664: <dt><span class="term">show-distfiles</span></dt>
6665: <dd><p>This target shows which distfiles and patchfiles
6666: are needed to build the package
6667: (<code class="varname">ALLFILES</code>, which contains all
6668: <code class="varname">DISTFILES</code> and
6669: <code class="varname">PATCHFILES</code>, but not
6670: <code class="filename">patches/*</code>).</p></dd>
6671: <dt><span class="term">show-downlevel</span></dt>
6672: <dd><p>This target shows nothing if the package is not
6673: installed. If a version of this package is installed,
6674: but is not the version provided in this version of
6675: pkgsrc, then a warning message is displayed. This target
6676: can be used to show which of your installed packages are
6677: downlevel, and so the old versions can be deleted, and
6678: the current ones added.</p></dd>
6679: <dt><span class="term">show-pkgsrc-dir</span></dt>
6680: <dd><p>This target shows the directory in the pkgsrc
6681: hierarchy from which the package can be built and
6682: installed. This may not be the same directory as the one
6683: from which the package was installed. This target is
6684: intended to be used by people who may wish to upgrade
6685: many packages on a single host, and can be invoked from
6686: the top-level pkgsrc Makefile by using the
1.23 wiz 6687: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 6688: <dt><span class="term">show-installed-depends</span></dt>
6689: <dd><p>This target shows which installed packages match
6690: the current package's <code class="varname">DEPENDS</code>. Useful
6691: if out of date dependencies are causing build
6692: problems.</p></dd>
1.95 wiz 6693: <dt><span class="term">print-build-depends-list</span></dt>
6694: <dd><p>This target shows the list of packages that the current package
6695: depends on for building.</p></dd>
6696: <dt><span class="term">print-run-depends-list</span></dt>
6697: <dd><p>This target shows the list of packages that the current package
6698: depends on for running.</p></dd>
1.1 dsieger 6699: <dt><span class="term">check-shlibs</span></dt>
6700: <dd><p>After a package is installed, check all its
6701: binaries and (on ELF platforms) shared libraries to see
6702: if they find the shared libs they need. Run by default
1.10 hubertf 6703: 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 6704: <dt><span class="term">print-PLIST</span></dt>
6705: <dd>
1.23 wiz 6706: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 6707: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 6708: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 6709: -newer work/.extract_done</strong></span>. An attempt is made
6710: to care for shared libs etc., but it is
6711: <span class="emphasis"><em>strongly</em></span> recommended to review the
6712: result before putting it into
6713: <code class="filename">PLIST</code>. On upgrades, it's useful to
6714: diff the output of this command against an already
6715: existing <code class="filename">PLIST</code> file.</p>
1.157 leot 6716: <p>If the package installs files via <a class="citerefentry" href="http://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 6717: other methods that don't update file access times, be
6718: sure to add these files manually to your
1.23 wiz 6719: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6720: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 6721: them!</p>
1.154 rillig 6722: <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 6723: information on this target.</p>
6724: </dd>
6725: <dt><span class="term">bulk-package</span></dt>
6726: <dd>
6727: <p>Used to do bulk builds. If an appropriate binary
6728: package already exists, no action is taken. If not, this
6729: target will compile, install and package it (and its
6730: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.154 rillig 6731: 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 6732: builds)</i></a>).
1.1 dsieger 6733: After creating the binary package, the sources, the
6734: just-installed package and its required packages are
6735: removed, preserving free disk space.</p>
6736: <p><span class="emphasis"><em>Beware that this target may deinstall
6737: all packages installed on a system!</em></span></p>
6738: </dd>
6739: <dt><span class="term">bulk-install</span></dt>
6740: <dd>
6741: <p>Used during bulk-installs to install required
6742: packages. If an up-to-date binary package is available,
1.157 leot 6743: it will be installed via <a class="citerefentry" href="http://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 6744: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 6745: but the installed binary won't be removed.</p>
6746: <p>A binary package is considered
1.23 wiz 6747: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.157 leot 6748: <a class="citerefentry" href="http://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 6749: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6750: <li class="listitem"><p>None of the package's files
1.1 dsieger 6751: (<code class="filename">Makefile</code>, ...) were modified
6752: since it was built.</p></li>
1.23 wiz 6753: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 6754: packages were modified since it was built.</p></li>
6755: </ul></div>
6756: <p><span class="emphasis"><em>Beware that this target may deinstall
6757: all packages installed on a system!</em></span></p>
6758: </dd>
6759: </dl></div>
6760: </div>
6761: </div>
1.41 asau 6762: <div class="chapter">
1.1 dsieger 6763: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 6764: <a name="tools"></a>Chapter 20. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6765: <div class="toc">
6766: <p><b>Table of Contents</b></p>
1.100 leot 6767: <dl class="toc">
1.154 rillig 6768: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
6769: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
6770: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6771: </dl>
6772: </div>
6773: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6774: by pkgsrc and also for individual packages to define what commands
1.156 leot 6775: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
1.1 dsieger 6776: or for later run-time of an installed packaged (such as
6777: <code class="varname">DEPENDS</code>).
6778: If the native system provides an adequate tool, then in many cases, a pkgsrc
6779: package will not be used.</p>
6780: <p>When building a package, the replacement tools are
6781: made available in a directory (as symlinks or wrapper scripts)
6782: that is early in the executable search path. Just like the buildlink
6783: system, this helps with consistent builds.</p>
6784: <p>A tool may be needed to help build a specific package. For example,
6785: perl, GNU make (gmake) or yacc may be needed.</p>
6786: <p>Also a tool may be needed, for example, because the native system's supplied
6787: tool may be inefficient for building a package with pkgsrc.
6788: For example, a package may need GNU awk, bison (instead of
6789: yacc) or a better sed.</p>
6790: <p>The tools used by a package can be listed by running
1.10 hubertf 6791: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6792: <div class="sect1">
1.1 dsieger 6793: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6794: <a name="pkgsrc-tools"></a>20.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 6795: <p>The default set of tools used by pkgsrc is defined in
6796: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 6797: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6798: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 6799: These can be seen by running:
1.10 hubertf 6800: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 6801: <p>If a package needs a specific program to build
6802: then the <code class="varname">USE_TOOLS</code> variable can be used
6803: to define the tools needed.</p>
6804: </div>
1.41 asau 6805: <div class="sect1">
1.1 dsieger 6806: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6807: <a name="package-tools"></a>20.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 6808: <p>In the following examples, the :run means that it is needed at
6809: run-time (and becomes a DEPENDS).
1.1 dsieger 6810: The default is a build dependency which can be set with
6811: :build. (So in this example, it is the same as gmake:build
6812: and pkg-config:build.)</p>
6813: <pre class="programlisting">
6814: USE_TOOLS+= gmake perl:run pkg-config
6815: </pre>
6816: <p>When using the tools framework, a
6817: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6818: which contains the full path to the appropriate tool. For example,
1.23 wiz 6819: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 6820: on Linux systems.</p>
6821: <p>If you always need a pkgsrc version of the
6822: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6823: </p>
6824: </div>
1.41 asau 6825: <div class="sect1">
1.1 dsieger 6826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6827: <a name="platform-tools"></a>20.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 6828: <p>When improving or porting pkgsrc to a new platform, have a look
6829: at (or create) the corresponding platform specific make file fragment under
6830: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6831: the name of the common tools. For example:</p>
6832: <pre class="programlisting">
6833: .if exists(/usr/bin/bzcat)
6834: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6835: .elif exists(/usr/bin/bzip2)
6836: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6837: .endif
6838:
6839: TOOLS_PLATFORM.true?= true # shell builtin
6840: </pre>
6841: </div>
6842: </div>
1.41 asau 6843: <div class="chapter">
1.1 dsieger 6844: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 6845: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 6846: <div class="toc">
6847: <p><b>Table of Contents</b></p>
1.100 leot 6848: <dl class="toc">
1.154 rillig 6849: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 6850: <dd><dl>
1.154 rillig 6851: <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>
6852: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
6853: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
6854: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
6855: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
6856: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
6857: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
6858: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
6859: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
6860: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
6861: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
6862: </dl></dd>
6863: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6864: <dd><dl>
6865: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
6866: <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>
6867: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
6868: </dl></dd>
6869: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6870: <dd><dl>
6871: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
6872: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
6873: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
6874: </dl></dd>
6875: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
6876: <dd><dl>
6877: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
6878: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
6879: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
6880: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
6881: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
6882: </dl></dd>
6883: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6884: <dd><dl>
6885: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
6886: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
6887: <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>
6888: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
6889: </dl></dd>
6890: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6891: <dd><dl>
6892: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
6893: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
6894: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
6895: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
6896: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
6897: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
6898: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
6899: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
6900: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
6901: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
6902: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
6903: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
6904: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
6905: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
6906: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
6907: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
6908: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
6909: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 6910: emulation</a></span></dt>
1.154 rillig 6911: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
6912: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 6913: </dl></dd>
1.154 rillig 6914: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 6915: </dl>
6916: </div>
1.41 asau 6917: <div class="sect1">
1.1 dsieger 6918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6919: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 6920: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 6921: different platforms. As a result, it is important to ensure,
6922: where possible, that packages in pkgsrc are portable. This
6923: chapter mentions some particular details you should pay
6924: attention to while working on pkgsrc.</p>
1.41 asau 6925: <div class="sect2">
1.1 dsieger 6926: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 6927: <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 6928: </h3></div></div></div>
6929: <p>The pkgsrc user can configure pkgsrc by overriding several
6930: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 6931: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 6932: want to use those variables in the preprocessor directives of
1.157 leot 6933: <a class="citerefentry" href="http://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 6934: <code class="literal">.for</code>), you need to include the file
6935: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
6936: loads the user preferences.</p>
6937: <p>But note that some variables may not be completely defined
6938: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
6939: included, as they may contain references to variables that are
1.108 rillig 6940: not yet defined. In shell commands (the lines in
6941: <code class="filename">Makefile</code> that are indented with a tab) this
6942: is no problem, since variables are only expanded when they are
6943: used. But in the preprocessor directives mentioned above and in
6944: dependency lines (of the form <code class="literal">target:
1.1 dsieger 6945: dependencies</code>) the variables are expanded at load
6946: time.</p>
1.41 asau 6947: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 6948: <h3 class="title">Note</h3>
1.108 rillig 6949: <p>To check whether a variable can be used at load time,
6950: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 6951: </div>
6952: </div>
1.41 asau 6953: <div class="sect2">
1.1 dsieger 6954: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 6955: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 6956: <p>Occasionally, packages require interaction from the user,
6957: and this can be in a number of ways:</p>
1.41 asau 6958: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6959: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 6960: interaction such as entering username/password or accepting a
6961: license on a web page.</p></li>
1.23 wiz 6962: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 6963: passwords.</p></li>
1.23 wiz 6964: <li class="listitem"><p>help to configure the package before it is built</p></li>
6965: <li class="listitem"><p>help during the build process</p></li>
6966: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 6967: </ul></div>
1.108 rillig 6968: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
6969: variable to define which stages need interaction. This should be
6970: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 6971: <pre class="programlisting">
6972: INTERACTIVE_STAGE= configure install
1.111 sevan 6973: </pre>
1.1 dsieger 6974: <p>The user can then decide to skip this package by setting the
1.108 rillig 6975: <code class="varname">BATCH</code> variable. Packages that require interaction
6976: are also excluded from bulk builds.</p>
1.1 dsieger 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="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 6981: <p>Authors of software can choose the licence under which software
6982: can be copied. The Free Software Foundation has declared some
6983: licenses "Free", and the Open Source Initiative has a definition of
6984: "Open Source".</p>
6985: <p>By default, pkgsrc allows packages with Free or Open Source
6986: licenses to be built. To allow packages with other licenses to be
6987: built as well, the pkgsrc user needs to add these licenses to the
6988: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
6989: that this variable only affects which packages may be
6990: <span class="emphasis"><em>built</em></span>, while the license terms often also
6991: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 6992: <p>One might want to only install packages with a BSD license,
1.108 rillig 6993: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 6994: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 6995: user can override the default by setting the
6996: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 6997: of "+=". The licenses accepted by default are defined in the
6998: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
6999: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7000: <p>The license tag mechanism is intended to address
7001: copyright-related issues surrounding building, installing and
7002: using a package, and not to address redistribution issues (see
7003: <code class="varname">RESTRICTED</code> and
1.111 sevan 7004: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7005: Packages with redistribution restrictions should set these
7006: tags.</p>
1.1 dsieger 7007: <p>Denoting that a package may be copied according to a
7008: particular license is done by placing the license in
7009: <code class="filename">pkgsrc/licenses</code> and setting the
7010: <code class="varname">LICENSE</code> variable to a string identifying the
1.137 leot 7011: 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 7012: <pre class="programlisting">
7013: LICENSE= xv-license
1.111 sevan 7014: </pre>
1.1 dsieger 7015: <p>When trying to build, the user will get a notice that the
7016: package is covered by a license which has not been placed in the
7017: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7018: <pre class="programlisting">
7019: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7020: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7021: ===> To view the license, enter "/usr/bin/make show-license".
7022: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7023: ===> ACCEPTABLE_LICENSES+=xv-license
7024: *** Error code 1
1.111 sevan 7025: </pre>
1.10 hubertf 7026: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7027: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7028: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7029: convey to pkgsrc that it should not in the future fail because of
7030: that license:</p>
7031: <pre class="programlisting">
7032: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7033: </pre>
7034: <p>The use of <code class="varname">LICENSE=shareware</code>,
7035: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7036: is deprecated because it does not crisply refer to a particular
7037: license text. Another problem with such usage is that it does not
7038: enable a user to tell pkgsrc to proceed for a single package
7039: without also telling pkgsrc to proceed for all packages with that
7040: tag.</p>
7041: <div class="sect3">
7042: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7043: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7044: <p>When adding a package with a new license, the following steps
7045: are required:</p>
7046: <div class="orderedlist"><ol class="orderedlist" type="1">
7047: <li class="listitem">
1.111 sevan 7048: <p>Check whether the license qualifies as Free or Open
7049: Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
7050: and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
7051: Open Source Initiative</a>. If this is the case, the filename in
7052: <code class="filename">pkgsrc/licenses/</code> does not need the
7053: <code class="filename">-license</code> suffix, and the license name should be
7054: added to:</p>
1.48 rodent 7055: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7056: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7057: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
7058: </ul></div>
7059: </li>
7060: <li class="listitem"><p>The license text should be added to <code class="filename">pkgsrc/licenses</code> for displaying. A list of known licenses can be seen in this directory.</p></li>
7061: </ol></div>
1.111 sevan 7062: </div>
7063: <div class="sect3">
7064: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7065: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7066: <p>When the license changes (in a way other than formatting),
1.111 sevan 7067: make sure that the new license has a different name (e.g.,
1.1 dsieger 7068: append the version number if it exists, or the date). Just
7069: because a user told pkgsrc to build programs under a previous
7070: version of a license does not mean that pkgsrc should build
7071: programs under the new licenses. The higher-level point is that
7072: pkgsrc does not evaluate licenses for reasonableness; the only
7073: test is a mechanistic test of whether a particular text has been
1.111 sevan 7074: approved by either of two bodies (FSF or OSI).</p>
7075: </div>
1.1 dsieger 7076: </div>
1.41 asau 7077: <div class="sect2">
1.1 dsieger 7078: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7079: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7080: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7081: By declaring the restrictions, package tools can
1.1 dsieger 7082: automatically refrain from e.g. placing binary packages on FTP
7083: sites.</p>
1.111 sevan 7084: <p>There are four possible restrictions, which are
1.1 dsieger 7085: the cross product of sources (distfiles) and binaries not being
7086: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7087: language in any license, and because non-Free licenses tend to be
7088: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7089: CD-ROM.
7090:
7091: "FTP" means making the source or binary file available over the
7092: Internet at no charge.
7093:
7094: "CD-ROM" means making the source or binary available on some kind of
7095: media, together with other source and binary packages, which is sold
7096: for a distribution charge.
1.1 dsieger 7097: </p>
7098: <p>In order to encode these restrictions, the package system
7099: defines five make variables that can be set to note these
7100: restrictions:</p>
1.41 asau 7101: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7102: <li class="listitem">
1.1 dsieger 7103: <p><code class="varname">RESTRICTED</code></p>
7104: <p>This variable should be set whenever a restriction
7105: exists (regardless of its kind). Set this variable to a
7106: string containing the reason for the restriction. It should
7107: be understood that those wanting to understand the restriction
7108: will have to read the license, and perhaps seek advice of
7109: counsel.</p>
7110: </li>
1.23 wiz 7111: <li class="listitem">
1.1 dsieger 7112: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7113: <p>Binaries may not be placed on CD-ROM containing other
7114: binary packages, for which a distribution charge may be made.
7115: In this case, set this variable to
7116: <code class="varname">${RESTRICTED}</code>.</p>
7117: </li>
1.23 wiz 7118: <li class="listitem">
1.1 dsieger 7119: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7120: <p>Binaries may not made available on the Internet without
7121: charge. In this case, set this variable to
7122: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7123: binary packages will not be included on ftp.NetBSD.org.</p>
7124: </li>
1.23 wiz 7125: <li class="listitem">
1.1 dsieger 7126: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7127: <p>Distfiles may not be placed on CD-ROM, together with
7128: other distfiles, for which a fee may be charged. In this
7129: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7130: </p>
7131: </li>
1.23 wiz 7132: <li class="listitem">
1.1 dsieger 7133: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7134: <p>Distfiles may not made available via FTP at no charge.
7135: In this case, set this variable to
7136: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7137: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7138: </li>
7139: </ul></div>
1.111 sevan 7140: <p>Please note that packages will be removed from pkgsrc when the
7141: distfiles are not distributable and cannot be obtained for a period
7142: of one full quarter branch. Packages with manual/interactive fetch
7143: must have a maintainer and it is his/her responsibility to ensure
7144: this.</p>
1.1 dsieger 7145: </div>
1.41 asau 7146: <div class="sect2">
1.1 dsieger 7147: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7148: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.1 dsieger 7149: <p>Your package may depend on some other package being present
7150: - and there are various ways of expressing this dependency.
7151: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
1.156 leot 7152: <code class="varname">DEPENDS</code> and
7153: <code class="varname">TOOL_DEPENDS</code> definitions, the
1.1 dsieger 7154: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7155: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7156: to handle dependencies, and which uses the variables named above.
1.154 rillig 7157: 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 7158: <p>The basic difference between the two variables is as
7159: follows: The <code class="varname">DEPENDS</code> definition registers
7160: that pre-requisite in the binary package so it will be pulled in
7161: when the binary package is later installed, whilst the
1.156 leot 7162: <code class="varname">BUILD_DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
7163: definitions does not, marking a dependency that is only needed for
7164: building the package.</p>
1.1 dsieger 7165: <p>This means that if you only need a package present whilst
7166: you are building, it should be noted as a
1.156 leot 7167: <code class="varname">TOOL_DEPENDS</code> or
7168: <code class="varname">BUILD_DEPENDS</code>. When cross-compiling,
7169: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7170: packages, i.e. packages for the architecture where the package
7171: is built;
7172: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
7173: packages, i.e. packages for the architecture for which the package
7174: is built.</p>
7175: <p>The format for <code class="varname">BUILD_DEPENDS</code>,
7176: <code class="varname">DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
7177: definition is:</p>
1.1 dsieger 7178: <pre class="programlisting">
7179: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7180: </pre>
1.23 wiz 7181: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7182: may include any of the wildcard version numbers recognized by
1.157 leot 7183: <a class="citerefentry" href="http://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 7184: <div class="orderedlist"><ol class="orderedlist" type="1">
7185: <li class="listitem">
1.1 dsieger 7186: <p>If your package needs another package's binaries or
1.54 wiz 7187: libraries to build and run, and if that package has a
1.1 dsieger 7188: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7189: <pre class="programlisting">
7190: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7191: </pre>
1.1 dsieger 7192: </li>
1.23 wiz 7193: <li class="listitem">
1.54 wiz 7194: <p>If your package needs another package's binaries or
7195: libraries only for building, and if that package has a
7196: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7197: <pre class="programlisting">
7198: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7199: </pre>
1.54 wiz 7200: <p>but set
7201: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7202: to make it a build dependency only. This case is rather
7203: rare.</p>
7204: </li>
7205: <li class="listitem">
1.25 spz 7206: <p>If your package needs binaries from another package to build,
1.156 leot 7207: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7208: <pre class="programlisting">
1.156 leot 7209: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7210: </pre>
1.1 dsieger 7211: </li>
1.156 leot 7212: <li class="listitem"><p>If your package needs static libraries to link against, header
7213: files to include, etc. from another package to build,
7214: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7215: <li class="listitem"><p>If your package needs a library with which to link and
7216: there is no <code class="filename">buildlink3.mk</code> file
7217: available, create one. Using
7218: <code class="varname">DEPENDS</code> won't be sufficient because the
7219: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7220: <li class="listitem">
1.25 spz 7221: <p>If your package needs some executable to be able to run
7222: correctly and if there's no
7223: <code class="filename">buildlink3.mk</code> file, this is specified
7224: using the <code class="varname">DEPENDS</code> variable. The
1.137 leot 7225: <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 7226: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7227: when it runs, and that is specified:</p>
1.1 dsieger 7228: <pre class="programlisting">
1.129 wiz 7229: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7230: </pre>
1.25 spz 7231: </li>
7232: <li class="listitem">
7233: <p>You can use wildcards in package dependencies. Note that
7234: such wildcard dependencies are retained when creating binary
7235: packages. The dependency is checked when installing the binary
7236: package and any package which matches the pattern will be
7237: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7238: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7239: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7240: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7241: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7242: <p>Wildcards can also be used to specify that a package
7243: will only build against a certain minimum version of a
7244: pre-requisite:</p>
7245: <pre class="programlisting">
1.25 spz 7246: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7247: </pre>
1.25 spz 7248: <p>This means that the package will build using version 6.0
7249: of ImageMagick or newer. Such a dependency may be warranted
7250: if, for example, the command line options of an executable
7251: have changed.</p>
7252: <p>If you need to depend on minimum versions of libraries,
7253: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7254: <p>For security fixes, please update the package
1.154 rillig 7255: 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 7256: information.</p>
7257: </li>
7258: </ol></div>
7259: <p>If your package needs files from another package to build,
7260: add the relevant distribution files to
7261: <code class="varname">DISTFILES</code>, so they will be extracted
1.137 leot 7262: 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 7263: (It relies on the jpeg sources being present in source form
7264: during the build.)</p>
7265: </div>
1.41 asau 7266: <div class="sect2">
1.1 dsieger 7267: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7268: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7269: <p>Your package may conflict with other packages a user might
7270: already have installed on his system, e.g. if your package
7271: installs the same set of files as another package in the pkgsrc
1.80 wiz 7272: tree or has the same <code class="varname">PKGNAME</code>.</p>
1.142 leot 7273: <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>
7274: 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>
7275: install the same shared library, thus you set in
7276: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7277: <pre class="programlisting">
7278: CONFLICTS= Xaw-Xpm-[0-9]*
7279: </pre>
7280: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7281: <pre class="programlisting">
7282: CONFLICTS= libXaw3d-[0-9]*
7283: </pre>
1.157 leot 7284: <p><a class="citerefentry" href="http://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 7285: that conflict with existing packages and abort. However, in many
7286: situations this is too late in the process. Binary package managers
7287: will not know about the conflict until they attempt to install the
7288: package after already downloading it and all its dependencies.
7289: Users may also waste time building a package and its dependencies
7290: only to find out at the end that it conflicts with another package
7291: they have installed.</p>
7292: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7293: should be added in all cases where it is known that packages conflict
7294: with each other. These <code class="varname">CONFLICTS</code> entries are
1.157 leot 7295: exported in <a class="citerefentry" href="http://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 7296: managers to inform users that packages cannot be installed onto
7297: the target system.</p>
1.1 dsieger 7298: </div>
1.41 asau 7299: <div class="sect2">
1.1 dsieger 7300: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7301: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7302: <p>There are several reasons why a package might be
7303: instructed to not build under certain circumstances. If the
7304: package builds and runs on most platforms, the exceptions
1.83 dholland 7305: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7306: the package builds and runs on a small handful of platforms,
7307: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7308: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7309: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7310: (OS-version-platform) that can use glob-style
7311: wildcards.</p>
7312: <p>If a package is not appropriate for some platforms (as
1.114 maya 7313: opposed to merely broken), a different set of variables should be
1.83 dholland 7314: used as this affects failure reporting and statistics.
7315: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7316: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7317: the package is appropriate for only a small handful of platforms
7318: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7319: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7320: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7321: (OS-version-platform) that can use glob-style
7322: wildcards.</p>
7323: <p>Some packages are tightly bound to a specific version of an
1.137 leot 7324: 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 7325: backwards compatible with other versions of the OS, and should be
7326: uploaded to a version specific directory on the FTP server. Mark
7327: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7328: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7329: the package system internals, but may be used in the
7330: future.</p>
7331: <p>If the package should be skipped (for example, because it
7332: provides functionality already provided by the system), set
7333: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7334: the package should fail because some preconditions are not met,
7335: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7336: message.</p>
7337: </div>
1.41 asau 7338: <div class="sect2">
1.1 dsieger 7339: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7340: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7341: <p>To ensure that a package may not be deleted, once it has been
7342: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7343: be set in the package Makefile. This will be carried into any
7344: binary package that is made from this pkgsrc entry. A
1.23 wiz 7345: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.157 leot 7346: not be deleted using <a class="citerefentry" href="http://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 7347: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7348: </div>
1.41 asau 7349: <div class="sect2">
1.1 dsieger 7350: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7351: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7352: <p>When a vulnerability is found, this should be noted in
7353: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7354: and after committing that file, ask pkgsrc-security@NetBSD.org to
7355: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7356: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7357: <code class="varname">PKGREVISION</code> should be increased (this is of
7358: course not necessary if the problem is fixed by using a newer
7359: release of the software), and the pattern in the
7360: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7361: <p>Also, if the fix should be applied to the stable pkgsrc
7362: branch, be sure to submit a pullup request!</p>
7363: <p>Binary packages already on ftp.NetBSD.org will be handled
7364: semi-automatically by a weekly cron job.</p>
7365: </div>
1.41 asau 7366: <div class="sect2">
1.1 dsieger 7367: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7368: <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 7369: <p>When making fixes to an existing package it can be useful
7370: to change the version number in <code class="varname">PKGNAME</code>. To
7371: avoid conflicting with future versions by the original author, a
1.23 wiz 7372: <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 7373: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7374: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7375: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7376: <pre class="programlisting">
7377: DISTNAME= foo-17.42
7378: PKGREVISION= 9
1.111 sevan 7379: </pre>
1.1 dsieger 7380: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7381: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7382: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7383: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7384: <code class="varname">PKGNAME_NOREV</code>.</p>
7385: <p>When a new release of the package is released, the
7386: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7387: minor release of the above package, things should be like:</p>
7388: <pre class="programlisting">
7389: DISTNAME= foo-17.43
1.111 sevan 7390: </pre>
1.1 dsieger 7391: <p><code class="varname">PKGREVISION</code> should be incremented for any
7392: non-trivial change in the resulting binary package. Without a
7393: <code class="varname">PKGREVISION</code> bump, someone with the previous
7394: version installed has no way of knowing that their package is out
7395: of date. Thus, changes without increasing
7396: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7397: trivial that no reasonable person would want to upgrade", and this
7398: is the rough test for when increasing
7399: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7400: changes that do not merit increasing
7401: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7402: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7403: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 7404: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 7405: or comments in Makefile.</p></li>
1.23 wiz 7406: <li class="listitem"><p>
1.1 dsieger 7407: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 7408: <li class="listitem"><p>
1.1 dsieger 7409: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 7410: <li class="listitem"><p>
1.1 dsieger 7411: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7412: </ul></div>
7413: <p>Examples of changes that do merit an increase to
7414: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7415: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7416: <li class="listitem"><p>
1.1 dsieger 7417: Security fixes</p></li>
1.23 wiz 7418: <li class="listitem"><p>
1.1 dsieger 7419: Changes or additions to a patch file</p></li>
1.23 wiz 7420: <li class="listitem"><p>
1.1 dsieger 7421: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 7422: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 7423: </ul></div>
7424: <p>PKGREVISION must also be incremented when dependencies have ABI
7425: changes.</p>
7426: </div>
1.41 asau 7427: <div class="sect2">
1.1 dsieger 7428: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7429: <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 7430: <p>When you want to replace the same text in multiple files
7431: or when the replacement text varies, patches alone cannot help.
7432: This is where the SUBST framework comes in. It provides an
7433: easy-to-use interface for replacing text in files.
7434: Example:</p>
7435: <pre class="programlisting">
7436: SUBST_CLASSES+= fix-paths
7437: SUBST_STAGE.fix-paths= pre-configure
7438: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7439: SUBST_FILES.fix-paths= src/*.c
7440: SUBST_FILES.fix-paths+= scripts/*.sh
7441: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7442: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.111 sevan 7443: </pre>
1.1 dsieger 7444: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
7445: that are used to identify the different SUBST blocks that are
7446: defined. The SUBST framework is heavily used by pkgsrc, so it is
7447: important to always use the <code class="literal">+=</code> operator with
7448: this variable. Otherwise some substitutions may be
7449: skipped.</p>
7450: <p>The remaining variables of each SUBST block are
7451: parameterized with the identifier from the first line
7452: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7453: parameters to a function call.</p>
7454: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
7455: which the replacement will take place. All combinations of
7456: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7457: <code class="literal">post-</code> together with a phase name are
7458: possible, though only few are actually used. Most commonly used
7459: are <code class="literal">post-patch</code> and
7460: <code class="literal">pre-configure</code>. Of these two,
7461: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 7462: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 7463: have the state after applying the patches but before making any
7464: other changes. This is especially useful when you are debugging
7465: a package in order to create new patches for it. Similarly,
7466: <code class="literal">post-build</code> is preferred over
7467: <code class="literal">pre-install</code>, because the install phase should
7468: generally be kept as simple as possible. When you use
7469: <code class="literal">post-build</code>, you have the same files in the
7470: working directory that will be installed later, so you can check
7471: if the substitution has succeeded.</p>
7472: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
7473: that is printed just before the substitution is done.</p>
7474: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
7475: globbing patterns that specifies the files in which the
7476: substitution will take place. The patterns are interpreted
7477: relatively to the <code class="varname">WRKSRC</code> directory.</p>
7478: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.157 leot 7479: <a class="citerefentry" href="http://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 7480: command should be prefixed with <code class="literal">-e</code>, so that
7481: all SUBST blocks look uniform.</p>
7482: <p>There are some more variables, but they are so seldomly
7483: used that they are only documented in the
7484: <code class="filename">mk/subst.mk</code> file.</p>
7485: </div>
7486: </div>
1.41 asau 7487: <div class="sect1">
1.1 dsieger 7488: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7489: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 7490: <div class="sect2">
1.1 dsieger 7491: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7492: <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 7493: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 7494: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 7495: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7496: with the name of each file to download as an argument, expecting
7497: it to output the URL of the directory from which to download
1.137 leot 7498: 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 7499: example of this usage.</p>
7500: <p>If the download can't be automated, because the user must
7501: submit personal information to apply for a password, or must pay
7502: for the source, or whatever, you can set
7503: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7504: displayed to the user before aborting the build. Example:</p>
7505: <pre class="programlisting">
7506: FETCH_MESSAGE= "Please download the files"
7507: FETCH_MESSAGE+= " "${DISTFILES:Q}
7508: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 7509: </pre>
1.1 dsieger 7510: </div>
1.41 asau 7511: <div class="sect2">
1.1 dsieger 7512: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7513: <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 7514: <p>Sometimes authors of a software package make some
7515: modifications after the software was released, and they put up a
7516: new distfile without changing the package's version number. If a
7517: package is already in pkgsrc at that time, the checksum will
7518: no longer match. The contents of the new distfile should be
7519: compared against the old one before changing anything, to make
7520: sure the distfile was really updated on purpose, and that
7521: no trojan horse or so crept in.
7522: Please mention that the distfiles were compared and what was found
1.53 rodent 7523: in your commit message.</p>
1.109 wiz 7524: <p>Then, the correct way to work around this is to set
7525: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7526: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7527: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7528: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 7529: <code class="varname">PATCHFILES</code> for this package will be put in that
1.154 rillig 7530: 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 7531: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 7532: including the <code class="filename">nbX</code> suffix) or a date stamp can
7533: be appended, like
7534: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.53 rodent 7535: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's name does not contain a version and the distfile is apt to change. In cases where the likelihood of this is very small, <code class="varname">DIST_SUBDIR</code> might not be required. Additionally, <code class="varname">DIST_SUBDIR</code> must not be removed unless the distfile name changes, even if a package is being moved or renamed.</p>
7536: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 7537: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7538: path in the filenames.
1.53 rodent 7539: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 7540: Furthermore, a mail to the package's authors seems appropriate
7541: telling them that changing distfiles after releases without
7542: changing the file names is not good practice.</p>
7543: </div>
1.88 tnn 7544: <div class="sect2">
7545: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7546: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.90 tnn 7547: <p>Helper methods exist for packages hosted on github.com which will often have distfile names that clash with other packages, for example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes from below:
7548: </p>
1.88 tnn 7549: <div class="sect3">
7550: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7551: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.88 tnn 7552: <p>
7553: If your distfile URL looks similar to <code class="literal">http://github.com/username/exampleproject/archive/v1.0.zip</code>, then you are packaging a tagged release.
7554: </p>
7555: <pre class="programlisting">
7556: DISTNAME= exampleproject-1.0
1.90 tnn 7557: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7558: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7559: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 7560: EXTRACT_SUFX= .zip
7561: </pre>
7562: </div>
7563: <div class="sect3">
7564: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7565: <a name="build.fetch.github.commit"></a>21.2.3.2. Fetch based on a specific commit</h4></div></div></div>
1.88 tnn 7566: <p>
7567: If your distfile URL looks similar to <code class="literal">http://github.com/example/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz</code>, then you are packaging a specific commit not tied to a release.
7568: </p>
7569: <pre class="programlisting">
7570: DISTNAME= example-1.0
1.107 jnemeth 7571: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 7572: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7573: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 7574: </pre>
1.88 tnn 7575: </div>
7576: <div class="sect3">
7577: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7578: <a name="build.fetch.github.release"></a>21.2.3.3. Fetch based on release</h4></div></div></div>
1.88 tnn 7579: <p>
7580: If your distfile URL looks similar to <code class="literal">http://github.com/username/exampleproject/releases/download/rel-1.6/offensive-1.6.zip</code>, then you are packaging a release.
7581: </p>
7582: <pre class="programlisting">
7583: DISTNAME= offensive-1.6
1.90 tnn 7584: PKGNAME= ${DISTNAME:S/offensive/proper/}
7585: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7586: GITHUB_PROJECT= exampleproject
7587: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
7588: EXTRACT_SUFX= .zip
1.111 sevan 7589: </pre>
1.88 tnn 7590: </div>
7591: </div>
1.1 dsieger 7592: </div>
1.41 asau 7593: <div class="sect1">
1.1 dsieger 7594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7595: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 7596: <div class="sect2">
1.1 dsieger 7597: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7598: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 7599: <p>pkgsrc supports many different machines, with different
7600: object formats like a.out and ELF, and varying abilities to do
7601: shared library and dynamic loading at all. To accompany this,
7602: varying commands and options have to be passed to the
7603: compiler, linker, etc. to get the Right Thing, which can be
7604: pretty annoying especially if you don't have all the machines
7605: at your hand to test things. The
1.137 leot 7606: <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 7607: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 7608: both static and dynamic libraries from a set of source files,
7609: thus being platform-independent.</p>
7610: <p>Here's how to use libtool in a package in seven simple
7611: steps:</p>
1.23 wiz 7612: <div class="orderedlist"><ol class="orderedlist" type="1">
7613: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 7614: Makefile.</p></li>
1.23 wiz 7615: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
7616: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 7617: add it to the definition of <code class="varname">CC</code>, if only
7618: libraries are being built in a given Makefile. This one command
7619: will build both PIC and non-PIC library objects, so you need not
7620: have separate shared and non-shared library rules.</p></li>
1.23 wiz 7621: <li class="listitem">
1.1 dsieger 7622: <p>For the linking of the library, remove any
1.23 wiz 7623: <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
7624: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 7625: <pre class="programlisting">
7626: ${LIBTOOL} --mode=link \
7627: ${CC} -o ${.TARGET:.a=.la} \
7628: ${OBJS:.o=.lo} \
7629: -rpath ${PREFIX}/lib \
7630: -version-info major:minor
1.111 sevan 7631: </pre>
1.1 dsieger 7632: <p>Note that the library is changed to have a
7633: <code class="filename">.la</code> extension, and the objects are
7634: changed to have a <code class="filename">.lo</code>
7635: extension. Change <code class="varname">OBJS</code> as
7636: necessary. This automatically creates all of the
7637: <code class="filename">.a</code>,
7638: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
7639: necessary) in the build directory. Be sure to include
1.23 wiz 7640: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 7641: minor are zero, as libtool will otherwise strip off the
7642: shared library version.</p>
7643: <p>From the libtool manual:</p>
7644: <pre class="programlisting">
7645: So, libtool library versions are described by three integers:
7646:
7647: CURRENT
7648: The most recent interface number that this library implements.
7649:
7650: REVISION
7651: The implementation number of the CURRENT interface.
7652:
7653: AGE
7654: The difference between the newest and oldest interfaces that
7655: this library implements. In other words, the library implements
7656: all the interface numbers in the range from number `CURRENT -
7657: AGE' to `CURRENT'.
7658:
7659: If two libraries have identical CURRENT and AGE numbers, then the
7660: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 7661: </pre>
1.23 wiz 7662: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 7663: different results for a.out and ELF (excluding symlinks)
7664: in only one case. An ELF library of the form
1.23 wiz 7665: <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 7666: will have a symlink of
1.23 wiz 7667: <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 7668: on an a.out platform. This is handled
7669: automatically.</p>
1.23 wiz 7670: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 7671: directory of the library being built.</p>
7672: <p>In the <code class="filename">PLIST</code>, include only the
7673: <code class="filename">.la</code> file, the other files will be
7674: added automatically.</p>
7675: </li>
1.23 wiz 7676: <li class="listitem">
1.1 dsieger 7677: <p>When linking shared object (<code class="filename">.so</code>)
1.157 leot 7678: files, i.e. files that are loaded via <a class="citerefentry" href="http://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 7679: shared libraries, use <span class="quote">“<span class="quote">-module
7680: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 7681: tacked on.</p>
7682: <p>The <code class="filename">PLIST</code> file gets the
7683: <code class="filename">foo.so</code> entry.</p>
7684: </li>
1.23 wiz 7685: <li class="listitem">
1.1 dsieger 7686: <p>When linking programs that depend on these libraries
7687: <span class="emphasis"><em>before</em></span> they are installed, preface
1.157 leot 7688: the <a class="citerefentry" href="http://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="http://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 7689: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 7690: libraries (static or shared), but please be aware that
7691: libtool will not allow you to specify a relative path in
1.23 wiz 7692: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 7693: expects you to change that argument to be the
7694: <code class="filename">.la</code> file. e.g.</p>
7695: <pre class="programlisting">
7696: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 7697: </pre>
1.1 dsieger 7698: <p>should be changed to:</p>
7699: <pre class="programlisting">
7700: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 7701: </pre>
1.1 dsieger 7702: <p>and it will do the right thing with the libraries.</p>
7703: </li>
1.23 wiz 7704: <li class="listitem">
1.157 leot 7705: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
7706: or <a class="citerefentry" href="http://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 7707: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 7708: <code class="filename">.la</code>. e.g.</p>
7709: <pre class="programlisting">
1.22 jakllsch 7710: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 7711: </pre>
1.1 dsieger 7712: <p>This will install the static <code class="filename">.a</code>,
7713: shared library, any needed symlinks, and run
1.157 leot 7714: <a class="citerefentry" href="http://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 7715: </li>
1.23 wiz 7716: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 7717: the <code class="filename">.la</code>
7718: file (this is a change from previous behaviour).</p></li>
7719: </ol></div>
7720: </div>
1.41 asau 7721: <div class="sect2">
1.1 dsieger 7722: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7723: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 7724: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
7725: package Makefile. This will override the package's own libtool
7726: in most cases. For older libtool using packages, libtool is
7727: made by ltconfig script during the do-configure step; you can
1.10 hubertf 7728: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 7729: configure; find work*/ -name libtool</strong></span>.</p>
7730: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
7731: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 7732: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
7733: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 7734: package's libtool script(s), set it as appropriate.</p>
7735: <p>If you do not need <code class="filename">*.a</code> static
7736: libraries built and installed, then use
7737: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
7738: <p>If your package makes use of the platform-independent library
7739: for loading dynamic shared objects, that comes with libtool
7740: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
7741: <p>Some packages use libtool incorrectly so that the package
7742: may not work or build in some circumstances. Some of the more
7743: common errors are:</p>
1.41 asau 7744: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7745: <li class="listitem">
1.1 dsieger 7746: <p>The inclusion of a shared object (-module) as a dependent library in an
7747: executable or library. This in itself isn't a problem if one of two things
7748: has been done:</p>
1.23 wiz 7749: <div class="orderedlist"><ol class="orderedlist" type="1">
7750: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 7751: <code class="filename">libfoo.la</code>, not
7752: <code class="filename">foo.la</code></p></li>
1.23 wiz 7753: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 7754: </ol></div>
7755: </li>
1.23 wiz 7756: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 7757: The function lt_dlinit() should be called and the macro
7758: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
7759: executables.</p></li>
7760: </ul></div>
7761: </div>
1.41 asau 7762: <div class="sect2">
1.1 dsieger 7763: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7764: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 7765: <p>If a package needs GNU autoconf or automake to be executed
7766: to regenerate the configure script and Makefile.in makefile
7767: templates, then they should be executed in a pre-configure
7768: target.</p>
7769: <p>For packages that need only autoconf:</p>
7770: <pre class="programlisting">
7771: AUTOCONF_REQD= 2.50 # if default version is not good enough
7772: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
7773: ...
7774:
7775: pre-configure:
7776: cd ${WRKSRC} && autoconf
7777:
7778: ...
1.111 sevan 7779: </pre>
1.1 dsieger 7780: <p>and for packages that need automake and autoconf:</p>
7781: <pre class="programlisting">
7782: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
7783: USE_TOOLS+= automake # use "automake14" for automake-1.4
7784: ...
7785:
7786: pre-configure:
7787: set -e; cd ${WRKSRC}; \
7788: aclocal; autoheader; automake -a --foreign -i; autoconf
7789:
7790: ...
1.111 sevan 7791: </pre>
1.1 dsieger 7792: <p>Packages which use GNU Automake will almost certainly
7793: require GNU Make.</p>
7794: <p>There are times when the configure process makes
7795: additional changes to the generated files, which then causes
7796: the build process to try to re-execute the automake sequence.
7797: This is prevented by touching various files in the configure
7798: stage. If this causes problems with your package you can set
7799: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
7800: Makefile.</p>
7801: </div>
7802: </div>
1.41 asau 7803: <div class="sect1">
1.1 dsieger 7804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7805: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41 asau 7806: <div class="sect2">
1.1 dsieger 7807: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7808: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 7809: <p>Compilers for the C, C++, and Fortran languages comes with
7810: the NetBSD base system. By default, pkgsrc assumes that a package
7811: is written in C and will hide all other compilers (via the wrapper
1.154 rillig 7812: framework, see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 7813: <p>To declare which language's compiler a package needs, set
7814: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 7815: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
7816: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
7817: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 7818: written in C++, usually need a C compiler for the configure
7819: phase.</p>
7820: </div>
1.41 asau 7821: <div class="sect2">
1.1 dsieger 7822: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7823: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 7824: <p>If a program is written in Java, use the Java framework in
7825: pkgsrc. The package must include
7826: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
7827: provides the following variables:</p>
1.41 asau 7828: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7829: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 7830: dependency on the JDK is added. If
1.23 wiz 7831: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 7832: there is only a runtime dependency on the JDK. The default is
1.23 wiz 7833: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 7834: JDK.</p></li>
1.23 wiz 7835: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 7836: a package needs a Java2 implementation. The supported values
1.23 wiz 7837: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
7838: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
7839: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
7840: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 7841: above. This variable is not set by default.</p></li>
1.24 wiz 7842: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
7843: automatically set to the runtime location of the used Java
7844: implementation dependency. It may be used to set
7845: <code class="varname">JAVA_HOME</code> to a good value if the program
7846: needs this variable to be defined.
7847: </p></li>
1.1 dsieger 7848: </ul></div>
7849: </div>
1.41 asau 7850: <div class="sect2">
1.1 dsieger 7851: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7852: <a name="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 7853: <p>If your package contains interpreted perl scripts, add
1.23 wiz 7854: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 7855: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
7856: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
7857: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 7858: that you want adjusted. Every occurrence of
7859: <code class="filename">*/bin/perl</code> in a she-bang line will be
7860: replaced with the full path to the perl executable.</p>
1.1 dsieger 7861: <p>If a particular version of perl is needed, set the
7862: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 7863: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.154 rillig 7864: <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 7865: about handling perl modules.</p>
7866: </div>
1.41 asau 7867: <div class="sect2">
1.1 dsieger 7868: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7869: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 7870: <p><code class="varname">REPLACE_SH</code>,
7871: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
7872: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
7873: hash bangs in files. Please use the appropriate one, prefering
7874: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 7875: Each should contain a list of scripts, relative to
7876: <code class="varname">WRKSRC</code>, that you want adjusted. Every
7877: occurrence of the matching shell in a she-bang line will be
7878: replaced with the full path to the shell executable.
1.40 wiz 7879: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
7880: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
7881: </div>
1.41 asau 7882: <div class="sect2">
1.40 wiz 7883: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7884: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 7885: <p>Currently, there is no special handling for other languages
7886: in pkgsrc. If a compiler package provides a
7887: <code class="filename">buildlink3.mk</code> file, include that, otherwise
7888: just add a (build) dependency on the appropriate compiler
7889: package.</p>
7890: </div>
7891: </div>
1.41 asau 7892: <div class="sect1">
1.1 dsieger 7893: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7894: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7895: <p>The most common failures when building a package are that
7896: some platforms do not provide certain header files, functions or
7897: libraries, or they provide the functions in a library that the
7898: original package author didn't know. To work around this, you
7899: can rewrite the source code in most cases so that it does not
7900: use the missing functions or provides a replacement function.</p>
1.41 asau 7901: <div class="sect2">
1.1 dsieger 7902: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7903: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 7904: <p>If a package already comes with a GNU configure script, the
7905: preferred way to fix the build failure is to change the
7906: configure script, not the code. In the other cases, you can
7907: utilize the C preprocessor, which defines certain macros
7908: depending on the operating system and hardware architecture it
7909: compiles for. These macros can be queried using for example
7910: <code class="varname">#if defined(__i386)</code>. Almost every operating
7911: system, hardware architecture and compiler has its own macro.
7912: For example, if the macros <code class="varname">__GNUC__</code>,
7913: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
7914: are all defined, you know that you are using NetBSD on an i386
7915: compatible CPU, and your compiler is GCC.</p>
7916: <p>The list of the following macros for hardware and
7917: operating system depends on the compiler that is used. For
7918: example, if you want to conditionally compile code on Solaris,
7919: don't use <code class="varname">__sun__</code>, as the SunPro compiler
7920: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 7921: <div class="sect3">
1.1 dsieger 7922: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7923: <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 7924: <p>To distinguish between 4.4 BSD-derived systems and the
7925: rest of the world, you should use the following code.</p>
7926: <pre class="programlisting">
7927: #include <sys/param.h>
7928: #if (defined(BSD) && BSD >= 199306)
7929: /* BSD-specific code goes here */
7930: #else
7931: /* non-BSD-specific code goes here */
7932: #endif
7933: </pre>
7934: <p>If this distinction is not fine enough, you can also test
7935: for the following macros.</p>
7936: <pre class="programlisting">
1.45 obache 7937: Cygwin __CYGWIN__
7938: DragonFly __DragonFly__
1.1 dsieger 7939: FreeBSD __FreeBSD__
1.45 obache 7940: Haiku __HAIKU__
1.1 dsieger 7941: Interix __INTERIX
7942: IRIX __sgi (TODO: get a definite source for this)
7943: Linux linux, __linux, __linux__
1.83 dholland 7944: Mac OS X __APPLE__
1.45 obache 7945: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7946: Minix3 __minix
1.1 dsieger 7947: NetBSD __NetBSD__
7948: OpenBSD __OpenBSD__
7949: Solaris sun, __sun
7950: </pre>
7951: </div>
1.41 asau 7952: <div class="sect3">
1.1 dsieger 7953: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7954: <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 7955: <pre class="programlisting">
7956: i386 i386, __i386, __i386__
7957: MIPS __mips
7958: SPARC sparc, __sparc
7959: </pre>
7960: </div>
1.41 asau 7961: <div class="sect3">
1.1 dsieger 7962: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7963: <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 7964: <pre class="programlisting">
7965: GCC __GNUC__ (major version), __GNUC_MINOR__
7966: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7967: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7968: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7969: </pre>
7970: </div>
7971: </div>
1.41 asau 7972: <div class="sect2">
1.1 dsieger 7973: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7974: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 7975: <p>Some source files trigger bugs in the compiler, based on
7976: combinations of compiler version and architecture and almost
7977: always relation to optimisation being enabled. Common symptoms
7978: are gcc internal errors or never finishing compiling a
7979: file.</p>
7980: <p>Typically, a workaround involves testing the
7981: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
7982: optimisation for that combination of file,
1.87 tnn 7983: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
7984: <p>This used to be a big problem in the past, but is rarely
7985: needed now as compiler technology has matured. If you still need
7986: to add a compiler specific workaround, please do so in the file
7987: <code class="filename">hacks.mk</code> and describe the symptom and
7988: compiler version as detailed as possible.</p>
1.1 dsieger 7989: </div>
1.41 asau 7990: <div class="sect2">
1.1 dsieger 7991: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7992: <a name="undefined-reference"></a>21.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 7993: </h3></div></div></div>
1.1 dsieger 7994: <p>This error message often means that a package did not
7995: link to a shared library it needs. The following functions are
7996: known to cause this error message over and over.</p>
7997: <div class="informaltable">
1.106 tnn 7998: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 7999: <colgroup>
8000: <col>
8001: <col>
8002: <col>
8003: </colgroup>
8004: <thead><tr>
8005: <th>Function</th>
8006: <th>Library</th>
8007: <th>Affected platforms</th>
8008: </tr></thead>
8009: <tbody>
8010: <tr>
8011: <td>accept, bind, connect</td>
8012: <td>-lsocket</td>
8013: <td>Solaris</td>
8014: </tr>
8015: <tr>
8016: <td>crypt</td>
8017: <td>-lcrypt</td>
8018: <td>DragonFly, NetBSD</td>
8019: </tr>
8020: <tr>
8021: <td>dlopen, dlsym</td>
8022: <td>-ldl</td>
8023: <td>Linux</td>
8024: </tr>
8025: <tr>
8026: <td>gethost*</td>
8027: <td>-lnsl</td>
8028: <td>Solaris</td>
8029: </tr>
8030: <tr>
8031: <td>inet_aton</td>
8032: <td>-lresolv</td>
8033: <td>Solaris</td>
8034: </tr>
8035: <tr>
8036: <td>nanosleep, sem_*, timer_*</td>
8037: <td>-lrt</td>
8038: <td>Solaris</td>
8039: </tr>
8040: <tr>
8041: <td>openpty</td>
8042: <td>-lutil</td>
8043: <td>Linux</td>
8044: </tr>
8045: </tbody>
8046: </table>
8047: </div>
8048: <p>To fix these linker errors, it is often sufficient to say
8049: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8050: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8051: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8052: bmake</strong></span>.</p>
1.41 asau 8053: <div class="sect3">
1.1 dsieger 8054: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8055: <a name="undefined-reference-sunpro"></a>21.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8056: <p>When you are using the SunPro compiler, there is another
8057: possibility. That compiler cannot handle the following code:</p>
8058: <pre class="programlisting">
8059: extern int extern_func(int);
8060:
8061: static inline int
8062: inline_func(int x)
8063: {
8064: return extern_func(x);
8065: }
8066:
8067: int main(void)
8068: {
8069: return 0;
8070: }
8071: </pre>
8072: <p>It generates the code for <code class="function">inline_func</code> even if
8073: that function is never used. This code then refers to
8074: <code class="function">extern_func</code>, which can usually not be resolved. To
8075: solve this problem you can try to tell the package to disable inlining
8076: of functions.</p>
8077: </div>
8078: </div>
1.41 asau 8079: <div class="sect2">
1.1 dsieger 8080: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8081: <a name="out-of-memory"></a>21.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8082: <p>Sometimes packages fail to build because the compiler runs
8083: into an operating system specific soft limit. With the
8084: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 8085: to unlimit the resources. Currently, the allowed values are any combination of
8086: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8087: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 8088: Setting this variable is similar to running the shell builtin
1.10 hubertf 8089: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8090: segment size or maximum stack size of a process, respectively, to
8091: their hard limits.</p>
8092: </div>
8093: </div>
1.41 asau 8094: <div class="sect1">
1.1 dsieger 8095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8096: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 8097: <div class="sect2">
1.1 dsieger 8098: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8099: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8100: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8101: with some operating systems cannot create more than one
8102: directory at a time. As such, you should call
8103: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8104: <pre class="programlisting">
8105: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8106: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 8107: </pre>
1.23 wiz 8108: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8109: dir2</code></span>”</span> to the
1.1 dsieger 8110: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8111: automatically do the right thing.</p>
8112: </div>
1.41 asau 8113: <div class="sect2">
1.1 dsieger 8114: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8115: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8116: <p>In general, documentation should be installed into
8117: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8118: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8119: includes the version number of the package).</p>
8120: <p>Many modern packages using GNU autoconf allow to set the
8121: directory where HTML documentation is installed with the
1.23 wiz 8122: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8123: is needed because otherwise the documentation ends up in
8124: <code class="filename">${PREFIX}/share/doc/html</code> or other
8125: places.</p>
8126: <p>An exception to the above is that library API documentation
1.137 leot 8127: 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 8128: browsers (devhelp) should be left at their default location, which
8129: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8130: documentation can be recognized from files ending in
8131: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8132: (It is also acceptable to install such files in
8133: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8134: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8135: <code class="filename">.devhelp*</code> file must be directly in that
8136: directory then, no additional subdirectory level is allowed in
8137: this case. This is usually achieved by using
1.23 wiz 8138: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8139: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8140: though.)</p>
8141: </div>
1.41 asau 8142: <div class="sect2">
1.1 dsieger 8143: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8144: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8145: <p>Certain packages, most of them in the games category, install
8146: a score file that allows all users on the system to record their
8147: highscores. In order for this to work, the binaries need to be
8148: installed setgid and the score files owned by the appropriate
1.35 wiz 8149: group and/or owner (traditionally the "games" user/group). Set
8150: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8151: following variables, documented in more detail in
8152: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8153: behaviour: <code class="varname">GAMEDATAMODE</code>,
8154: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8155: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8156: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8157: <code class="varname">GAMEDATA_PERMS</code> and
8158: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8159: <p>An example that illustrates some of the variables described above is
8160: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8161: used to properly set directory permissions of the directory where the
8162: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8163: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8164: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8165: binary:</p>
8166: <pre class="programlisting">
1.112 rillig 8167: USE_GAMESGROUP= yes
1.100 leot 8168:
1.112 rillig 8169: BUILD_DEFS+= VARBASE
1.100 leot 8170:
1.112 rillig 8171: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8172: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8173: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 8174: </pre>
1.100 leot 8175: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8176: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8177: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8178: needed to be accessed by setgid games and
8179: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8180: <p>A package should therefore never hard code file ownership or
1.100 leot 8181: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8182: or alternatively on <code class="varname">INSTALL_GAME</code>,
8183: <code class="varname">INSTALL_GAME_DATA</code> and
8184: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8185: </div>
1.41 asau 8186: <div class="sect2">
1.1 dsieger 8187: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8188: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8189: <p><code class="varname">DESTDIR</code> support means that a package
8190: installs into a staging directory, not the final location of the
8191: files. Then a binary package is created which can be used for
8192: installation as usual. There are two ways: Either the package must
1.23 wiz 8193: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8194: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8195: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8196: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 8197: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8198: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 8199: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8200: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8201: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8202: the inclusion.</p></li>
1.23 wiz 8203: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8204: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8205: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8206: automatically. Many manual rules and pre/post-install often are
8207: incorrect; fix them.</p></li>
1.23 wiz 8208: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8209: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8210: <li class="listitem"><p>In general, packages should support
1.4 rillig 8211: <code class="varname">UNPRIVILEGED</code> to be able to use
8212: DESTDIR.</p></li>
8213: </ul></div>
8214: </div>
1.41 asau 8215: <div class="sect2">
1.4 rillig 8216: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8217: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8218: <p>Your package may also contain scripts with hardcoded paths to
8219: other interpreters besides (or as well as) perl. To correct the
8220: full pathname to the script interpreter, you need to set the
8221: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8222: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8223: <pre class="programlisting">
8224: REPLACE_INTERPRETER+= tcl
8225: REPLACE.tcl.old= .*/bin/tclsh
8226: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8227: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8228: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 8229: </pre>
1.41 asau 8230: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8231: <h3 class="title">Note</h3>
8232: <p>Before March 2006, these variables were called
8233: <code class="varname">_REPLACE.*</code> and
8234: <code class="varname">_REPLACE_FILES.*</code>.</p>
8235: </div>
8236: </div>
1.41 asau 8237: <div class="sect2">
1.1 dsieger 8238: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8239: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8240: <p>Makefiles of packages providing perl5 modules should include
8241: the Makefile fragment
8242: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8243: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8244: configuration for such modules as well as various hooks to tune
8245: this configuration. See comments in this file for
8246: details.</p>
8247: <p>Perl5 modules will install into different places depending
8248: on the version of perl used during the build process. To
8249: address this, pkgsrc will append lines to the
8250: <code class="filename">PLIST</code> corresponding to the files listed in
8251: the installed <code class="filename">.packlist</code> file generated by
8252: most perl5 modules. This is invoked by defining
8253: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8254: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8255: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8256: e.g.:</p>
1.1 dsieger 8257: <pre class="programlisting">
1.47 wiz 8258: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 8259: </pre>
1.47 wiz 8260: <p>The perl5 config variables
8261: <code class="varname">installarchlib</code>,
8262: <code class="varname">installscript</code>,
8263: <code class="varname">installvendorbin</code>,
8264: <code class="varname">installvendorscript</code>,
8265: <code class="varname">installvendorarch</code>,
8266: <code class="varname">installvendorlib</code>,
8267: <code class="varname">installvendorman1dir</code>, and
8268: <code class="varname">installvendorman3dir</code> represent those
8269: locations in which components of perl5 modules may be installed,
8270: provided as variable with uppercase and prefixed with
8271: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8272: and may be used by perl5 packages that don't have a packlist.
8273: These variables are also substituted for in the
8274: <code class="filename">PLIST</code> as uppercase prefixed with
8275: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8276: </div>
1.41 asau 8277: <div class="sect2">
1.1 dsieger 8278: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8279: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8280: <p>Some packages install info files or use the
1.23 wiz 8281: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8282: commands. <code class="varname">INFO_FILES</code> should be defined in
8283: the package Makefile so that <code class="filename">INSTALL</code> and
8284: <code class="filename">DEINSTALL</code> scripts will be generated to
8285: handle registration of the info files in the Info directory
1.23 wiz 8286: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8287: files registration is either provided by the system, or by a
8288: special purpose package automatically added as dependency if
8289: needed.</p>
8290: <p><code class="varname">PKGINFODIR</code> is the directory under
8291: <code class="filename">${PREFIX}</code> where info files are primarily
8292: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8293: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8294: <p>The info files for the package should be listed in the
8295: package <code class="filename">PLIST</code>; however any split info files
8296: need not be listed.</p>
1.23 wiz 8297: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8298: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8299: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8300: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8301: should be noted with the <code class="varname">TEXINFO_REQD</code>
8302: variable in the package <code class="filename">Makefile</code>. By
8303: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8304: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8305: does not match the required minimum, a build dependency on the
1.137 leot 8306: <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 8307: be added automatically.</p>
8308: <p>The build and installation process of the software provided
8309: by the package should not use the
1.10 hubertf 8310: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8311: info files is the task of the package
8312: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8313: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8314: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8315: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8316: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8317: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8318: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8319: no effect except the logging of a message. The script overriding
1.10 hubertf 8320: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8321: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8322: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8323: </div>
1.41 asau 8324: <div class="sect2">
1.1 dsieger 8325: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8326: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8327: <p>All packages that install manual pages should install them
8328: into the same directory, so that there is one common place to look
8329: for them. In pkgsrc, this place is
8330: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8331: should be used in packages. The default for
8332: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8333: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8334: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8335: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8336: <h3 class="title">Note</h3>
8337: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8338: is far from complete.</p>
8339: </div>
8340: <p>The <code class="filename">PLIST</code> files can just use
8341: <code class="filename">man/</code> as the top level directory for the man
8342: page file entries, and the pkgsrc framework will convert as
8343: needed. In all other places, the correct
8344: <code class="varname">PKGMANDIR</code> must be used.</p>
8345: <p>Packages that are
8346: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8347: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8348: <code class="filename">./configure</code>
8349: --mandir switch to set where the man pages should be installed.
8350: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8351: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8352: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8353: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8354: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8355: Or if the <code class="filename">./configure</code> script uses
8356: a non-standard use of --mandir, you can set
8357: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.154 rillig 8358: <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 8359: information on installation of compressed manual pages.</p>
8360: </div>
1.41 asau 8361: <div class="sect2">
1.1 dsieger 8362: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8363: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8364: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8365: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8366: you need to take some extra steps to make sure they get registered
8367: in the database:</p>
1.23 wiz 8368: <div class="orderedlist"><ol class="orderedlist" type="1">
8369: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8370: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8371: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8372: deinstallation time, and tells the package where to install
1.7 rillig 8373: GConf data files using some standard configure arguments. It
1.1 dsieger 8374: also disallows any access to the database directly from the
8375: package.</p></li>
1.23 wiz 8376: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8377: <code class="filename">.schemas</code> files under
8378: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8379: installed under <code class="filename">${PREFIX}/etc</code>, you will
8380: need to manually patch the package.</p></li>
1.23 wiz 8381: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8382: directory, as they will be handled automatically. See
1.154 rillig 8383: <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 8384: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8385: your <code class="filename">Makefile</code> with a list of all
8386: <code class="filename">.schemas</code> files installed by the package, if
8387: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8388: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8389: your <code class="filename">Makefile</code> with a
8390: list of all <code class="filename">.entries</code> files installed by the
8391: package, if any. Names must not contain any directories in
8392: them.</p></li>
8393: </ol></div>
8394: </div>
1.41 asau 8395: <div class="sect2">
1.1 dsieger 8396: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8397: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8398: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8399: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8400: get registered in the database:</p>
1.23 wiz 8401: <div class="orderedlist"><ol class="orderedlist" type="1">
8402: <li class="listitem"><p>Include
1.18 snj 8403: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8404: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8405: takes care of rebuilding the scrollkeeper database at
8406: installation and deinstallation time, and disallows any access
8407: to it directly from the package.</p></li>
1.23 wiz 8408: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8409: <code class="filename">libdata/scrollkeeper</code> directory, as they
8410: will be handled automatically.</p></li>
1.23 wiz 8411: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8412: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8413: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8414: </ol></div>
8415: </div>
1.41 asau 8416: <div class="sect2">
1.1 dsieger 8417: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8418: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8419: <p>If a package installs font files, you will need to rebuild
8420: the fonts database in the directory where they get installed at
8421: installation and deinstallation time. This can be automatically
8422: done by using the pkginstall framework.</p>
8423: <p>You can list the directories where fonts are installed in the
8424: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8425: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8426: <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 8427: Also make sure that the database file
8428: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8429: <p>Note that you should not create new directories for fonts;
8430: instead use the standard ones to avoid that the user needs to
8431: manually configure his X server to find them.</p>
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="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8436: <p>If a package installs GTK2 immodules or loaders, you need to
8437: take some extra steps to get them registered in the GTK2 database
8438: properly:</p>
1.23 wiz 8439: <div class="orderedlist"><ol class="orderedlist" type="1">
8440: <li class="listitem"><p>Include
1.1 dsieger 8441: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8442: <code class="filename">buildlink3.mk</code> file. This takes care of
8443: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8444: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8445: your package installs GTK2 immodules.</p></li>
1.23 wiz 8446: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8447: GTK2 loaders.</p></li>
1.23 wiz 8448: <li class="listitem">
1.1 dsieger 8449: <p>Patch the package to not touch any of the GTK2
8450: databases directly. These are:</p>
1.41 asau 8451: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8452: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8453: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 8454: </ul></div>
8455: </li>
1.23 wiz 8456: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 8457: any entries under the <code class="filename">libdata/gtk-2.0</code>
8458: directory, as they will be handled automatically.</p></li>
8459: </ol></div>
8460: </div>
1.41 asau 8461: <div class="sect2">
1.1 dsieger 8462: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8463: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8464: <p>If a package installs SGML or XML data files that need to be
8465: registered in system-wide catalogs (like DTDs, sub-catalogs,
8466: etc.), you need to take some extra steps:</p>
1.23 wiz 8467: <div class="orderedlist"><ol class="orderedlist" type="1">
8468: <li class="listitem"><p>Include
1.1 dsieger 8469: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8470: your <code class="filename">Makefile</code>, which takes care of
8471: registering those files in system-wide catalogs at
8472: installation and deinstallation time.</p></li>
1.23 wiz 8473: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 8474: any SGML catalogs installed by the package.</p></li>
1.23 wiz 8475: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 8476: any XML catalogs installed by the package.</p></li>
1.23 wiz 8477: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 8478: to be added to the SGML catalog. These come in groups of
8479: three strings; see xmlcatmgr(1) for more information
8480: (specifically, arguments recognized by the 'add' action).
8481: Note that you will normally not use this variable.</p></li>
1.23 wiz 8482: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 8483: to be added to the XML catalog. These come in groups of three
8484: strings; see xmlcatmgr(1) for more information (specifically,
8485: arguments recognized by the 'add' action). Note that you will
8486: normally not use this variable.</p></li>
8487: </ol></div>
8488: </div>
1.41 asau 8489: <div class="sect2">
1.1 dsieger 8490: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8491: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 8492: <p>If a package provides extensions to the MIME database by
8493: installing <code class="filename">.xml</code> files inside
8494: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8495: need to take some extra steps to ensure that the database is kept
8496: consistent with respect to these new files:</p>
1.23 wiz 8497: <div class="orderedlist"><ol class="orderedlist" type="1">
8498: <li class="listitem"><p>Include
1.1 dsieger 8499: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8500: (avoid using the <code class="filename">buildlink3.mk</code> file from
8501: this same directory, which is reserved for inclusion from
8502: other <code class="filename">buildlink3.mk</code> files). It takes
8503: care of rebuilding the MIME database at installation and
8504: deinstallation time, and disallows any access to it directly
8505: from the package.</p></li>
1.23 wiz 8506: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8507: <code class="filename">share/mime</code> directory,
8508: <span class="emphasis"><em>except</em></span> for files saved under
8509: <code class="filename">share/mime/packages</code>. The former are
8510: handled automatically by
8511: the update-mime-database program, but the latter are
8512: package-dependent and must be removed by the package that
8513: installed them in the first place.</p></li>
1.23 wiz 8514: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 8515: from the PLIST. They will be handled by the shared-mime-info
8516: package.</p></li>
8517: </ol></div>
8518: </div>
1.41 asau 8519: <div class="sect2">
1.1 dsieger 8520: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8521: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 8522: <p>If a package uses intltool during its build, add
8523: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
8524: which forces it to use the intltool package provided by pkgsrc,
8525: instead of the one bundled with the distribution file.</p>
8526: <p>This tracks intltool's build-time dependencies and uses the
8527: latest available version; this way, the package benefits of any
8528: bug fixes that may have appeared since it was released.</p>
8529: </div>
1.41 asau 8530: <div class="sect2">
1.1 dsieger 8531: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8532: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 8533: <p>If a package contains a rc.d script, it won't be copied into
8534: the startup directory by default, but you can enable it, by adding
8535: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 8536: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 8537: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8538: it will automatically remove the scripts when the package is
8539: deinstalled.</p>
8540: </div>
1.41 asau 8541: <div class="sect2">
1.1 dsieger 8542: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8543: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 8544: <p>If a package installs TeX packages into the texmf tree,
8545: the <code class="filename">ls-R</code> database of the tree needs to be
8546: updated.</p>
1.41 asau 8547: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8548: <h3 class="title">Note</h3>
1.22 jakllsch 8549: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 8550: packages should install files
1.22 jakllsch 8551: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
8552: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 8553: </div>
1.23 wiz 8554: <div class="orderedlist"><ol class="orderedlist" type="1">
8555: <li class="listitem"><p>Include
1.22 jakllsch 8556: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 8557: takes care of rebuilding the <code class="filename">ls-R</code>
8558: database at installation and deinstallation time.</p></li>
1.23 wiz 8559: <li class="listitem">
1.1 dsieger 8560: <p>If your package installs files into a texmf
8561: tree other than the one
1.22 jakllsch 8562: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
8563: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 8564: trees that need database update.</p>
8565: <p>If your package also installs font map files that need
1.10 hubertf 8566: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 8567: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 8568: set <code class="varname">TEX_MAP_FILES</code> and/or
8569: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 8570: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 8571: be run automatically at installation/deinstallation to
8572: enable/disable font map files for TeX output
8573: drivers.</p>
8574: </li>
1.23 wiz 8575: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 8576: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 8577: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 8578: </ol></div>
8579: </div>
1.41 asau 8580: <div class="sect2">
1.1 dsieger 8581: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8582: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.1 dsieger 8583: emulation</h3></div></div></div>
8584: <p>There are some packages that provide libraries and
8585: executables for running binaries from a one operating system
8586: on a different one (if the latter supports it). One example
8587: is running Linux binaries on NetBSD.</p>
1.137 leot 8588: <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 8589: helps in extracting and packaging Linux rpm packages.</p>
8590: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 8591: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 8592: if all libraries for each installed executable can be found by
8593: the dynamic linker. Since the standard dynamic linker is run,
8594: this fails for emulation packages, because the libraries used
8595: by the emulation are not in the standard directories.</p>
8596: </div>
1.41 asau 8597: <div class="sect2">
1.1 dsieger 8598: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8599: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 8600: <p>If a package installs images under the
8601: <code class="filename">share/icons/hicolor</code> and/or updates the
8602: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8603: database, you need to take some extra steps to make sure that the
8604: shared theme directory is handled appropriately and that the cache
8605: database is rebuilt:</p>
1.23 wiz 8606: <div class="orderedlist"><ol class="orderedlist" type="1">
8607: <li class="listitem"><p>Include
1.1 dsieger 8608: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 8609: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 8610: entry that refers to the theme cache.</p></li>
1.23 wiz 8611: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 8612: directories from the <code class="filename">share/icons/hicolor</code>
8613: hierarchy because they will be handled automatically.</p></li>
8614: </ol></div>
8615: <p>The best way to verify that the PLIST is correct with
8616: respect to the last two points is to regenerate it using
1.10 hubertf 8617: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 8618: </div>
1.41 asau 8619: <div class="sect2">
1.1 dsieger 8620: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8621: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 8622: <p>If a package installs <code class="filename">.desktop</code> files
8623: under <code class="filename">share/applications</code> and these include
1.53 rodent 8624: MIME information (MimeType key), you need to take extra steps to
8625: ensure that they are registered into the MIME database:</p>
1.23 wiz 8626: <div class="orderedlist"><ol class="orderedlist" type="1">
8627: <li class="listitem"><p>Include
1.1 dsieger 8628: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 8629: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 8630: <code class="filename">share/applications/mimeinfo.cache</code> file.
8631: It will be handled automatically.</p></li>
8632: </ol></div>
8633: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 8634: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 8635: print-PLIST</strong></span>.</p>
8636: </div>
8637: </div>
1.41 asau 8638: <div class="sect1">
1.1 dsieger 8639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8640: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 8641: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 8642: immediately. In this case, one can plainly mark a package as broken. For
8643: this, one just sets the variable <code class="varname">BROKEN</code> to the
8644: reason why the package is broken (similar to the
8645: <code class="varname">RESTRICTED</code> variable). A user trying to build
8646: the package will immediately be shown this message, and the build
8647: will not be even tried.</p>
8648: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 8649: intervals.</p>
8650: </div>
8651: </div>
1.41 asau 8652: <div class="chapter">
1.1 dsieger 8653: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 8654: <a name="debug"></a>Chapter 22. Debugging</h2></div></div></div>
1.1 dsieger 8655: <p>To check out all the gotchas when building a package, here are
8656: the steps that I do in order to get a package working. Please note
8657: this is basically the same as what was explained in the previous
8658: sections, only with some debugging aids.</p>
1.41 asau 8659: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8660: <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>
8661: <li class="listitem">
1.137 leot 8662: <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 8663: create a directory for a new package, change into it, then run
1.10 hubertf 8664: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 8665: <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>
8666: <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>
8667: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
8668: </li>
1.23 wiz 8669: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
8670: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
8671: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
8672: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 8673: configure step to the package's
8674: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 8675: <li class="listitem">
1.1 dsieger 8676: <p>Make the package compile, doing multiple rounds of</p>
8677: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8678: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
8679: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
8680: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
8681: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
8682: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
8683: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
8684: <p>Doing this step as non-root user will ensure that no files
8685: are modified that shouldn't be, especially during the build
1.10 hubertf 8686: phase. <span class="command"><strong>mkpatches</strong></span>,
8687: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.137 leot 8688: 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 8689: package.</p>
8690: </li>
1.23 wiz 8691: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
1.154 rillig 8692: 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 8693: <li class="listitem">
1.1 dsieger 8694: <p>Generate a <code class="filename">PLIST</code>:</p>
8695: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8696: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
8697: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
8698: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8699: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
8700: <p>You usually need to be <code class="username">root</code> to do
8701: this. Look if there are any files left:</p>
8702: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8703: <p>If this reveals any files that are missing in
8704: <code class="filename">PLIST</code>, add them.</p>
8705: </li>
1.23 wiz 8706: <li class="listitem">
1.1 dsieger 8707: <p>Now that the <code class="filename">PLIST</code> is OK, install the
8708: package again and make a binary package:</p>
8709: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
8710: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
8711: </li>
1.23 wiz 8712: <li class="listitem">
1.1 dsieger 8713: <p>Delete the installed package:</p>
8714: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
8715: </li>
1.23 wiz 8716: <li class="listitem">
1.10 hubertf 8717: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 8718: command, which shouldn't find anything now:</p>
8719: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8720: </li>
1.23 wiz 8721: <li class="listitem">
1.1 dsieger 8722: <p>Reinstall the binary package:</p>
8723: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
8724: </li>
1.23 wiz 8725: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
8726: <li class="listitem">
1.137 leot 8727: <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 8728: reports:</p>
8729: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
8730: </li>
1.154 rillig 8731: <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 8732: </ul></div>
8733: </div>
1.41 asau 8734: <div class="chapter">
1.1 dsieger 8735: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 8736: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 8737: <div class="toc">
8738: <p><b>Table of Contents</b></p>
1.100 leot 8739: <dl class="toc">
1.154 rillig 8740: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
8741: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
8742: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
8743: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
8744: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
8745: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
8746: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
8747: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 8748: </dl>
8749: </div>
1.41 asau 8750: <div class="sect1">
1.1 dsieger 8751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8752: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 8753: <p>Our policy is that we accept binaries only from pkgsrc
8754: developers to guarantee that the packages don't contain any
8755: trojan horses etc. This is not to annoy anyone but rather to
8756: protect our users! You're still free to put up your home-made
8757: binary packages and tell the world where to get them. NetBSD
8758: developers doing bulk builds and wanting to upload them please
1.154 rillig 8759: 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 8760: builds)</i></a>.</p>
1.1 dsieger 8761: </div>
1.41 asau 8762: <div class="sect1">
1.1 dsieger 8763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8764: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 8765: <p>First, check that your package is complete, compiles and
1.154 rillig 8766: runs well; see <a class="xref" href="#debug" title="Chapter 22. Debugging">Chapter 22, <i>Debugging</i></a> and the rest of this
1.157 leot 8767: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://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 8768: archive that contains all files that make up the package.
8769: Finally, send this package to the pkgsrc bug tracking system,
1.157 leot 8770: either with the <a class="citerefentry" href="http://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 8771: that, go to the web page
1.10 hubertf 8772: <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 8773: which contains some instructions and a link to a form where you
8774: can submit packages. The
1.137 leot 8775: <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 8776: also available as a substitute for either of the above two tools.
8777: </p>
1.1 dsieger 8778: <p>In the form of the problem report, the category should be
1.23 wiz 8779: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 8780: and version number, and the description field should contain a
8781: short description of your package (contents of the COMMENT
8782: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 8783: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 8784: <p>If you want to submit several packages, please send a
8785: separate PR for each one, it's easier for us to track things
8786: that way.</p>
8787: <p>Alternatively, you can also import new packages into
1.23 wiz 8788: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.105 wiz 8789: homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1 dsieger 8790: for details.</p>
8791: </div>
1.41 asau 8792: <div class="sect1">
1.1 dsieger 8793: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8794: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 8795: <p>Please note all package additions, updates, moves, and
8796: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
8797: important to keep this file up to date and conforming to the
8798: existing format, because it will be used by scripts to
1.10 hubertf 8799: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 8800: sites. Additionally, check the
8801: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
8802: for the package you updated or removed, in case it was mentioned
8803: there.</p>
8804: <p>When the <code class="varname">PKGREVISION</code> of a package is
8805: bumped, the change should appear in
8806: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
8807: related or otherwise relevant. Mass bumps that result from a
8808: dependency being updated should not be mentioned. In all other
8809: cases it's the developer's decision.</p>
8810: <p>There is a make target that helps in creating proper
1.10 hubertf 8811: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 8812: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
8813: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
8814: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
8815: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 8816: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
8817: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 8818: For new packages, or package moves or removals, set the
8819: <code class="varname">CTYPE</code> variable on the command line to "Added",
8820: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 8821: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 8822: not the same as your NetBSD login name. The target also automatically
8823: removes possibly existing entries for the package in the
8824: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 8825: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 8826: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
8827: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
8828: makes the cvs commands use the main repository.
8829: </p>
1.1 dsieger 8830: </div>
1.41 asau 8831: <div class="sect1">
1.1 dsieger 8832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8833: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 8834: <p>For several years, there have been mirrors of pkgsrc in
8835: fossil, git, and hg. Standard practise when using these tools is to
8836: make the first line of a commit message function as a summary that
8837: can be read without the rest, such as is commonly done with "git log
8838: --oneline". For this reason, we have the following guidelines for
8839: pkgsrc commit messages:</p>
8840: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8841: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 8842: big picture in 65 characters or less. When a commit is for one
1.130 wiz 8843: package, include the name of the package. For updates, include the
8844: version to which it is updated.</p></li>
8845: <li class="listitem"><p>Leave the next line empty.</p></li>
8846: <li class="listitem"><p>Then come the details for the commit (changes in that
8847: package, reason for a change) and any relevant PRs. Wrap this
8848: section.</p></li>
8849: </ul></div>
8850: <p>Here is an example:
8851: </p>
8852: <pre class="programlisting">
8853: libxslt: update to 1.0.30
8854:
8855: Changes since 1.0.29:
8856: ...
8857: </pre>
8858: <p>
8859: </p>
8860: <p>Here is another example:
8861: </p>
8862: <pre class="programlisting">
8863: mk/bsd.pkg.mk: enable SSP by default on NetBSD
8864:
8865: (rationale)
8866: </pre>
8867: <p>
8868: </p>
8869: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
8870: allowed on the pkgsrc repository to change commit messages.</p>
8871: </div>
8872: <div class="sect1">
8873: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8874: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 8875: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 8876: access to the pkgsrc repository.</p>
8877: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
8878: Start by adding the directory and then files in the directory. Don't
8879: forget to add the new package to the category's
8880: <code class="filename">Makefile</code>. Make sure you don't forget any files;
8881: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
8882: <pre class="programlisting">
8883: <code class="prompt">$</code> cd .../pkgsrc/category
8884: <code class="prompt">$</code> cvs add pkgname
8885: <code class="prompt">$</code> cd pkgname
8886: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8887: <code class="prompt">$</code> cvs add patches/p*
8888: <code class="prompt">$</code> cvs status | less
1.34 wiz 8889: <code class="prompt">$</code> cvs commit
1.33 wiz 8890: <code class="prompt">$</code> cd ..
8891: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 8892: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 8893: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 8894: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 8895: </pre>
1.1 dsieger 8896: <p>The commit message of the initial import should include part of the
8897: <code class="filename">DESCR</code> file, so people reading the mailing lists know
8898: what the package is/does.</p>
1.33 wiz 8899: <p>Also mention the new package in
8900: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
8901: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
8902: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 8903: </div>
1.41 asau 8904: <div class="sect1">
1.1 dsieger 8905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8906: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 8907: <p>Please always put a concise, appropriate and relevant summary of the
8908: changes between old and new versions into the commit log when updating
8909: a package. There are various reasons for this:</p>
1.41 asau 8910: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8911: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 8912: or its information may be overwritten by newer information.</p></li>
1.23 wiz 8913: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8914: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 8915: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 8916: repository is very useful for people who read the pkgsrc-changes mailing
8917: list, so that they can make tactical decisions about when to upgrade
8918: the package.</p></li>
8919: </ul></div>
8920: <p>Please also recognize that, just because a new version of a package
8921: has been released, it should not automatically be upgraded in the CVS
8922: repository. We prefer to be conservative in the packages that are
8923: included in pkgsrc - development or beta packages are not really the
8924: best thing for most places in which pkgsrc is used. Please use your
8925: judgement about what should go into pkgsrc, and bear in mind that
8926: stability is to be preferred above new and possibly untested features.</p>
8927: </div>
1.41 asau 8928: <div class="sect1">
1.1 dsieger 8929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8930: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 8931: <p>Renaming packages is not recommended.</p>
8932: <p>When renaming packages, be sure to fix any references to old name
8933: in other Makefiles, options, buildlink files, etc.</p>
8934: <p>Also When renaming a package, please define
8935: <code class="varname">SUPERSEDES</code> to the package name and dewey version
8936: pattern(s) of the previous package name.
8937: This may be repeated for multiple renames.
8938: The new package would be an exact replacement.
8939: </p>
1.23 wiz 8940: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 8941: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
8942: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
8943: not be an exact replacement but is a suggestion for the replaced
8944: functionality.</p>
8945: </div>
1.41 asau 8946: <div class="sect1">
1.20 snj 8947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8948: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 8949: <p>It is preferred that packages are not renamed or moved, but if needed
8950: please follow these steps.
8951: </p>
1.23 wiz 8952: <div class="orderedlist"><ol class="orderedlist" type="1">
8953: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
8954: <li class="listitem">
1.1 dsieger 8955: <p>Remove all CVS dirs.</p>
8956: <p>Alternatively to the first two steps you can also do:</p>
8957: <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>
8958: <p>and use that for further work.</p>
8959: </li>
1.23 wiz 8960: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
8961: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
8962: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
8963: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 8964: <code class="varname">PREV_PKGPATH</code> to the previous category/package
8965: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
8966: for doing an update using pkgsrc building; for example, it can
1.157 leot 8967: search the <a class="citerefentry" href="http://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 8968: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
8969: new <code class="varname">PKGPATH</code> for that moved package. Note that
8970: it may have multiple matches, so the tool should also check on the
8971: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
8972: probably has no value unless <code class="varname">SUPERSEDES</code> is not
8973: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 8974: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 8975: place.</p></li>
1.23 wiz 8976: <li class="listitem">
1.1 dsieger 8977: <p>Check if any package depends on it:
8978: </p>
8979: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
8980: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
8981: </li>
1.23 wiz 8982: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
8983: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
8984: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
8985: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
8986: <li class="listitem">
1.1 dsieger 8987: <p>Commit the changed and removed files:</p>
8988: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
8989: <p>(and any packages from step 5, of course).</p>
8990: </li>
8991: </ol></div>
8992: </div>
8993: </div>
1.41 asau 8994: <div class="chapter">
1.1 dsieger 8995: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 8996: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 8997: <p>This section contains the answers to questions that may
8998: arise when you are writing a package. If you don't find your
8999: question answered here, first have a look in the other chapters,
9000: and if you still don't have the answer, ask on the
9001: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9002: <div class="qandaset">
1.161 ! leot 9003: <a name="idm74689200"></a><dl>
1.154 rillig 9004: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9005: MAKEFLAGS, .MAKEFLAGS and
9006: MAKE_FLAGS?</a>
9007: </dt>
1.154 rillig 9008: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9009: MAKE, GMAKE and
9010: MAKE_PROGRAM?</a>
9011: </dt>
1.154 rillig 9012: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9013: CC, PKG_CC and
9014: PKGSRC_COMPILER?</a>
9015: </dt>
1.154 rillig 9016: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9017: BUILDLINK_LDFLAGS,
9018: BUILDLINK_LDADD and
9019: BUILDLINK_LIBS?</a>
9020: </dt>
1.154 rillig 9021: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9022: VARNAME=BUILDLINK_PREFIX.foo
9023: say it's empty?</a>
9024: </dt>
1.154 rillig 9025: <dt>24.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9026: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9027: don't understand the := inside
9028: it.</a>
9029: </dt>
1.154 rillig 9030: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9031: developers?</a>
9032: </dt>
1.154 rillig 9033: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9034: documentation?</a>
9035: </dt>
1.154 rillig 9036: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9037: do?</a>
9038: </dt>
9039: </dl>
1.41 asau 9040: <table border="0" style="width: 100%;">
9041: <colgroup>
1.1 dsieger 9042: <col align="left" width="1%">
1.23 wiz 9043: <col>
1.41 asau 9044: </colgroup>
1.1 dsieger 9045: <tbody>
1.41 asau 9046: <tr class="question">
1.1 dsieger 9047: <td align="left" valign="top">
1.161 ! leot 9048: <a name="devfaq.makeflags"></a><a name="idm74688816"></a><p><b>24.1.</b></p>
1.1 dsieger 9049: </td>
9050: <td align="left" valign="top"><p>What is the difference between
9051: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9052: <code class="varname">MAKE_FLAGS</code>?</p></td>
9053: </tr>
9054: <tr class="answer">
9055: <td align="left" valign="top"></td>
9056: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.157 leot 9057: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://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 9058: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9059: the <code class="varname">MAKE_PROGRAM</code> when building the
9060: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9061: </tr>
1.41 asau 9062: <tr class="question">
1.1 dsieger 9063: <td align="left" valign="top">
1.161 ! leot 9064: <a name="devfaq.make"></a><a name="idm74693040"></a><p><b>24.2.</b></p>
1.1 dsieger 9065: </td>
9066: <td align="left" valign="top"><p>What is the difference between
9067: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9068: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9069: </tr>
9070: <tr class="answer">
9071: <td align="left" valign="top"></td>
9072: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.157 leot 9073: <a class="citerefentry" href="http://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 9074: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9075: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9076: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9077: Make program that is used for building the
9078: package.</p></td>
9079: </tr>
1.41 asau 9080: <tr class="question">
1.1 dsieger 9081: <td align="left" valign="top">
1.161 ! leot 9082: <a name="devfaq.cc"></a><a name="idm74696880"></a><p><b>24.3.</b></p>
1.1 dsieger 9083: </td>
9084: <td align="left" valign="top"><p>What is the difference between
9085: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9086: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9087: </tr>
9088: <tr class="answer">
9089: <td align="left" valign="top"></td>
9090: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9091: compiler, which can be configured by the pkgsrc user.
9092: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9093: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9094: path to a compiler, but the type of compiler that should be
9095: used. See <code class="filename">mk/compiler.mk</code> for more
9096: information about the latter variable.</p></td>
9097: </tr>
1.41 asau 9098: <tr class="question">
1.1 dsieger 9099: <td align="left" valign="top">
1.161 ! leot 9100: <a name="devfaq.bl3flags"></a><a name="idm74700976"></a><p><b>24.4.</b></p>
1.1 dsieger 9101: </td>
9102: <td align="left" valign="top"><p>What is the difference between
9103: <code class="varname">BUILDLINK_LDFLAGS</code>,
9104: <code class="varname">BUILDLINK_LDADD</code> and
9105: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9106: </tr>
9107: <tr class="answer">
9108: <td align="left" valign="top"></td>
9109: <td align="left" valign="top"><p>[FIXME]</p></td>
9110: </tr>
1.41 asau 9111: <tr class="question">
1.1 dsieger 9112: <td align="left" valign="top">
1.161 ! leot 9113: <a name="devfaq.bl3prefix"></a><a name="idm74698800"></a><p><b>24.5.</b></p>
1.1 dsieger 9114: </td>
1.10 hubertf 9115: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9116: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9117: say it's empty?</p></td>
9118: </tr>
9119: <tr class="answer">
9120: <td align="left" valign="top"></td>
9121: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 9122: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9123: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 9124: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 9125: command.</p></td>
9126: </tr>
1.41 asau 9127: <tr class="question">
1.1 dsieger 9128: <td align="left" valign="top">
1.161 ! leot 9129: <a name="devfaq.master_sites"></a><a name="idm74703920"></a><p><b>24.6.</b></p>
1.1 dsieger 9130: </td>
9131: <td align="left" valign="top"><p>What does
1.108 rillig 9132: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9133: don't understand the <code class="code">:=</code> inside
1.1 dsieger 9134: it.</p></td>
9135: </tr>
9136: <tr class="answer">
9137: <td align="left" valign="top"></td>
1.108 rillig 9138: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
9139: assignment operator, although it looks like it.
1.1 dsieger 9140: Instead, it is a degenerate form of
1.108 rillig 9141: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.157 leot 9142: which is documented in the <a class="citerefentry" href="http://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 9143: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 9144: case of <code class="varname">MASTER_SITE_*</code>,
9145: <em class="replaceable"><code>old_string</code></em> is the empty string and
9146: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 9147: <code class="code">package/</code>. That's where the
9148: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 9149: together.</p></td>
9150: </tr>
1.41 asau 9151: <tr class="question">
1.1 dsieger 9152: <td align="left" valign="top">
1.161 ! leot 9153: <a name="devfaq.mailinglists"></a><a name="idm74717616"></a><p><b>24.7.</b></p>
1.1 dsieger 9154: </td>
9155: <td align="left" valign="top"><p>Which mailing lists are there for package
9156: developers?</p></td>
9157: </tr>
9158: <tr class="answer">
9159: <td align="left" valign="top"></td>
1.41 asau 9160: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 9161: <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 9162: <dd><p>This is a list for technical discussions related
9163: to pkgsrc development, e.g. soliciting feedback for changes to
9164: pkgsrc infrastructure, proposed new features, questions related
9165: to porting pkgsrc to a new platform, advice for maintaining a
9166: package, patches that affect many packages, help requests moved
9167: from pkgsrc-users when an infrastructure bug is found,
9168: etc.</p></dd>
1.10 hubertf 9169: <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 9170: <dd><p>All bug reports in category "pkg" sent with
1.157 leot 9171: <a class="citerefentry" href="http://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 9172: directly; use one of the other mailing
9173: lists.</p></dd>
9174: </dl></div></td>
9175: </tr>
1.41 asau 9176: <tr class="question">
1.1 dsieger 9177: <td align="left" valign="top">
1.161 ! leot 9178: <a name="devfaq.documentation"></a><a name="idm74722096"></a><p><b>24.8.</b></p>
1.1 dsieger 9179: </td>
9180: <td align="left" valign="top"><p>Where is the pkgsrc
9181: documentation?</p></td>
9182: </tr>
9183: <tr class="answer">
9184: <td align="left" valign="top"></td>
9185: <td align="left" valign="top">
9186: <p>There are many places where you can find
9187: documentation about pkgsrc:</p>
1.41 asau 9188: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9189: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9190: of chapters that explain large parts of pkgsrc, but some
9191: chapters tend to be outdated. Which ones they are is hard to
9192: say.</p></li>
1.23 wiz 9193: <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 9194: about certain features, announcements of new parts of the pkgsrc
9195: infrastructure and sometimes even announcements that a certain
9196: feature has been marked as obsolete. The benefit here is that
9197: each message has a date appended to it.</p></li>
1.23 wiz 9198: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9199: <code class="filename">mk/</code> directory start with a comment that
9200: describes the purpose of the file and how it can be used by the
9201: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9202: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9203: help</strong></span>.</p></li>
1.23 wiz 9204: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9205: information, but they tend to be highly abbreviated, especially
9206: for actions that occur often. Some contain a detailed
9207: description of what has changed, but they are geared towards the
9208: other pkgsrc developers, not towards an average pkgsrc user.
9209: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9210: don't know what has been before, these messages may not be worth
9211: too much to you.</p></li>
1.23 wiz 9212: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9213: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9214: mind of the developer who wrote the code. To get this
1.10 hubertf 9215: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9216: to see who has written it and ask on the
9217: <code class="literal">tech-pkg</code> mailing list, so that others can
9218: find your questions later (see above). To be sure that the
9219: developer in charge reads the mail, you may CC him or
9220: her.</p></li>
9221: </ul></div>
9222: </td>
9223: </tr>
1.41 asau 9224: <tr class="question">
1.1 dsieger 9225: <td align="left" valign="top">
1.161 ! leot 9226: <a name="devfaq.too-much-time"></a><a name="idm74727984"></a><p><b>24.9.</b></p>
1.1 dsieger 9227: </td>
9228: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9229: do?</p></td>
9230: </tr>
9231: <tr class="answer">
9232: <td align="left" valign="top"></td>
9233: <td align="left" valign="top">
9234: <p>This is not really an FAQ yet, but here's the answer
9235: anyway.</p>
1.41 asau 9236: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9237: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.137 leot 9238: <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 9239: will tell you about newer versions of installed packages that are
9240: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9241: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9242: — it contains a list of suggested new packages and a list of
1.1 dsieger 9243: cleanups and enhancements for pkgsrc that would be nice to
9244: have.</p></li>
1.23 wiz 9245: <li class="listitem"><p>Review packages for which review was requested on
1.71 wiz 9246: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9247: mailing list.</p></li>
9248: </ul></div>
9249: </td>
9250: </tr>
9251: </tbody>
9252: </table>
9253: </div>
9254: </div>
1.41 asau 9255: <div class="chapter">
1.1 dsieger 9256: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9257: <a name="gnome"></a>Chapter 25. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9258: <div class="toc">
9259: <p><b>Table of Contents</b></p>
1.100 leot 9260: <dl class="toc">
1.154 rillig 9261: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
9262: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
9263: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
9264: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1 dsieger 9265: </dl>
9266: </div>
1.10 hubertf 9267: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9268: site</a>:</p>
9269: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9270: environment, an intuitive and attractive desktop for users, and the
9271: GNOME development platform, an extensive framework for building
9272: applications that integrate into the rest of the desktop.</p></blockquote></div>
9273: <p>pkgsrc provides a seamless way to automatically build and install
9274: a complete GNOME environment <span class="emphasis"><em>under many different
9275: platforms</em></span>. We can say with confidence that pkgsrc is one of
9276: the most advanced build and packaging systems for GNOME due to its
9277: included technologies buildlink3, the wrappers and tools framework and
9278: automatic configuration file management. Lots of efforts are put into
9279: achieving a completely clean deinstallation of installed software
9280: components.</p>
1.10 hubertf 9281: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9282: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9283: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9284: pkgsrc as its preferred packaging system, contributing lots of
9285: portability fixes to make GNOME build and install under it.</p>
9286: <p>This chapter is aimed at pkgsrc developers and other people
9287: interested in helping our GNOME porting and packaging efforts. It
9288: provides instructions on how to manage the existing packages and some
9289: important information regarding their internals.</p>
1.41 asau 9290: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9291: <h3 class="title">We need your help!</h3>
9292: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9293: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9294: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9295: work</a> list! There is still a long way to go to get a
9296: fully-functional GNOME desktop under NetBSD and we need your help to
9297: achieve it!</p>
9298: </div>
1.41 asau 9299: <div class="sect1">
1.1 dsieger 9300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9301: <a name="meta-packages"></a>25.1. Meta packages</h2></div></div></div>
1.1 dsieger 9302: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9303: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 9304: <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 9305: the core GNOME desktop environment. It only includes the necessary
9306: bits to get it to boot correctly, although it may lack important
9307: functionality for daily operation. The idea behind this package is
9308: to let end users build their own configurations on top of this one,
9309: first installing this meta package to achieve a functional setup and
9310: then adding individual applications.</p></li>
1.137 leot 9311: <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 9312: complete installation of the GNOME platform and desktop as defined
9313: by the GNOME project; this is based on the components distributed in
9314: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9315: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9316: official FTP server. Developer-only tools found in those
9317: directories are not installed unless required by some other
9318: component to work properly. Similarly, packages from the bindings
9319: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9320: in unless required as a dependency for an end-user component. This
1.137 leot 9321: 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>
9322: <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 9323: Installs all the tools required to build a GNOME component when
9324: fetched from the CVS repository. These are required to let the
1.10 hubertf 9325: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9326: </ul></div>
9327: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9328: sorted in a way that eases updates: a package may depend on other
9329: packages listed before it but not on any listed after it. It is very
9330: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9331: change it to alphabetical sorting!</em></span></p>
9332: </div>
1.41 asau 9333: <div class="sect1">
1.1 dsieger 9334: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9335: <a name="new-package"></a>25.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9336: <p>Almost all GNOME applications are written in C and use a common
9337: set of tools as their build system. Things get different with the new
9338: bindings to other languages (such as Python), but the following will
9339: give you a general idea on the minimum required tools:</p>
1.41 asau 9340: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9341: <li class="listitem">
1.1 dsieger 9342: <p>Almost all GNOME applications use the GNU Autotools as their
9343: build system. As a general rule you will need to tell this to your
9344: package:</p>
9345: <pre class="programlisting">
9346: GNU_CONFIGURE=yes
9347: USE_LIBTOOL=yes
9348: USE_TOOLS+=gmake
9349: </pre>
9350: </li>
1.23 wiz 9351: <li class="listitem">
1.1 dsieger 9352: <p>If the package uses pkg-config to detect dependencies, add this
9353: tool to the list of required utilities:</p>
1.111 sevan 9354: <pre class="programlisting">
9355: USE_TOOLS+=pkg-config
9356: </pre>
1.137 leot 9357: <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 9358: the end of the build process to ensure that you did not miss to
9359: specify any dependency in your package and that the version
9360: requirements are all correct.</p>
9361: </li>
1.23 wiz 9362: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9363: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9364: to handle dependencies and to force the package to use the latest
9365: available version.</p></li>
1.23 wiz 9366: <li class="listitem">
1.1 dsieger 9367: <p>If the package uses gtk-doc (a documentation generation
9368: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9369: tool is rather big and the distfile should come with pregenerated
9370: documentation anyway; if it does not, it is a bug that you ought to
9371: report. For such packages you should disable gtk-doc (unless it is
9372: the default):</p>
1.111 sevan 9373: <pre class="programlisting">
9374: CONFIGURE_ARGS+=--disable-gtk-doc
9375: </pre>
1.1 dsieger 9376: <p>The default location of installed HTML files
9377: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9378: and should not be changed unless the package insists on installing
9379: them somewhere else. Otherwise programs as
1.10 hubertf 9380: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9381: do that with an entry similar to:</p>
1.111 sevan 9382: <pre class="programlisting">
9383: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9384: </pre>
1.1 dsieger 9385: </li>
9386: </ul></div>
9387: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9388: files under the installation prefix to maintain databases. In this
9389: context, shared means that those exact same directories and files are
9390: used among several different packages, leading to conflicts in the
9391: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9392: handle the most common cases, so you have to forget about using
9393: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9394: omitting shared files from them. If you find yourself doing those,
9395: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9396: <p>The following table lists the common situations that result in
9397: using shared directories or files. For each of them, the appropriate
9398: solution is given. After applying the solution be sure to
9399: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9400: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9401: <div class="table">
1.154 rillig 9402: <a name="plist-handling"></a><p class="title"><b>Table 25.1. PLIST handling for GNOME packages</b></p>
1.106 tnn 9403: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1 dsieger 9404: <colgroup>
9405: <col>
9406: <col>
9407: </colgroup>
9408: <thead><tr>
9409: <th>If the package...</th>
9410: <th>Then...</th>
9411: </tr></thead>
9412: <tbody>
9413: <tr>
9414: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.154 rillig 9415: <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 9416: </tr>
9417: <tr>
9418: <td>Installs icons under the
9419: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9420: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.154 rillig 9421: <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 9422: </tr>
9423: <tr>
9424: <td>Installs files under
9425: <code class="filename">share/mime/packages</code>.</td>
1.154 rillig 9426: <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 9427: </tr>
9428: <tr>
9429: <td>Installs <code class="filename">.desktop</code> files under
9430: <code class="filename">share/applications</code> and these include MIME
9431: information.</td>
1.154 rillig 9432: <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 9433: </tr>
9434: </tbody>
9435: </table></div>
9436: </div>
9437: <br class="table-break">
9438: </div>
1.41 asau 9439: <div class="sect1">
1.1 dsieger 9440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9441: <a name="full-update"></a>25.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9442: <p>When seeing GNOME as a whole, there are two kinds of
9443: updates:</p>
1.41 asau 9444: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 9445: <dt><span class="term">Major update</span></dt>
9446: <dd>
9447: <p>Given that there is still a very long way for GNOME 3 (if it
9448: ever appears), we consider a major update one that goes from a
9449: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9450: where <code class="literal">Y</code> is even and greater than
9451: <code class="literal">X</code>. These are hard to achieve because they
9452: introduce lots of changes in the components' code and almost all
9453: GNOME distfiles are updated to newer versions. Some of them can
9454: even break API and ABI compatibility with the previous major
9455: version series. As a result, the update needs to be done all at
9456: once to minimize breakage.</p>
9457: <p>A major update typically consists of around 80 package
9458: updates and the addition of some new ones.</p>
9459: </dd>
9460: <dt><span class="term">Minor update</span></dt>
9461: <dd>
9462: <p>We consider a minor update one that goes from a
9463: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9464: one where <code class="literal">Y</code> is greater than
9465: <code class="literal">X</code>. These are easy to achieve because they do
9466: not update all GNOME components, can be done in an incremental way
9467: and do not break API nor ABI compatibility.</p>
9468: <p>A minor update typically consists of around 50 package
9469: updates, although the numbers here may vary a lot.</p>
9470: </dd>
9471: </dl></div>
9472: <p>In order to update the GNOME components in pkgsrc to a new stable
9473: release (either major or minor), the following steps should be
9474: followed:</p>
1.23 wiz 9475: <div class="orderedlist"><ol class="orderedlist" type="1">
9476: <li class="listitem">
1.1 dsieger 9477: <p>Get a list of all the tarballs that form the new release by
9478: using the following commands. These will leave the full list of the
1.18 snj 9479: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 9480: file:</p>
9481: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9482: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9483: awk '{ print $9 }' >list.txt</code></strong>
9484: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9485: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9486: awk '{ print $9 }' >>list.txt</code></strong></pre>
9487: </li>
1.23 wiz 9488: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 9489: bump their version to the release you are updating them to. The
9490: three meta packages should be always consistent with versioning.
9491: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9492: in them.</p></li>
1.23 wiz 9493: <li class="listitem">
1.1 dsieger 9494: <p>For each meta package, update all its
9495: <code class="varname">DEPENDS</code> lines to match the latest versions as
9496: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9497: newer version (even if found in the FTP) because the meta packages
9498: are supposed to list the exact versions that form a specific GNOME
9499: release. Exceptions are permitted here if a newer version solves a
9500: serious issue in the overall desktop experience; these typically
9501: come in the form of a revision bump in pkgsrc, not in newer versions
9502: from the developers.</p>
9503: <p>Packages not listed in the <code class="filename">list.txt</code> file
9504: should be updated to the latest version available (if found in
9505: pkgsrc). This is the case, for example, of the dependencies on the
1.137 leot 9506: 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 9507: </li>
1.23 wiz 9508: <li class="listitem">
1.1 dsieger 9509: <p>Generate a patch from the modified meta packages and extract the
9510: list of "new" lines. This will provide you an outline on what
9511: packages need to be updated in pkgsrc and in what order:</p>
9512: <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>
9513: </li>
1.23 wiz 9514: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 9515: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 9516: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 9517: of <code class="filename">todo.txt</code> and update the packages listed in
9518: it in order. For major desktop updates none of these should be
9519: committed until the entire set is completed because there are chances
9520: of breaking not-yet-updated packages.</p></li>
1.23 wiz 9521: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 9522: the tree one by one with appropriate log messages. At the end,
9523: commit the three meta package updates and all the corresponding
9524: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9525: <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>
9526: </ol></div>
9527: </div>
1.41 asau 9528: <div class="sect1">
1.1 dsieger 9529: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9530: <a name="patching"></a>25.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9531: <p>GNOME is a very big component in pkgsrc which approaches 100
9532: packages. Please, it is very important that you always, always,
9533: <span class="strong"><strong>always</strong></span> feed back any portability
1.154 rillig 9534: 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 9535: their attention on portability issues and to ensure that future versions
9536: can be built out-of-the box on NetBSD. The less custom patches in
9537: pkgsrc, the easier further updates are. Those developers in charge of
9538: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9539: <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 9540: Bugzilla</a>. Not all components use these to track bugs, but most
9541: of them do. Do not be short on your reports: always provide detailed
9542: explanations of the current failure, how it can be improved to achieve
9543: maximum portability and, if at all possible, provide a patch against CVS
9544: head. The more verbose you are, the higher chances of your patch being
9545: accepted.</p>
9546: <p>Also, please avoid using preprocessor magic to fix portability
9547: issues. While the FreeBSD GNOME people are doing a great job in porting
9548: GNOME to their operating system, the official GNOME sources are now
9549: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9550: and similar macros. This hurts portability. Please see our patching
1.154 rillig 9551: 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 9552: details.</p>
9553: </div>
9554: </div>
9555: </div>
1.41 asau 9556: <div class="part">
1.1 dsieger 9557: <div class="titlepage"><div><div><h1 class="title">
9558: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 9559: <div class="partintro">
1.1 dsieger 9560: <div></div>
9561: <p>This part of the guide deals with everything
9562: from the infrastructure that is behind the interfaces described
9563: in the developer's guide. A casual package maintainer should not
9564: need anything from this part.</p>
9565: <div class="toc">
9566: <p><b>Table of Contents</b></p>
1.100 leot 9567: <dl class="toc">
1.154 rillig 9568: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 9569: <dd><dl>
1.154 rillig 9570: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
9571: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
9572: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 9573: <dd><dl>
1.154 rillig 9574: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
9575: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 9576: </dl></dd>
1.154 rillig 9577: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
9578: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9579: <dd><dl>
1.154 rillig 9580: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
9581: <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 9582: </dl></dd>
1.154 rillig 9583: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9584: <dd><dl>
1.154 rillig 9585: <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>
9586: <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 9587: </dl></dd>
9588: </dl></dd>
1.154 rillig 9589: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1 dsieger 9590: <dd><dl>
1.154 rillig 9591: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
9592: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9593: <dd><dl>
1.154 rillig 9594: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
9595: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 9596: </dl></dd>
9597: </dl></dd>
1.154 rillig 9598: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
9599: <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 9600: </dl>
9601: </div>
9602: </div>
1.41 asau 9603: <div class="chapter">
1.1 dsieger 9604: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9605: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 9606: <div class="toc">
9607: <p><b>Table of Contents</b></p>
1.100 leot 9608: <dl class="toc">
1.154 rillig 9609: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
9610: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
9611: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 9612: <dd><dl>
1.154 rillig 9613: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
9614: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 9615: </dl></dd>
1.154 rillig 9616: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
9617: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 9618: <dd><dl>
1.154 rillig 9619: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
9620: <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 9621: </dl></dd>
1.154 rillig 9622: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 9623: <dd><dl>
1.154 rillig 9624: <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>
9625: <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 9626: </dl></dd>
9627: </dl>
9628: </div>
9629: <p>The pkgsrc infrastructure consists of many small Makefile
9630: fragments. Each such fragment needs a properly specified
9631: interface. This chapter explains how such an interface looks
9632: like.</p>
1.41 asau 9633: <div class="sect1">
1.1 dsieger 9634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9635: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 9636: <p>Whenever a variable is defined in the pkgsrc
9637: infrastructure, the location and the way of definition provide
9638: much information about the intended use of that variable.
9639: Additionally, more documentation may be found in a header
9640: comment or in this pkgsrc guide.</p>
9641: <p>A special file is
9642: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9643: variables that are intended to be user-defined. They are either
9644: defined using the <code class="literal">?=</code> operator or they are
9645: left undefined because defining them to anything would
1.23 wiz 9646: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 9647: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9648: file.</p>
9649: <p>Outside this file, the following conventions apply:
9650: Variables that are defined using the <code class="literal">?=</code>
9651: operator may be overridden by a package.</p>
9652: <p>Variables that are defined using the <code class="literal">=</code>
9653: operator may be used read-only at run-time.</p>
9654: <p>Variables whose name starts with an underscore must not be
9655: accessed outside the pkgsrc infrastructure at all. They may
9656: change without further notice.</p>
1.41 asau 9657: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9658: <h3 class="title">Note</h3>
9659: <p>These conventions are currently not applied
9660: consistently to the complete pkgsrc
9661: infrastructure.</p>
9662: </div>
9663: </div>
1.41 asau 9664: <div class="sect1">
1.1 dsieger 9665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9666: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 9667: <p>All variables that contain lists of things should default
9668: to being empty. Two examples that do not follow this rule are
9669: <code class="varname">USE_LANGUAGES</code> and
9670: <code class="varname">DISTFILES</code>. These variables cannot simply be
9671: modified using the <code class="literal">+=</code> operator in package
9672: <code class="filename">Makefile</code>s (or other files included by
9673: them), since there is no guarantee whether the variable is
9674: already set or not, and what its value is. In the case of
1.23 wiz 9675: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 9676: the default value and just define it as in the following
9677: example.</p>
9678: <pre class="programlisting">
9679: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
9680: </pre>
9681: <p>Because of the selection of this default value, the same
9682: value appears in many package Makefiles. Similarly for
9683: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 9684: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 9685: doesn't stand out. Nevertheless it is mentioned in many
9686: files.</p>
9687: </div>
1.41 asau 9688: <div class="sect1">
1.1 dsieger 9689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9690: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.41 asau 9691: <div class="sect2">
1.1 dsieger 9692: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9693: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.1 dsieger 9694: <p>Variable evaluation takes place either at load time or at
9695: runtime, depending on the context in which they occur. The
9696: contexts where variables are evaluated at load time are:</p>
1.41 asau 9697: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9698: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 9699: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 9700: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 9701: <code class="literal">.for</code>,</p></li>
1.23 wiz 9702: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 9703: </ul></div>
9704: <p>A special exception are references to the iteration
9705: variables of <code class="literal">.for</code> loops, which are expanded
9706: inline, no matter in which context they appear.</p>
9707: <p>As the values of variables may change during load time,
9708: care must be taken not to evaluate them by accident. Typical
9709: examples for variables that should not be evaluated at load time
9710: are <code class="varname">DEPENDS</code> and
9711: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9712: clear, here is an example:</p>
9713: <pre class="programlisting">
9714: CONFIGURE_ARGS= # none
9715: CFLAGS= -O
9716: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
9717:
9718: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
9719:
9720: CFLAGS+= -Wall
1.111 sevan 9721: </pre>
1.1 dsieger 9722: <p>This code shows how the use of the <code class="literal">:=</code>
9723: operator can quickly lead to unexpected results. The first
9724: paragraph is fairly common code. The second paragraph evaluates
9725: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9726: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9727: <code class="literal">-Wall</code> is appended to the
9728: <code class="varname">CFLAGS</code>, but this addition will not appear in
9729: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9730: paragraphs from above typically occur in completely unrelated
9731: files.</p>
9732: </div>
1.41 asau 9733: <div class="sect2">
1.1 dsieger 9734: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9735: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.1 dsieger 9736: <p>After all the files have been loaded, the values of the
9737: variables cannot be changed anymore. Variables that are used in
9738: the shell commands are expanded at this point.</p>
9739: </div>
9740: </div>
1.41 asau 9741: <div class="sect1">
1.1 dsieger 9742: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9743: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 9744: <p>There are many ways in which the definition and use of a
1.108 rillig 9745: variable can be restricted in order to detect bugs and violations
9746: of the (mostly unwritten) policies. A package can be checked with
9747: <code class="literal">pkglint -Wall</code> to see whether it meets these
9748: rules.</p>
1.1 dsieger 9749: </div>
1.41 asau 9750: <div class="sect1">
1.1 dsieger 9751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9752: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 9753: <p>Most of the <code class="filename">.mk</code> files fall into one
9754: of the following classes. Cases where a file falls into more
9755: than one class should be avoided as it often leads to subtle
9756: bugs.</p>
1.41 asau 9757: <div class="sect2">
1.1 dsieger 9758: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9759: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 9760: <p>In a traditional imperative programming language some of
9761: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 9762: procedures. They take some input parameters and—after
9763: inclusion—provide a result in output parameters. Since all
1.1 dsieger 9764: variables in <code class="filename">Makefile</code>s have global scope
9765: care must be taken not to use parameter names that have already
9766: another meaning. For example, <code class="varname">PKGNAME</code> is a
9767: bad choice for a parameter name.</p>
9768: <p>Procedures are completely evaluated at preprocessing time.
9769: That is, when calling a procedure all input parameters must be
9770: completely resolvable. For example,
9771: <code class="varname">CONFIGURE_ARGS</code> should never be an input
9772: parameter since it is very likely that further text will be
9773: added after calling the procedure, which would effectively apply
9774: the procedure to only a part of the variable. Also, references
1.108 rillig 9775: to other variables will be modified after calling the
1.1 dsieger 9776: procedure.</p>
9777: <p>A procedure can declare its output parameters either as
9778: suitable for use in preprocessing directives or as only
9779: available at runtime. The latter alternative is for variables
9780: that contain references to other runtime variables.</p>
9781: <p>Procedures shall be written such that it is possible to
9782: call the procedure more than once. That is, the file must not
9783: contain multiple-inclusion guards.</p>
9784: <p>Examples for procedures are
9785: <code class="filename">mk/bsd.options.mk</code> and
9786: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
9787: that the parameters are evaluated at load time, they should be
9788: assigned using the <code class="literal">:=</code> operator, which should
9789: be used only for this purpose.</p>
9790: </div>
1.41 asau 9791: <div class="sect2">
1.1 dsieger 9792: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9793: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 9794: <p>Action files take some input parameters and may define
9795: runtime variables. They shall not define loadtime variables.
9796: There are action files that are included implicitly by the
9797: pkgsrc infrastructure, while other must be included
9798: explicitly.</p>
9799: <p>An example for action files is
9800: <code class="filename">mk/subst.mk</code>.</p>
9801: </div>
9802: </div>
1.41 asau 9803: <div class="sect1">
1.1 dsieger 9804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9805: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 9806: <p>Package <code class="filename">Makefile</code>s usually consist of
9807: a set of variable definitions, and include the file
9808: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
9809: Before that, they may also include various other
9810: <code class="filename">*.mk</code> files if they need to query the
9811: availability of certain features like the type of compiler or
9812: the X11 implementation. Due to the heavy use of preprocessor
9813: directives like <code class="literal">.if</code> and
9814: <code class="literal">.for</code>, the order in which the files are loaded
9815: matters.</p>
9816: <p>This section describes at which point the various files
9817: are loaded and gives reasons for that order.</p>
1.41 asau 9818: <div class="sect2">
1.1 dsieger 9819: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9820: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 9821: </h3></div></div></div>
9822: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
9823: is to define some essential variables like
9824: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
9825: <code class="varname">MACHINE_ARCH</code>.</p>
9826: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 9827: 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 9828: After that, those variables
1.1 dsieger 9829: that have not been overridden by the user are loaded from
9830: <code class="filename">mk/defaults/mk.conf</code>.</p>
9831: <p>After the user settings, the system settings and platform
9832: settings are loaded, which may override the user
9833: settings.</p>
9834: <p>Then, the tool definitions are loaded. The tool wrappers
9835: are not yet in effect. This only happens when building a
9836: package, so the proper variables must be used instead of the
9837: direct tool names.</p>
9838: <p>As the last steps, some essential variables from the
9839: wrapper and the package system flavor are loaded, as well as the
9840: variables that have been cached in earlier phases of a package
9841: build.</p>
9842: </div>
1.41 asau 9843: <div class="sect2">
1.1 dsieger 9844: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9845: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 9846: </h3></div></div></div>
9847: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
9848: <p>Then, the various <code class="filename">*-vars.mk</code> files are
9849: loaded, which fill default values for those variables that have
9850: not been defined by the package. These variables may later
9851: be used even in unrelated files.</p>
9852: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
9853: provides the target <code class="literal">error-check</code> that is added
9854: as a special dependency to all other targets that use
9855: <code class="varname">DELAYED_ERROR_MSG</code> or
9856: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
9857: <p>Then, the package-specific hacks from
9858: <code class="filename">hacks.mk</code> are included.</p>
9859: <p>Then, various other files follow. Most of them don't have
9860: any dependencies on what they need to have included before or
9861: after them, though some do.</p>
9862: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
9863: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
9864: restricts the use of these variables to all the files that have
9865: been included before. Appearances in later files will be
9866: silently ignored.</p>
9867: <p>Then, the files for the main targets are included, in the
9868: order of later execution, though the actual order should not
9869: matter.</p>
9870: <p>At last, some more files are included that don't set any
9871: interesting variables but rather just define make targets to be
9872: executed.</p>
9873: </div>
9874: </div>
9875: </div>
1.41 asau 9876: <div class="chapter">
1.1 dsieger 9877: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9878: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.1 dsieger 9879: <div class="toc">
9880: <p><b>Table of Contents</b></p>
1.100 leot 9881: <dl class="toc">
1.154 rillig 9882: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
9883: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 9884: <dd><dl>
1.154 rillig 9885: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
9886: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 9887: </dl></dd>
9888: </dl>
9889: </div>
9890: <p>The pkgsrc infrastructure consists of a large codebase,
9891: and there are many corners where every little bit of a file is
9892: well thought out, making pkgsrc likely to fail as soon as
9893: anything is changed near those parts. To prevent most changes
9894: from breaking anything, a suite of regression tests should go
9895: along with every important part of the pkgsrc infrastructure.
9896: This chapter describes how regression tests work in pkgsrc and
9897: how you can add new tests.</p>
1.41 asau 9898: <div class="sect1">
1.1 dsieger 9899: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9900: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.137 leot 9901: <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 9902: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 9903: can simply run that command, which will run all tests in the
9904: <code class="filename">regress</code> category.</p>
9905: </div>
1.41 asau 9906: <div class="sect1">
1.1 dsieger 9907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9908: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.1 dsieger 9909: <p>Every directory in the <code class="filename">regress</code>
9910: category that contains a file called <code class="filename">spec</code>
9911: is considered a regression test. This file is a shell program
1.10 hubertf 9912: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 9913: The following functions can be overridden to suit your
9914: needs.</p>
1.41 asau 9915: <div class="sect2">
1.1 dsieger 9916: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9917: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 9918: <p>These functions do not take any parameters. Although they
9919: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
9920: first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
9921: question</a> for details.</p>
1.41 asau 9922: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9923: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 9924: <dd><p>This function prepares the environment for the
9925: test. By default it does nothing.</p></dd>
1.108 rillig 9926: <dt><span class="term"><code class="varname">do_test</code></span></dt>
9927: <dd>
9928: <p>This function runs the actual test. By default,
1.1 dsieger 9929: it calls <code class="varname">TEST_MAKE</code> with the arguments
9930: <code class="varname">MAKEARGS_TEST</code> and writes its output including
9931: error messages into the file
1.108 rillig 9932: <code class="varname">TEST_OUTFILE</code>.</p>
9933: <p>When defining this function, make sure that all output that
9934: needs to be checked is written to the correct output file.
9935: Example:</p>
9936: <pre class="programlisting">
9937: do_test() {
1.112 rillig 9938: echo "Example output"
1.108 rillig 9939: } 1>$TEST_OUTFILE 2>&1
9940: </pre>
9941: </dd>
9942: <dt><span class="term"><code class="varname">check_result</code></span></dt>
9943: <dd>
9944: <p>This function is run after the test and is
1.1 dsieger 9945: typically used to compare the actual output from the one that is
9946: expected. It can make use of the various helper functions from
1.108 rillig 9947: the next section. Example:</p>
9948: <pre class="programlisting">
9949: check_result() {
1.112 rillig 9950: exit_status 0
9951: output_require "Example"
9952: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9953: output_prohibit "no such file or directory"
1.108 rillig 9954: }
9955: </pre>
9956: </dd>
9957: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 9958: <dd><p>This function cleans everything up after the
9959: test has been run. By default it does nothing.</p></dd>
9960: </dl></div>
9961: </div>
1.41 asau 9962: <div class="sect2">
1.1 dsieger 9963: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9964: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.41 asau 9965: <div class="variablelist"><dl class="variablelist">
1.108 rillig 9966: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 9967: <dd><p>This function compares the exitcode of the
1.108 rillig 9968: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 9969: If they differ, the test will fail.</p></dd>
1.108 rillig 9970: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
9971: <dd>
9972: <p>This function checks for each of its parameters
9973: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 9974: extended regular expression. If it does not, the test will
1.108 rillig 9975: fail. Example:</p>
9976: <pre class="programlisting">
9977: output_require "looks fine"
9978: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9979: </pre>
9980: </dd>
1.1 dsieger 9981: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
9982: <dd><p>This function checks for each of its parameters
1.10 hubertf 9983: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 9984: <span class="emphasis"><em>not</em></span> match the extended regular expression.
9985: If any of the regular expressions matches, the test will
9986: fail.</p></dd>
9987: </dl></div>
9988: </div>
9989: </div>
9990: </div>
1.41 asau 9991: <div class="chapter">
1.1 dsieger 9992: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9993: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 9994: <div class="toc">
9995: <p><b>Table of Contents</b></p>
1.154 rillig 9996: <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 9997: </div>
9998: <p>The pkgsrc system has already been ported to many
9999: operating systems, hardware architectures and compilers. This
10000: chapter explains the necessary steps to make pkgsrc even more
10001: portable.</p>
1.41 asau 10002: <div class="sect1">
1.1 dsieger 10003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10004: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10005: <p>To port pkgsrc to a new operating system (called
10006: <code class="literal">MyOS</code> in this example), you need to touch the
10007: following files:</p>
1.41 asau 10008: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10009: <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>
10010: <dd><p>This file contains some basic definitions, for
10011: example the name of the C
10012: compiler.</p></dd>
10013: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10014: <dd><p>Insert code that defines the variables
10015: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10016: <code class="varname">LOWER_OS_VERSION</code>,
10017: <code class="varname">LOWER_VENDOR</code>,
10018: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10019: <code class="varname">APPEND_ELF</code>, and the other variables that
10020: appear in this file.</p></dd>
10021: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10022: <dd><p>This file contains the platform-specific
10023: definitions that are used by pkgsrc. Start by copying one of the
10024: other files and edit it to your
10025: needs.</p></dd>
10026: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10027: <dd><p>This file defines the paths to all the tools
10028: that are needed by one or the other package in pkgsrc, as well
10029: as by pkgsrc itself. Find out where these tools are on your
10030: platform and add them.</p></dd>
10031: </dl></div>
10032: <p>Now, you should be able to build some basic packages, like
1.137 leot 10033: <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 10034: </div>
10035: </div>
10036: </div>
1.41 asau 10037: <div class="appendix">
10038: <div class="titlepage"><div><div><h1 class="title">
10039: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10040: <div class="toc">
10041: <p><b>Table of Contents</b></p>
1.100 leot 10042: <dl class="toc">
1.1 dsieger 10043: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10044: <dd><dl>
10045: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10046: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10047: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 10048: <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 10049: </dl></dd>
10050: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10051: </dl>
10052: </div>
10053: <p>We checked to find a piece of software that wasn't in the packages
10054: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10055: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10056: present in the tree is beyond us, but it's useful for the purposes of
10057: this exercise.</p>
1.41 asau 10058: <div class="sect1">
1.1 dsieger 10059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10060: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10061: <div class="sect2">
1.1 dsieger 10062: <div class="titlepage"><div><div><h3 class="title">
10063: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10064: <pre class="programlisting">
10065: # $NetBSD$
10066: #
10067:
10068: DISTNAME= bison-1.25
10069: CATEGORIES= devel
10070: MASTER_SITES= ${MASTER_SITE_GNU}
10071:
1.29 dholland 10072: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 10073: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10074: COMMENT= GNU yacc clone
10075:
10076: GNU_CONFIGURE= yes
1.46 wiz 10077: INFO_FILES= yes
1.1 dsieger 10078:
10079: .include "../../mk/bsd.pkg.mk"
10080: </pre>
10081: </div>
1.41 asau 10082: <div class="sect2">
1.1 dsieger 10083: <div class="titlepage"><div><div><h3 class="title">
10084: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10085: <pre class="programlisting">
10086: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.157 leot 10087: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://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 10088: of the NetBSD source tree is beyond me.
10089: </pre>
10090: </div>
1.41 asau 10091: <div class="sect2">
1.1 dsieger 10092: <div class="titlepage"><div><div><h3 class="title">
10093: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10094: <pre class="programlisting">
10095: @comment $NetBSD$
10096: bin/bison
10097: man/man1/bison.1.gz
10098: share/bison.simple
10099: share/bison.hairy
10100: </pre>
10101: </div>
1.41 asau 10102: <div class="sect2">
1.1 dsieger 10103: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 10104: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 10105: </h3></div></div></div>
10106: <p>The NetBSD package system comes with
1.137 leot 10107: <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 10108: which helps to check the contents of these
10109: files. After installation it is quite easy to use, just change to the
10110: directory of the package you wish to examine and execute
1.10 hubertf 10111: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10112: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10113: looks fine.</pre>
10114: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 10115: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 10116: -Wall</strong></span> for a very thorough check.</p>
10117: </div>
10118: </div>
1.41 asau 10119: <div class="sect1">
1.1 dsieger 10120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10121: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10122: <p>Create the directory where the package lives,
10123: plus any auxiliary directories:</p>
10124: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10125: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10126: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10127: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10128: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.154 rillig 10129: <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 10130: then continue with fetching the distfile:</p>
10131: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10132: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10133: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10134: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10135: ftp: Error retrieving file: 500 Internal error
10136:
10137: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10138: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10139: ftp: Error retrieving file: 500 Internal error
10140:
10141: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10142: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10143: Successfully retrieved file.</pre>
10144: <p>Generate the checksum of the distfile into
10145: <code class="filename">distinfo</code>:</p>
10146: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10147: <p>Now compile:</p>
10148: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10149: >> Checksum OK for bison-1.25.tar.gz.
10150: ===> Extracting for bison-1.25
10151: ===> Patching for bison-1.25
10152: ===> Ignoring empty patch directory
10153: ===> Configuring for bison-1.25
10154: creating cache ./config.cache
10155: checking for gcc... cc
10156: checking whether we are using GNU C... yes
10157: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10158: checking how to run the C preprocessor... cc -E
10159: checking for minix/config.h... no
10160: checking for POSIXized ISC... no
10161: checking whether cross-compiling... no
10162: checking for ANSI C header files... yes
10163: checking for string.h... yes
10164: checking for stdlib.h... yes
10165: checking for memory.h... yes
10166: checking for working const... yes
10167: checking for working alloca.h... no
10168: checking for alloca... yes
10169: checking for strerror... yes
10170: updating cache ./config.cache
10171: creating ./config.status
10172: creating Makefile
10173: ===> Building for bison-1.25
10174: 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
10175: 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
10176: 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
10177: 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
10178: 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
10179: 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
10180: 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
10181: 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
10182: 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
10183: 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
10184: 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
10185: 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
10186: 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
10187: 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
10188: 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
10189: 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
10190: 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
10191: 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
10192: 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
10193: 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
10194: 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
10195: 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
10196: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10197: rm -f bison.s1
10198: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10199: <p>Everything seems OK, so install the files:</p>
10200: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10201: >> Checksum OK for bison-1.25.tar.gz.
10202: ===> Installing for bison-1.25
10203: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10204: rm -f /usr/pkg/bin/bison
10205: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10206: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10207: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10208: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10209: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10210: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10211: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10212: ===> Registering installation for bison-1.25</pre>
10213: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10214: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10215: binary package, do this now:</p>
10216: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10217: >> Checksum OK for bison-1.25.tar.gz.
10218: ===> Building package for bison-1.25
10219: Creating package bison-1.25.tgz
10220: Registering depends:.
10221: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10222: <p>Now that you don't need the source and object files
10223: any more, clean up:</p>
10224: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10225: ===> Cleaning for bison-1.25</pre>
10226: </div>
10227: </div>
1.41 asau 10228: <div class="appendix">
10229: <div class="titlepage"><div><div><h1 class="title">
10230: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10231: <div class="toc">
10232: <p><b>Table of Contents</b></p>
1.100 leot 10233: <dl class="toc">
1.1 dsieger 10234: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10235: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10236: </dl>
10237: </div>
1.41 asau 10238: <div class="sect1">
1.1 dsieger 10239: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10240: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10241: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10242: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10243: => figlet221.tar.gz doesn't seem to exist on this system.
10244: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10245: => [172219 bytes]
10246: Connected to ftp.plig.net.
10247: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10248: 331 Guest login ok, send your complete e-mail address as password.
10249: 230-You are user #5 of 500 simultaneous users allowed.
10250: 230-
10251: 230- ___ _ _ _
10252: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10253: 230- | _| _| . |_| . | | | . |_| . | _| . |
10254: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10255: 230- |_| |_| |___| |___|
10256: 230-
10257: 230-** Welcome to ftp.plig.org **
10258: 230-
10259: 230-Please note that all transfers from this FTP site are logged. If you
10260: 230-do not like this, please disconnect now.
10261: 230-
1.18 snj 10262: 230-This archive is available via
1.1 dsieger 10263: 230-
10264: 230-HTTP: http://ftp.plig.org/
10265: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10266: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10267: 230-
10268: 230-Please email comments, bug reports and requests for packages to be
10269: 230-mirrored to ftp-admin@plig.org.
10270: 230-
10271: 230-
10272: 230 Logged in anonymously.
10273: Remote system type is UNIX.
10274: Using binary mode to transfer files.
10275: 200 Type okay.
10276: 250 "/pub" is new cwd.
10277: 250-"/pub/figlet" is new cwd.
10278: 250-
10279: 250-Welcome to the figlet archive at ftp.figlet.org
10280: 250-
10281: 250- ftp://ftp.figlet.org/pub/figlet/
10282: 250-
10283: 250-The official FIGlet web page is:
10284: 250- http://www.figlet.org/
10285: 250-
10286: 250-If you have questions, please mailto:info@figlet.org. If you want to
10287: 250-contribute a font or something else, you can email us.
10288: 250
10289: 250 "/pub/figlet/program" is new cwd.
10290: 250 "/pub/figlet/program/unix" is new cwd.
10291: local: figlet221.tar.gz remote: figlet221.tar.gz
10292: 502 Unimplemented command.
10293: 227 Entering Passive Mode (195,40,6,41,246,104)
10294: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10295: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10296: 226 Transfer completed.
10297: 172219 bytes received in 00:02 (75.99 KB/s)
10298: 221 Goodbye.
10299: => Checksum OK for figlet221.tar.gz.
10300: ===> Extracting for figlet-2.2.1nb2
10301: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10302: ===> Patching for figlet-2.2.1nb2
10303: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10304: ===> Overriding tools for figlet-2.2.1nb2
10305: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10306: ===> Configuring for figlet-2.2.1nb2
10307: ===> Building for figlet-2.2.1nb2
10308: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10309: chmod a+x figlet
10310: gcc -O2 -o chkfont chkfont.c
10311: => Unwrapping files-to-be-installed.
10312: <code class="prompt">#</code>
10313: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10314: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10315: ===> Installing for figlet-2.2.1nb2
10316: install -d -o root -g wheel -m 755 /usr/pkg/bin
10317: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10318: mkdir -p /usr/pkg/share/figlet
10319: cp figlet /usr/pkg/bin
10320: cp chkfont /usr/pkg/bin
10321: chmod 555 figlist showfigfonts
10322: cp figlist /usr/pkg/bin
10323: cp showfigfonts /usr/pkg/bin
10324: cp fonts/*.flf /usr/pkg/share/figlet
10325: cp fonts/*.flc /usr/pkg/share/figlet
10326: cp figlet.6 /usr/pkg/man/man6
10327: ===> Registering installation for figlet-2.2.1nb2
10328: <code class="prompt">#</code></pre>
10329: </div>
1.41 asau 10330: <div class="sect1">
1.1 dsieger 10331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10332: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10333: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10334: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10335: ===> Packaging figlet-2.2.1nb2
10336: ===> Building binary package for figlet-2.2.1nb2
10337: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10338: Using SrcDir value of /usr/pkg
10339: Registering depends:.
10340: <code class="prompt">#</code></pre>
10341: </div>
10342: </div>
1.41 asau 10343: <div class="appendix">
10344: <div class="titlepage"><div><div><h1 class="title">
10345: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10346: <div class="toc">
10347: <p><b>Table of Contents</b></p>
1.100 leot 10348: <dl class="toc">
1.23 wiz 10349: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10350: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10351: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10352: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10353: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148 leot 10354: <code class="filename">stable</code>,
1.23 wiz 10355: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10356: source packages</a></span></dt>
10357: </dl>
10358: </div>
10359: <p>As in other big projects, the directory layout of pkgsrc
10360: is quite complex for newbies. This chapter explains where you
10361: find things on the FTP server. The base directory on
1.10 hubertf 10362: <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 10363: On other servers it may be different, but inside this directory,
10364: everything should look the same, no matter on which server you
10365: are. This directory contains some subdirectories, which are
10366: explained below.</p>
1.41 asau 10367: <div class="sect1">
1.1 dsieger 10368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10369: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10370: <p>The directory <code class="filename">distfiles</code> contains lots
10371: of archive files from all pkgsrc packages, which are mirrored
10372: here. The subdirectories are called after their package names
10373: and are used when the distributed files have names that don't
10374: explicitly contain a version number or are otherwise too generic
10375: (for example <code class="filename">release.tar.gz</code>).</p>
10376: </div>
1.41 asau 10377: <div class="sect1">
1.1 dsieger 10378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10379: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10380: <p>This directory contains things that individual pkgsrc
10381: developers find worth publishing.</p>
10382: </div>
1.41 asau 10383: <div class="sect1">
1.1 dsieger 10384: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10385: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10386: <p>This directory contains binary packages for the various
10387: platforms that are supported by pkgsrc.
10388: 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 10389: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10390: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10391: operating system for which the packages have been built. The
1.10 hubertf 10392: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10393: command, so it may differ from the one you are used to
10394: hear.</p></li>
1.23 wiz 10395: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10396: architecture of the platform for which the packages have been
1.10 hubertf 10397: built. It also includes the <code class="varname">ABI</code> (Application
10398: Binary Interface) for platforms that have several of
10399: them.</p></li>
1.23 wiz 10400: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10401: the operating system. For version numbers that change often (for
10402: example NetBSD-current), the often-changing part should be
10403: replaced with an <code class="literal">x</code>, for example
10404: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10405: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10406: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10407: for a stable branch, or <code class="literal">head</code> for packages
10408: built from the HEAD branch. The latter should only be used when
10409: the packages are updated on a regular basis. Otherwise the date
10410: from checking out pkgsrc should be appended, for example
10411: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10412: </ul></div>
10413: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10414: can quickly click through the directories on the
10415: server and find the best binary packages for their machines. Since they
10416: usually know the operating system and the hardware architecture, OPSYS
10417: and ARCH are placed first. After these choices, they can select the
10418: best combination of OSVERSION and TAG together, since it is usually the
10419: case that packages stay compatible between different version of the
10420: operating system.</p>
10421: <p>In each of these directories, there is a
10422: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10423: <code class="filename">All</code> which contains all binary packages.
10424: Besides that, there are various category directories that
10425: contain symbolic links to the real binary packages.</p>
10426: </div>
1.41 asau 10427: <div class="sect1">
1.1 dsieger 10428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10429: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10430: <p>Here are the reports from bulk builds, for those who want
10431: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10432: 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 10433: </div>
1.41 asau 10434: <div class="sect1">
1.8 rillig 10435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10436: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.148 leot 10437: <code class="filename">stable</code>,
1.22 jakllsch 10438: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10439: source packages</h2></div></div></div>
1.23 wiz 10440: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 10441: that is the files that define how to create binary packages from
10442: source archives.</p>
1.149 leot 10443: <p>Each of the <code class="filename">current</code>,
10444: <code class="filename">stable</code> and
10445: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
10446: directories share the same structure. They each contain a
10447: <code class="filename">pkgsrc</code> directory and
10448: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 10449: <p>The directory <code class="filename">pkgsrc</code> contains a
10450: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 10451: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
10452: as the directory, ready to be downloaded as a whole.</p>
10453: <p>The <code class="filename">current</code> directory contains files
10454: related to the HEAD branch of the CVS repository.
10455: In this directory there is an additional file called
10456: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
10457: all pkgsrc <code class="filename">README</code>s with information about
10458: categories and packages.
10459: </p>
10460: <p>The <code class="filename">stable</code> directory is a symlink to
10461: the latest
10462: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
10463: </p>
10464: <p>The
10465: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
10466: directories contain files related to the
10467: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
10468: stable branch of the CVS repository. In these directories there is
10469: an additional file called
10470: <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 10471: which contains the state of pkgsrc when it was branched.</p>
10472: </div>
10473: </div>
1.41 asau 10474: <div class="appendix">
10475: <div class="titlepage"><div><div><h1 class="title">
1.154 rillig 10476: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
10477: <p>
10478: The following list contains all help topics that are available
10479: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
10480: </p>
1.156 leot 10481: <table border="0" summary="Simple list" class="simplelist">
10482: <tr>
10483: <td>#!</td>
10484: <td>-lintl</td>
10485: </tr>
10486: <tr>
10487: <td>64bit</td>
10488: <td>ABI</td>
10489: </tr>
10490: <tr>
10491: <td>ACCEPTABLE_LICENSES</td>
10492: <td>ACROREAD_FONTPATH</td>
10493: </tr>
10494: <tr>
10495: <td>ADDITIONAL</td>
10496: <td>AFAIK</td>
10497: </tr>
10498: <tr>
10499: <td>AIX</td>
10500: <td>ALLOW_VULNERABLE_PACKAGES</td>
10501: </tr>
10502: <tr>
10503: <td>ALL_ENV</td>
1.161 ! leot 10504: <td>ALSA_PC</td>
! 10505: </tr>
! 10506: <tr>
1.160 brook 10507: <td>ALTERNATIVES_SRC</td>
1.161 ! leot 10508: <td>AMANDA_TMP</td>
1.159 rillig 10509: </tr>
10510: <tr>
1.160 brook 10511: <td>AMANDA_USER</td>
1.161 ! leot 10512: <td>AMANDA_VAR</td>
1.156 leot 10513: </tr>
10514: <tr>
1.160 brook 10515: <td>APACHE_GROUP</td>
1.161 ! leot 10516: <td>APACHE_MODULE_NAME</td>
1.156 leot 10517: </tr>
10518: <tr>
1.160 brook 10519: <td>APACHE_MODULE_SRC</td>
1.161 ! leot 10520: <td>APACHE_MODULE_SRCDIR</td>
1.156 leot 10521: </tr>
10522: <tr>
1.160 brook 10523: <td>APACHE_PKG_PREFIX</td>
1.161 ! leot 10524: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.156 leot 10525: </tr>
10526: <tr>
1.160 brook 10527: <td>APACHE_SUEXEC_DOCROOT</td>
1.161 ! leot 10528: <td>APACHE_USER</td>
1.156 leot 10529: </tr>
10530: <tr>
1.160 brook 10531: <td>APPEND_ABI</td>
1.161 ! leot 10532: <td>APPEND_ELF</td>
1.156 leot 10533: </tr>
10534: <tr>
1.160 brook 10535: <td>ARLA_CACHE</td>
1.161 ! leot 10536: <td>AUDIT_PACKAGES_FLAGS</td>
1.156 leot 10537: </tr>
10538: <tr>
1.160 brook 10539: <td>AUTOCONF_REQD</td>
1.161 ! leot 10540: <td>AUTOMAKE_OVERRIDE</td>
1.156 leot 10541: </tr>
10542: <tr>
1.160 brook 10543: <td>AUTOMAKE_REQD</td>
1.161 ! leot 10544: <td>AUTO_MKDIRS</td>
1.156 leot 10545: </tr>
10546: <tr>
1.160 brook 10547: <td>BDB185_DEFAULT</td>
1.161 ! leot 10548: <td>BDBBASE</td>
1.156 leot 10549: </tr>
10550: <tr>
1.160 brook 10551: <td>BDB_ACCEPTED</td>
1.161 ! leot 10552: <td>BDB_DEFAULT</td>
1.156 leot 10553: </tr>
10554: <tr>
1.160 brook 10555: <td>BDB_LIBS</td>
1.161 ! leot 10556: <td>BDB_TYPE</td>
1.156 leot 10557: </tr>
10558: <tr>
1.160 brook 10559: <td>BIND_DIR</td>
1.161 ! leot 10560: <td>BIND_GROUP</td>
1.156 leot 10561: </tr>
10562: <tr>
1.160 brook 10563: <td>BIND_USER</td>
1.161 ! leot 10564: <td>BINPKG_SITES</td>
1.156 leot 10565: </tr>
10566: <tr>
1.160 brook 10567: <td>BIN_INSTALL_FLAGS</td>
1.161 ! leot 10568: <td>BISON_PKGDATADIR</td>
! 10569: </tr>
! 10570: <tr>
! 10571: <td>BLAS_ACCEPTED</td>
! 10572: <td>BLAS_LIBS</td>
1.156 leot 10573: </tr>
10574: <tr>
1.161 ! leot 10575: <td>BLAS_TYPE</td>
1.156 leot 10576: <td>BOOTSTRAP_DEPENDS</td>
10577: </tr>
10578: <tr>
10579: <td>BOOTSTRAP_SETUPTOOLS</td>
10580: <td>BROKEN</td>
10581: </tr>
10582: <tr>
10583: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
10584: <td>BROKEN_ON_PLATFORM</td>
10585: </tr>
10586: <tr>
10587: <td>BSDSRCDIR</td>
10588: <td>BSDXSRCDIR</td>
10589: </tr>
10590: <tr>
10591: <td>BSD_MAKE_ENV</td>
10592: <td>BUILDLINK_AUTO_DIRS</td>
10593: </tr>
10594: <tr>
10595: <td>BUILDLINK_AUTO_VARS</td>
10596: <td>BUILDLINK_CFLAGS</td>
10597: </tr>
10598: <tr>
10599: <td>BUILDLINK_CONTENTS_FILTER</td>
10600: <td>BUILDLINK_CPPFLAGS</td>
10601: </tr>
10602: <tr>
10603: <td>BUILDLINK_DEPMETHOD</td>
10604: <td>BUILDLINK_FILES</td>
10605: </tr>
10606: <tr>
10607: <td>BUILDLINK_FILES_CMD</td>
10608: <td>BUILDLINK_FNAME_TRANSFORM</td>
10609: </tr>
10610: <tr>
10611: <td>BUILDLINK_LDFLAGS</td>
10612: <td>BUILDLINK_LIBS</td>
10613: </tr>
10614: <tr>
10615: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
10616: <td>BUILDLINK_PKGNAME</td>
10617: </tr>
10618: <tr>
10619: <td>BUILDLINK_PREFIX</td>
10620: <td>BUILDLINK_RPATHDIRS</td>
10621: </tr>
10622: <tr>
10623: <td>BUILDLINK_TREE</td>
10624: <td>BUILD_DEFS</td>
10625: </tr>
10626: <tr>
10627: <td>BUILD_DEFS_EFFECTS</td>
10628: <td>BUILD_DEPENDS</td>
10629: </tr>
10630: <tr>
10631: <td>BUILD_DIRS</td>
10632: <td>BUILD_ENV_SHELL</td>
10633: </tr>
10634: <tr>
10635: <td>BUILD_MAKE_CMD</td>
10636: <td>BUILD_MAKE_FLAGS</td>
10637: </tr>
10638: <tr>
10639: <td>BUILD_TARGET</td>
10640: <td>BUILTIN_FIND_FILES</td>
10641: </tr>
10642: <tr>
10643: <td>BUILTIN_FIND_FILES_VAR</td>
10644: <td>BUILTIN_FIND_GREP</td>
10645: </tr>
10646: <tr>
10647: <td>BUILTIN_FIND_HEADERS</td>
10648: <td>BUILTIN_FIND_HEADERS_VAR</td>
10649: </tr>
10650: <tr>
10651: <td>BUILTIN_PKG</td>
10652: <td>BUILTIN_TEST_CURSES_DEFINES</td>
10653: </tr>
10654: <tr>
10655: <td>BUILTIN_TEST_CURSES_FUNCS</td>
10656: <td>BUILTIN_VERSION_SCRIPT</td>
10657: </tr>
10658: <tr>
10659: <td>BUILTIN_X11_TYPE</td>
10660: <td>BUILTIN_X11_VERSION</td>
10661: </tr>
10662: <tr>
10663: <td>CACTI_GROUP</td>
10664: <td>CACTI_USER</td>
10665: </tr>
10666: <tr>
10667: <td>CANNA_GROUP</td>
10668: <td>CANNA_USER</td>
10669: </tr>
10670: <tr>
10671: <td>CAT</td>
10672: <td>CCACHE_BASE</td>
10673: </tr>
10674: <tr>
10675: <td>CCACHE_DIR</td>
10676: <td>CCACHE_LOGFILE</td>
10677: </tr>
10678: <tr>
10679: <td>CC_VERSION</td>
10680: <td>CC_VERSION_STRING</td>
10681: </tr>
10682: <tr>
10683: <td>CDRECORD_CONF</td>
10684: <td>CDROM_PKG_URL_DIR</td>
10685: </tr>
10686: <tr>
10687: <td>CDROM_PKG_URL_HOST</td>
1.161 ! leot 10688: <td>CHECKOUT_DATE</td>
! 10689: </tr>
! 10690: <tr>
1.160 brook 10691: <td>CHECK_FAKEHOME</td>
1.161 ! leot 10692: <td>CHECK_FILES</td>
1.159 rillig 10693: </tr>
10694: <tr>
1.160 brook 10695: <td>CHECK_FILES_SKIP</td>
1.161 ! leot 10696: <td>CHECK_FILES_STRICT</td>
1.156 leot 10697: </tr>
10698: <tr>
1.160 brook 10699: <td>CHECK_HEADERS</td>
1.161 ! leot 10700: <td>CHECK_HEADERS_SKIP</td>
1.156 leot 10701: </tr>
10702: <tr>
1.160 brook 10703: <td>CHECK_INTERPRETER</td>
1.161 ! leot 10704: <td>CHECK_INTERPRETER_SKIP</td>
1.156 leot 10705: </tr>
10706: <tr>
1.160 brook 10707: <td>CHECK_PERMS</td>
1.161 ! leot 10708: <td>CHECK_PERMS_AUTOFIX</td>
1.156 leot 10709: </tr>
10710: <tr>
1.160 brook 10711: <td>CHECK_PERMS_SKIP</td>
1.161 ! leot 10712: <td>CHECK_PORTABILITY</td>
1.156 leot 10713: </tr>
10714: <tr>
1.160 brook 10715: <td>CHECK_PORTABILITY_SKIP</td>
1.161 ! leot 10716: <td>CHECK_RELRO</td>
1.156 leot 10717: </tr>
10718: <tr>
1.160 brook 10719: <td>CHECK_RELRO_SKIP</td>
1.161 ! leot 10720: <td>CHECK_RELRO_SUPPORTED</td>
1.156 leot 10721: </tr>
10722: <tr>
1.160 brook 10723: <td>CHECK_SHLIBS</td>
1.161 ! leot 10724: <td>CHECK_SHLIBS_BLACKLIST</td>
1.156 leot 10725: </tr>
10726: <tr>
1.160 brook 10727: <td>CHECK_SHLIBS_SKIP</td>
1.161 ! leot 10728: <td>CHECK_SHLIBS_SUPPORTED</td>
1.156 leot 10729: </tr>
10730: <tr>
1.160 brook 10731: <td>CHECK_SSP</td>
1.161 ! leot 10732: <td>CHECK_SSP_SKIP</td>
1.156 leot 10733: </tr>
10734: <tr>
1.160 brook 10735: <td>CHECK_SSP_SUPPORTED</td>
1.161 ! leot 10736: <td>CHECK_STRIPPED</td>
1.156 leot 10737: </tr>
10738: <tr>
1.160 brook 10739: <td>CHECK_STRIPPED_SKIP</td>
1.161 ! leot 10740: <td>CHECK_WRKREF</td>
1.156 leot 10741: </tr>
10742: <tr>
1.160 brook 10743: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.161 ! leot 10744: <td>CHECK_WRKREF_SKIP</td>
1.156 leot 10745: </tr>
10746: <tr>
1.160 brook 10747: <td>CLAMAV_DBDIR</td>
1.161 ! leot 10748: <td>CLAMAV_GROUP</td>
1.156 leot 10749: </tr>
10750: <tr>
1.160 brook 10751: <td>CLAMAV_USER</td>
1.161 ! leot 10752: <td>CLANGBASE</td>
1.156 leot 10753: </tr>
10754: <tr>
1.160 brook 10755: <td>CLEANDEPENDS</td>
1.161 ! leot 10756: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.156 leot 10757: </tr>
10758: <tr>
1.160 brook 10759: <td>CMAKE_INSTALL_PREFIX</td>
1.161 ! leot 10760: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.156 leot 10761: </tr>
10762: <tr>
1.160 brook 10763: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.161 ! leot 10764: <td>CMAKE_PREFIX_PATH</td>
1.156 leot 10765: </tr>
10766: <tr>
10767: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.161 ! leot 10768: <td>COMMON_LISP_DOCFILES</td>
! 10769: </tr>
! 10770: <tr>
! 10771: <td>COMMON_LISP_EXAMPLES</td>
! 10772: <td>COMMON_LISP_EXTRAFILES</td>
! 10773: </tr>
! 10774: <tr>
! 10775: <td>COMMON_LISP_PACKAGES</td>
! 10776: <td>COMMON_LISP_SYSTEM</td>
1.156 leot 10777: </tr>
10778: <tr>
10779: <td>COMPILER_RPATH_FLAG</td>
10780: <td>COMPILER_USE_SYMLINKS</td>
10781: </tr>
10782: <tr>
10783: <td>CONFIGURE_ARGS</td>
10784: <td>CONFIGURE_DIRS</td>
10785: </tr>
10786: <tr>
10787: <td>CONFIGURE_ENV</td>
10788: <td>CONFIGURE_HAS_INFODIR</td>
10789: </tr>
10790: <tr>
10791: <td>CONFIGURE_HAS_MANDIR</td>
10792: <td>CONFIGURE_SCRIPT</td>
10793: </tr>
10794: <tr>
10795: <td>CONFIG_SHELL</td>
10796: <td>CONFIG_SHELL_FLAGS</td>
10797: </tr>
10798: <tr>
10799: <td>CONF_FILES</td>
10800: <td>CONF_FILES_MODE</td>
10801: </tr>
10802: <tr>
10803: <td>CONF_FILES_PERMS</td>
10804: <td>CONSERVER_DEFAULTHOST</td>
10805: </tr>
10806: <tr>
10807: <td>CONSERVER_DEFAULTPORT</td>
10808: <td>CP</td>
10809: </tr>
10810: <tr>
10811: <td>CPP</td>
10812: <td>CPP_PRECOMP_FLAGS</td>
10813: </tr>
10814: <tr>
10815: <td>CREATE_WRKDIR_SYMLINK</td>
10816: <td>CROSSBASE</td>
10817: </tr>
10818: <tr>
10819: <td>CTFCONVERT</td>
10820: <td>CTF_FILES_SKIP</td>
10821: </tr>
10822: <tr>
10823: <td>CTF_SUPPORTED</td>
10824: <td>CTYPE</td>
10825: </tr>
10826: <tr>
10827: <td>CUPS_GROUP</td>
10828: <td>CUPS_SYSTEM_GROUPS</td>
10829: </tr>
10830: <tr>
10831: <td>CUPS_USER</td>
10832: <td>CURSES_DEFAULT</td>
10833: </tr>
10834: <tr>
10835: <td>CURSES_TYPE</td>
1.161 ! leot 10836: <td>CVS_EXTRACTDIR</td>
! 10837: </tr>
! 10838: <tr>
! 10839: <td>CVS_MODULE</td>
! 10840: <td>CVS_PROJECT</td>
! 10841: </tr>
! 10842: <tr>
! 10843: <td>CVS_REPOSITORIES</td>
! 10844: <td>CVS_ROOT</td>
! 10845: </tr>
! 10846: <tr>
! 10847: <td>CVS_ROOT_GNU</td>
! 10848: <td>CVS_ROOT_NONGNU</td>
! 10849: </tr>
! 10850: <tr>
! 10851: <td>CVS_ROOT_SOURCEFORGE</td>
! 10852: <td>CVS_TAG</td>
! 10853: </tr>
! 10854: <tr>
1.160 brook 10855: <td>CXX</td>
1.161 ! leot 10856: <td>CYRUS_GROUP</td>
1.159 rillig 10857: </tr>
10858: <tr>
1.160 brook 10859: <td>CYRUS_IDLE</td>
1.161 ! leot 10860: <td>CYRUS_USER</td>
1.156 leot 10861: </tr>
10862: <tr>
1.160 brook 10863: <td>DAEMONTOOLS_GROUP</td>
1.161 ! leot 10864: <td>DAEMONTOOLS_LOG_USER</td>
1.156 leot 10865: </tr>
10866: <tr>
1.160 brook 10867: <td>DBUS_GROUP</td>
1.161 ! leot 10868: <td>DBUS_USER</td>
1.156 leot 10869: </tr>
10870: <tr>
1.160 brook 10871: <td>DEFANG_GROUP</td>
1.161 ! leot 10872: <td>DEFANG_USER</td>
1.156 leot 10873: </tr>
10874: <tr>
1.160 brook 10875: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.161 ! leot 10876: <td>DEFAULT_DISTFILES</td>
1.156 leot 10877: </tr>
10878: <tr>
1.160 brook 10879: <td>DEFAULT_IRC_SERVER</td>
1.161 ! leot 10880: <td>DEFAULT_SERIAL_DEVICE</td>
1.156 leot 10881: </tr>
10882: <tr>
1.160 brook 10883: <td>DEF_UMASK</td>
1.161 ! leot 10884: <td>DEINSTALLDEPENDS</td>
1.156 leot 10885: </tr>
10886: <tr>
1.160 brook 10887: <td>DEINSTALL_SRC</td>
1.161 ! leot 10888: <td>DEINSTALL_TEMPLATES</td>
1.156 leot 10889: </tr>
10890: <tr>
1.160 brook 10891: <td>DELAYED_ERROR_MSG</td>
1.161 ! leot 10892: <td>DELAYED_WARNING_MSG</td>
1.156 leot 10893: </tr>
10894: <tr>
1.160 brook 10895: <td>DEPENDS</td>
1.161 ! leot 10896: <td>DEPENDS_TARGET</td>
1.156 leot 10897: </tr>
10898: <tr>
1.160 brook 10899: <td>DEPENDS_TYPE</td>
1.161 ! leot 10900: <td>DESTDIR</td>
1.156 leot 10901: </tr>
10902: <tr>
1.160 brook 10903: <td>DESTDIR_VARNAME</td>
1.161 ! leot 10904: <td>DIALER_GROUP</td>
1.156 leot 10905: </tr>
10906: <tr>
1.160 brook 10907: <td>DIGEST_REQD</td>
1.161 ! leot 10908: <td>DISTDIR</td>
1.156 leot 10909: </tr>
10910: <tr>
1.160 brook 10911: <td>DISTFILES</td>
1.161 ! leot 10912: <td>DISTINFO_FILE</td>
1.156 leot 10913: </tr>
10914: <tr>
1.160 brook 10915: <td>DISTNAME</td>
1.161 ! leot 10916: <td>DIST_PATH</td>
1.156 leot 10917: </tr>
10918: <tr>
1.160 brook 10919: <td>DIST_SUBDIR</td>
1.161 ! leot 10920: <td>DJBDNS_AXFR_USER</td>
1.156 leot 10921: </tr>
10922: <tr>
1.160 brook 10923: <td>DJBDNS_CACHE_USER</td>
1.161 ! leot 10924: <td>DJBDNS_DJBDNS_GROUP</td>
1.156 leot 10925: </tr>
10926: <tr>
1.160 brook 10927: <td>DJBDNS_LOG_USER</td>
1.161 ! leot 10928: <td>DJBDNS_RBL_USER</td>
1.156 leot 10929: </tr>
10930: <tr>
1.160 brook 10931: <td>DJBDNS_TINY_USER</td>
1.161 ! leot 10932: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.156 leot 10933: </tr>
10934: <tr>
1.160 brook 10935: <td>DL_AUTO_VARS</td>
1.161 ! leot 10936: <td>DL_CFLAGS</td>
1.156 leot 10937: </tr>
10938: <tr>
1.160 brook 10939: <td>DL_LDFLAGS</td>
1.161 ! leot 10940: <td>DL_LIBS</td>
1.156 leot 10941: </tr>
10942: <tr>
1.160 brook 10943: <td>DNS</td>
1.161 ! leot 10944: <td>DOWNLOADED_DISTFILE</td>
1.156 leot 10945: </tr>
10946: <tr>
1.160 brook 10947: <td>DT_LAYOUT</td>
1.161 ! leot 10948: <td>DYNAMIC_SITES_CMD</td>
1.156 leot 10949: </tr>
10950: <tr>
1.160 brook 10951: <td>DYNAMIC_SITES_SCRIPT</td>
1.161 ! leot 10952: <td>ECHO</td>
1.156 leot 10953: </tr>
10954: <tr>
1.160 brook 10955: <td>ECHO_N</td>
1.161 ! leot 10956: <td>ELK_GUI</td>
1.156 leot 10957: </tr>
10958: <tr>
1.160 brook 10959: <td>EMACS_TYPE</td>
1.161 ! leot 10960: <td>EMULDIR</td>
1.156 leot 10961: </tr>
10962: <tr>
1.160 brook 10963: <td>EMULSUBDIR</td>
1.161 ! leot 10964: <td>EMULSUBDIRSLASH</td>
1.156 leot 10965: </tr>
10966: <tr>
1.160 brook 10967: <td>EMUL_ARCH</td>
1.161 ! leot 10968: <td>EMUL_DISTRO</td>
1.156 leot 10969: </tr>
10970: <tr>
1.160 brook 10971: <td>EMUL_EXEC_FMT</td>
1.161 ! leot 10972: <td>EMUL_IS_NATIVE</td>
1.156 leot 10973: </tr>
10974: <tr>
1.160 brook 10975: <td>EMUL_MODULES</td>
1.161 ! leot 10976: <td>EMUL_OPSYS</td>
1.156 leot 10977: </tr>
10978: <tr>
1.160 brook 10979: <td>EMUL_PKG_FMT</td>
1.161 ! leot 10980: <td>EMUL_PLATFORM</td>
1.156 leot 10981: </tr>
10982: <tr>
1.160 brook 10983: <td>EMUL_PLATFORMS</td>
1.161 ! leot 10984: <td>EMUL_PREFER</td>
1.156 leot 10985: </tr>
10986: <tr>
1.160 brook 10987: <td>EMUL_REQD</td>
1.161 ! leot 10988: <td>EMUL_TYPE</td>
1.156 leot 10989: </tr>
10990: <tr>
1.160 brook 10991: <td>ERROR_MSG</td>
1.161 ! leot 10992: <td>EXIM_GROUP</td>
1.156 leot 10993: </tr>
10994: <tr>
1.160 brook 10995: <td>EXIM_USER</td>
1.161 ! leot 10996: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.156 leot 10997: </tr>
10998: <tr>
1.160 brook 10999: <td>EXTRACTOR</td>
1.161 ! leot 11000: <td>EXTRACT_CMD</td>
1.156 leot 11001: </tr>
11002: <tr>
1.160 brook 11003: <td>EXTRACT_CMD_DEFAULT</td>
1.161 ! leot 11004: <td>EXTRACT_DIR</td>
1.156 leot 11005: </tr>
11006: <tr>
1.160 brook 11007: <td>EXTRACT_ELEMENTS</td>
1.161 ! leot 11008: <td>EXTRACT_ENV</td>
1.156 leot 11009: </tr>
11010: <tr>
1.160 brook 11011: <td>EXTRACT_ONLY</td>
1.161 ! leot 11012: <td>EXTRACT_OPTS</td>
1.156 leot 11013: </tr>
11014: <tr>
1.160 brook 11015: <td>EXTRACT_SUFX</td>
1.161 ! leot 11016: <td>EXTRACT_USING</td>
1.156 leot 11017: </tr>
11018: <tr>
1.160 brook 11019: <td>FAILOVER_FETCH</td>
1.161 ! leot 11020: <td>FAIL_MSG</td>
1.156 leot 11021: </tr>
11022: <tr>
1.160 brook 11023: <td>FAKE_NCURSES</td>
1.161 ! leot 11024: <td>FAM</td>
1.156 leot 11025: </tr>
11026: <tr>
1.160 brook 11027: <td>FAM_ACCEPTED</td>
1.161 ! leot 11028: <td>FAM_DEFAULT</td>
1.156 leot 11029: </tr>
11030: <tr>
1.160 brook 11031: <td>FAM_SERVER</td>
1.161 ! leot 11032: <td>FCPATH</td>
1.156 leot 11033: </tr>
11034: <tr>
1.160 brook 11035: <td>FEATURE_CPPFLAGS</td>
1.161 ! leot 11036: <td>FEATURE_LDFLAGS</td>
1.156 leot 11037: </tr>
11038: <tr>
1.160 brook 11039: <td>FEATURE_LIBS</td>
1.161 ! leot 11040: <td>FETCH_AFTER_ARGS</td>
1.156 leot 11041: </tr>
11042: <tr>
1.160 brook 11043: <td>FETCH_BEFORE_ARGS</td>
1.161 ! leot 11044: <td>FETCH_CMD</td>
1.156 leot 11045: </tr>
11046: <tr>
1.160 brook 11047: <td>FETCH_OUTPUT_ARGS</td>
1.161 ! leot 11048: <td>FETCH_PROXY</td>
1.156 leot 11049: </tr>
11050: <tr>
1.160 brook 11051: <td>FETCH_RESUME_ARGS</td>
1.161 ! leot 11052: <td>FETCH_USING</td>
1.156 leot 11053: </tr>
11054: <tr>
1.160 brook 11055: <td>FILES_SUBST</td>
1.161 ! leot 11056: <td>FILES_SUBST_SED</td>
1.156 leot 11057: </tr>
11058: <tr>
1.160 brook 11059: <td>FIX_SYSTEM_HEADERS</td>
1.161 ! leot 11060: <td>FLUXBOX_USE_GNOME</td>
1.156 leot 11061: </tr>
11062: <tr>
1.160 brook 11063: <td>FLUXBOX_USE_KDE</td>
1.161 ! leot 11064: <td>FLUXBOX_USE_XFT</td>
1.156 leot 11065: </tr>
11066: <tr>
11067: <td>FLUXBOX_USE_XINERAMA</td>
1.161 ! leot 11068: <td>FONTDIR</td>
1.156 leot 11069: </tr>
11070: <tr>
11071: <td>FONTS_DIRS</td>
11072: <td>FONTS_VERBOSE</td>
11073: </tr>
11074: <tr>
11075: <td>FOO_HACKS_MK</td>
1.161 ! leot 11076: <td>FOSSIL_EXTRACTDIR</td>
! 11077: </tr>
! 11078: <tr>
! 11079: <td>FOSSIL_REPO</td>
! 11080: <td>FOSSIL_REPOSITORIES</td>
! 11081: </tr>
! 11082: <tr>
! 11083: <td>FOSSIL_VERSION</td>
1.156 leot 11084: <td>FOX_USE_XUNICODE</td>
11085: </tr>
11086: <tr>
11087: <td>FREEWNN_GROUP</td>
11088: <td>FREEWNN_USER</td>
11089: </tr>
11090: <tr>
11091: <td>FTP_PKG_URL_DIR</td>
11092: <td>FTP_PKG_URL_HOST</td>
11093: </tr>
11094: <tr>
11095: <td>GAMEDATAMODE</td>
11096: <td>GAMEDATA_PERMS</td>
11097: </tr>
11098: <tr>
11099: <td>GAMEDIRMODE</td>
11100: <td>GAMEDIR_PERMS</td>
11101: </tr>
11102: <tr>
11103: <td>GAMEGRP</td>
11104: <td>GAMEMODE</td>
11105: </tr>
11106: <tr>
11107: <td>GAMEOWN</td>
11108: <td>GAMES_GROUP</td>
11109: </tr>
11110: <tr>
11111: <td>GAMES_USER</td>
11112: <td>GCC</td>
11113: </tr>
11114: <tr>
11115: <td>GCCBASE</td>
11116: <td>GCC_REQD</td>
11117: </tr>
11118: <tr>
11119: <td>GCC_VERSION_SUFFIX</td>
11120: <td>GEM_BUILD</td>
11121: </tr>
11122: <tr>
11123: <td>GEM_CLEANBUILD</td>
11124: <td>GEM_CLEANBUILD_EXTENSIONS</td>
11125: </tr>
11126: <tr>
11127: <td>GEM_DOCDIR</td>
11128: <td>GEM_EXTSDIR</td>
11129: </tr>
11130: <tr>
11131: <td>GEM_HOME</td>
11132: <td>GEM_LIBDIR</td>
11133: </tr>
11134: <tr>
11135: <td>GEM_NAME</td>
11136: <td>GEM_PATH</td>
11137: </tr>
11138: <tr>
11139: <td>GEM_SPECFILE</td>
11140: <td>GENERATE_PLIST</td>
11141: </tr>
11142: <tr>
11143: <td>GHOSTSCRIPT_REQD</td>
11144: <td>GITHUB_PROJECT</td>
11145: </tr>
11146: <tr>
11147: <td>GITHUB_RELEASE</td>
11148: <td>GITHUB_TAG</td>
11149: </tr>
11150: <tr>
11151: <td>GITHUB_TYPE</td>
1.161 ! leot 11152: <td>GIT_BRANCH</td>
! 11153: </tr>
! 11154: <tr>
! 11155: <td>GIT_ENV</td>
! 11156: <td>GIT_EXTRACTDIR</td>
! 11157: </tr>
! 11158: <tr>
! 11159: <td>GIT_REPO</td>
! 11160: <td>GIT_REPOSITORIES</td>
! 11161: </tr>
! 11162: <tr>
! 11163: <td>GIT_REVISION</td>
! 11164: <td>GIT_TAG</td>
! 11165: </tr>
! 11166: <tr>
1.160 brook 11167: <td>GNU</td>
1.161 ! leot 11168: <td>GNU_CONFIGURE</td>
1.159 rillig 11169: </tr>
11170: <tr>
1.160 brook 11171: <td>GNU_CONFIGURE_INFODIR</td>
1.161 ! leot 11172: <td>GNU_CONFIGURE_MANDIR</td>
1.156 leot 11173: </tr>
11174: <tr>
1.160 brook 11175: <td>GNU_CONFIGURE_STRICT</td>
1.161 ! leot 11176: <td>GODEP_REDIRECTS</td>
1.156 leot 11177: </tr>
11178: <tr>
1.160 brook 11179: <td>GO_BUILD_PATTERN</td>
1.161 ! leot 11180: <td>GO_DEPS</td>
1.156 leot 11181: </tr>
11182: <tr>
1.160 brook 11183: <td>GO_DIST_BASE</td>
1.161 ! leot 11184: <td>GO_SRCPATH</td>
1.156 leot 11185: </tr>
11186: <tr>
1.161 ! leot 11187: <td>GO_VERSION_DEFAULT</td>
1.160 brook 11188: <td>GROUP_SPECIFIC_PKGS</td>
1.156 leot 11189: </tr>
11190: <tr>
1.159 rillig 11191: <td>GRUB_NETWORK_CARDS</td>
1.160 brook 11192: <td>GRUB_PRESET_COMMAND</td>
1.156 leot 11193: </tr>
11194: <tr>
1.159 rillig 11195: <td>GRUB_SCAN_ARGS</td>
1.160 brook 11196: <td>GZIP</td>
1.156 leot 11197: </tr>
11198: <tr>
1.159 rillig 11199: <td>HASKELL_COMPILER</td>
1.160 brook 11200: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.156 leot 11201: </tr>
11202: <tr>
1.159 rillig 11203: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.160 brook 11204: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.156 leot 11205: </tr>
11206: <tr>
1.159 rillig 11207: <td>HAS_CONFIGURE</td>
1.156 leot 11208: <td>HEADER_TEMPLATES</td>
11209: </tr>
11210: <tr>
1.161 ! leot 11211: <td>HG_REPO</td>
! 11212: <td>HG_REPOSITORIES</td>
! 11213: </tr>
! 11214: <tr>
! 11215: <td>HG_TAG</td>
1.156 leot 11216: <td>HOST_PKGTOOLS_ARGS</td>
1.161 ! leot 11217: </tr>
! 11218: <tr>
1.156 leot 11219: <td>HOST_SPECIFIC_PKGS</td>
1.161 ! leot 11220: <td>HOWL_GROUP</td>
1.156 leot 11221: </tr>
11222: <tr>
11223: <td>HOWL_USER</td>
1.161 ! leot 11224: <td>ICCBASE</td>
1.156 leot 11225: </tr>
11226: <tr>
11227: <td>ICECAST_CHROOTDIR</td>
1.161 ! leot 11228: <td>ICON_THEMES</td>
1.156 leot 11229: </tr>
11230: <tr>
11231: <td>IDOBASE</td>
1.161 ! leot 11232: <td>IGNORE_CCACHE</td>
1.156 leot 11233: </tr>
11234: <tr>
11235: <td>IGNORE_INFO_DIRS</td>
1.161 ! leot 11236: <td>IGNORE_INTERACTIVE_FETCH</td>
1.156 leot 11237: </tr>
11238: <tr>
11239: <td>IMAKE</td>
1.161 ! leot 11240: <td>IMAKEOPTS</td>
1.156 leot 11241: </tr>
11242: <tr>
11243: <td>IMAKE_MAKE</td>
1.161 ! leot 11244: <td>IMAKE_MANINSTALL</td>
1.156 leot 11245: </tr>
11246: <tr>
11247: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.161 ! leot 11248: <td>IMDICTDIR</td>
1.156 leot 11249: </tr>
11250: <tr>
11251: <td>INCOMPAT_CURSES</td>
1.161 ! leot 11252: <td>INFO_DIR</td>
1.156 leot 11253: </tr>
11254: <tr>
11255: <td>INFO_FILES</td>
1.161 ! leot 11256: <td>INFO_FILES_VERBOSE</td>
1.156 leot 11257: </tr>
11258: <tr>
11259: <td>INFO_MSG</td>
1.161 ! leot 11260: <td>INIT_SYSTEM</td>
1.156 leot 11261: </tr>
11262: <tr>
11263: <td>INN_DATA_DIR</td>
1.161 ! leot 11264: <td>INN_GROUP</td>
1.156 leot 11265: </tr>
11266: <tr>
11267: <td>INN_USER</td>
1.161 ! leot 11268: <td>INSTALLATION_DIRS</td>
1.156 leot 11269: </tr>
11270: <tr>
11271: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.161 ! leot 11272: <td>INSTALL_ENV</td>
1.156 leot 11273: </tr>
11274: <tr>
11275: <td>INSTALL_SH_OVERRIDE</td>
1.161 ! leot 11276: <td>INSTALL_SRC</td>
1.156 leot 11277: </tr>
11278: <tr>
11279: <td>INSTALL_TEMPLATES</td>
1.161 ! leot 11280: <td>INSTALL_UNSTRIPPED</td>
1.156 leot 11281: </tr>
11282: <tr>
11283: <td>IRCD_HYBRID_IRC_GROUP</td>
1.161 ! leot 11284: <td>IRCD_HYBRID_IRC_USER</td>
1.156 leot 11285: </tr>
11286: <tr>
11287: <td>IRCD_HYBRID_MAXCONN</td>
1.161 ! leot 11288: <td>IRCD_HYBRID_NICLEN</td>
1.156 leot 11289: </tr>
11290: <tr>
11291: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.161 ! leot 11292: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.156 leot 11293: </tr>
11294: <tr>
11295: <td>IRCD_HYBRID_TOPICLEN</td>
1.161 ! leot 11296: <td>IRIX</td>
1.156 leot 11297: </tr>
11298: <tr>
11299: <td>IRRD_USE_PGP</td>
1.161 ! leot 11300: <td>JABBERD_GROUP</td>
1.156 leot 11301: </tr>
11302: <tr>
11303: <td>JABBERD_LOGDIR</td>
1.161 ! leot 11304: <td>JABBERD_PIDDIR</td>
1.156 leot 11305: </tr>
11306: <tr>
11307: <td>JABBERD_SPOOLDIR</td>
1.161 ! leot 11308: <td>JABBERD_USER</td>
1.156 leot 11309: </tr>
11310: <tr>
11311: <td>JAKARTA_HOME</td>
1.161 ! leot 11312: <td>JAVA_APP_PATH</td>
1.156 leot 11313: </tr>
11314: <tr>
1.161 ! leot 11315: <td>JAVA_APP_TARGETS</td>
1.156 leot 11316: <td>JAVA_BINPREFIX</td>
1.161 ! leot 11317: </tr>
! 11318: <tr>
1.156 leot 11319: <td>JAVA_CLASSPATH</td>
1.161 ! leot 11320: <td>JAVA_HOME</td>
1.156 leot 11321: </tr>
11322: <tr>
11323: <td>JAVA_LD_LIBRARY_PATH</td>
1.161 ! leot 11324: <td>JAVA_NAME</td>
1.156 leot 11325: </tr>
11326: <tr>
11327: <td>JAVA_UNLIMIT</td>
1.161 ! leot 11328: <td>JAVA_WRAPPERS</td>
1.156 leot 11329: </tr>
11330: <tr>
11331: <td>JPEG_ACCEPTED</td>
1.161 ! leot 11332: <td>JPEG_DEFAULT</td>
1.156 leot 11333: </tr>
11334: <tr>
11335: <td>KERBEROS</td>
1.161 ! leot 11336: <td>KERMIT_SUID_UUCP</td>
1.156 leot 11337: </tr>
11338: <tr>
11339: <td>KJS_USE_PCRE</td>
1.161 ! leot 11340: <td>KNEWS_DOMAIN_FILE</td>
1.156 leot 11341: </tr>
11342: <tr>
11343: <td>KNEWS_DOMAIN_NAME</td>
1.161 ! leot 11344: <td>KRB5_ACCEPTED</td>
1.156 leot 11345: </tr>
11346: <tr>
11347: <td>KRB5_DEFAULT</td>
1.161 ! leot 11348: <td>LANGUAGES</td>
1.156 leot 11349: </tr>
11350: <tr>
1.161 ! leot 11351: <td>LAPACK_LIBS</td>
1.160 brook 11352: <td>LATEX2HTML_ICONPATH</td>
1.156 leot 11353: </tr>
11354: <tr>
11355: <td>LDCONFIG_ADD_CMD</td>
1.160 brook 11356: <td>LDCONFIG_REMOVE_CMD</td>
1.156 leot 11357: </tr>
11358: <tr>
11359: <td>LEAFNODE_DATA_DIR</td>
1.160 brook 11360: <td>LEAFNODE_GROUP</td>
1.156 leot 11361: </tr>
11362: <tr>
11363: <td>LEAFNODE_USER</td>
1.160 brook 11364: <td>LIBDVDCSS_HOMEPAGE</td>
1.156 leot 11365: </tr>
11366: <tr>
11367: <td>LIBDVDCSS_MASTER_SITES</td>
1.160 brook 11368: <td>LIBRSVG_TYPE</td>
1.157 leot 11369: </tr>
11370: <tr>
1.156 leot 11371: <td>LIBTOOL</td>
1.160 brook 11372: <td>LIBTOOLIZE_PLIST</td>
1.156 leot 11373: </tr>
11374: <tr>
11375: <td>LIBTOOL_M4_OVERRIDE</td>
1.160 brook 11376: <td>LIBUSB_TYPE</td>
1.156 leot 11377: </tr>
11378: <tr>
11379: <td>LICENSE</td>
1.160 brook 11380: <td>LINKER_RPATH_FLAG</td>
1.156 leot 11381: </tr>
11382: <tr>
11383: <td>LINK_RPATH_FLAG</td>
1.161 ! leot 11384: <td>LINUX_BASE_NODEPS</td>
! 11385: </tr>
! 11386: <tr>
! 11387: <td>LINUX_BASE_PREFERRED</td>
! 11388: <td>LINUX_BASE_REQUIRED</td>
! 11389: </tr>
! 11390: <tr>
1.159 rillig 11391: <td>LINUX_LOCALES</td>
1.161 ! leot 11392: <td>LOCALBASE</td>
1.156 leot 11393: </tr>
11394: <tr>
1.158 brook 11395: <td>LOCALBASE_LOCKTYPE</td>
1.161 ! leot 11396: <td>LOCALPATCHES</td>
1.156 leot 11397: </tr>
11398: <tr>
1.158 brook 11399: <td>LOVE_DATA</td>
1.161 ! leot 11400: <td>LOVE_GAME</td>
1.156 leot 11401: </tr>
11402: <tr>
1.158 brook 11403: <td>LOVE_VERSION</td>
1.161 ! leot 11404: <td>LP64PLATFORMS</td>
1.156 leot 11405: </tr>
11406: <tr>
1.158 brook 11407: <td>MACHINE_PLATFORM</td>
1.161 ! leot 11408: <td>MAILAGENT_DOMAIN</td>
1.156 leot 11409: </tr>
11410: <tr>
1.158 brook 11411: <td>MAILAGENT_EMAIL</td>
1.161 ! leot 11412: <td>MAILAGENT_FQDN</td>
1.156 leot 11413: </tr>
11414: <tr>
1.158 brook 11415: <td>MAILAGENT_ORGANIZATION</td>
1.161 ! leot 11416: <td>MAJORDOMO_HOMEDIR</td>
1.156 leot 11417: </tr>
11418: <tr>
1.161 ! leot 11419: <td>MAJOR_OS_VERSION</td>
1.160 brook 11420: <td>MAKEINFO_ARGS</td>
1.159 rillig 11421: </tr>
11422: <tr>
11423: <td>MAKE_DIRS</td>
1.160 brook 11424: <td>MAKE_DIRS_PERMS</td>
1.156 leot 11425: </tr>
11426: <tr>
1.159 rillig 11427: <td>MAKE_ENV</td>
1.160 brook 11428: <td>MAKE_FILE</td>
1.156 leot 11429: </tr>
11430: <tr>
1.159 rillig 11431: <td>MAKE_FLAGS</td>
1.160 brook 11432: <td>MAKE_JOBS</td>
1.156 leot 11433: </tr>
11434: <tr>
1.159 rillig 11435: <td>MAKE_JOBS_SAFE</td>
1.160 brook 11436: <td>MAKE_PROGRAM</td>
1.156 leot 11437: </tr>
11438: <tr>
1.159 rillig 11439: <td>MANINSTALL</td>
1.160 brook 11440: <td>MANZ</td>
1.156 leot 11441: </tr>
11442: <tr>
1.159 rillig 11443: <td>MASTER_SITES</td>
1.160 brook 11444: <td>MASTER_SITE_BACKUP</td>
1.156 leot 11445: </tr>
11446: <tr>
1.159 rillig 11447: <td>MASTER_SITE_CYGWIN</td>
1.160 brook 11448: <td>MASTER_SITE_GNOME</td>
1.156 leot 11449: </tr>
11450: <tr>
1.159 rillig 11451: <td>MASTER_SITE_GNU</td>
1.160 brook 11452: <td>MASTER_SITE_LOCAL</td>
1.156 leot 11453: </tr>
11454: <tr>
1.159 rillig 11455: <td>MASTER_SITE_MOZILLA</td>
1.160 brook 11456: <td>MASTER_SITE_OPENOFFICE</td>
1.156 leot 11457: </tr>
11458: <tr>
1.159 rillig 11459: <td>MASTER_SITE_OVERRIDE</td>
1.160 brook 11460: <td>MASTER_SITE_PERL_CPAN</td>
1.156 leot 11461: </tr>
11462: <tr>
1.159 rillig 11463: <td>MASTER_SITE_SUNSITE</td>
1.160 brook 11464: <td>MASTER_SITE_SUSE</td>
1.156 leot 11465: </tr>
11466: <tr>
1.159 rillig 11467: <td>MASTER_SITE_TEX_CTAN</td>
1.160 brook 11468: <td>MASTER_SITE_XCONTRIB</td>
1.156 leot 11469: </tr>
11470: <tr>
1.159 rillig 11471: <td>MASTER_SITE_XEMACS</td>
1.160 brook 11472: <td>MASTER_SORT</td>
1.156 leot 11473: </tr>
11474: <tr>
1.159 rillig 11475: <td>MASTER_SORT_RANDOM</td>
1.160 brook 11476: <td>MASTER_SORT_REGEX</td>
1.156 leot 11477: </tr>
11478: <tr>
1.159 rillig 11479: <td>MECAB_CHARSET</td>
1.160 brook 11480: <td>MEDIATOMB_GROUP</td>
1.156 leot 11481: </tr>
11482: <tr>
1.159 rillig 11483: <td>MEDIATOMB_USER</td>
1.160 brook 11484: <td>MIPSPROBASE</td>
1.156 leot 11485: </tr>
11486: <tr>
1.159 rillig 11487: <td>MIREDO_GROUP</td>
1.160 brook 11488: <td>MIREDO_USER</td>
1.156 leot 11489: </tr>
11490: <tr>
1.159 rillig 11491: <td>MISSING_FEATURES</td>
1.160 brook 11492: <td>MKDIR</td>
1.156 leot 11493: </tr>
11494: <tr>
1.159 rillig 11495: <td>MLDONKEY_GROUP</td>
1.160 brook 11496: <td>MLDONKEY_HOME</td>
1.156 leot 11497: </tr>
11498: <tr>
1.159 rillig 11499: <td>MLDONKEY_USER</td>
1.160 brook 11500: <td>MONOTONE_GROUP</td>
1.156 leot 11501: </tr>
11502: <tr>
1.159 rillig 11503: <td>MONOTONE_USER</td>
1.160 brook 11504: <td>MOTIFBASE</td>
1.156 leot 11505: </tr>
11506: <tr>
1.159 rillig 11507: <td>MOTIF_TYPE</td>
1.160 brook 11508: <td>MOTIF_TYPE_DEFAULT</td>
1.156 leot 11509: </tr>
11510: <tr>
1.159 rillig 11511: <td>MPI_TYPE</td>
1.160 brook 11512: <td>MSGFMT_STRIP_MSGCTXT</td>
1.156 leot 11513: </tr>
11514: <tr>
1.159 rillig 11515: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.160 brook 11516: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.156 leot 11517: </tr>
11518: <tr>
1.159 rillig 11519: <td>MUST</td>
1.160 brook 11520: <td>MV</td>
1.156 leot 11521: </tr>
11522: <tr>
1.159 rillig 11523: <td>MYSQL_CHARSET</td>
1.160 brook 11524: <td>MYSQL_DATADIR</td>
1.156 leot 11525: </tr>
11526: <tr>
1.159 rillig 11527: <td>MYSQL_EXTRA_CHARSET</td>
1.160 brook 11528: <td>MYSQL_GROUP</td>
1.156 leot 11529: </tr>
11530: <tr>
1.159 rillig 11531: <td>MYSQL_PKGSRCDIR</td>
1.160 brook 11532: <td>MYSQL_USER</td>
1.156 leot 11533: </tr>
11534: <tr>
1.159 rillig 11535: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.160 brook 11536: <td>MYSQL_VERSION_DEFAULT</td>
1.156 leot 11537: </tr>
11538: <tr>
1.159 rillig 11539: <td>NAGIOSCMD_GROUP</td>
1.160 brook 11540: <td>NAGIOSDIR</td>
1.156 leot 11541: </tr>
11542: <tr>
1.159 rillig 11543: <td>NAGIOS_GROUP</td>
1.160 brook 11544: <td>NAGIOS_USER</td>
1.156 leot 11545: </tr>
11546: <tr>
1.159 rillig 11547: <td>NATIVE_APPEND_ABI</td>
1.160 brook 11548: <td>NATIVE_APPEND_ELF</td>
1.156 leot 11549: </tr>
11550: <tr>
1.159 rillig 11551: <td>NATIVE_EXEC_FMT</td>
1.160 brook 11552: <td>NATIVE_MACHINE_PLATFORM</td>
1.156 leot 11553: </tr>
11554: <tr>
1.159 rillig 11555: <td>NATIVE_OBJECT_FMT</td>
1.160 brook 11556: <td>NBPAX_PROGRAM_PREFIX</td>
1.156 leot 11557: </tr>
11558: <tr>
1.159 rillig 11559: <td>NETBSD_LOGIN_NAME</td>
1.160 brook 11560: <td>NMH_EDITOR</td>
1.156 leot 11561: </tr>
11562: <tr>
1.159 rillig 11563: <td>NMH_MTA</td>
1.160 brook 11564: <td>NMH_PAGER</td>
1.156 leot 11565: </tr>
11566: <tr>
1.159 rillig 11567: <td>NOLOGIN</td>
1.160 brook 11568: <td>NONZERO_FILESIZE_P</td>
1.156 leot 11569: </tr>
11570: <tr>
1.159 rillig 11571: <td>NOTE</td>
1.160 brook 11572: <td>NOT_FOR_PLATFORM</td>
1.156 leot 11573: </tr>
11574: <tr>
1.159 rillig 11575: <td>NOT_PAX_ASLR_SAFE</td>
1.160 brook 11576: <td>NOT_PAX_MPROTECT_SAFE</td>
1.156 leot 11577: </tr>
11578: <tr>
1.159 rillig 11579: <td>NO_BUILD</td>
1.160 brook 11580: <td>NO_CHECKSUM</td>
1.156 leot 11581: </tr>
11582: <tr>
1.159 rillig 11583: <td>NO_CONFIGURE</td>
1.160 brook 11584: <td>NO_SKIP</td>
1.156 leot 11585: </tr>
11586: <tr>
1.159 rillig 11587: <td>NS_PREFERRED</td>
1.160 brook 11588: <td>NULLMAILER_GROUP</td>
1.156 leot 11589: </tr>
11590: <tr>
1.159 rillig 11591: <td>NULLMAILER_USER</td>
1.160 brook 11592: <td>OASIS</td>
1.156 leot 11593: </tr>
11594: <tr>
1.159 rillig 11595: <td>OASIS_BUILD_ARGS</td>
1.160 brook 11596: <td>OBJHOSTNAME</td>
1.156 leot 11597: </tr>
11598: <tr>
1.159 rillig 11599: <td>OBJMACHINE</td>
1.160 brook 11600: <td>OCAML_FINDLIB_DIRS</td>
1.156 leot 11601: </tr>
11602: <tr>
1.159 rillig 11603: <td>OCAML_FINDLIB_REGISTER</td>
1.160 brook 11604: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.156 leot 11605: </tr>
11606: <tr>
1.159 rillig 11607: <td>OCAML_SITELIBDIR</td>
1.160 brook 11608: <td>OCAML_TOPKG_DOCDIR</td>
1.156 leot 11609: </tr>
11610: <tr>
1.159 rillig 11611: <td>OCAML_USE_DUNE</td>
1.160 brook 11612: <td>OCAML_USE_FINDLIB</td>
1.156 leot 11613: </tr>
11614: <tr>
1.159 rillig 11615: <td>OCAML_USE_JBUILDER</td>
1.160 brook 11616: <td>OCAML_USE_OASIS</td>
1.156 leot 11617: </tr>
11618: <tr>
1.159 rillig 11619: <td>OCAML_USE_OASIS_DYNRUN</td>
1.160 brook 11620: <td>OCAML_USE_OPAM</td>
1.156 leot 11621: </tr>
11622: <tr>
1.159 rillig 11623: <td>OCAML_USE_OPT_COMPILER</td>
1.160 brook 11624: <td>OCAML_USE_TOPKG</td>
1.156 leot 11625: </tr>
11626: <tr>
1.159 rillig 11627: <td>OMF</td>
1.160 brook 11628: <td>ONLY_FOR_COMPILER</td>
1.156 leot 11629: </tr>
11630: <tr>
1.159 rillig 11631: <td>ONLY_FOR_PLATFORM</td>
1.160 brook 11632: <td>OPENSSH_CHROOT</td>
1.156 leot 11633: </tr>
11634: <tr>
1.159 rillig 11635: <td>OPENSSH_GROUP</td>
1.160 brook 11636: <td>OPENSSH_USER</td>
1.156 leot 11637: </tr>
11638: <tr>
1.159 rillig 11639: <td>OPSYS</td>
1.160 brook 11640: <td>OPSYS_EMULDIR</td>
1.156 leot 11641: </tr>
11642: <tr>
1.159 rillig 11643: <td>OSS_TYPE</td>
1.160 brook 11644: <td>OSX</td>
1.156 leot 11645: </tr>
11646: <tr>
1.159 rillig 11647: <td>OSX_TOLERATE_SDK_SKEW</td>
1.161 ! leot 11648: <td>OS_HAVE_ALSA</td>
! 11649: </tr>
! 11650: <tr>
! 11651: <td>OS_HAVE_RCD</td>
1.160 brook 11652: <td>OS_VARIANT</td>
1.159 rillig 11653: </tr>
11654: <tr>
11655: <td>OS_VERSION</td>
1.160 brook 11656: <td>OTF_FONTS_DIR</td>
1.156 leot 11657: </tr>
11658: <tr>
1.159 rillig 11659: <td>OVERRIDE_DIRDEPTH</td>
1.160 brook 11660: <td>OVERRIDE_GEMSPEC</td>
1.156 leot 11661: </tr>
11662: <tr>
1.159 rillig 11663: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.161 ! leot 11664: <td>OVERRIDE_ROCKSPEC</td>
! 11665: </tr>
! 11666: <tr>
1.158 brook 11667: <td>OWN_DIRS</td>
1.161 ! leot 11668: <td>OWN_DIRS_PERMS</td>
1.156 leot 11669: </tr>
11670: <tr>
1.158 brook 11671: <td>P4GROUP</td>
1.161 ! leot 11672: <td>P4PORT</td>
1.156 leot 11673: </tr>
11674: <tr>
1.158 brook 11675: <td>P4ROOT</td>
1.161 ! leot 11676: <td>P4USER</td>
1.156 leot 11677: </tr>
11678: <tr>
1.158 brook 11679: <td>PACKAGES</td>
1.161 ! leot 11680: <td>PALMOS_DEFAULT_SDK</td>
1.156 leot 11681: </tr>
11682: <tr>
1.158 brook 11683: <td>PAMBASE</td>
1.161 ! leot 11684: <td>PAM_DEFAULT</td>
1.156 leot 11685: </tr>
11686: <tr>
1.158 brook 11687: <td>PAPERSIZE</td>
1.161 ! leot 11688: <td>PASSIVE_FETCH</td>
1.156 leot 11689: </tr>
11690: <tr>
1.158 brook 11691: <td>PATCHDIR</td>
1.161 ! leot 11692: <td>PATCHFILES</td>
1.156 leot 11693: </tr>
11694: <tr>
1.158 brook 11695: <td>PATCH_ARGS</td>
1.161 ! leot 11696: <td>PATCH_DEBUG</td>
1.156 leot 11697: </tr>
11698: <tr>
1.158 brook 11699: <td>PATCH_DIST_ARGS</td>
1.161 ! leot 11700: <td>PATCH_DIST_CAT</td>
1.156 leot 11701: </tr>
11702: <tr>
1.158 brook 11703: <td>PATCH_DIST_STRIP</td>
1.161 ! leot 11704: <td>PATCH_FUZZ_FACTOR</td>
1.156 leot 11705: </tr>
11706: <tr>
1.158 brook 11707: <td>PATCH_STRIP</td>
1.161 ! leot 11708: <td>PATH</td>
1.156 leot 11709: </tr>
11710: <tr>
11711: <td>PCCBASE</td>
1.161 ! leot 11712: <td>PEAR</td>
1.156 leot 11713: </tr>
11714: <tr>
1.161 ! leot 11715: <td>PEAR_CHANNEL</td>
! 11716: <td>PEAR_CHANNEL_ALIAS</td>
! 11717: </tr>
! 11718: <tr>
! 11719: <td>PEAR_CHANNEL_VERSION</td>
1.157 leot 11720: <td>PEAR_CMD</td>
1.161 ! leot 11721: </tr>
! 11722: <tr>
1.158 brook 11723: <td>PEAR_LIB</td>
1.161 ! leot 11724: <td>PEAR_PACKAGE_XML</td>
1.156 leot 11725: </tr>
11726: <tr>
1.158 brook 11727: <td>PERL5</td>
1.161 ! leot 11728: <td>PERL5_CONFIGURE</td>
1.156 leot 11729: </tr>
11730: <tr>
1.158 brook 11731: <td>PERL5_CONFIGURE_DIRS</td>
1.161 ! leot 11732: <td>PERL5_LDFLAGS</td>
1.156 leot 11733: </tr>
11734: <tr>
1.158 brook 11735: <td>PERL5_LICENSE</td>
1.161 ! leot 11736: <td>PERL5_MODULE_TYPE</td>
1.156 leot 11737: </tr>
11738: <tr>
1.158 brook 11739: <td>PERL5_PACKLIST</td>
1.161 ! leot 11740: <td>PERL5_PACKLIST_DIR</td>
1.156 leot 11741: </tr>
11742: <tr>
1.158 brook 11743: <td>PERL5_PERLBASE</td>
1.161 ! leot 11744: <td>PERL5_SITEBASE</td>
1.156 leot 11745: </tr>
11746: <tr>
1.158 brook 11747: <td>PERL5_USE_PACKLIST</td>
1.161 ! leot 11748: <td>PERL5_VENDORBASE</td>
1.156 leot 11749: </tr>
11750: <tr>
1.158 brook 11751: <td>PFCTL</td>
1.161 ! leot 11752: <td>PFVAR_H</td>
1.156 leot 11753: </tr>
11754: <tr>
1.158 brook 11755: <td>PF_VERSION</td>
1.161 ! leot 11756: <td>PGGROUP</td>
1.156 leot 11757: </tr>
11758: <tr>
1.158 brook 11759: <td>PGHOME</td>
1.161 ! leot 11760: <td>PGPKGSRCDIR</td>
1.156 leot 11761: </tr>
11762: <tr>
1.158 brook 11763: <td>PGSQL_TYPE</td>
1.161 ! leot 11764: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.156 leot 11765: </tr>
11766: <tr>
1.158 brook 11767: <td>PGSQL_VERSION_DEFAULT</td>
1.161 ! leot 11768: <td>PGUSER</td>
1.156 leot 11769: </tr>
11770: <tr>
1.158 brook 11771: <td>PG_LIB_EXT</td>
1.161 ! leot 11772: <td>PHP</td>
1.156 leot 11773: </tr>
11774: <tr>
1.158 brook 11775: <td>PHPCOMMON_MK</td>
1.161 ! leot 11776: <td>PHPPKGSRCDIR</td>
1.156 leot 11777: </tr>
11778: <tr>
1.158 brook 11779: <td>PHP_BASE_VERS</td>
1.161 ! leot 11780: <td>PHP_CHECK_INSTALLED</td>
1.156 leot 11781: </tr>
11782: <tr>
1.158 brook 11783: <td>PHP_EXTENSION_DIR</td>
1.161 ! leot 11784: <td>PHP_INITIAL_TEENY</td>
1.156 leot 11785: </tr>
11786: <tr>
1.158 brook 11787: <td>PHP_PKG_PREFIX</td>
1.161 ! leot 11788: <td>PHP_VERSION</td>
1.156 leot 11789: </tr>
11790: <tr>
1.158 brook 11791: <td>PHP_VERSIONS_ACCEPTED</td>
1.161 ! leot 11792: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.156 leot 11793: </tr>
11794: <tr>
1.158 brook 11795: <td>PHP_VERSION_DEFAULT</td>
1.161 ! leot 11796: <td>PHP_VERSION_REQD</td>
1.156 leot 11797: </tr>
11798: <tr>
1.158 brook 11799: <td>PILRC_USE_GTK</td>
1.161 ! leot 11800: <td>PKGCONFIG_BASE</td>
1.156 leot 11801: </tr>
11802: <tr>
1.158 brook 11803: <td>PKGCONFIG_FILE</td>
1.161 ! leot 11804: <td>PKGCONFIG_OVERRIDE</td>
1.156 leot 11805: </tr>
11806: <tr>
1.158 brook 11807: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.161 ! leot 11808: <td>PKGDIR</td>
1.156 leot 11809: </tr>
11810: <tr>
1.158 brook 11811: <td>PKGGNUDIR</td>
1.161 ! leot 11812: <td>PKGINFODIR</td>
1.156 leot 11813: </tr>
11814: <tr>
1.158 brook 11815: <td>PKGLOCALEDIR</td>
1.161 ! leot 11816: <td>PKGMANDIR</td>
1.156 leot 11817: </tr>
11818: <tr>
1.158 brook 11819: <td>PKGNAME</td>
1.161 ! leot 11820: <td>PKGNAME_REQD</td>
1.156 leot 11821: </tr>
11822: <tr>
1.158 brook 11823: <td>PKGPATH</td>
1.161 ! leot 11824: <td>PKGREVISION</td>
1.156 leot 11825: </tr>
11826: <tr>
1.161 ! leot 11827: <td>PKGSRC_BLAS_TYPES</td>
1.160 brook 11828: <td>PKGSRC_CHANGES</td>
1.159 rillig 11829: </tr>
11830: <tr>
11831: <td>PKGSRC_COMPILER</td>
1.160 brook 11832: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.156 leot 11833: </tr>
11834: <tr>
1.159 rillig 11835: <td>PKGSRC_LOCKTYPE</td>
1.160 brook 11836: <td>PKGSRC_MAKE_ENV</td>
1.156 leot 11837: </tr>
11838: <tr>
1.159 rillig 11839: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.160 brook 11840: <td>PKGSRC_MKPIE</td>
1.156 leot 11841: </tr>
11842: <tr>
1.159 rillig 11843: <td>PKGSRC_MKREPRO</td>
1.160 brook 11844: <td>PKGSRC_RUN_TEST</td>
1.156 leot 11845: </tr>
11846: <tr>
1.159 rillig 11847: <td>PKGSRC_SETENV</td>
1.160 brook 11848: <td>PKGSRC_SLEEPSECS</td>
1.156 leot 11849: </tr>
11850: <tr>
1.159 rillig 11851: <td>PKGSRC_TODO</td>
1.160 brook 11852: <td>PKGSRC_USE_CTF</td>
1.156 leot 11853: </tr>
11854: <tr>
1.159 rillig 11855: <td>PKGSRC_USE_FORTIFY</td>
1.160 brook 11856: <td>PKGSRC_USE_RELRO</td>
1.156 leot 11857: </tr>
11858: <tr>
1.159 rillig 11859: <td>PKGSRC_USE_SSP</td>
1.160 brook 11860: <td>PKGSRC_USE_STACK_CHECK</td>
1.156 leot 11861: </tr>
11862: <tr>
1.159 rillig 11863: <td>PKGTASKS_DATAFILE</td>
1.160 brook 11864: <td>PKGTOOLS_ARGS</td>
1.156 leot 11865: </tr>
11866: <tr>
1.159 rillig 11867: <td>PKGTOOLS_ENV</td>
1.160 brook 11868: <td>PKG_ALTERNATIVES</td>
1.156 leot 11869: </tr>
11870: <tr>
1.159 rillig 11871: <td>PKG_APACHE</td>
1.160 brook 11872: <td>PKG_APACHE_ACCEPTED</td>
1.156 leot 11873: </tr>
11874: <tr>
1.159 rillig 11875: <td>PKG_APACHE_DEFAULT</td>
1.160 brook 11876: <td>PKG_BEST_EXISTS</td>
1.156 leot 11877: </tr>
11878: <tr>
1.159 rillig 11879: <td>PKG_BUILD_OPTIONS</td>
1.160 brook 11880: <td>PKG_COMPRESSION</td>
1.156 leot 11881: </tr>
11882: <tr>
1.159 rillig 11883: <td>PKG_CONFIG</td>
1.160 brook 11884: <td>PKG_CONFIG_PERMS</td>
1.156 leot 11885: </tr>
11886: <tr>
1.159 rillig 11887: <td>PKG_CREATE_USERGROUP</td>
1.160 brook 11888: <td>PKG_DB_TMPDIR</td>
1.156 leot 11889: </tr>
11890: <tr>
1.159 rillig 11891: <td>PKG_DEBUG_LEVEL</td>
1.160 brook 11892: <td>PKG_DEFAULT_OPTIONS</td>
1.156 leot 11893: </tr>
11894: <tr>
1.159 rillig 11895: <td>PKG_DESTDIR_SUPPORT</td>
1.160 brook 11896: <td>PKG_DEVELOPER</td>
1.156 leot 11897: </tr>
11898: <tr>
1.159 rillig 11899: <td>PKG_DISABLED_OPTIONS</td>
1.160 brook 11900: <td>PKG_FATAL_ERRORS</td>
1.156 leot 11901: </tr>
11902: <tr>
1.159 rillig 11903: <td>PKG_FC</td>
1.160 brook 11904: <td>PKG_FILELIST_CMD</td>
1.156 leot 11905: </tr>
11906: <tr>
1.159 rillig 11907: <td>PKG_GECOS</td>
1.160 brook 11908: <td>PKG_GID</td>
1.156 leot 11909: </tr>
11910: <tr>
1.159 rillig 11911: <td>PKG_GROUPS</td>
1.160 brook 11912: <td>PKG_GROUPS_VARS</td>
1.156 leot 11913: </tr>
11914: <tr>
1.159 rillig 11915: <td>PKG_HOME</td>
1.160 brook 11916: <td>PKG_INIT_SCRIPTS</td>
1.156 leot 11917: </tr>
11918: <tr>
1.159 rillig 11919: <td>PKG_JAVA_HOME</td>
1.160 brook 11920: <td>PKG_JVM</td>
1.156 leot 11921: </tr>
11922: <tr>
1.159 rillig 11923: <td>PKG_JVMS_ACCEPTED</td>
1.160 brook 11924: <td>PKG_JVM_DEFAULT</td>
1.156 leot 11925: </tr>
11926: <tr>
1.159 rillig 11927: <td>PKG_LEGACY_OPTIONS</td>
1.160 brook 11928: <td>PKG_LIBTOOL</td>
1.156 leot 11929: </tr>
11930: <tr>
1.159 rillig 11931: <td>PKG_OPTIONS</td>
1.160 brook 11932: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.156 leot 11933: </tr>
11934: <tr>
1.159 rillig 11935: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.160 brook 11936: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.156 leot 11937: </tr>
11938: <tr>
1.159 rillig 11939: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.160 brook 11940: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.156 leot 11941: </tr>
11942: <tr>
1.159 rillig 11943: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.160 brook 11944: <td>PKG_OPTIONS_VAR</td>
1.156 leot 11945: </tr>
11946: <tr>
1.159 rillig 11947: <td>PKG_PHP</td>
1.160 brook 11948: <td>PKG_PHP_MAJOR_VERS</td>
1.156 leot 11949: </tr>
11950: <tr>
1.159 rillig 11951: <td>PKG_PHP_VERSION</td>
1.160 brook 11952: <td>PKG_RCD_SCRIPTS</td>
1.156 leot 11953: </tr>
11954: <tr>
1.159 rillig 11955: <td>PKG_REFCOUNT_DBDIR</td>
1.160 brook 11956: <td>PKG_REGISTER_SHELLS</td>
1.156 leot 11957: </tr>
11958: <tr>
1.159 rillig 11959: <td>PKG_RESUME_TRANSFERS</td>
1.160 brook 11960: <td>PKG_SHELL</td>
1.156 leot 11961: </tr>
11962: <tr>
1.159 rillig 11963: <td>PKG_SUGGESTED_OPTIONS</td>
1.160 brook 11964: <td>PKG_SUPPORTED_OPTIONS</td>
1.156 leot 11965: </tr>
11966: <tr>
1.159 rillig 11967: <td>PKG_SYSCONFBASE</td>
1.160 brook 11968: <td>PKG_SYSCONFBASEDIR</td>
1.156 leot 11969: </tr>
11970: <tr>
1.159 rillig 11971: <td>PKG_SYSCONFDIR</td>
1.160 brook 11972: <td>PKG_SYSCONFDIR_PERMS</td>
1.156 leot 11973: </tr>
11974: <tr>
1.159 rillig 11975: <td>PKG_SYSCONFSUBDIR</td>
1.160 brook 11976: <td>PKG_SYSCONFVAR</td>
1.156 leot 11977: </tr>
11978: <tr>
1.159 rillig 11979: <td>PKG_TOOLS_BIN</td>
1.160 brook 11980: <td>PKG_UID</td>
1.156 leot 11981: </tr>
11982: <tr>
1.159 rillig 11983: <td>PKG_UPDATE_FONTS_DB</td>
1.160 brook 11984: <td>PKG_USERS</td>
1.156 leot 11985: </tr>
11986: <tr>
1.159 rillig 11987: <td>PKG_USERS_VARS</td>
1.160 brook 11988: <td>PKG_VERBOSE</td>
1.156 leot 11989: </tr>
11990: <tr>
1.159 rillig 11991: <td>PLIST</td>
1.160 brook 11992: <td>PLIST_AWK</td>
1.156 leot 11993: </tr>
11994: <tr>
1.159 rillig 11995: <td>PLIST_AWK_ENV</td>
1.160 brook 11996: <td>PLIST_SRC</td>
1.156 leot 11997: </tr>
11998: <tr>
1.159 rillig 11999: <td>PLIST_SUBST</td>
1.160 brook 12000: <td>PLIST_TYPE</td>
1.156 leot 12001: </tr>
12002: <tr>
1.159 rillig 12003: <td>PLIST_VARS</td>
1.160 brook 12004: <td>POPTOP_USE_MPPE</td>
1.156 leot 12005: </tr>
12006: <tr>
1.159 rillig 12007: <td>POST_FETCH_HOOK</td>
1.160 brook 12008: <td>PREFER</td>
1.156 leot 12009: </tr>
12010: <tr>
1.159 rillig 12011: <td>PREFER_NATIVE</td>
1.160 brook 12012: <td>PREFER_NATIVE_PTHREADS</td>
1.156 leot 12013: </tr>
12014: <tr>
1.159 rillig 12015: <td>PREFER_PKGSRC</td>
1.160 brook 12016: <td>PREFIX</td>
1.156 leot 12017: </tr>
12018: <tr>
1.159 rillig 12019: <td>PREPEND_PATH</td>
1.160 brook 12020: <td>PRE_ROOT_CMD</td>
1.156 leot 12021: </tr>
12022: <tr>
1.159 rillig 12023: <td>PRIVILEGED_STAGES</td>
1.160 brook 12024: <td>PS</td>
1.156 leot 12025: </tr>
12026: <tr>
1.159 rillig 12027: <td>PTHREAD_AUTO_VARS</td>
1.160 brook 12028: <td>PTHREAD_CFLAGS</td>
1.156 leot 12029: </tr>
12030: <tr>
1.159 rillig 12031: <td>PTHREAD_LDFLAGS</td>
1.160 brook 12032: <td>PTHREAD_LIBS</td>
1.156 leot 12033: </tr>
12034: <tr>
1.159 rillig 12035: <td>PTHREAD_OPTS</td>
1.160 brook 12036: <td>PTHREAD_TYPE</td>
1.156 leot 12037: </tr>
12038: <tr>
1.159 rillig 12039: <td>PVM_SSH</td>
1.160 brook 12040: <td>PYPKGPREFIX</td>
1.156 leot 12041: </tr>
12042: <tr>
1.159 rillig 12043: <td>PYTHON_FOR_BUILD_ONLY</td>
1.160 brook 12044: <td>PYTHON_SELF_CONFLICT</td>
1.156 leot 12045: </tr>
12046: <tr>
1.159 rillig 12047: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.160 brook 12048: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.156 leot 12049: </tr>
12050: <tr>
1.159 rillig 12051: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.160 brook 12052: <td>PYTHON_VERSION_DEFAULT</td>
1.156 leot 12053: </tr>
12054: <tr>
1.159 rillig 12055: <td>PYTHON_VERSION_REQD</td>
1.160 brook 12056: <td>PYVERSSUFFIX</td>
1.156 leot 12057: </tr>
12058: <tr>
1.159 rillig 12059: <td>PY_NO_EGG</td>
1.160 brook 12060: <td>QMAILDIR</td>
1.156 leot 12061: </tr>
12062: <tr>
1.159 rillig 12063: <td>QMAIL_ALIAS_USER</td>
1.160 brook 12064: <td>QMAIL_DAEMON_USER</td>
1.156 leot 12065: </tr>
12066: <tr>
1.159 rillig 12067: <td>QMAIL_LOG_USER</td>
1.160 brook 12068: <td>QMAIL_NOFILES_GROUP</td>
1.156 leot 12069: </tr>
12070: <tr>
1.159 rillig 12071: <td>QMAIL_PASSWD_USER</td>
1.160 brook 12072: <td>QMAIL_QMAIL_GROUP</td>
1.156 leot 12073: </tr>
12074: <tr>
1.159 rillig 12075: <td>QMAIL_QUEUE_DIR</td>
1.160 brook 12076: <td>QMAIL_QUEUE_EXTRA</td>
1.156 leot 12077: </tr>
12078: <tr>
1.159 rillig 12079: <td>QMAIL_QUEUE_USER</td>
1.160 brook 12080: <td>QMAIL_REMOTE_USER</td>
1.156 leot 12081: </tr>
12082: <tr>
1.159 rillig 12083: <td>QMAIL_ROOT_USER</td>
1.160 brook 12084: <td>QMAIL_SEND_USER</td>
1.156 leot 12085: </tr>
12086: <tr>
1.159 rillig 12087: <td>QPOPPER_FAC</td>
1.160 brook 12088: <td>QPOPPER_SPOOL_DIR</td>
1.156 leot 12089: </tr>
12090: <tr>
1.159 rillig 12091: <td>QPOPPER_USER</td>
1.160 brook 12092: <td>RAKE_NAME</td>
1.156 leot 12093: </tr>
12094: <tr>
1.159 rillig 12095: <td>RASMOL_DEPTH</td>
1.161 ! leot 12096: <td>RCD_DIR</td>
! 12097: </tr>
! 12098: <tr>
! 12099: <td>RCD_ORDER</td>
1.160 brook 12100: <td>RCD_SCRIPTS</td>
1.159 rillig 12101: </tr>
12102: <tr>
12103: <td>RCD_SCRIPTS_DIR</td>
1.160 brook 12104: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.156 leot 12105: </tr>
12106: <tr>
1.159 rillig 12107: <td>RCD_SCRIPTS_MODE</td>
1.160 brook 12108: <td>RCD_SCRIPTS_SHELL</td>
1.156 leot 12109: </tr>
12110: <tr>
1.159 rillig 12111: <td>RCD_SCRIPT_SRC</td>
1.161 ! leot 12112: <td>RCD_SUBR</td>
! 12113: </tr>
! 12114: <tr>
1.157 leot 12115: <td>RDOC</td>
1.161 ! leot 12116: <td>READLINE_DEFAULT</td>
1.156 leot 12117: </tr>
12118: <tr>
1.157 leot 12119: <td>READLINE_TYPE</td>
1.161 ! leot 12120: <td>REAL_ROOT_GROUP</td>
1.156 leot 12121: </tr>
12122: <tr>
1.157 leot 12123: <td>REAL_ROOT_USER</td>
1.161 ! leot 12124: <td>RECURSIVE_MAKE</td>
1.156 leot 12125: </tr>
12126: <tr>
1.157 leot 12127: <td>RELAY_CTRL_DIR</td>
1.161 ! leot 12128: <td>REPLACE_AWK</td>
1.156 leot 12129: </tr>
12130: <tr>
1.157 leot 12131: <td>REPLACE_BASH</td>
1.161 ! leot 12132: <td>REPLACE_CSH</td>
1.156 leot 12133: </tr>
12134: <tr>
1.157 leot 12135: <td>REPLACE_KSH</td>
1.161 ! leot 12136: <td>REPLACE_PERL</td>
1.156 leot 12137: </tr>
12138: <tr>
1.157 leot 12139: <td>REPLACE_PERL6</td>
1.161 ! leot 12140: <td>REPLACE_PYTHON</td>
1.156 leot 12141: </tr>
12142: <tr>
1.157 leot 12143: <td>REPLACE_RUBY</td>
1.161 ! leot 12144: <td>REPLACE_RUBY_DIRS</td>
1.156 leot 12145: </tr>
12146: <tr>
1.157 leot 12147: <td>REPLACE_RUBY_PAT</td>
1.161 ! leot 12148: <td>REPLACE_SH</td>
1.156 leot 12149: </tr>
12150: <tr>
1.157 leot 12151: <td>REPLACE_TEXLUA</td>
1.161 ! leot 12152: <td>REQD_DIRS</td>
1.156 leot 12153: </tr>
12154: <tr>
1.157 leot 12155: <td>REQD_DIRS_PERMS</td>
1.161 ! leot 12156: <td>REQD_FILES</td>
1.156 leot 12157: </tr>
12158: <tr>
1.157 leot 12159: <td>REQD_FILES_MODE</td>
1.161 ! leot 12160: <td>REQD_FILES_PERMS</td>
1.156 leot 12161: </tr>
12162: <tr>
1.157 leot 12163: <td>RESOLV_AUTO_VARS</td>
1.161 ! leot 12164: <td>RESOLV_LDFLAGS</td>
1.156 leot 12165: </tr>
12166: <tr>
1.157 leot 12167: <td>RESOLV_LIBS</td>
1.161 ! leot 12168: <td>RM</td>
! 12169: </tr>
! 12170: <tr>
! 12171: <td>ROCKSPEC_NAME</td>
! 12172: <td>ROCKSPEC_SPECFILE</td>
1.156 leot 12173: </tr>
12174: <tr>
1.157 leot 12175: <td>ROOT_CMD</td>
1.161 ! leot 12176: <td>ROOT_GROUP</td>
1.156 leot 12177: </tr>
12178: <tr>
1.157 leot 12179: <td>ROOT_USER</td>
1.161 ! leot 12180: <td>RPCGEN</td>
1.156 leot 12181: </tr>
12182: <tr>
1.157 leot 12183: <td>RPM</td>
1.161 ! leot 12184: <td>RPM2PKG_PLIST</td>
1.156 leot 12185: </tr>
12186: <tr>
1.157 leot 12187: <td>RPM2PKG_PREFIX</td>
1.161 ! leot 12188: <td>RPM2PKG_STAGE</td>
1.156 leot 12189: </tr>
12190: <tr>
1.157 leot 12191: <td>RPM2PKG_STRIP</td>
1.161 ! leot 12192: <td>RPM2PKG_SUBPREFIX</td>
1.156 leot 12193: </tr>
12194: <tr>
1.157 leot 12195: <td>RPMFILES</td>
1.161 ! leot 12196: <td>RPMIGNOREPATH</td>
1.156 leot 12197: </tr>
12198: <tr>
1.157 leot 12199: <td>RPM_DB_PREFIX</td>
1.161 ! leot 12200: <td>RSSH_CVS_PATH</td>
1.156 leot 12201: </tr>
12202: <tr>
1.157 leot 12203: <td>RSSH_RDIST_PATH</td>
1.161 ! leot 12204: <td>RSSH_RSYNC_PATH</td>
1.156 leot 12205: </tr>
12206: <tr>
1.157 leot 12207: <td>RSSH_SCP_PATH</td>
1.161 ! leot 12208: <td>RSSH_SFTP_SERVER_PATH</td>
1.156 leot 12209: </tr>
12210: <tr>
1.157 leot 12211: <td>RUBY</td>
1.161 ! leot 12212: <td>RUBYGEM</td>
1.156 leot 12213: </tr>
12214: <tr>
1.157 leot 12215: <td>RUBYGEM_NAME</td>
1.161 ! leot 12216: <td>RUBYGEM_OPTIONS</td>
1.156 leot 12217: </tr>
12218: <tr>
1.157 leot 12219: <td>RUBY_ABI_VERSION</td>
1.161 ! leot 12220: <td>RUBY_ARCH</td>
1.156 leot 12221: </tr>
12222: <tr>
1.157 leot 12223: <td>RUBY_ARCHINC</td>
1.161 ! leot 12224: <td>RUBY_ARCHLIB</td>
1.156 leot 12225: </tr>
12226: <tr>
1.157 leot 12227: <td>RUBY_BASE</td>
1.161 ! leot 12228: <td>RUBY_BASERIDIR</td>
1.156 leot 12229: </tr>
12230: <tr>
1.157 leot 12231: <td>RUBY_BUILD_RDOC</td>
1.161 ! leot 12232: <td>RUBY_BUILD_RI</td>
1.156 leot 12233: </tr>
12234: <tr>
1.157 leot 12235: <td>RUBY_DLEXT</td>
1.161 ! leot 12236: <td>RUBY_DOC</td>
1.156 leot 12237: </tr>
12238: <tr>
1.157 leot 12239: <td>RUBY_DYNAMIC_DIRS</td>
1.161 ! leot 12240: <td>RUBY_EG</td>
1.156 leot 12241: </tr>
12242: <tr>
1.157 leot 12243: <td>RUBY_ENCODING_ARG</td>
1.161 ! leot 12244: <td>RUBY_EXTCONF</td>
1.156 leot 12245: </tr>
12246: <tr>
1.157 leot 12247: <td>RUBY_EXTCONF_CHECK</td>
1.161 ! leot 12248: <td>RUBY_EXTCONF_DEBUG</td>
1.156 leot 12249: </tr>
12250: <tr>
1.157 leot 12251: <td>RUBY_EXTCONF_MAKEFILE</td>
1.161 ! leot 12252: <td>RUBY_GEM_BASE</td>
1.156 leot 12253: </tr>
12254: <tr>
1.157 leot 12255: <td>RUBY_INC</td>
1.161 ! leot 12256: <td>RUBY_LIB</td>
1.156 leot 12257: </tr>
12258: <tr>
1.157 leot 12259: <td>RUBY_LIB_BASE</td>
1.161 ! leot 12260: <td>RUBY_NAME</td>
1.156 leot 12261: </tr>
12262: <tr>
1.157 leot 12263: <td>RUBY_NOVERSION</td>
1.161 ! leot 12264: <td>RUBY_PKGPREFIX</td>
1.156 leot 12265: </tr>
12266: <tr>
1.157 leot 12267: <td>RUBY_RAILS</td>
1.161 ! leot 12268: <td>RUBY_RAILS42_VERSION</td>
1.156 leot 12269: </tr>
12270: <tr>
1.157 leot 12271: <td>RUBY_RAILS51_VERSION</td>
1.161 ! leot 12272: <td>RUBY_RAILS52_VERSION</td>
1.156 leot 12273: </tr>
12274: <tr>
1.157 leot 12275: <td>RUBY_RAILS_ACCEPTED</td>
1.161 ! leot 12276: <td>RUBY_RAILS_DEFAULT</td>
1.156 leot 12277: </tr>
12278: <tr>
1.157 leot 12279: <td>RUBY_RAILS_REQD</td>
1.161 ! leot 12280: <td>RUBY_RAILS_STRICT_DEP</td>
1.156 leot 12281: </tr>
12282: <tr>
1.157 leot 12283: <td>RUBY_RIDIR</td>
1.161 ! leot 12284: <td>RUBY_SETUP</td>
1.156 leot 12285: </tr>
12286: <tr>
1.157 leot 12287: <td>RUBY_SHLIB</td>
1.161 ! leot 12288: <td>RUBY_SHLIBALIAS</td>
1.156 leot 12289: </tr>
12290: <tr>
1.157 leot 12291: <td>RUBY_SHLIBVER</td>
1.161 ! leot 12292: <td>RUBY_SIMPLE_INSTALL</td>
1.156 leot 12293: </tr>
12294: <tr>
1.157 leot 12295: <td>RUBY_SITEARCHLIB</td>
1.161 ! leot 12296: <td>RUBY_SITELIB</td>
1.156 leot 12297: </tr>
12298: <tr>
1.157 leot 12299: <td>RUBY_SITELIB_BASE</td>
1.161 ! leot 12300: <td>RUBY_SITERIDIR</td>
1.156 leot 12301: </tr>
12302: <tr>
1.157 leot 12303: <td>RUBY_SLEXT</td>
1.161 ! leot 12304: <td>RUBY_SRCDIR</td>
1.156 leot 12305: </tr>
12306: <tr>
1.157 leot 12307: <td>RUBY_STATICLIB</td>
1.161 ! leot 12308: <td>RUBY_SUFFIX</td>
1.156 leot 12309: </tr>
12310: <tr>
1.157 leot 12311: <td>RUBY_SYSRIDIR</td>
1.161 ! leot 12312: <td>RUBY_USE_PTHREAD</td>
1.156 leot 12313: </tr>
12314: <tr>
1.157 leot 12315: <td>RUBY_VENDORARCHLIB</td>
1.161 ! leot 12316: <td>RUBY_VENDORLIB</td>
1.156 leot 12317: </tr>
12318: <tr>
1.157 leot 12319: <td>RUBY_VENDORLIB_BASE</td>
1.161 ! leot 12320: <td>RUBY_VER</td>
1.156 leot 12321: </tr>
12322: <tr>
1.157 leot 12323: <td>RUBY_VERSION</td>
1.161 ! leot 12324: <td>RUBY_VERSIONS_ACCEPTED</td>
1.156 leot 12325: </tr>
12326: <tr>
1.157 leot 12327: <td>RUBY_VERSION_DEFAULT</td>
1.161 ! leot 12328: <td>RUBY_VERSION_REQD</td>
1.156 leot 12329: </tr>
12330: <tr>
1.157 leot 12331: <td>RUBY_VER_DIR</td>
1.161 ! leot 12332: <td>RUN</td>
1.156 leot 12333: </tr>
12334: <tr>
1.157 leot 12335: <td>RUN_LDCONFIG</td>
1.161 ! leot 12336: <td>SAWFISH_THEMES</td>
1.156 leot 12337: </tr>
12338: <tr>
1.157 leot 12339: <td>SCO</td>
1.161 ! leot 12340: <td>SCREWS_GROUP</td>
1.156 leot 12341: </tr>
12342: <tr>
1.157 leot 12343: <td>SCREWS_USER</td>
1.161 ! leot 12344: <td>SCRIPTS_ENV</td>
1.156 leot 12345: </tr>
12346: <tr>
1.157 leot 12347: <td>SCROLLKEEPER_DATADIR</td>
1.161 ! leot 12348: <td>SCROLLKEEPER_REBUILDDB</td>
1.156 leot 12349: </tr>
12350: <tr>
1.157 leot 12351: <td>SCROLLKEEPER_UPDATEDB</td>
1.161 ! leot 12352: <td>SDIST_PAWD</td>
1.156 leot 12353: </tr>
12354: <tr>
1.157 leot 12355: <td>SERIAL_DEVICES</td>
1.161 ! leot 12356: <td>SETGIDGAME</td>
1.156 leot 12357: </tr>
12358: <tr>
1.157 leot 12359: <td>SETGID_GAMES_PERMS</td>
1.161 ! leot 12360: <td>SETUID_ROOT_PERMS</td>
1.156 leot 12361: </tr>
12362: <tr>
1.157 leot 12363: <td>SH</td>
1.161 ! leot 12364: <td>SHLIB</td>
1.156 leot 12365: </tr>
12366: <tr>
1.161 ! leot 12367: <td>SHORTNAME</td>
1.160 brook 12368: <td>SIGN_PACKAGES</td>
1.159 rillig 12369: </tr>
12370: <tr>
12371: <td>SILC_CLIENT_WITH_PERL</td>
1.160 brook 12372: <td>SITE_SPECIFIC_PKGS</td>
1.156 leot 12373: </tr>
12374: <tr>
1.159 rillig 12375: <td>SKIP_DEPENDS</td>
1.160 brook 12376: <td>SKIP_PORTABILITY_CHECK</td>
1.156 leot 12377: </tr>
12378: <tr>
1.159 rillig 12379: <td>SMF_INSTANCES</td>
1.160 brook 12380: <td>SMF_MANIFEST</td>
1.156 leot 12381: </tr>
12382: <tr>
1.159 rillig 12383: <td>SMF_METHODS</td>
1.160 brook 12384: <td>SMF_METHOD_SHELL</td>
1.156 leot 12385: </tr>
12386: <tr>
1.159 rillig 12387: <td>SMF_METHOD_SRC</td>
1.160 brook 12388: <td>SMF_NAME</td>
1.156 leot 12389: </tr>
12390: <tr>
1.159 rillig 12391: <td>SMF_PREFIX</td>
1.160 brook 12392: <td>SMF_SRCDIR</td>
1.156 leot 12393: </tr>
12394: <tr>
1.159 rillig 12395: <td>SNIPROXY_GROUP</td>
1.160 brook 12396: <td>SNIPROXY_USER</td>
1.156 leot 12397: </tr>
12398: <tr>
1.159 rillig 12399: <td>SOURCE_BUFFSIZE</td>
1.160 brook 12400: <td>SPECIAL_PERMS</td>
1.156 leot 12401: </tr>
12402: <tr>
1.159 rillig 12403: <td>SPECIFIC_PKGS</td>
1.160 brook 12404: <td>SSH_SUID</td>
1.156 leot 12405: </tr>
12406: <tr>
1.159 rillig 12407: <td>SSYNC_PAWD</td>
1.160 brook 12408: <td>STEP_MSG</td>
1.156 leot 12409: </tr>
12410: <tr>
1.159 rillig 12411: <td>STRIP</td>
1.160 brook 12412: <td>STRIP_DBG</td>
1.156 leot 12413: </tr>
12414: <tr>
1.159 rillig 12415: <td>STRIP_DEBUG</td>
1.160 brook 12416: <td>STRIP_DEBUG_SUPPORTED</td>
1.156 leot 12417: </tr>
12418: <tr>
1.159 rillig 12419: <td>STRIP_FILES_SKIP</td>
1.160 brook 12420: <td>SU</td>
1.156 leot 12421: </tr>
12422: <tr>
1.159 rillig 12423: <td>SUBDIR</td>
1.160 brook 12424: <td>SUBST_CLASSES</td>
1.156 leot 12425: </tr>
12426: <tr>
1.159 rillig 12427: <td>SUBST_FILES</td>
1.160 brook 12428: <td>SUBST_FILTER_CMD</td>
1.156 leot 12429: </tr>
12430: <tr>
1.159 rillig 12431: <td>SUBST_MESSAGE</td>
1.160 brook 12432: <td>SUBST_SED</td>
1.156 leot 12433: </tr>
12434: <tr>
1.159 rillig 12435: <td>SUBST_SHOW_DIFF</td>
1.160 brook 12436: <td>SUBST_SKIP_TEXT_CHECK</td>
1.156 leot 12437: </tr>
12438: <tr>
1.159 rillig 12439: <td>SUBST_STAGE</td>
1.160 brook 12440: <td>SUBST_VARS</td>
1.156 leot 12441: </tr>
12442: <tr>
1.159 rillig 12443: <td>SUNWSPROBASE</td>
1.160 brook 12444: <td>SUSE_PREFER</td>
1.156 leot 12445: </tr>
12446: <tr>
1.159 rillig 12447: <td>SU_CMD</td>
1.161 ! leot 12448: <td>SVN_EXTRACTDIR</td>
! 12449: </tr>
! 12450: <tr>
! 12451: <td>SVN_REPO</td>
! 12452: <td>SVN_REPOSITORIES</td>
! 12453: </tr>
! 12454: <tr>
! 12455: <td>SVN_REVISION</td>
1.160 brook 12456: <td>TERMCAP_TYPE</td>
1.159 rillig 12457: </tr>
12458: <tr>
12459: <td>TERMINFO_DEFAULT</td>
1.160 brook 12460: <td>TERMINFO_TYPE</td>
1.156 leot 12461: </tr>
12462: <tr>
1.159 rillig 12463: <td>TEST</td>
1.160 brook 12464: <td>TEST_DEPENDS</td>
1.156 leot 12465: </tr>
12466: <tr>
1.159 rillig 12467: <td>TEST_DIRS</td>
1.160 brook 12468: <td>TEST_ENV</td>
1.156 leot 12469: </tr>
12470: <tr>
1.159 rillig 12471: <td>TEST_MAKE_CMD</td>
1.160 brook 12472: <td>TEST_MAKE_FLAGS</td>
1.156 leot 12473: </tr>
12474: <tr>
1.159 rillig 12475: <td>TEST_TARGET</td>
1.160 brook 12476: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.156 leot 12477: </tr>
12478: <tr>
1.159 rillig 12479: <td>TEXLIVE_REV</td>
1.160 brook 12480: <td>TEXMFSITE</td>
1.156 leot 12481: </tr>
12482: <tr>
1.159 rillig 12483: <td>TEX_FORMATS</td>
1.160 brook 12484: <td>TEX_HYPHEN_DAT</td>
1.156 leot 12485: </tr>
12486: <tr>
1.159 rillig 12487: <td>TEX_HYPHEN_DEF</td>
1.160 brook 12488: <td>TEX_TEXMF_DIRS</td>
1.156 leot 12489: </tr>
12490: <tr>
1.159 rillig 12491: <td>THTTPD_LOG_FACILITY</td>
1.160 brook 12492: <td>TO</td>
1.156 leot 12493: </tr>
12494: <tr>
1.159 rillig 12495: <td>TOOLS_ALIASES</td>
1.160 brook 12496: <td>TOOLS_ARGS</td>
1.156 leot 12497: </tr>
12498: <tr>
1.159 rillig 12499: <td>TOOLS_BROKEN</td>
1.160 brook 12500: <td>TOOLS_CMD</td>
1.156 leot 12501: </tr>
12502: <tr>
1.159 rillig 12503: <td>TOOLS_CREATE</td>
1.160 brook 12504: <td>TOOLS_DIR</td>
1.156 leot 12505: </tr>
12506: <tr>
1.159 rillig 12507: <td>TOOLS_FAIL</td>
1.160 brook 12508: <td>TOOLS_GNU_MISSING</td>
1.156 leot 12509: </tr>
12510: <tr>
1.159 rillig 12511: <td>TOOLS_LDCONFIG</td>
1.160 brook 12512: <td>TOOLS_NOOP</td>
1.156 leot 12513: </tr>
12514: <tr>
1.159 rillig 12515: <td>TOOLS_PATH</td>
1.160 brook 12516: <td>TOOLS_SCRIPT</td>
1.156 leot 12517: </tr>
12518: <tr>
1.159 rillig 12519: <td>TOOL_DEPENDS</td>
1.161 ! leot 12520: <td>TTF_FONTDIR</td>
! 12521: </tr>
! 12522: <tr>
1.157 leot 12523: <td>TTF_FONTS_DIR</td>
1.161 ! leot 12524: <td>TYPE</td>
1.156 leot 12525: </tr>
12526: <tr>
1.157 leot 12527: <td>UAC_REQD_EXECS</td>
1.161 ! leot 12528: <td>UCSPI_SSL_GROUP</td>
1.156 leot 12529: </tr>
12530: <tr>
1.157 leot 12531: <td>UCSPI_SSL_USER</td>
1.161 ! leot 12532: <td>UNLIMIT_RESOURCES</td>
1.156 leot 12533: </tr>
12534: <tr>
1.157 leot 12535: <td>UNPRIVILEGED</td>
1.161 ! leot 12536: <td>UNPRIVILEGED_GROUP</td>
1.156 leot 12537: </tr>
12538: <tr>
1.157 leot 12539: <td>UNPRIVILEGED_GROUPS</td>
1.161 ! leot 12540: <td>UNPRIVILEGED_USER</td>
1.156 leot 12541: </tr>
12542: <tr>
1.157 leot 12543: <td>UNWRAP_FILES</td>
1.161 ! leot 12544: <td>UNWRAP_PATTERNS</td>
1.156 leot 12545: </tr>
12546: <tr>
1.157 leot 12547: <td>UPDATE_GEMSPEC</td>
1.161 ! leot 12548: <td>UPDATE_TARGET</td>
1.156 leot 12549: </tr>
12550: <tr>
1.157 leot 12551: <td>URI</td>
1.161 ! leot 12552: <td>USA</td>
1.156 leot 12553: </tr>
12554: <tr>
1.157 leot 12555: <td>USERGROUP_PHASE</td>
1.161 ! leot 12556: <td>USERPPP_GROUP</td>
1.156 leot 12557: </tr>
12558: <tr>
1.157 leot 12559: <td>USER_SPECIFIC_PKGS</td>
1.161 ! leot 12560: <td>USE_ABI_DEPENDS</td>
1.156 leot 12561: </tr>
12562: <tr>
1.157 leot 12563: <td>USE_APR</td>
1.161 ! leot 12564: <td>USE_BSD_MAKEFILE</td>
1.156 leot 12565: </tr>
12566: <tr>
1.157 leot 12567: <td>USE_BUILTIN</td>
1.161 ! leot 12568: <td>USE_CROSS_COMPILE</td>
1.156 leot 12569: </tr>
12570: <tr>
1.157 leot 12571: <td>USE_CURSES</td>
1.161 ! leot 12572: <td>USE_CWRAPPERS</td>
1.156 leot 12573: </tr>
12574: <tr>
1.157 leot 12575: <td>USE_DB185</td>
1.161 ! leot 12576: <td>USE_FEATURES</td>
1.156 leot 12577: </tr>
12578: <tr>
1.157 leot 12579: <td>USE_GAMESGROUP</td>
1.161 ! leot 12580: <td>USE_GCC_RUNTIME</td>
1.156 leot 12581: </tr>
12582: <tr>
1.157 leot 12583: <td>USE_IMAKE</td>
1.161 ! leot 12584: <td>USE_JAVA</td>
1.156 leot 12585: </tr>
12586: <tr>
1.157 leot 12587: <td>USE_JAVA2</td>
1.161 ! leot 12588: <td>USE_LANGUAGES</td>
1.156 leot 12589: </tr>
12590: <tr>
1.157 leot 12591: <td>USE_LIBTOOL</td>
1.161 ! leot 12592: <td>USE_NATIVE_GCC</td>
1.156 leot 12593: </tr>
12594: <tr>
1.157 leot 12595: <td>USE_NETBSD_REPO</td>
1.161 ! leot 12596: <td>USE_PKGSRC_GCC</td>
1.156 leot 12597: </tr>
12598: <tr>
1.157 leot 12599: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.161 ! leot 12600: <td>USE_PKGTASKS</td>
1.156 leot 12601: </tr>
12602: <tr>
1.157 leot 12603: <td>USE_RUBY_EXTCONF</td>
1.161 ! leot 12604: <td>USE_RUBY_INSTALL</td>
1.156 leot 12605: </tr>
12606: <tr>
1.157 leot 12607: <td>USE_RUBY_SETUP</td>
1.161 ! leot 12608: <td>USE_RUBY_SETUP_PKG</td>
1.156 leot 12609: </tr>
12610: <tr>
1.157 leot 12611: <td>USE_TOOLS</td>
1.161 ! leot 12612: <td>UUCP_GROUP</td>
1.156 leot 12613: </tr>
12614: <tr>
1.157 leot 12615: <td>UUCP_USER</td>
1.161 ! leot 12616: <td>VARBASE</td>
1.156 leot 12617: </tr>
12618: <tr>
1.157 leot 12619: <td>VARNAME</td>
1.161 ! leot 12620: <td>VIM_EXTRA_OPTS</td>
1.156 leot 12621: </tr>
12622: <tr>
1.157 leot 12623: <td>WARNING_MSG</td>
1.161 ! leot 12624: <td>WCALC_CGIDIR</td>
1.156 leot 12625: </tr>
12626: <tr>
1.157 leot 12627: <td>WCALC_CGIPATH</td>
1.161 ! leot 12628: <td>WCALC_HTMLDIR</td>
1.156 leot 12629: </tr>
12630: <tr>
1.157 leot 12631: <td>WCALC_HTMLPATH</td>
1.161 ! leot 12632: <td>WDM_MANAGERS</td>
1.156 leot 12633: </tr>
12634: <tr>
1.157 leot 12635: <td>WRAPPER_REORDER_CMDS</td>
1.161 ! leot 12636: <td>WRKDIR</td>
1.156 leot 12637: </tr>
12638: <tr>
1.157 leot 12639: <td>WRKDIR_BASENAME</td>
1.161 ! leot 12640: <td>WRKDIR_LOCKTYPE</td>
1.156 leot 12641: </tr>
12642: <tr>
1.157 leot 12643: <td>WRKLOG</td>
1.161 ! leot 12644: <td>WRKOBJDIR</td>
1.156 leot 12645: </tr>
12646: <tr>
1.157 leot 12647: <td>WRKSRC</td>
1.161 ! leot 12648: <td>WXGTK_ACCEPTED</td>
1.156 leot 12649: </tr>
12650: <tr>
1.157 leot 12651: <td>WXGTK_DEFAULT</td>
1.161 ! leot 12652: <td>X10_PORT</td>
1.156 leot 12653: </tr>
12654: <tr>
1.157 leot 12655: <td>X11</td>
1.161 ! leot 12656: <td>X11BASE</td>
1.156 leot 12657: </tr>
12658: <tr>
1.157 leot 12659: <td>X11_PKGSRCDIR</td>
1.161 ! leot 12660: <td>X11_TYPE</td>
1.156 leot 12661: </tr>
12662: <tr>
1.157 leot 12663: <td>X509_CERTIFICATE</td>
1.161 ! leot 12664: <td>X509_KEY</td>
1.156 leot 12665: </tr>
12666: <tr>
1.157 leot 12667: <td>XAW_TYPE</td>
1.161 ! leot 12668: <td>XLOCK_DEFAULT_MODE</td>
1.156 leot 12669: </tr>
12670: <tr>
1.157 leot 12671: <td>XMKMF_FLAGS</td>
1.161 ! leot 12672: <td>XXX</td>
1.156 leot 12673: </tr>
12674: <tr>
1.161 ! leot 12675: <td>XXXX</td>
1.160 brook 12676: <td>YES</td>
1.159 rillig 12677: </tr>
12678: <tr>
12679: <td>ZERO_FILESIZE_P</td>
1.160 brook 12680: <td>ZSH_STATIC</td>
1.156 leot 12681: </tr>
12682: <tr>
1.159 rillig 12683: <td>__stdc__</td>
1.160 brook 12684: <td>_vargroups</td>
1.156 leot 12685: </tr>
12686: <tr>
1.159 rillig 12687: <td>add</td>
1.160 brook 12688: <td>all</td>
1.156 leot 12689: </tr>
12690: <tr>
1.159 rillig 12691: <td>alternatives</td>
1.160 brook 12692: <td>aslr</td>
1.156 leot 12693: </tr>
12694: <tr>
1.159 rillig 12695: <td>asprintf</td>
1.161 ! leot 12696: <td>atlas</td>
! 12697: </tr>
! 12698: <tr>
1.158 brook 12699: <td>autoconf</td>
1.161 ! leot 12700: <td>automake</td>
1.156 leot 12701: </tr>
12702: <tr>
1.158 brook 12703: <td>autoreconf</td>
1.161 ! leot 12704: <td>awk</td>
1.156 leot 12705: </tr>
12706: <tr>
1.158 brook 12707: <td>bash</td>
1.161 ! leot 12708: <td>big-endian</td>
1.156 leot 12709: </tr>
12710: <tr>
1.158 brook 12711: <td>bin-install</td>
1.161 ! leot 12712: <td>binpkg-list</td>
1.156 leot 12713: </tr>
12714: <tr>
1.161 ! leot 12715: <td>blas</td>
1.160 brook 12716: <td>bootstrap-depends</td>
1.159 rillig 12717: </tr>
12718: <tr>
12719: <td>broken</td>
1.160 brook 12720: <td>broken_on_platform</td>
1.156 leot 12721: </tr>
12722: <tr>
1.159 rillig 12723: <td>build</td>
1.160 brook 12724: <td>build-env</td>
1.156 leot 12725: </tr>
12726: <tr>
1.159 rillig 12727: <td>buildlink-directories</td>
1.160 brook 12728: <td>buildlink-oss-soundcard-h</td>
1.156 leot 12729: </tr>
12730: <tr>
1.159 rillig 12731: <td>c</td>
1.160 brook 12732: <td>c++</td>
1.156 leot 12733: </tr>
12734: <tr>
1.159 rillig 12735: <td>ccache</td>
1.160 brook 12736: <td>cce</td>
1.156 leot 12737: </tr>
12738: <tr>
1.159 rillig 12739: <td>cdefs</td>
1.160 brook 12740: <td>changes</td>
1.156 leot 12741: </tr>
12742: <tr>
1.159 rillig 12743: <td>changes-entry</td>
1.160 brook 12744: <td>changes-entry-noupdate</td>
1.156 leot 12745: </tr>
12746: <tr>
1.159 rillig 12747: <td>check</td>
1.160 brook 12748: <td>check-clean</td>
1.156 leot 12749: </tr>
12750: <tr>
1.159 rillig 12751: <td>check-files</td>
1.160 brook 12752: <td>check-files-clean</td>
1.156 leot 12753: </tr>
12754: <tr>
1.159 rillig 12755: <td>check-vulnerable</td>
1.160 brook 12756: <td>checksum</td>
1.156 leot 12757: </tr>
12758: <tr>
1.159 rillig 12759: <td>checksum-phase</td>
1.160 brook 12760: <td>clean</td>
1.156 leot 12761: </tr>
12762: <tr>
1.159 rillig 12763: <td>clean-depends</td>
1.160 brook 12764: <td>cleandir</td>
1.156 leot 12765: </tr>
12766: <tr>
1.159 rillig 12767: <td>commit</td>
1.160 brook 12768: <td>commit-changes-entry</td>
1.156 leot 12769: </tr>
12770: <tr>
1.159 rillig 12771: <td>compact</td>
1.160 brook 12772: <td>compiler</td>
1.156 leot 12773: </tr>
12774: <tr>
1.159 rillig 12775: <td>conf</td>
1.160 brook 12776: <td>config.guess</td>
1.156 leot 12777: </tr>
12778: <tr>
1.159 rillig 12779: <td>config.sub</td>
1.160 brook 12780: <td>configuration</td>
1.156 leot 12781: </tr>
12782: <tr>
1.159 rillig 12783: <td>configure</td>
1.160 brook 12784: <td>configure-help</td>
1.156 leot 12785: </tr>
12786: <tr>
1.159 rillig 12787: <td>configure_args</td>
1.160 brook 12788: <td>cputime</td>
1.156 leot 12789: </tr>
12790: <tr>
1.159 rillig 12791: <td>create-usergroup</td>
1.160 brook 12792: <td>csh</td>
1.156 leot 12793: </tr>
12794: <tr>
1.159 rillig 12795: <td>ctf</td>
1.161 ! leot 12796: <td>cvs</td>
! 12797: </tr>
! 12798: <tr>
1.157 leot 12799: <td>debug</td>
1.161 ! leot 12800: <td>declaration</td>
1.156 leot 12801: </tr>
12802: <tr>
1.157 leot 12803: <td>declare</td>
1.161 ! leot 12804: <td>defined</td>
1.156 leot 12805: </tr>
12806: <tr>
1.157 leot 12807: <td>depend</td>
1.161 ! leot 12808: <td>dependencies</td>
1.156 leot 12809: </tr>
12810: <tr>
1.157 leot 12811: <td>depends</td>
1.161 ! leot 12812: <td>depends-checksum</td>
1.156 leot 12813: </tr>
12814: <tr>
1.157 leot 12815: <td>depends-fetch</td>
1.161 ! leot 12816: <td>deps</td>
1.156 leot 12817: </tr>
12818: <tr>
1.157 leot 12819: <td>describe</td>
1.161 ! leot 12820: <td>destdir</td>
1.156 leot 12821: </tr>
12822: <tr>
1.157 leot 12823: <td>distclean</td>
1.161 ! leot 12824: <td>distinfo</td>
1.156 leot 12825: </tr>
12826: <tr>
1.157 leot 12827: <td>dl</td>
1.161 ! leot 12828: <td>dlopen</td>
1.156 leot 12829: </tr>
12830: <tr>
1.157 leot 12831: <td>do-build</td>
1.161 ! leot 12832: <td>do-buildlink</td>
1.156 leot 12833: </tr>
12834: <tr>
1.157 leot 12835: <td>do-clean</td>
1.161 ! leot 12836: <td>do-configure-post-hook</td>
1.156 leot 12837: </tr>
12838: <tr>
1.157 leot 12839: <td>do-extract</td>
1.161 ! leot 12840: <td>do-fetch</td>
1.156 leot 12841: </tr>
12842: <tr>
1.161 ! leot 12843: <td>do-install</td>
1.160 brook 12844: <td>emul</td>
1.159 rillig 12845: </tr>
12846: <tr>
12847: <td>emulation</td>
1.160 brook 12848: <td>emulator</td>
1.156 leot 12849: </tr>
12850: <tr>
1.159 rillig 12851: <td>endian</td>
1.160 brook 12852: <td>enomem</td>
1.156 leot 12853: </tr>
12854: <tr>
1.159 rillig 12855: <td>err</td>
1.160 brook 12856: <td>errx</td>
1.156 leot 12857: </tr>
12858: <tr>
1.159 rillig 12859: <td>etc</td>
1.160 brook 12860: <td>feature</td>
1.156 leot 12861: </tr>
12862: <tr>
1.159 rillig 12863: <td>features</td>
1.160 brook 12864: <td>fetch</td>
1.156 leot 12865: </tr>
12866: <tr>
1.159 rillig 12867: <td>fetch-list</td>
1.160 brook 12868: <td>follows</td>
1.156 leot 12869: </tr>
12870: <tr>
1.159 rillig 12871: <td>forbids</td>
1.160 brook 12872: <td>form</td>
1.156 leot 12873: </tr>
12874: <tr>
1.159 rillig 12875: <td>format</td>
1.160 brook 12876: <td>fortify</td>
1.156 leot 12877: </tr>
12878: <tr>
1.159 rillig 12879: <td>fortify_source</td>
1.161 ! leot 12880: <td>fossil</td>
! 12881: </tr>
! 12882: <tr>
1.157 leot 12883: <td>friend</td>
1.161 ! leot 12884: <td>from</td>
1.156 leot 12885: </tr>
12886: <tr>
1.157 leot 12887: <td>fts</td>
1.161 ! leot 12888: <td>fts_close</td>
1.156 leot 12889: </tr>
12890: <tr>
1.157 leot 12891: <td>fts_open</td>
1.161 ! leot 12892: <td>fts_read</td>
1.156 leot 12893: </tr>
12894: <tr>
1.157 leot 12895: <td>fts_set</td>
1.161 ! leot 12896: <td>full</td>
1.156 leot 12897: </tr>
12898: <tr>
1.157 leot 12899: <td>gcc</td>
1.161 ! leot 12900: <td>getopt_long</td>
1.156 leot 12901: </tr>
12902: <tr>
1.157 leot 12903: <td>getprogname</td>
1.161 ! leot 12904: <td>gettext</td>
1.156 leot 12905: </tr>
12906: <tr>
1.161 ! leot 12907: <td>git</td>
1.160 brook 12908: <td>github</td>
1.159 rillig 12909: </tr>
12910: <tr>
12911: <td>glob</td>
1.160 brook 12912: <td>gnu</td>
1.156 leot 12913: </tr>
12914: <tr>
1.159 rillig 12915: <td>gnu_configure_strict</td>
1.160 brook 12916: <td>go</td>
1.156 leot 12917: </tr>
12918: <tr>
1.159 rillig 12919: <td>go-deps</td>
1.160 brook 12920: <td>golang</td>
1.156 leot 12921: </tr>
12922: <tr>
1.159 rillig 12923: <td>guess-license</td>
1.160 brook 12924: <td>hashbang</td>
1.156 leot 12925: </tr>
12926: <tr>
1.159 rillig 12927: <td>heimdal</td>
1.156 leot 12928: <td>help</td>
12929: </tr>
12930: <tr>
1.161 ! leot 12931: <td>hg</td>
1.156 leot 12932: <td>imake</td>
1.161 ! leot 12933: </tr>
! 12934: <tr>
1.157 leot 12935: <td>increment</td>
1.161 ! leot 12936: <td>interp</td>
1.156 leot 12937: </tr>
12938: <tr>
1.157 leot 12939: <td>interpreter</td>
1.161 ! leot 12940: <td>intl</td>
1.156 leot 12941: </tr>
12942: <tr>
1.157 leot 12943: <td>iso</td>
1.161 ! leot 12944: <td>kerberos</td>
1.156 leot 12945: </tr>
12946: <tr>
1.157 leot 12947: <td>krb</td>
1.161 ! leot 12948: <td>krb5</td>
1.156 leot 12949: </tr>
12950: <tr>
1.157 leot 12951: <td>ksh</td>
1.161 ! leot 12952: <td>lapack</td>
1.156 leot 12953: </tr>
12954: <tr>
12955: <td>latex</td>
1.160 brook 12956: <td>libnbcompat</td>
1.159 rillig 12957: </tr>
12958: <tr>
12959: <td>libs</td>
1.160 brook 12960: <td>libtool</td>
1.156 leot 12961: </tr>
12962: <tr>
1.159 rillig 12963: <td>licence</td>
1.160 brook 12964: <td>license</td>
1.156 leot 12965: </tr>
12966: <tr>
1.159 rillig 12967: <td>lintl</td>
1.160 brook 12968: <td>little-endian</td>
1.156 leot 12969: </tr>
12970: <tr>
1.159 rillig 12971: <td>lock</td>
1.160 brook 12972: <td>locking</td>
1.156 leot 12973: </tr>
12974: <tr>
1.159 rillig 12975: <td>lvalue</td>
1.160 brook 12976: <td>make</td>
1.156 leot 12977: </tr>
12978: <tr>
1.159 rillig 12979: <td>makesum</td>
1.157 leot 12980: <td>memory</td>
1.156 leot 12981: </tr>
12982: <tr>
1.161 ! leot 12983: <td>mercurial</td>
1.157 leot 12984: <td>meta</td>
1.161 ! leot 12985: </tr>
! 12986: <tr>
1.158 brook 12987: <td>meta-package</td>
1.161 ! leot 12988: <td>meta_package</td>
1.156 leot 12989: </tr>
12990: <tr>
1.158 brook 12991: <td>mit-krb5</td>
1.161 ! leot 12992: <td>mk.conf</td>
1.156 leot 12993: </tr>
12994: <tr>
1.161 ! leot 12995: <td>mkl</td>
1.160 brook 12996: <td>mount</td>
1.159 rillig 12997: </tr>
12998: <tr>
12999: <td>mprotect</td>
1.160 brook 13000: <td>mremap</td>
1.156 leot 13001: </tr>
13002: <tr>
1.159 rillig 13003: <td>nb</td>
1.160 brook 13004: <td>nbcompat</td>
1.156 leot 13005: </tr>
13006: <tr>
1.159 rillig 13007: <td>no</td>
1.160 brook 13008: <td>obstack</td>
1.156 leot 13009: </tr>
13010: <tr>
1.159 rillig 13011: <td>obstack_ptr_grow</td>
1.160 brook 13012: <td>occurs</td>
1.156 leot 13013: </tr>
13014: <tr>
1.159 rillig 13015: <td>only</td>
1.161 ! leot 13016: <td>openblas</td>
! 13017: </tr>
! 13018: <tr>
1.158 brook 13019: <td>options</td>
1.161 ! leot 13020: <td>options.mk</td>
1.156 leot 13021: </tr>
13022: <tr>
1.158 brook 13023: <td>order</td>
1.161 ! leot 13024: <td>override</td>
1.156 leot 13025: </tr>
13026: <tr>
1.158 brook 13027: <td>override-intltool</td>
1.161 ! leot 13028: <td>override-message-intltool</td>
1.156 leot 13029: </tr>
13030: <tr>
1.158 brook 13031: <td>package</td>
1.161 ! leot 13032: <td>parallel</td>
1.156 leot 13033: </tr>
13034: <tr>
1.158 brook 13035: <td>partial</td>
1.161 ! leot 13036: <td>path</td>
1.156 leot 13037: </tr>
13038: <tr>
1.158 brook 13039: <td>pax</td>
1.161 ! leot 13040: <td>paxctl</td>
1.156 leot 13041: </tr>
13042: <tr>
1.158 brook 13043: <td>pbulk-index</td>
1.161 ! leot 13044: <td>pc</td>
1.156 leot 13045: </tr>
13046: <tr>
1.158 brook 13047: <td>perl</td>
1.161 ! leot 13048: <td>perl5</td>
1.156 leot 13049: </tr>
13050: <tr>
1.158 brook 13051: <td>perms</td>
1.161 ! leot 13052: <td>php</td>
1.156 leot 13053: </tr>
13054: <tr>
1.158 brook 13055: <td>pkg-build-options</td>
1.161 ! leot 13056: <td>pkg-config</td>
1.156 leot 13057: </tr>
13058: <tr>
1.158 brook 13059: <td>pkg_build_options</td>
1.161 ! leot 13060: <td>platform</td>
1.156 leot 13061: </tr>
13062: <tr>
1.158 brook 13063: <td>plist</td>
1.161 ! leot 13064: <td>post-extract</td>
1.156 leot 13065: </tr>
13066: <tr>
1.158 brook 13067: <td>post-fetch</td>
1.161 ! leot 13068: <td>post-wrapper</td>
1.156 leot 13069: </tr>
13070: <tr>
1.158 brook 13071: <td>pre-configure</td>
1.161 ! leot 13072: <td>pre-extract</td>
1.156 leot 13073: </tr>
13074: <tr>
1.158 brook 13075: <td>pre-fetch</td>
1.161 ! leot 13076: <td>print-go-deps</td>
1.156 leot 13077: </tr>
13078: <tr>
1.158 brook 13079: <td>print-plist</td>
1.161 ! leot 13080: <td>print-summary-data</td>
1.156 leot 13081: </tr>
13082: <tr>
1.158 brook 13083: <td>privileged-install-hook</td>
1.161 ! leot 13084: <td>pypi</td>
1.156 leot 13085: </tr>
13086: <tr>
1.158 brook 13087: <td>python</td>
1.161 ! leot 13088: <td>readme-all</td>
1.156 leot 13089: </tr>
13090: <tr>
1.158 brook 13091: <td>regcomp</td>
1.161 ! leot 13092: <td>relro</td>
1.156 leot 13093: </tr>
13094: <tr>
1.158 brook 13095: <td>rename</td>
1.161 ! leot 13096: <td>reorder</td>
1.156 leot 13097: </tr>
13098: <tr>
1.158 brook 13099: <td>replace</td>
1.161 ! leot 13100: <td>replace_interpreter</td>
1.156 leot 13101: </tr>
13102: <tr>
1.158 brook 13103: <td>reproducible</td>
1.161 ! leot 13104: <td>resolv</td>
1.156 leot 13105: </tr>
13106: <tr>
1.158 brook 13107: <td>root</td>
1.161 ! leot 13108: <td>ruby</td>
1.156 leot 13109: </tr>
13110: <tr>
1.158 brook 13111: <td>setenv</td>
1.161 ! leot 13112: <td>setgid</td>
1.156 leot 13113: </tr>
13114: <tr>
1.158 brook 13115: <td>setprogname</td>
1.161 ! leot 13116: <td>setuid</td>
1.156 leot 13117: </tr>
13118: <tr>
1.158 brook 13119: <td>sh</td>
1.161 ! leot 13120: <td>show</td>
1.156 leot 13121: </tr>
13122: <tr>
1.158 brook 13123: <td>show-all</td>
1.161 ! leot 13124: <td>show-build-defs</td>
1.156 leot 13125: </tr>
13126: <tr>
1.158 brook 13127: <td>show-depends</td>
1.161 ! leot 13128: <td>show-deps</td>
1.156 leot 13129: </tr>
13130: <tr>
1.158 brook 13131: <td>show-distfiles</td>
1.161 ! leot 13132: <td>show-downlevel</td>
1.156 leot 13133: </tr>
13134: <tr>
1.158 brook 13135: <td>show-subdir-var</td>
1.161 ! leot 13136: <td>show-tools</td>
1.156 leot 13137: </tr>
13138: <tr>
1.158 brook 13139: <td>show-var</td>
1.161 ! leot 13140: <td>show-vars</td>
1.156 leot 13141: </tr>
13142: <tr>
1.158 brook 13143: <td>snprintf</td>
1.161 ! leot 13144: <td>ssp</td>
1.156 leot 13145: </tr>
13146: <tr>
1.158 brook 13147: <td>st_mode</td>
1.161 ! leot 13148: <td>stage-install</td>
1.156 leot 13149: </tr>
13150: <tr>
1.158 brook 13151: <td>strip</td>
1.161 ! leot 13152: <td>strnlen</td>
1.156 leot 13153: </tr>
13154: <tr>
1.157 leot 13155: <td>strong</td>
1.161 ! leot 13156: <td>subst</td>
1.156 leot 13157: </tr>
13158: <tr>
1.161 ! leot 13159: <td>subversion</td>
1.160 brook 13160: <td>sun</td>
1.159 rillig 13161: </tr>
13162: <tr>
13163: <td>sunpro</td>
1.156 leot 13164: <td>sunwspro</td>
13165: </tr>
13166: <tr>
1.161 ! leot 13167: <td>svn</td>
! 13168: <td>symlink</td>
! 13169: </tr>
! 13170: <tr>
1.156 leot 13171: <td>test</td>
1.157 leot 13172: <td>tex</td>
1.156 leot 13173: </tr>
13174: <tr>
13175: <td>texlive</td>
1.157 leot 13176: <td>tmp</td>
1.156 leot 13177: </tr>
13178: <tr>
13179: <td>tool</td>
1.157 leot 13180: <td>tools</td>
1.156 leot 13181: </tr>
13182: <tr>
13183: <td>tools-libtool-m4-override</td>
1.157 leot 13184: <td>type</td>
1.156 leot 13185: </tr>
13186: <tr>
13187: <td>ulimit</td>
1.157 leot 13188: <td>undefined</td>
1.156 leot 13189: </tr>
13190: <tr>
13191: <td>undo-replace</td>
1.157 leot 13192: <td>unlimit</td>
1.156 leot 13193: </tr>
13194: <tr>
13195: <td>unprivileged</td>
1.157 leot 13196: <td>unprivileged-install-hook</td>
1.156 leot 13197: </tr>
13198: <tr>
13199: <td>unstripped</td>
1.157 leot 13200: <td>update</td>
1.156 leot 13201: </tr>
13202: <tr>
13203: <td>upload</td>
1.157 leot 13204: <td>upload-distfiles</td>
1.156 leot 13205: </tr>
13206: <tr>
13207: <td>usage</td>
1.157 leot 13208: <td>use_tools</td>
1.156 leot 13209: </tr>
13210: <tr>
13211: <td>user</td>
1.157 leot 13212: <td>utimes</td>
1.156 leot 13213: </tr>
13214: <tr>
13215: <td>vasprintf</td>
1.157 leot 13216: <td>verbose</td>
1.156 leot 13217: </tr>
13218: <tr>
13219: <td>vsnprintf</td>
1.157 leot 13220: <td>warn</td>
1.156 leot 13221: </tr>
13222: <tr>
13223: <td>warning</td>
1.157 leot 13224: <td>warnings</td>
1.156 leot 13225: </tr>
13226: <tr>
13227: <td>warnx</td>
1.157 leot 13228: <td>weak</td>
1.156 leot 13229: </tr>
13230: <tr>
13231: <td>work</td>
1.157 leot 13232: <td>wrapper</td>
1.156 leot 13233: </tr>
13234: <tr>
1.161 ! leot 13235: <td>wrkdir</td>
1.156 leot 13236: <td>yes</td>
13237: </tr>
13238: </table>
1.154 rillig 13239: </div>
13240: <div class="appendix">
13241: <div class="titlepage"><div><div><h1 class="title">
13242: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 13243: <div class="toc">
13244: <p><b>Table of Contents</b></p>
1.100 leot 13245: <dl class="toc">
1.154 rillig 13246: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
13247: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1 dsieger 13248: </dl>
13249: </div>
13250: <p>This section contains information on editing the pkgsrc
13251: guide itself.</p>
1.41 asau 13252: <div class="sect1">
1.1 dsieger 13253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 13254: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.1 dsieger 13255: <p>The pkgsrc guide's source code is stored in
13256: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
13257: are created from it:</p>
1.41 asau 13258: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 13259: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
13260: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
13261: <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>
13262: <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 13263: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 13264: <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 13265: PostScript version of the pkgsrc guide.</p></li>
13266: </ul></div>
13267: </div>
1.41 asau 13268: <div class="sect1">
1.1 dsieger 13269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 13270: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.1 dsieger 13271: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 13272: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 13273: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 13274: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 13275: documentation) installed. These are automatically installed when
1.137 leot 13276: 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 13277: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 13278: right directory. All further steps will take place
13279: here.</p></li>
1.41 asau 13280: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 13281: <code class="filename">files/</code>.</p></li>
1.41 asau 13282: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 13283: guide for valid XML and to build the final output files. If you
13284: get any errors at this stage, you can just edit the files, as
13285: there are only symbolic links in the working directory, pointing
13286: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 13287: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 13288: commit)</strong></span></p></li>
1.41 asau 13289: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 13290: regenerate the output files with the proper RCS
13291: Ids.</p></li>
1.41 asau 13292: <li class="step">
1.10 hubertf 13293: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 13294: commit the files in both <code class="filename">pkgsrc/doc</code> and
13295: <code class="filename">htdocs</code>.</p>
1.41 asau 13296: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 13297: <h3 class="title">Note</h3>
13298: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 13299: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
13300: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 13301: directory.</p>
13302: </div>
13303: </li>
13304: </ol></div>
13305: </div>
13306: </div>
13307: </div></body>
13308: </html>
CVSweb <webmaster@jp.NetBSD.org>