Annotation of pkgsrc/doc/pkgsrc.html, revision 1.271
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.132 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
1.148 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75 rillig 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.110 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.75 rillig 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.110 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.75 rillig 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.259 jnemeth 33: <div><p class="copyright">Copyright © 1994-2019 The NetBSD Foundation, Inc</p></div>
1.268 sevan 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.35 2019/04/28 15:22:24 rillig Exp $</p></div>
1.148 asau 35: <div><div class="abstract">
1.75 rillig 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.210 leot 48: <dl class="toc">
1.75 rillig 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
1.75 rillig 56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
1.267 rillig 63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75 rillig 65: <dd><dl>
1.267 rillig 66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 67: <dd><dl>
1.267 rillig 68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75 rillig 70: </dl></dd>
1.267 rillig 71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 72: <dd><dl>
1.267 rillig 73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75 rillig 75: </dl></dd>
76: </dl></dd>
1.267 rillig 77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75 rillig 78: <dd><dl>
1.267 rillig 79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75 rillig 81: </dl></dd>
1.267 rillig 82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75 rillig 83: <dd><dl>
1.267 rillig 84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 85: <dd><dl>
1.267 rillig 86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
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.75 rillig 93: </dl></dd>
1.267 rillig 94: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75 rillig 95: <dd><dl>
1.267 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.75 rillig 99: </dl></dd>
100: </dl></dd>
1.267 rillig 101: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75 rillig 102: <dd><dl>
1.267 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.88 wiz 107: <dd><dl>
1.267 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.88 wiz 111: </dl></dd>
1.267 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.75 rillig 114: </dl></dd>
1.267 rillig 115: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75 rillig 116: <dd><dl>
1.267 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.106 rillig 119: </dl></dd>
1.267 rillig 120: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 121: builds)</a></span></dt>
1.75 rillig 122: <dd><dl>
1.267 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.128 wiz 147: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 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.75 rillig 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.267 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.91 rillig 161: <dd><dl>
1.267 rillig 162: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.91 rillig 163: <dd><dl>
1.267 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.271 ! 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. TeX packages</a></span></dt>
1.91 rillig 168: </dl></dd>
1.267 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.106 rillig 171: </dl></dd>
1.267 rillig 172: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.106 rillig 173: <dd><dl>
1.267 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.106 rillig 177: <dd><dl>
1.267 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.106 rillig 183: </dl></dd>
1.267 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.106 rillig 186: <dd><dl>
1.267 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.106 rillig 190: </dl></dd>
1.267 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.106 rillig 193: </dl></dd>
1.267 rillig 194: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 195: <dd><dl>
1.267 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.106 rillig 200: <dd><dl>
1.267 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.106 rillig 205: </dl></dd>
206: </dl></dd>
1.267 rillig 207: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.106 rillig 208: <dd><dl>
1.267 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.106 rillig 218: </dl></dd>
1.267 rillig 219: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.106 rillig 220: <dd><dl>
1.267 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.106 rillig 223: <dd><dl>
1.267 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.133 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.106 rillig 230: </dl></dd>
1.267 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.106 rillig 232: <dd><dl>
1.267 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.106 rillig 235: </dl></dd>
236: </dl></dd>
1.267 rillig 237: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.106 rillig 238: <dd><dl>
1.267 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.87 wiz 359: emulation</a></span></dt>
1.267 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.77 rillig 362: </dl></dd>
1.267 rillig 363: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 364: </dl></dd>
1.267 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.77 rillig 367: <dd><dl>
1.267 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.85 jmmv 384: </dl></dd>
1.75 rillig 385: </dl></dd>
386: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
387: <dd><dl>
1.267 rillig 388: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 389: <dd><dl>
1.267 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.81 rillig 393: <dd><dl>
1.267 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.81 rillig 396: </dl></dd>
1.267 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.75 rillig 399: <dd><dl>
1.267 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.75 rillig 402: </dl></dd>
1.267 rillig 403: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.75 rillig 404: <dd><dl>
1.267 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.75 rillig 407: </dl></dd>
408: </dl></dd>
1.267 rillig 409: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.75 rillig 410: <dd><dl>
1.267 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.75 rillig 413: <dd><dl>
1.267 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.75 rillig 416: </dl></dd>
417: </dl></dd>
1.267 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.75 rillig 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.128 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.75 rillig 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>
1.76 rillig 437: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
438: <dd><dl>
1.128 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.261 leot 444: <code class="filename">stable</code>,
1.128 wiz 445: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 446: source packages</a></span></dt>
447: </dl></dd>
1.267 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.75 rillig 450: <dd><dl>
1.267 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.75 rillig 453: </dl></dd>
454: </dl>
455: </div>
1.82 rillig 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.267 rillig 461: <dt>13.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 462: </dt>
1.267 rillig 463: <dt>25.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 464: </dt>
1.82 rillig 465: </dl>
466: </div>
1.148 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.75 rillig 470: <div class="toc">
471: <p><b>Table of Contents</b></p>
1.210 leot 472: <dl class="toc">
1.75 rillig 473: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 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>
1.75 rillig 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>
1.88 wiz 480: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 481: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
482: </dl>
483: </div>
1.148 asau 484: <div class="sect1">
1.75 rillig 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>
1.82 rillig 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>
1.75 rillig 494: <p>pkgsrc currently contains several thousand packages,
495: including:</p>
1.148 asau 496: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 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.75 rillig 498: web server</p></li>
1.250 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.75 rillig 500: web browser</p></li>
1.250 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.75 rillig 502: Desktop Environment</p></li>
1.250 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.75 rillig 504: Desktop Environment</p></li>
505: </ul></div>
1.219 rillig 506: <p>… just to name a few.</p>
1.75 rillig 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.148 asau 510: <div class="sect2">
1.82 rillig 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.148 asau 516: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 517: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82 rillig 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.128 wiz 523: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82 rillig 524: including binaries, libraries, man pages and other
525: documentation.</p></li>
1.214 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.128 wiz 530: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82 rillig 531: consists of highly portable code. This allows the greatest speed of
1.132 spz 532: development when porting to a new platform. This portability also
1.82 rillig 533: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
534: platforms</em></span>.</p></li>
1.128 wiz 535: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82 rillig 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.128 wiz 539: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82 rillig 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>
1.91 rillig 545: <p>The following principles are basic to pkgsrc:</p>
1.148 asau 546: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 547: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.126 jakllsch 548: — That means, if a package contains bugs, it's better to find
1.91 rillig 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.250 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.91 rillig 552: of shell scripts), and post-installation checks (installed files,
553: references to shared libraries, script interpreters).</p></li>
1.128 wiz 554: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.126 jakllsch 555: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 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>
1.82 rillig 559: </div>
1.148 asau 560: <div class="sect2">
1.82 rillig 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>
1.75 rillig 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>
1.82 rillig 570: <div class="table">
571: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216 tnn 572: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 573: <colgroup>
574: <col>
575: <col>
1.202 sevan 576: <col>
1.82 rillig 577: </colgroup>
578: <thead><tr>
579: <th>Platform</th>
580: <th>Date Support Added</th>
1.202 sevan 581: <th>Notes</th>
1.82 rillig 582: </tr></thead>
583: <tbody>
584: <tr>
1.110 hubertf 585: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 586: <td align="center">Aug 1997</td>
1.202 sevan 587: <td class="auto-generated"> </td>
1.82 rillig 588: </tr>
589: <tr>
1.110 hubertf 590: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 591: <td align="center">Mar 1999</td>
1.264 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.82 rillig 593: </tr>
594: <tr>
1.110 hubertf 595: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 596: <td align="center">Jun 1999</td>
1.264 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.82 rillig 598: </tr>
599: <tr>
600: <td>
1.230 sevan 601: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82 rillig 602: </td>
603: <td align="center">Oct 2001</td>
1.264 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.82 rillig 605: </tr>
606: <tr>
1.110 hubertf 607: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 608: <td align="center">Nov 2002</td>
1.264 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.82 rillig 610: </tr>
611: <tr>
1.110 hubertf 612: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 613: <td align="center">Nov 2002</td>
1.264 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.82 rillig 615: </tr>
616: <tr>
1.110 hubertf 617: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 618: <td align="center">Dec 2002</td>
1.202 sevan 619: <td>
1.264 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.202 sevan 622: </td>
1.82 rillig 623: </tr>
624: <tr>
625: <td>BSD/OS</td>
626: <td align="center">Dec 2003</td>
1.202 sevan 627: <td class="auto-generated"> </td>
1.82 rillig 628: </tr>
629: <tr>
1.110 hubertf 630: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 631: <td align="center">Dec 2003</td>
1.264 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.82 rillig 633: </tr>
634: <tr>
635: <td>
1.110 hubertf 636: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 637: (Microsoft Windows Services for Unix)
638: </td>
639: <td align="center">Mar 2004</td>
1.264 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.82 rillig 641: </tr>
642: <tr>
1.110 hubertf 643: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 644: <td align="center">Oct 2004</td>
1.202 sevan 645: <td class="auto-generated"> </td>
1.82 rillig 646: </tr>
647: <tr>
1.110 hubertf 648: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 649: <td align="center">Nov 2004</td>
1.264 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.82 rillig 651: </tr>
1.98 wiz 652: <tr>
1.110 hubertf 653: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 654: <td align="center">Apr 2007</td>
1.264 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.98 wiz 656: </tr>
1.128 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.264 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.128 wiz 661: </tr>
1.151 obache 662: <tr>
663: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163 bsiegert 664: <td align="center">Jan 2011</td>
1.202 sevan 665: <td class="auto-generated"> </td>
1.151 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.264 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.151 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.264 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.151 obache 676: </tr>
1.166 jnemeth 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.264 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.166 jnemeth 681: </tr>
1.214 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.264 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.214 sevan 686: </tr>
1.82 rillig 687: </tbody>
1.91 rillig 688: </table></div>
1.82 rillig 689: </div>
1.91 rillig 690: <br class="table-break">
1.82 rillig 691: </div>
1.75 rillig 692: </div>
1.148 asau 693: <div class="sect1">
1.75 rillig 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.110 hubertf 697: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 698: describes how one can use one of the packages in the Package
699: Collection, either by installing a precompiled binary package,
1.93 rillig 700: or by building one's own copy using the NetBSD package system.
1.110 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.75 rillig 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.110 hubertf 704: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 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.110 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.75 rillig 709: </div>
1.148 asau 710: <div class="sect1">
1.75 rillig 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.128 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.75 rillig 715: terminology used within this document.</p>
1.148 asau 716: <div class="variablelist"><dl class="variablelist">
1.75 rillig 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.236 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.75 rillig 725: <dt><span class="term">The NetBSD package system</span></dt>
1.128 wiz 726: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.87 wiz 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>
1.75 rillig 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
1.76 rillig 739: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 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.128 wiz 743: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.75 rillig 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
1.76 rillig 748: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 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
1.76 rillig 752: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132 spz 753: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128 wiz 754: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.75 rillig 755: especially in the context of precompiled packages.</p>
756: </dd>
757: <dt><span class="term">Program</span></dt>
1.88 wiz 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>
1.75 rillig 761: </dl></div>
1.148 asau 762: <div class="sect2">
1.75 rillig 763: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 764: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148 asau 765: <div class="variablelist"><dl class="variablelist">
1.75 rillig 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.128 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.75 rillig 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.110 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.75 rillig 777: documentation.</p>
778: </dd>
779: <dt><span class="term">package maintainers</span></dt>
780: <dd><p>A
1.110 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.75 rillig 782: <dt><span class="term">infrastructure developers</span></dt>
783: <dd><p>These people are involved in all those files
1.76 rillig 784: that live in the <code class="filename">mk/</code> directory and below.
1.110 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.75 rillig 786: too.</p></dd>
787: </dl></div>
788: </div>
789: </div>
1.148 asau 790: <div class="sect1">
1.75 rillig 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.128 wiz 795: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.226 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.75 rillig 799: </div>
800: </div>
1.148 asau 801: <div class="part">
1.75 rillig 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.210 leot 806: <dl class="toc">
1.267 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.75 rillig 809: <dd><dl>
1.267 rillig 810: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 811: <dd><dl>
1.267 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.75 rillig 814: </dl></dd>
1.267 rillig 815: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 816: <dd><dl>
1.267 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.75 rillig 819: </dl></dd>
820: </dl></dd>
1.267 rillig 821: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75 rillig 822: <dd><dl>
1.267 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.75 rillig 825: </dl></dd>
1.267 rillig 826: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75 rillig 827: <dd><dl>
1.267 rillig 828: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 829: <dd><dl>
1.267 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.75 rillig 837: </dl></dd>
1.267 rillig 838: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75 rillig 839: <dd><dl>
1.267 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.75 rillig 843: </dl></dd>
844: </dl></dd>
1.267 rillig 845: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75 rillig 846: <dd><dl>
1.267 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.88 wiz 851: <dd><dl>
1.267 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.88 wiz 855: </dl></dd>
1.267 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.75 rillig 858: </dl></dd>
1.267 rillig 859: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75 rillig 860: <dd><dl>
1.267 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.106 rillig 863: </dl></dd>
1.267 rillig 864: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 865: builds)</a></span></dt>
1.75 rillig 866: <dd><dl>
1.267 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.128 wiz 891: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 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.75 rillig 899: </dl></dd>
900: </dl>
901: </div>
1.148 asau 902: <div class="chapter">
1.75 rillig 903: <div class="titlepage"><div><div><h2 class="title">
1.267 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.75 rillig 936: <div class="toc">
937: <p><b>Table of Contents</b></p>
1.210 leot 938: <dl class="toc">
1.267 rillig 939: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75 rillig 940: <dd><dl>
1.267 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.75 rillig 943: </dl></dd>
1.267 rillig 944: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75 rillig 945: <dd><dl>
1.267 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.75 rillig 948: </dl></dd>
949: </dl>
950: </div>
1.91 rillig 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.148 asau 959: <div class="sect1">
1.75 rillig 960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 961: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75 rillig 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.270 leot 968: <code class="literal">2019Q2</code>.</p>
1.75 rillig 969: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128 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.157 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.148 asau 974: <div class="sect2">
1.75 rillig 975: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 976: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75 rillig 977: <p>The primary download location for all pkgsrc files is
1.264 sevan 978: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157 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.264 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.230 sevan 985: It is autogenerated weekly.</p>
1.157 asau 986: <p>To save download time we provide bzip2- and
987: xz-compressed archives which are published at
1.264 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.157 asau 989: and
1.264 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.157 asau 991: respectively.
992: </p>
993: <p>You can fetch the same files using FTP.</p>
1.270 leot 994: <p>The tar file for the stable branch 2019Q2 is in the
995: directory <code class="filename">pkgsrc-2019Q2</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q2/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249 leot 996: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112 weinem 997: <pre class="screen">
1.270 leot 998: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q2/pkgsrc.tar.gz</code></strong></pre>
1.188 snj 999: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157 asau 1000: or your web browser.</p>
1.112 weinem 1001: <p>Then, extract it with:</p>
1.188 snj 1002: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112 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.75 rillig 1008: </div>
1.148 asau 1009: <div class="sect2">
1.75 rillig 1010: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1011: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128 wiz 1012: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.270 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-2019Q2 -P pkgsrc</code></strong>
1.128 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.146 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 grant 1020: </pre>
1.188 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.128 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.146 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.128 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.101 rillig 1038: <pre class="programlisting">
1039: # recommended CVS configuration file from the pkgsrc guide
1.268 sevan 1040: cvs -q
1.101 rillig 1041: checkout -P
1.103 wiz 1042: update -dP
1043: diff -upN
1.101 rillig 1044: rdiff -u
1.128 wiz 1045: release -d
1.101 rillig 1046: </pre>
1.75 rillig 1047: </div>
1048: </div>
1.148 asau 1049: <div class="sect1">
1.75 rillig 1050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1051: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75 rillig 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.148 asau 1056: <div class="sect2">
1.75 rillig 1057: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1058: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148 asau 1059: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1060: <h3 class="title">Warning</h3>
1.77 rillig 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>
1.75 rillig 1068: </div>
1.82 rillig 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.188 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.82 rillig 1073: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267 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.75 rillig 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.148 asau 1080: <div class="sect2">
1.75 rillig 1081: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1082: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132 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.148 asau 1089: <div class="sect3">
1.75 rillig 1090: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1091: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75 rillig 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.128 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.75 rillig 1097: back to the stable branch, add the
1.270 leot 1098: <span class="quote">“<span class="quote">-rpkgsrc-2019Q2</span>”</span> option.</p>
1.75 rillig 1099: </div>
1.148 asau 1100: <div class="sect3">
1.75 rillig 1101: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 1102: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75 rillig 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.128 wiz 1109: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.75 rillig 1110: </div>
1111: </div>
1112: </div>
1113: </div>
1.148 asau 1114: <div class="chapter">
1.75 rillig 1115: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1116: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75 rillig 1117: <div class="toc">
1118: <p><b>Table of Contents</b></p>
1.210 leot 1119: <dl class="toc">
1.267 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.75 rillig 1122: </dl>
1123: </div>
1.148 asau 1124: <div class="sect1">
1.75 rillig 1125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.82 rillig 1128: </div>
1.148 asau 1129: <div class="sect1">
1.82 rillig 1130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1131: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149 asau 1132: <p>pkgsrc can be bootstrapped for use in two different modes:
1133: privileged and unprivileged one. In unprivileged mode in contrast
1.150 asau 1134: to privileged one all programs are installed under one particular user
1.149 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.82 rillig 1138: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1139: <pre class="screen">
1.167 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.75 rillig 1141: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1142: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1143: </pre>
1.149 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.230 sevan 1148: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149 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.230 sevan 1154: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149 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.148 asau 1160: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1161: <h3 class="title">Note</h3>
1.110 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.128 wiz 1165: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.75 rillig 1166: </div>
1.149 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.75 rillig 1175: </div>
1176: </div>
1.148 asau 1177: <div class="chapter">
1.75 rillig 1178: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1179: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75 rillig 1180: <div class="toc">
1181: <p><b>Table of Contents</b></p>
1.210 leot 1182: <dl class="toc">
1.267 rillig 1183: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75 rillig 1184: <dd><dl>
1.267 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.75 rillig 1198: </dl></dd>
1199: </dl>
1200: </div>
1201: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1202: is to only install the package tools and to use binary packages
1.128 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.88 wiz 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.148 asau 1207: <div class="sect1">
1.75 rillig 1208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1209: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.264 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.109 rillig 1212: ready to be installed. These binary packages have been built using the
1213: default settings for the directories, that is:</p>
1.148 asau 1214: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.109 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.267 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.148 asau 1222: <div class="sect2">
1.75 rillig 1223: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1224: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105 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.264 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.105 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.128 wiz 1232: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.109 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.230 sevan 1239: for managing binary packages and the database of installed packages).</p>
1.75 rillig 1240: </div>
1.148 asau 1241: <div class="sect2">
1.75 rillig 1242: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1243: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1244: <p>In the directory from the last section, there is a
1.196 wiz 1245: subdirectory called <code class="filename">All/</code>, which contains all the
1.109 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.128 wiz 1248: medium you are using).</p>
1.109 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.110 hubertf 1251: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1252: <pre class="screen">
1253: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.264 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.109 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.230 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.109 rillig 1267: </pre>
1.75 rillig 1268: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1269: package in question will be installed, too, assuming they are
1270: present where you install from.</p>
1.128 wiz 1271: <p>Adding packages might install vulnerable packages.
1272: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1273: regularly, especially after installing new packages, and verify
1274: that the vulnerabilities are acceptable for your configuration.</p>
1.75 rillig 1275: <p>After you've installed packages, be sure to have
1.88 wiz 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>
1.75 rillig 1279: </div>
1.148 asau 1280: <div class="sect2">
1.75 rillig 1281: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1282: <a name="using.pkg_delete"></a>5.1.3. Deinstalling packages</h3></div></div></div>
1.82 rillig 1283: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1284: installed from source code or from a binary package. The
1.110 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.88 wiz 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>
1.82 rillig 1293: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1294: removes all the packages that require the package in question
1295: and then removes the package itself. For example:
1.82 rillig 1296:
1.88 wiz 1297: </p>
1.82 rillig 1298: <pre class="screen">
1.88 wiz 1299: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1300: </pre>
1.82 rillig 1301: <p>
1302:
1.88 wiz 1303: will remove jpeg and all the packages that used it; this allows
1304: upgrading the jpeg package.</p>
1.82 rillig 1305: </div>
1.148 asau 1306: <div class="sect2">
1.82 rillig 1307: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1308: <a name="using.pkg_info"></a>5.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1309: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1310: installed packages or binary package files.</p>
1.82 rillig 1311: </div>
1.148 asau 1312: <div class="sect2">
1.82 rillig 1313: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1314: <a name="vulnerabilities"></a>5.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82 rillig 1315: <p>
1.88 wiz 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.264 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.88 wiz 1320: </p>
1.82 rillig 1321: <p>
1.125 wiz 1322: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88 wiz 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>
1.82 rillig 1327: <p>
1.125 wiz 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.88 wiz 1331: the list of vulnerabilities from the NetBSD FTP site. The second
1.125 wiz 1332: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88 wiz 1333: installed packages are vulnerable. If a package is vulnerable, you
1334: will see output similar to the following:
1335: </p>
1.82 rillig 1336: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1337: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1338: <p>
1.125 wiz 1339: You may wish to have the
1.264 sevan 1340: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125 wiz 1341: file downloaded daily so that
1342: it remains current. This may be done by adding an appropriate entry
1.270 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.125 wiz 1344: </p>
1345: <pre class="screen">
1.233 sevan 1346: # Download vulnerabilities file
1.230 sevan 1347: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.233 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.125 wiz 1351: </pre>
1352: <p>
1.230 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.125 wiz 1355:
1.230 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.235 yyamano 1365: desired (not required), by adding the following line to
1.230 sevan 1366: <code class="filename">/etc/security.conf</code>:
1.125 wiz 1367: </p>
1368: <pre class="screen">
1.230 sevan 1369: check_pkg_vulnerabilities=YES
1.125 wiz 1370: </pre>
1371: <p>
1.270 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.88 wiz 1373: </p>
1.82 rillig 1374: </div>
1.148 asau 1375: <div class="sect2">
1.82 rillig 1376: <div class="titlepage"><div><div><h3 class="title">
1.267 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.82 rillig 1378: <p>
1.250 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.128 wiz 1380: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.88 wiz 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>
1.82 rillig 1385: ...
1.88 wiz 1386: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1387: </pre>
1.110 hubertf 1388: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1389: package on your system and rebuild any dependencies.
1390: </p>
1.82 rillig 1391: </div>
1.148 asau 1392: <div class="sect2">
1.82 rillig 1393: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1394: <a name="using.pkg_admin"></a>5.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1395: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1396: administrative functions on the package system.</p>
1.82 rillig 1397: </div>
1.75 rillig 1398: </div>
1.148 asau 1399: <div class="sect1">
1.75 rillig 1400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1401: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88 wiz 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.110 hubertf 1405: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1406: directory to build local <code class="filename">README.html</code> files for
1.250 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.88 wiz 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.110 hubertf 1411: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 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.110 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.88 wiz 1416: instructions how to create your own packages.</p>
1.148 asau 1417: <div class="sect2">
1.75 rillig 1418: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1419: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82 rillig 1420: <p>To build packages from source, you need a working C
1.88 wiz 1421: compiler. On NetBSD, you need to install the
1.128 wiz 1422: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.88 wiz 1423: sets. If you want to build X11-related packages, the
1.128 wiz 1424: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.88 wiz 1425: sets are required, too.</p>
1.75 rillig 1426: </div>
1.148 asau 1427: <div class="sect2">
1.75 rillig 1428: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1429: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75 rillig 1430: <p>The first step for building a package is downloading the
1.88 wiz 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>
1.82 rillig 1438: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1439: <p>
1.110 hubertf 1440: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 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>
1.88 wiz 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>
1.75 rillig 1459: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1460: if you want to keep the settings, by editing the
1.110 hubertf 1461: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1462: and adding the definitions there.</p>
1.82 rillig 1463: <p>
1.88 wiz 1464: If a package depends on many other packages (such as
1.250 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.88 wiz 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>
1.82 rillig 1470: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1471: <p>
1.88 wiz 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>
1.75 rillig 1476: </div>
1.148 asau 1477: <div class="sect2">
1.75 rillig 1478: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1479: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1480: <p>
1.88 wiz 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.148 asau 1486: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 1487: <h3 class="title">Note</h3>
1488: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1489: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128 wiz 1490: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.75 rillig 1491: </div>
1.87 wiz 1492: <p>For example, type</p>
1.88 wiz 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>
1.75 rillig 1497: <p>at the shell prompt to build the various components of the
1.88 wiz 1498: package.</p>
1.82 rillig 1499: <p>The next stage is to actually install the newly compiled
1.88 wiz 1500: program onto your system. Do this by entering:
1.82 rillig 1501:
1.88 wiz 1502: </p>
1.82 rillig 1503: <pre class="screen">
1.88 wiz 1504: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1505: </pre>
1.82 rillig 1506: <p>
1507:
1.88 wiz 1508: while you are still in the directory for whatever package you
1509: are installing.</p>
1.82 rillig 1510: <p>Installing the package on your system may require you to
1.88 wiz 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>
1.82 rillig 1514: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1515: You can now enter:
1.82 rillig 1516:
1.88 wiz 1517: </p>
1.82 rillig 1518: <pre class="screen">
1.88 wiz 1519: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1520: </pre>
1.82 rillig 1521: <p>
1522:
1.88 wiz 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>
1.82 rillig 1527: <pre class="screen">
1.88 wiz 1528: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1529: </pre>
1.75 rillig 1530: <p>Taking the figlet utility as an example, we can install it on our
1.110 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.88 wiz 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.110 hubertf 1549: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 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.110 hubertf 1554: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 1555: set them each time you want to use pkgsrc.</p>
1.128 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.88 wiz 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.128 wiz 1561: <div class="orderedlist"><ol class="orderedlist" type="1">
1562: <li class="listitem">
1.270 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.88 wiz 1564: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1565: information will be displayed. For example,</p>
1.75 rillig 1566: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 1567: <p>will show all the commands that are invoked, up to and
1.128 wiz 1568: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.75 rillig 1569: </li>
1.128 wiz 1570: <li class="listitem">
1.270 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.88 wiz 1572: definition, then the <code class="varname">VARNAME</code> definition
1573: should be used, in conjunction with the show-var
1.270 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.88 wiz 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>
1.75 rillig 1578: /usr/pkg
1579: <code class="prompt">%</code>
1.88 wiz 1580: </pre>
1.75 rillig 1581: </li>
1582: </ol></div>
1583: <p>If you want to install a binary package that you've either
1.88 wiz 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.270 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.110 hubertf 1588: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 1589: sites searched is kept in the variable
1590: <code class="varname">BINPKG_SITES</code>, which defaults to
1.270 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.88 wiz 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>
1.75 rillig 1605: </div>
1606: </div>
1607: </div>
1.148 asau 1608: <div class="chapter">
1.75 rillig 1609: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 1610: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75 rillig 1611: <div class="toc">
1612: <p><b>Table of Contents</b></p>
1.210 leot 1613: <dl class="toc">
1.267 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.88 wiz 1622: </dl></dd>
1.267 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.75 rillig 1625: </dl>
1626: </div>
1.104 rillig 1627: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 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.270 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.89 rillig 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.223 rillig 1638: spelling mistakes) takes place.</p>
1.148 asau 1639: <div class="sect1">
1.75 rillig 1640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1641: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223 rillig 1642: <p>The following variables apply to all
1.89 rillig 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.148 asau 1647: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1648: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75 rillig 1649: packages will be installed. The default is
1.76 rillig 1650: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 1651: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128 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.75 rillig 1654: installed. The default is
1.76 rillig 1655: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128 wiz 1656: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75 rillig 1657: X11 is installed on the system. The default is
1.194 bsiegert 1658: <code class="filename">/usr/X11R7</code>.</p></li>
1.128 wiz 1659: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75 rillig 1660: downloaded copies of the original source distributions used
1661: for building pkgsrc packages. The default is
1.76 rillig 1662: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128 wiz 1663: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97 rillig 1664: database about installed packages is stored. The default is
1.230 sevan 1665: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128 wiz 1666: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75 rillig 1667: If set, override the packages'
1668: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128 wiz 1669: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75 rillig 1670: Backup location(s) for distribution files and patch files
1671: if not found locally or in
1.76 rillig 1672: <code class="filename">${MASTER_SITES}</code> or
1673: <code class="filename">${PATCH_SITES}</code> respectively.
1.230 sevan 1674: The defaults is
1675: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128 wiz 1676: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 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.128 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.125 wiz 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.75 rillig 1687: </ul></div>
1688: </div>
1.148 asau 1689: <div class="sect1">
1.75 rillig 1690: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1691: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219 rillig 1692: <p>
1.75 rillig 1693: </p>
1.148 asau 1694: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1695: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75 rillig 1696: directory for the binary packages. The default is
1.76 rillig 1697: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128 wiz 1698: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75 rillig 1699: The top level directory where, if defined, the separate
1700: working directories will get created, and symbolically
1.76 rillig 1701: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 1702: This is useful for building packages on several
1.76 rillig 1703: architectures, then <code class="filename">${PKGSRCDIR}</code>
1704: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 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.126 jakllsch 1707: — it is an internal definition which refers to the
1.75 rillig 1708: root of the pkgsrc tree. It is possible to have many
1709: pkgsrc tree instances.)</p></li>
1.128 wiz 1710: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75 rillig 1711: Directory for local patches that aren't part of pkgsrc.
1.267 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.93 rillig 1713: information.</p></li>
1.128 wiz 1714: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 1715: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 1716: BSD-style Makefile. If this is not set,
1717: <code class="varname">MAKECONF</code> is set to
1.76 rillig 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>
1.75 rillig 1720: </ul></div>
1721: </div>
1.148 asau 1722: <div class="sect1">
1.75 rillig 1723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1724: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.256 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.263 leot 1727: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256 maya 1728: this variable to "no" prevents this.</p></li></ul></div>
1.217 jnemeth 1729: <p>Packages have to support installation into a
1.103 wiz 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.148 asau 1733: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1734: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131 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.103 wiz 1740: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1741: clean</code></strong> needs to be run as root.</p>
1.118 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.174 asau 1759: <code class="prompt">$</code> make stage-install
1.118 imil 1760: </pre>
1761: <p>
1762:
1763: Create a package without root privileges
1764:
1765: </p>
1766: <pre class="programlisting">
1.174 asau 1767: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118 imil 1768: </pre>
1769: <p>
1770:
1771: For the following command, you must be able to gain root
1.270 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.118 imil 1773:
1774: </p>
1775: <pre class="programlisting">
1.174 asau 1776: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118 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.103 wiz 1789: </div>
1.148 asau 1790: <div class="sect1">
1.103 wiz 1791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1792: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.148 asau 1793: <div class="sect2">
1.78 rillig 1794: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 1795: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 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.148 asau 1798: <div class="variablelist"><dl class="variablelist">
1.89 rillig 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.148 asau 1804: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174 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.128 wiz 1811: <li class="listitem"><p><code class="varname">distcc</code>:
1.89 rillig 1812: distributed C/C++ (chainable)</p></li>
1.174 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.128 wiz 1819: <li class="listitem"><p><code class="varname">gcc</code>:
1.89 rillig 1820: GNU C/C++ Compiler</p></li>
1.174 asau 1821: <li class="listitem"><p><code class="varname">hp</code>:
1822: HP-UX C/aC++ compilers</p></li>
1.128 wiz 1823: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89 rillig 1824: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174 asau 1825: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89 rillig 1826: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128 wiz 1827: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89 rillig 1828: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174 asau 1829: <li class="listitem"><p><code class="varname">xlc</code>:
1.230 sevan 1830: IBM's XL C/C++ compiler suite</p></li>
1.89 rillig 1831: </ul></div>
1832: <p>The default is
1.128 wiz 1833: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.89 rillig 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.128 wiz 1837: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.94 dmcmahil 1838: variable should always be terminated with a value for
1839: a real compiler. Note that only one real compiler
1.128 wiz 1840: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.94 dmcmahil 1841: is not allowed).</p>
1.89 rillig 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.266 leot 1848: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225 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.89 rillig 1859: </dl></div>
1860: </div>
1.148 asau 1861: <div class="sect2">
1.89 rillig 1862: <div class="titlepage"><div><div><h3 class="title">
1.267 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.78 rillig 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">
1.100 rillig 1868: CFLAGS+= -your -flags
1.78 rillig 1869: </pre>
1870: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128 wiz 1871: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.117 jnemeth 1872: need to add their own flags. You may want to take a look
1.250 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.128 wiz 1874: package if you're interested in optimization specifically
1875: for the current CPU. </p>
1.78 rillig 1876: </div>
1.148 asau 1877: <div class="sect2">
1.88 wiz 1878: <div class="titlepage"><div><div><h3 class="title">
1.267 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.88 wiz 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">
1.100 rillig 1891: LDFLAGS+= -your -linkerflags
1.88 wiz 1892: </pre>
1893: </div>
1.78 rillig 1894: </div>
1.148 asau 1895: <div class="sect1">
1.78 rillig 1896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1897: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.194 bsiegert 1898: <p>
1.75 rillig 1899: </p>
1.148 asau 1900: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 1901: <li class="listitem">
1.75 rillig 1902: <p><code class="varname">PKG_DEVELOPER</code>:
1903: Run some sanity checks that package developers want:
1904: </p>
1.148 asau 1905: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128 wiz 1906: <li class="listitem"><p>make sure patches apply with zero
1.88 wiz 1907: fuzz</p></li>
1.128 wiz 1908: <li class="listitem"><p>run check-shlibs to see that all
1.88 wiz 1909: binaries will find their shared libs.</p></li>
1.75 rillig 1910: </ul></div>
1911: <p>
1.87 wiz 1912: </p>
1.75 rillig 1913: </li>
1.128 wiz 1914: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88 wiz 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.223 rillig 1921: as well as their actual execution progress with <span class="command"><strong>set
1922: -x</strong></span>.</p></li>
1.75 rillig 1923: </ul></div>
1924: <p>
1925: </p>
1926: </div>
1.148 asau 1927: <div class="sect1">
1.75 rillig 1928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 1929: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 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>
1.75 rillig 1933: <p>To see which options, if any, a package supports, and which
1.110 hubertf 1934: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 1935: show-options</strong></span>, for example:</p>
1.75 rillig 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.
1.1 grant 1945:
1.75 rillig 1946: These options are enabled by default: firefox
1947: These options are currently enabled: mozilla ssl
1.1 grant 1948: </pre>
1.75 rillig 1949: <p>The following variables can be defined in
1.110 hubertf 1950: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 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.128 wiz 1957: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.88 wiz 1958: are disabled. A few examples:</p>
1.75 rillig 1959: <pre class="screen">
1.110 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.75 rillig 1961: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1962: PKG_OPTIONS.kdebase= debug -sasl
1963: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 1964: <p>It is important to note that options that were specifically
1.120 snj 1965: suggested by the package maintainer must be explicitly removed if
1.111 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.88 wiz 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.128 wiz 1971: <div class="orderedlist"><ol class="orderedlist" type="1">
1972: <li class="listitem"><p>the default options as suggested by the package
1.88 wiz 1973: maintainer</p></li>
1.128 wiz 1974: <li class="listitem"><p>the options implied by the settings of legacy
1.88 wiz 1975: variables (see below)</p></li>
1.128 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.75 rillig 1978: </ol></div>
1979: <p>For groups of mutually exclusive options, the last option
1.88 wiz 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.110 hubertf 1988: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 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.110 hubertf 1993: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 1994: directly. Support for the legacy variables will be removed
1995: eventually.</p>
1.75 rillig 1996: </div>
1997: </div>
1.148 asau 1998: <div class="chapter">
1.75 rillig 1999: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2000: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75 rillig 2001: <div class="toc">
2002: <p><b>Table of Contents</b></p>
1.210 leot 2003: <dl class="toc">
1.267 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.75 rillig 2006: </dl>
2007: </div>
1.148 asau 2008: <div class="sect1">
1.75 rillig 2009: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2010: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87 wiz 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.270 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.87 wiz 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.110 hubertf 2018: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2019: package</strong></span>:</p>
2020: <pre class="screen">
1.223 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.87 wiz 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.110 hubertf 2026: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2027: it. Binary packages are created by default in
2028: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 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.250 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.267 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.87 wiz 2032: such a binary package.</p>
1.75 rillig 2033: </div>
1.148 asau 2034: <div class="sect1">
1.75 rillig 2035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.106 rillig 2038: </div>
2039: </div>
1.148 asau 2040: <div class="chapter">
1.106 rillig 2041: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2042: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106 rillig 2043: builds)</h2></div></div></div>
2044: <div class="toc">
2045: <p><b>Table of Contents</b></p>
1.210 leot 2046: <dl class="toc">
1.267 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.106 rillig 2053: </dl>
2054: </div>
1.180 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.223 rillig 2062: The bulk build system, or pbulk ("p" stands for "parallel").
2063: This chapter describes how to set it up.</p>
1.148 asau 2064: <div class="sect1">
1.106 rillig 2065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2066: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180 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.223 rillig 2074: Note that all their dependencies will be built, so you don't need to track them manually.
1.180 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.223 rillig 2079: Essentially, you should provide a fresh system, either a chroot environment
1.180 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.106 rillig 2084: certain packages tried to install files outside the
2085: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180 wiz 2086: <code class="filename">/etc</code>.
2087: </p>
1.106 rillig 2088: </div>
1.148 asau 2089: <div class="sect1">
1.106 rillig 2090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2091: <a name="bulk.pbulk"></a>8.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116 rillig 2092: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148 asau 2093: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.116 rillig 2096: </ul></div>
1.148 asau 2097: <div class="sect2">
1.116 rillig 2098: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 2099: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223 rillig 2100: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178 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.223 rillig 2103: Create a user with name "pbulk".</p>
1.178 asau 2104: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2105: <pre class="screen">
1.264 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.181 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.178 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.230 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.178 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.223 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.178 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.223 rillig 2130: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178 asau 2131: <pre class="programlisting">
2132: www/firefox
2133: mail/thunderbird
2134: misc/libreoffice4
2135: </pre>
1.179 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.178 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.106 rillig 2156: </div>
2157: </div>
1.148 asau 2158: <div class="sect1">
1.106 rillig 2159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2160: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180 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.267 rillig 2176: <a name="creating-cdroms"></a>8.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 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.250 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.87 wiz 2181: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2182: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2183: way that keeps all the dependencies for a given package on the same
2184: CD as that package.</p>
1.148 asau 2185: <div class="sect2">
1.75 rillig 2186: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 2187: <a name="cdpack-example"></a>8.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 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>
1.75 rillig 2196: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 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>
1.75 rillig 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>
1.87 wiz 2210: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2211: </pre>
1.75 rillig 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>
1.76 rillig 2214: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2215: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2216: in their root directories.</p>
1.75 rillig 2217: </div>
2218: </div>
2219: </div>
1.148 asau 2220: <div class="chapter">
1.75 rillig 2221: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2222: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 2223: <div class="toc">
2224: <p><b>Table of Contents</b></p>
1.210 leot 2225: <dl class="toc">
1.267 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.90 rillig 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>
1.91 rillig 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">
1.100 rillig 2242: LOCALBASE= /usr/pkg
2243: PKG_SYSCONFBASE= /usr/pkg/etc
2244: VARBASE= /var
1.231 sevan 2245: PKG_DBDIR= /usr/pkg/pkgdb
1.91 rillig 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">
1.100 rillig 2250: LOCALBASE= ${HOME}/pkg
2251: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2252: VARBASE= ${HOME}/pkg/var
1.231 sevan 2253: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.91 rillig 2254: </pre>
2255: <p>What these four directories are for, and what they look like is
2256: explained below.</p>
1.148 asau 2257: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 2258: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90 rillig 2259: <code class="filename">/usr</code> directory in the base system. It is the
1.128 wiz 2260: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.90 rillig 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.128 wiz 2265: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90 rillig 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.128 wiz 2269: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90 rillig 2270: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 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.90 rillig 2272: itself.</p></li>
2273: </ul></div>
1.148 asau 2274: <div class="sect1">
1.90 rillig 2275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2276: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 2277: </h2></div></div></div>
1.90 rillig 2278: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 2279: in <code class="filename">${LOCALBASE}</code>.</p>
1.148 asau 2280: <div class="variablelist"><dl class="variablelist">
1.90 rillig 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.148 asau 2340: <div class="sect1">
1.90 rillig 2341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2342: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 2343: </h2></div></div></div>
1.148 asau 2344: <div class="variablelist"><dl class="variablelist">
1.90 rillig 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.148 asau 2361: <div class="chapter">
1.90 rillig 2362: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 2363: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 2364: <div class="toc">
2365: <p><b>Table of Contents</b></p>
1.210 leot 2366: <dl class="toc">
1.267 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.128 wiz 2377: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.267 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.75 rillig 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.148 asau 2390: <div class="sect1">
1.75 rillig 2391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2392: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 2393: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148 asau 2394: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.78 rillig 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.128 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.75 rillig 2405: A list where the results of pkgsrc bulk builds are sent and
2406: discussed.</p></li>
1.128 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.75 rillig 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">
1.100 rillig 2416: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 2417: </pre>
2418: <p>Archives for all these mailing lists are available from
1.110 hubertf 2419: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 2420: </div>
1.148 asau 2421: <div class="sect1">
1.75 rillig 2422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2423: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 2424: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 2425: a number of useful utilities for both users and developers of pkgsrc. This
1.233 sevan 2426: section attempts only to make the reader aware of some of the utilities and when
1.75 rillig 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.250 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.75 rillig 2431: Symlinks for use by buildlink.</p></li></ul></div>
2432: <p>OS tool augmentation (automatically installed when needed):</p>
1.148 asau 2433: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 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.233 sevan 2435: Calculates various kinds of checksums (including SHA3).</p></li>
1.250 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.75 rillig 2437: Compatibility library for pkgsrc tools.</p></li>
1.250 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.87 wiz 2439: non-BSD systems due to lack of native mtree.</p></li>
1.250 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.75 rillig 2441: Up-to-date replacement for
1.76 rillig 2442: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 2443: systems where pkg_install is not present.</p></li>
2444: </ul></div>
2445: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148 asau 2446: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 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.75 rillig 2448: Create a binary package from an
1.110 hubertf 2449: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 2450: save the old package.</p></li>
1.250 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.75 rillig 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.250 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.117 jnemeth 2456: the best compiler flags to optimise code for your current
1.128 wiz 2457: CPU and compiler. </p></li>
1.75 rillig 2458: </ul></div>
2459: <p>Utilities for keeping track of installed packages, being up to date,
2460: etc:</p>
1.148 asau 2461: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 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.173 wiz 2463: update tool similar to apt(1). Download, install, and upgrade
2464: binary packages easily.</p></li>
1.250 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.75 rillig 2466: packages whose installed versions do not match the latest pkgsrc
2467: entries.</p></li>
1.250 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.75 rillig 2469: dependency graphs of packages, to aid in choosing a strategy for
2470: updating.</p></li>
1.250 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.112 weinem 2474: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.250 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.75 rillig 2476: does various checks on the complete pkgsrc system.</p></li>
1.250 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.75 rillig 2478: packages you have installed.</p></li>
2479: </ul></div>
2480: <p>Utilities for people maintaining or creating individual packages:</p>
1.148 asau 2481: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 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.75 rillig 2483: making and maintaining patches for a package (includes pkgdiff,
2484: pkgvi, mkpatches, etc.).</p></li>
1.250 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.75 rillig 2486: converting to pkgsrc.</p></li>
2487: </ul></div>
2488: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2489: utilities)</p>
1.148 asau 2490: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 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.75 rillig 2492: packages in a chrooted area.</p></li>
1.250 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.75 rillig 2494: kernel version for chrooted cross builds.</p></li>
2495: </ul></div>
2496: </div>
1.148 asau 2497: <div class="sect1">
1.75 rillig 2498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2499: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219 rillig 2500: <p>To install packages from source as a non-root user, download
1.267 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.219 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.75 rillig 2508: </div>
1.148 asau 2509: <div class="sect1">
1.75 rillig 2510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2511: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 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.110 hubertf 2515: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 2516: distfile is found, pkgsrc will try to resume it.</p>
2517: <p>You can also
1.168 wiz 2518: use a different program than the platform default program by changing the
1.117 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.75 rillig 2526: <p>For example, if you want to use
1.117 jnemeth 2527: <code class="filename">wget</code> to download, you'll have to use something
1.75 rillig 2528: like:</p>
2529: <pre class="programlisting">
1.223 rillig 2530: FETCH_USING= wget
1.1 grant 2531: </pre>
1.75 rillig 2532: </div>
1.148 asau 2533: <div class="sect1">
1.75 rillig 2534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.103 wiz 2536: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 2537: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 2538: you will have to add the following line into
1.110 hubertf 2539: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 2540: <pre class="programlisting">
1.103 wiz 2541: X11_TYPE=modular
1.1 grant 2542: </pre>
1.75 rillig 2543: </div>
1.148 asau 2544: <div class="sect1">
1.75 rillig 2545: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2546: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 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.128 wiz 2551: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.75 rillig 2552: port 80 as the proxy port number. So the proxy environment variables
2553: are:</p>
2554: <pre class="programlisting">
1.100 rillig 2555: ftp_proxy=ftp://orpheus.amdahl.com:80/
2556: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 2557: </pre>
1.75 rillig 2558: </div>
1.148 asau 2559: <div class="sect1">
1.75 rillig 2560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2561: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173 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.267 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.75 rillig 2577: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 2578: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 2579: the first available command from the following list:</p>
1.148 asau 2580: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 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.75 rillig 2583: </ul></div>
2584: <p>On a default NetBSD installation, this will be
1.76 rillig 2585: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 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.110 hubertf 2588: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 2589: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2590: <p>Having that option present will prevent
1.76 rillig 2591: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 2592: transfers.</p>
2593: </div>
1.148 asau 2594: <div class="sect1">
1.75 rillig 2595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2596: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 2597: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 2598: from work or university, where you can't run a <span class="command"><strong>make
1.132 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.75 rillig 2600: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 2601: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 2602: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 2603: resulting list to your machine at work/school and use it there. If you
1.270 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.75 rillig 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>
1.76 rillig 2613: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 2614: home.</p>
2615: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 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.110 hubertf 2618: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 2619: directly by running:</p>
1.75 rillig 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.148 asau 2626: <div class="sect1">
1.75 rillig 2627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.128 wiz 2629: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.250 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.75 rillig 2631: package, you get the error from make that it doesn't know how to make
1.76 rillig 2632: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128 wiz 2633: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.75 rillig 2634: the NetBSD base distribution on your machine. It is recommended to do
2635: that to format man pages.</p>
1.250 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.75 rillig 2637: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 2638: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 2639: </div>
1.148 asau 2640: <div class="sect1">
1.75 rillig 2641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.87 wiz 2643: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 2644: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 2645: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 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>
1.76 rillig 2648: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 2649: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 2650: -r</strong></span>).</p>
2651: </div>
1.148 asau 2652: <div class="sect1">
1.75 rillig 2653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2654: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 2655: <p>When installing packages as non-root user and using the just-in-time
1.270 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.75 rillig 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.250 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.110 hubertf 2661: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 2662: <span class="emphasis"><em>after</em></span> the definition of the
2663: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 2664: <pre class="programlisting">
1.100 rillig 2665: .if exists(${LOCALBASE}/bin/sudo)
2666: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2667: .endif
1.1 grant 2668: </pre>
1.75 rillig 2669: </div>
1.148 asau 2670: <div class="sect1">
1.75 rillig 2671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2672: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 2673: <p>As the system administrator, you can choose where configuration files
2674: are installed. The default settings make all these files go into
1.76 rillig 2675: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 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.110 hubertf 2681: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 2682: directory; some common examples include <code class="filename">/etc</code> or
2683: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 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.148 asau 2692: <div class="sect1">
1.75 rillig 2693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2694: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75 rillig 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.114 jmcneill 2701: do this, refer to the following two tools (installed as part of the
1.250 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.128 wiz 2703: <div class="orderedlist"><ol class="orderedlist" type="1">
2704: <li class="listitem">
1.122 reed 2705: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75 rillig 2706: download a list of the security vulnerabilities information. This list
1.132 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.75 rillig 2710: </li>
1.128 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.75 rillig 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.233 sevan 2717: <p>Use of these tools is strongly recommended!
1.267 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.233 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.75 rillig 2722: </div>
1.148 asau 2723: <div class="sect1">
1.75 rillig 2724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.75 rillig 2726: <p>When you add your own preferences to the
2727: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 2728: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 2729: environment variables to the <code class="filename">./configure</code>
1.270 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.75 rillig 2731: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 2732: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 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.110 hubertf 2736: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 2737: directory and then inspect any <code class="filename">Makefile</code> and
2738: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 2739: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128 wiz 2740: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.75 rillig 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.148 asau 2745: <div class="sect1">
1.80 rillig 2746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 2747: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.128 wiz 2748: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 2749: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80 rillig 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.148 asau 2755: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128 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.80 rillig 2758: files.</p></li>
1.148 asau 2759: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110 hubertf 2760: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 2761: verify this.</p></li>
1.218 rillig 2762: <li class="step"><p>If you are a package developer who wants to invest
1.267 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.148 asau 2764: <li class="step"><p>If the problem still exists, write a mail to the
1.80 rillig 2765: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2766: </ol></div>
2767: </div>
1.148 asau 2768: <div class="sect1">
1.88 wiz 2769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 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.89 rillig 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.110 hubertf 2778: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 2779: -dP</strong></span> in that directory to download the current version.</p>
2780: </div>
1.75 rillig 2781: </div>
2782: </div>
1.148 asau 2783: <div class="part">
1.75 rillig 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.148 asau 2786: <div class="partintro">
1.77 rillig 2787: <div></div>
2788: <p>This part of the book deals with creating and
1.128 wiz 2789: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.77 rillig 2790: guide on creating a new package. The remaining chapters are more
2791: like a reference manual for pkgsrc.</p>
1.75 rillig 2792: <div class="toc">
2793: <p><b>Table of Contents</b></p>
1.210 leot 2794: <dl class="toc">
1.267 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.91 rillig 2797: <dd><dl>
1.267 rillig 2798: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.91 rillig 2799: <dd><dl>
1.267 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.271 ! 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. TeX packages</a></span></dt>
1.91 rillig 2804: </dl></dd>
1.267 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.106 rillig 2807: </dl></dd>
1.267 rillig 2808: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.106 rillig 2809: <dd><dl>
1.267 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.106 rillig 2813: <dd><dl>
1.267 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.106 rillig 2819: </dl></dd>
1.267 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.106 rillig 2822: <dd><dl>
1.267 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.106 rillig 2826: </dl></dd>
1.267 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.106 rillig 2829: </dl></dd>
1.267 rillig 2830: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106 rillig 2831: <dd><dl>
1.267 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.106 rillig 2836: <dd><dl>
1.267 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.106 rillig 2841: </dl></dd>
2842: </dl></dd>
1.267 rillig 2843: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.106 rillig 2844: <dd><dl>
1.267 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.106 rillig 2854: </dl></dd>
1.267 rillig 2855: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.106 rillig 2856: <dd><dl>
1.267 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.106 rillig 2859: <dd><dl>
1.267 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.133 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.106 rillig 2866: </dl></dd>
1.267 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.106 rillig 2868: <dd><dl>
1.267 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.106 rillig 2871: </dl></dd>
2872: </dl></dd>
1.267 rillig 2873: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.106 rillig 2874: <dd><dl>
1.267 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.87 wiz 2995: emulation</a></span></dt>
1.267 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.77 rillig 2998: </dl></dd>
1.267 rillig 2999: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3000: </dl></dd>
1.267 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.77 rillig 3003: <dd><dl>
1.267 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.85 jmmv 3020: </dl></dd>
1.75 rillig 3021: </dl>
3022: </div>
1.77 rillig 3023: </div>
1.148 asau 3024: <div class="chapter">
1.77 rillig 3025: <div class="titlepage"><div><div><h2 class="title">
1.267 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.91 rillig 3058: <div class="toc">
3059: <p><b>Table of Contents</b></p>
1.210 leot 3060: <dl class="toc">
1.267 rillig 3061: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.91 rillig 3062: <dd><dl>
1.267 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.271 ! 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. TeX packages</a></span></dt>
1.91 rillig 3067: </dl></dd>
1.267 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.91 rillig 3070: </dl>
3071: </div>
1.77 rillig 3072: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 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.128 wiz 3076: <div class="procedure"><ol class="procedure" type="1">
1.250 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.148 asau 3078: <li class="step"><p>Then, choose one of the top-level directories as the
1.91 rillig 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.148 asau 3083: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 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.148 asau 3090: <li class="step">
1.91 rillig 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.132 spz 3098: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3099: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3100: <p>If you just need binaries from a package, add a
1.91 rillig 3101: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3102: version of the dependency and where it can be found in pkgsrc. This line
3103: should be placed in the third paragraph. If the dependency is only
3104: needed for building the package, but not when using it, use
1.269 leot 3105: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
3106: instead of <code class="varname">DEPENDS</code>.
3107: The difference between <code class="varname">TOOL_DEPENDS</code> and
3108: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
3109: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
3110: packages, i.e. packages for the architecture where the package
3111: is built;
3112: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
3113: packages, i.e. packages for the architecture for which the package
3114: is built.
1.91 rillig 3115: Your package may then look like this:</p>
1.77 rillig 3116: <pre class="programlisting">
1.100 rillig 3117: [...]
1.77 rillig 3118:
1.269 leot 3119: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100 rillig 3120: DEPENDS+= screen-[0-9]*:../../misc/screen
3121: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3122:
1.100 rillig 3123: [...]
1.77 rillig 3124:
1.100 rillig 3125: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3126: .include "../../devel/glib2/buildlink3.mk"
3127: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3128: </pre>
3129: </li>
1.148 asau 3130: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128 wiz 3131: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.110 hubertf 3132: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3133: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3134: -e</strong></span>, which outputs additional
3135: explanations.</p></li>
1.148 asau 3136: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.267 rillig 3137: 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.91 rillig 3138: over there, you can hopefully continue here.</p></li>
1.148 asau 3139: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3140: directory from the extracted files. Besides these files, a lot of cache
3141: files and other system information has been saved in the working
3142: directory, which may become wrong after you edited the
3143: <code class="filename">Makefile</code>.</p></li>
1.148 asau 3144: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.267 rillig 3145: 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.148 asau 3146: <li class="step"><p>When the package builds fine, the next step is to install
1.110 hubertf 3147: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3148: everything works.</p></li>
1.148 asau 3149: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91 rillig 3150: contains a list of the files that are installed by the package, is
1.110 hubertf 3151: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3152: >PLIST</strong></span> to generate a probably correct list. Check
3153: the file using your preferred text editor to see if the list of
3154: files looks plausible.</p></li>
1.148 asau 3155: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3156: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148 asau 3157: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3158: has been registered in the database of installed files, but with an
1.110 hubertf 3159: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3160: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3161: registered with the list of files from
3162: <code class="filename">PLIST</code>.</p></li>
1.148 asau 3163: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3164: package from the set of installed files.</p></li>
1.77 rillig 3165: </ol></div>
1.148 asau 3166: <div class="sect1">
1.91 rillig 3167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3168: <a name="creating.common"></a>12.1. Common types of packages</h2></div></div></div>
1.148 asau 3169: <div class="sect2">
1.91 rillig 3170: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 3171: <a name="creating.perl-module"></a>12.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3172: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3173: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3174: </div>
1.148 asau 3175: <div class="sect2">
1.91 rillig 3176: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 3177: <a name="creating.python-module"></a>12.1.2. Python modules and programs</h3></div></div></div>
1.118 imil 3178: <p>Python modules and programs packages are easily created using a
3179: set of predefined variables.</p>
3180: <p>
1.171 wiz 3181: If some Python versions are not supported by the software, set the
3182: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3183: that are not supported, e.g.
1.118 imil 3184: </p>
3185: <pre class="programlisting">
1.203 sevan 3186: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.118 imil 3187: </pre>
3188: <p>
1.213 wiz 3189: If the packaged software is a Python module, include one of
3190: <code class="filename">../../lang/python/egg.mk</code>,
3191: <code class="filename">../../lang/python/distutils.mk</code>, or
3192: <code class="filename">../../lang/python/extension.mk</code>.</p>
3193: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3194: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
3195: if the packaged software is using setuptools, you only need
3196: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3197: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
3198: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
3199: so pkgsrc will use this framework.
3200: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3201: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3202: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3203: to the name of the script.</p>
3204: <p>Either way, the package directory should be called
1.128 wiz 3205: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3206: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.118 imil 3207: </p>
3208: <pre class="programlisting">
3209: DISTNAME= foopymodule-1.2.10
3210: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3211: </pre>
1.171 wiz 3212: <p>If it is an application, include
3213: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3214: In order to correctly set the path to the Python interpreter, use the
1.118 imil 3215: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142 wiz 3216: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171 wiz 3217: For example:
1.118 imil 3218: </p>
3219: <pre class="programlisting">
1.142 wiz 3220: REPLACE_PYTHON= *.py
1.118 imil 3221: </pre>
1.171 wiz 3222: <p>Some Python modules have separate distributions for Python-2.x
3223: and Python-3.x support. In pkgsrc this is handled by the
3224: <code class="filename">versioned_dependencies.mk</code> file. Set
3225: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3226: packages that should be depended upon and include
3227: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3228: then the pkgsrc infrastructure will depend on the appropriate package
3229: version. For example:
3230: </p>
3231: <pre class="programlisting">
1.248 wiz 3232: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.171 wiz 3233: </pre>
3234: <p>
3235: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3236: of supported packages.</p>
1.118 imil 3237: </div>
1.271 ! brook 3238: <div class="sect2">
! 3239: <div class="titlepage"><div><div><h3 class="title">
! 3240: <a name="creating.R-package"></a>12.1.3. R packages</h3></div></div></div>
! 3241: <p>Simple R packages from CRAN are handled automatically by
! 3242: <span class="command"><strong>R2pkg</strong></span>, including dependencies.</p>
! 3243: </div>
! 3244: <div class="sect2">
! 3245: <div class="titlepage"><div><div><h3 class="title">
! 3246: <a name="creating.TeX-package"></a>12.1.4. TeX packages</h3></div></div></div>
! 3247: <p>TeX and LaTeX packages from CTAN are handled automatically by
! 3248: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
! 3249: </div>
1.91 rillig 3250: </div>
1.148 asau 3251: <div class="sect1">
1.91 rillig 3252: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3253: <a name="creating.examples"></a>12.2. Examples</h2></div></div></div>
1.148 asau 3254: <div class="sect2">
1.91 rillig 3255: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 3256: <a name="creating.nvu"></a>12.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148 asau 3257: <div class="sect3">
1.91 rillig 3258: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 3259: <a name="creating.nvu.init"></a>12.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3260: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128 wiz 3261: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.91 rillig 3262: pkgsrc. As the description says it has to do with the web, the obvious
1.128 wiz 3263: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.91 rillig 3264: <pre class="programlisting">
1.100 rillig 3265: <code class="prompt">$</code> mkdir www/nvu
3266: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3267: </pre>
3268: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3269: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 3270: <pre class="programlisting">
1.100 rillig 3271: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 3272: </pre>
3273: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3274: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128 wiz 3275: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.91 rillig 3276: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3277: <code class="varname">COMMENT</code> fields. Then the package
3278: <code class="filename">Makefile</code> looked like that:</p>
3279: <pre class="programlisting">
1.233 sevan 3280: # $NetBSD $
1.100 rillig 3281: #
1.91 rillig 3282:
1.100 rillig 3283: DISTNAME= nvu-1.0-sources
3284: PKGNAME= nvu-1.0
3285: CATEGORIES= www
3286: MASTER_SITES= http://cvs.nvu.com/download/
3287: EXTRACT_SUFX= .tar.bz2
3288:
3289: MAINTAINER= rillig@NetBSD.org
3290: HOMEPAGE= http://cvs.nvu.com/
3291: COMMENT= Web Authoring System
1.91 rillig 3292:
1.100 rillig 3293: # url2pkg-marker (please do not remove this line.)
3294: .include "../../mk/bsd.pkg.mk"
1.91 rillig 3295: </pre>
1.237 wiz 3296: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.233 sevan 3297: this is a workaround to prevent CVS expanding to the filename of the
3298: guide.</p>
1.91 rillig 3299: <p>Then, I quit the editor and watched pkgsrc downloading a large
3300: source archive:</p>
3301: <pre class="programlisting">
1.100 rillig 3302: url2pkg> Running "make makesum" ...
3303: => Required installed package digest>=20010302: digest-20060826 found
3304: => Fetching nvu-1.0-sources.tar.bz2
3305: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3306: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3307: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3308: url2pkg> Running "make extract" ...
3309: => Required installed package digest>=20010302: digest-20060826 found
3310: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3311: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3312: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3313: ===> Installing dependencies for nvu-1.0
3314: ===> Overriding tools for nvu-1.0
3315: ===> Extracting for nvu-1.0
3316: url2pkg> Adjusting the Makefile.
1.91 rillig 3317:
1.100 rillig 3318: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 3319:
1.100 rillig 3320: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 3321: </pre>
3322: </div>
1.148 asau 3323: <div class="sect3">
1.91 rillig 3324: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 3325: <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.91 rillig 3326: <p>Now that the package has been extracted, let's see what's inside
3327: it. The package has a <code class="filename">README.txt</code>, but that only
3328: says something about mozilla, so it's probably useless for seeing what
3329: dependencies this package has. But since there is a GNU configure script
3330: in the package, let's hope that it will complain about everything it
3331: needs.</p>
3332: <pre class="programlisting">
1.100 rillig 3333: <code class="prompt">$</code> bmake
3334: => Required installed package digest>=20010302: digest-20060826 found
3335: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3336: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3337: ===> Patching for nvu-1.0
3338: ===> Creating toolchain wrappers for nvu-1.0
3339: ===> Configuring for nvu-1.0
3340: [...]
3341: configure: error: Perl 5.004 or higher is required.
3342: [...]
3343: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3344: [...]
1.91 rillig 3345: </pre>
3346: <p>That worked quite well. So I opened the package Makefile in my
3347: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128 wiz 3348: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.91 rillig 3349: package have changed now, and since a perl wrapper is automatically
1.128 wiz 3350: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.91 rillig 3351: from scratch.</p>
3352: <pre class="programlisting">
1.100 rillig 3353: <code class="prompt">$</code> bmake clean
3354: ===> Cleaning for nvu-1.0
3355: <code class="prompt">$</code> bmake
3356: [...]
3357: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3358: GNU Make. You will not be able to build Mozilla without GNU Make.
3359: [...]
1.91 rillig 3360: </pre>
1.128 wiz 3361: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.91 rillig 3362: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3363: <pre class="programlisting">
1.100 rillig 3364: [...]
3365: checking for GTK - version >= 1.2.0... no
3366: *** Could not run GTK test program, checking why...
3367: [...]
1.91 rillig 3368: </pre>
3369: <p>Now to the other dependencies. The first question is: Where is the
3370: GTK package hidden in pkgsrc?</p>
3371: <pre class="programlisting">
1.100 rillig 3372: <code class="prompt">$</code> echo ../../*/gtk*
3373: [many packages ...]
3374: <code class="prompt">$</code> echo ../../*/gtk
3375: ../../x11/gtk
3376: <code class="prompt">$</code> echo ../../*/gtk2
3377: ../../x11/gtk2
3378: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3379: ../../x11/gtk2/buildlink3.mk
1.91 rillig 3380: </pre>
3381: <p>The first try was definitely too broad. The second one had exactly
3382: one result, which is very good. But there is one pitfall with GNOME
3383: packages. Before GNOME 2 had been released, there were already many
3384: GNOME 1 packages in pkgsrc. To be able to continue to use these
3385: packages, the GNOME 2 packages were imported as separate packages, and
1.128 wiz 3386: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.91 rillig 3387: whether this was the case here, and indeed it was.</p>
3388: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3389: file, adding the dependency is very easy. I just inserted an
3390: <code class="literal">.include</code> line before the last line of the package
3391: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3392: <pre class="programlisting">
1.100 rillig 3393: [...]
3394: .include "../../x11/gtk2/buildlink3.mk"
3395: .include "../../mk/bsd.pkg.mk
1.91 rillig 3396: </pre>
1.110 hubertf 3397: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 3398: was:</p>
3399: <pre class="programlisting">
1.100 rillig 3400: [...]
3401: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3402: checking for GTK - version >= 1.2.0... no
3403: *** Could not run GTK test program, checking why...
3404: *** The test program failed to compile or link. See the file config.log for the
3405: *** exact error that occured. This usually means GTK was incorrectly installed
3406: *** or that you have moved GTK since it was installed. In the latter case, you
3407: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3408: configure: error: Test for GTK failed.
3409: [...]
1.91 rillig 3410: </pre>
1.128 wiz 3411: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3412: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.91 rillig 3413: told me that this package really wanted to have the GNOME 1 version of
3414: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 3415: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 3416: So I changed the <code class="literal">x11/gtk2</code> to
3417: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3418: and tried again.</p>
3419: <pre class="programlisting">
1.100 rillig 3420: [...]
1.166 jnemeth 3421: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.100 rillig 3422: In file included from xpidl.c:42:
3423: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3424: In file included from xpidl.c:42:
3425: xpidl.h:132: error: parse error before "IDL_ns"
3426: [...]
1.91 rillig 3427: </pre>
3428: <p>The package still does not find all of its dependencies. Now the
3429: question is: Which package provides the
3430: <code class="filename">libIDL/IDL.h</code> header file?</p>
3431: <pre class="programlisting">
1.100 rillig 3432: <code class="prompt">$</code> echo ../../*/*idl*
3433: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3434: <code class="prompt">$</code> echo ../../*/*IDL*
3435: ../../net/libIDL
1.91 rillig 3436: </pre>
3437: <p>Let's take the one from the second try. So I included the
3438: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3439: again. But the error didn't change. After digging through some of the
3440: code, I concluded that the build process of the package was broken and
3441: couldn't have ever worked, but since the Mozilla source tree is quite
3442: large, I didn't want to fix it. So I added the following to the package
3443: <code class="filename">Makefile</code> and tried again:</p>
3444: <pre class="programlisting">
1.100 rillig 3445: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.252 leot 3446: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.91 rillig 3447: </pre>
3448: <p>The latter line is needed because the package expects the library
3449: <code class="filename">libIDL.so</code>, but only
3450: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3451: wrapper to rewrite that on the fly.</p>
3452: <p>The next problem was related to a recent change of the FreeType
1.250 leot 3453: 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.91 rillig 3454: which patch files were relevant for this issue and copied them to the
3455: <code class="filename">patches</code> directory. Then I retried, fixed the
3456: patches so that they applied cleanly and retried again. This time,
3457: everything worked.</p>
3458: </div>
1.148 asau 3459: <div class="sect3">
1.91 rillig 3460: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 3461: <a name="creating.nvu.inst"></a>12.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 3462: <pre class="programlisting">
1.100 rillig 3463: <code class="prompt">$</code> bmake CHECK_FILES=no install
3464: [...]
3465: <code class="prompt">$</code> bmake print-PLIST >PLIST
3466: <code class="prompt">$</code> bmake deinstall
3467: <code class="prompt">$</code> bmake install
1.91 rillig 3468: </pre>
3469: </div>
3470: </div>
3471: </div>
1.77 rillig 3472: </div>
1.148 asau 3473: <div class="chapter">
1.75 rillig 3474: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 3475: <a name="components"></a>Chapter 13. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 3476: <div class="toc">
3477: <p><b>Table of Contents</b></p>
1.210 leot 3478: <dl class="toc">
1.267 rillig 3479: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
3480: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
3481: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
3482: <dd><dl>
3483: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
3484: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
3485: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
3486: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
3487: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
3488: </dl></dd>
3489: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
3490: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
3491: <dd><dl>
3492: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
3493: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
3494: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 3495: </dl></dd>
1.267 rillig 3496: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
3497: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 3498: </dl>
3499: </div>
1.87 wiz 3500: <p>Whenever you're preparing a package, there are a number of
3501: files involved which are described in the following
3502: sections.</p>
1.148 asau 3503: <div class="sect1">
1.75 rillig 3504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3505: <a name="components.Makefile"></a>13.1. <code class="filename">Makefile</code>
1.93 rillig 3506: </h2></div></div></div>
1.75 rillig 3507: <p>Building, installation and creation of a binary package are all
1.87 wiz 3508: controlled by the package's <code class="filename">Makefile</code>.
3509: The <code class="filename">Makefile</code> describes various things about
3510: a package, for example from where to get it, how to configure,
3511: build, and install it.</p>
1.76 rillig 3512: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 3513: sections that describe the package.</p>
1.75 rillig 3514: <p>In the first section there are the following variables, which
1.87 wiz 3515: should appear exactly in the order given here. The order and
3516: grouping of the variables is mostly historical and has no further
3517: meaning.</p>
1.148 asau 3518: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3519: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 3520: distribution file to be downloaded from the package's
3521: website.</p></li>
1.128 wiz 3522: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174 asau 3523: package, as used by pkgsrc. You need to provide it if
1.87 wiz 3524: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174 asau 3525: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3526: provided (no distribution file is required). Usually it is the pkgsrc
1.87 wiz 3527: directory name together with the version number. It must match the
3528: regular expression
3529: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3530: starts with a letter or digit, and contains only letters, digits,
3531: dashes, underscores, dots and plus signs.</p></li>
1.128 wiz 3532: <li class="listitem">
1.75 rillig 3533: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 3534: which the package fits in. You can choose any of the top-level
3535: directories of pkgsrc for it.</p>
1.75 rillig 3536: <p>Currently the following values are available for
1.87 wiz 3537: <code class="varname">CATEGORIES</code>. If more than
3538: one is used, they need to be separated by spaces:</p>
1.75 rillig 3539: <pre class="programlisting">
1.100 rillig 3540: archivers cross geography meta-pkgs security
3541: audio databases graphics misc shells
3542: benchmarks devel ham multimedia sysutils
3543: biology editors inputmethod net textproc
3544: cad emulators lang news time
3545: chat finance mail parallel wm
3546: comms fonts math pkgtools www
3547: converters games mbone print x11
3548: </pre>
1.75 rillig 3549: </li>
1.128 wiz 3550: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 3551: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3552: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3553: and <code class="varname">DISTFILES</code> are discussed in detail in
1.267 rillig 3554: <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.75 rillig 3555: </ul></div>
3556: <p>The second section contains information about separately
1.87 wiz 3557: downloaded patches, if any.
3558: </p>
1.148 asau 3559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190 wiz 3560: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87 wiz 3561: Name(s) of additional files that contain distribution patches.
3562: There is no default. pkgsrc will look for them at
3563: <code class="varname">PATCH_SITES</code>.
3564: They will automatically be uncompressed before patching if
3565: the names end with <code class="filename">.gz</code> or
3566: <code class="filename">.Z</code>.</p></li>
1.128 wiz 3567: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 3568: Primary location(s) for distribution patch files (see
1.190 wiz 3569: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3570: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.270 leot 3571: 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.190 wiz 3572: help find the correct files to patch. It defaults to
3573: <span class="command"><strong>-p0</strong></span>.</p></li>
1.75 rillig 3574: </ul></div>
3575: <p>The third section contains the following variables.
1.87 wiz 3576: </p>
1.148 asau 3577: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3578: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114 jmcneill 3579: address of the person who feels responsible for this package,
3580: and who is most likely to look at problems or questions regarding
1.270 leot 3581: 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.114 jmcneill 3582: Other developers may contact the <code class="varname">MAINTAINER</code>
3583: before making changes to the package, but are not required to
3584: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3585: to yourself. If you really can't maintain the package for future
3586: updates, set it to
1.110 hubertf 3587: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.128 wiz 3588: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114 jmcneill 3589: of <code class="varname">MAINTAINER</code> when you do not want other
3590: developers to update or change the package without contacting
3591: you first. A package Makefile should contain one of
3592: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3593: not both. </p></li>
1.128 wiz 3594: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 3595: find more information about the package.</p></li>
1.128 wiz 3596: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 3597: description of the package (should not include the package
3598: name).</p></li>
1.234 leot 3599: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.267 rillig 3600: 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.75 rillig 3601: </ul></div>
3602: <p>Other variables that affect the build:
1.87 wiz 3603: </p>
1.148 asau 3604: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75 rillig 3605: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 3606: interesting distribution files of the package are found. The
3607: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3608: works for most packages.</p>
1.75 rillig 3609: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 3610: (most GNU software does, for instance), but extracts itself in
3611: the current directory, you should set
3612: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3613: <p>If a package doesn't create a subdirectory with the
3614: name of <code class="varname">DISTNAME</code> but some different name,
3615: set <code class="varname">WRKSRC</code> to point to the proper name in
3616: <code class="filename">${WRKDIR}</code>, for example
3617: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.250 leot 3618: <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.75 rillig 3619: <p>The name of the working directory created by pkgsrc is
1.87 wiz 3620: taken from the <code class="varname">WRKDIR_BASENAME</code>
3621: variable. By default, its value is
3622: <code class="filename">work</code>. If you want to use the same
3623: pkgsrc tree for building different kinds of binary packages,
3624: you can change the variable according to your needs. Two
3625: other variables handle common cases of setting
3626: <code class="varname">WRKDIR_BASENAME</code> individually. If
3627: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 3628: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 3629: the host's name is attached to the directory name. If
3630: <code class="varname">OBJMACHINE</code> is defined, the platform name
3631: is attached, which might look like
3632: <code class="filename">work.i386</code> or
3633: <code class="filename">work.sparc</code>.</p>
1.75 rillig 3634: </li></ul></div>
3635: <p>Please pay attention to the following gotchas:</p>
1.148 asau 3636: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3637: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 3638: installed in compressed form by the package. For packages using
3639: BSD-style makefiles which honor MANZ, there is
3640: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128 wiz 3641: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3642: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.88 wiz 3643: below).</p></li>
1.267 rillig 3644: <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.75 rillig 3645: </ul></div>
3646: </div>
1.148 asau 3647: <div class="sect1">
1.75 rillig 3648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3649: <a name="components.distinfo"></a>13.2. <code class="filename">distinfo</code>
1.93 rillig 3650: </h2></div></div></div>
1.76 rillig 3651: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 3652: digest, or checksum, of each distfile needed for the package. This
3653: ensures that the distfiles retrieved from the Internet have not been
3654: corrupted during transfer or altered by a malign force to introduce
1.219 rillig 3655: a security hole. To provide maximum security, all distfiles are
3656: protected using three different message digest algorithms (SHA1,
3657: RMD160, SHA512), as well as the file size.</p>
1.76 rillig 3658: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 3659: checksums for all the patches found in the
1.267 rillig 3660: <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.258 leot 3661: are only applied intentionally and that they don't accidentally change,
3662: e.g. when merging different changes together. They also make sure that
3663: new patches are actually added to CVS and old ones are removed.
3664: Too see whether the patches and the <code class="filename">distinfo</code> file
3665: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
1.76 rillig 3666: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.219 rillig 3667: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.75 rillig 3668: <p>Some packages have different sets of distfiles depending on
1.250 leot 3669: 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.87 wiz 3670: <code class="filename">distinfo</code> file and care should be taken when
3671: upgrading such a package to ensure distfile information is not
3672: lost.</p>
1.75 rillig 3673: </div>
1.148 asau 3674: <div class="sect1">
1.75 rillig 3675: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3676: <a name="components.patches"></a>13.3. <code class="filename">patches/*</code>
1.219 rillig 3677: </h2></div></div></div>
3678: <p>Some packages don't work out-of-the box on the various
3679: platforms that are supported by pkgsrc. These packages need
3680: to be patched to make them work. The patch files can be
1.93 rillig 3681: found in the <code class="filename">patches/</code> directory.</p>
3682: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3683: applied to the files in <code class="varname">WRKSRC</code> directory after
1.219 rillig 3684: extracting them, in alphabetic order.</p>
1.148 asau 3685: <div class="sect2">
1.93 rillig 3686: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 3687: <a name="components.patch.structure"></a>13.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 3688: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 3689: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 3690: problems. (To force patches to apply with fuzz you can set
3691: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 3692: should contain only changes for a single file, and no file should be
1.93 rillig 3693: patched by more than one patch file. This helps to keep future
3694: modifications simple.</p>
3695: <p>Each patch file is structured as follows: In the first line,
3696: there is the RCS Id of the patch itself. The second line should be
3697: empty for aesthetic reasons. After that, there should be a comment for
3698: each change that the patch does. There are a number of standard
3699: cases:</p>
1.148 asau 3700: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 3701: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93 rillig 3702: mention the vulnerability ID (CAN, CVE).</p></li>
1.128 wiz 3703: <li class="listitem"><p>Patches that change source code should mention the
1.93 rillig 3704: platform and other environment (for example, the compiler) that the
3705: patch is needed for.</p></li>
3706: </ul></div>
1.219 rillig 3707: <p>The patch should be commented so that any
1.93 rillig 3708: developer who knows the code of the application can make some use of
3709: the patch. Special care should be taken for the upstream developers,
3710: since we generally want that they accept our patches, so we have less
3711: work in the future.</p>
3712: </div>
1.148 asau 3713: <div class="sect2">
1.93 rillig 3714: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 3715: <a name="components.patches.caveats"></a>13.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 3716: <p>One important thing to mention is to pay attention that no RCS
3717: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 3718: later checked into the NetBSD CVS tree. Use the
1.250 leot 3719: <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.93 rillig 3720: problems.</p>
1.87 wiz 3721: <p>For even more automation, we recommend using
1.110 hubertf 3722: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 3723: whole set of patches. You just have to backup files before you
3724: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 3725: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3726: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 3727: you upgrade a package this way, you can easily compare the new
3728: set of patches with the previously existing one with
1.130 wiz 3729: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3730: are replaced by new files, so carefully check if you want to take all
3731: the changes.</p>
1.87 wiz 3732: <p>When you have finished a package, remember to generate
1.110 hubertf 3733: the checksums for the patch files by using the <span class="command"><strong>make
1.267 rillig 3734: 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.87 wiz 3735: <p>When adding a patch that corrects a problem in the
3736: distfile (rather than e.g. enforcing pkgsrc's view of where
3737: man pages should go), send the patch as a bug report to the
3738: maintainer. This benefits non-pkgsrc users of the package,
3739: and usually makes it possible to remove the patch in future
3740: version.</p>
1.101 rillig 3741: <p>The file names of the patch files are usually of the form
1.130 wiz 3742: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3743: Many packages still use the previous convention
3744: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3745: but new patches should be of the form containing the filename.
1.250 leot 3746: <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.130 wiz 3747: automatically.</p>
1.93 rillig 3748: </div>
1.148 asau 3749: <div class="sect2">
1.93 rillig 3750: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 3751: <a name="components.patches.sources"></a>13.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 3752: <p>If you want to share patches between multiple packages
3753: in pkgsrc, e.g. because they use the same distfiles, set
3754: <code class="varname">PATCHDIR</code> to the path where the patch files
3755: can be found, e.g.:</p>
3756: <pre class="programlisting">
1.100 rillig 3757: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 3758: </pre>
1.75 rillig 3759: <p>Patch files that are distributed by the author or other
1.87 wiz 3760: maintainers can be listed in
3761: <code class="varname">PATCHFILES</code>.</p>
3762: <p>If it is desired to store any patches that should not be
3763: committed into pkgsrc, they can be kept outside the pkgsrc
3764: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3765: directory tree there is expected to have the same
1.128 wiz 3766: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.87 wiz 3767: patches are expected to be stored inside these dirs (also
3768: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3769: example, if you want to keep a private patch for
3770: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3771: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3772: files in the named directory are expected to be patch files,
3773: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3774: applied</em></span>.</p>
1.93 rillig 3775: </div>
1.148 asau 3776: <div class="sect2">
1.85 jmmv 3777: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 3778: <a name="components.patches.guidelines"></a>13.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 3779: <p>When fixing a portability issue in the code do not use
3780: preprocessor magic to check for the current operating system nor
3781: platform. Doing so hurts portability to other platforms because
3782: the OS-specific details are not abstracted appropriately.</p>
3783: <p>The general rule to follow is: instead of checking for the
3784: operating system the application is being built on, check for the
3785: specific <span class="emphasis"><em>features</em></span> you need. For example,
3786: instead of assuming that kqueue is available under NetBSD and
3787: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126 jakllsch 3788: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 3789: yes, this generally involves patching the
1.110 hubertf 3790: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 3791: that prevents some OSes from adopting interfaces from other OSes
3792: (e.g. Linux implementing kqueue), something that the above checks
3793: cannot take into account.</p>
3794: <p>Of course, checking for features generally involves more
3795: work on the developer's side, but the resulting changes are
1.87 wiz 3796: cleaner and there are chances they will work on many other
1.85 jmmv 3797: platforms. Not to mention that there are higher chances of being
3798: later integrated into the mainstream sources. Remember:
3799: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3800: <p>Some typical examples:</p>
3801: <div class="table">
1.267 rillig 3802: <a name="patch-examples"></a><p class="title"><b>Table 13.1. Patching examples</b></p>
1.216 tnn 3803: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.85 jmmv 3804: <colgroup>
3805: <col>
3806: <col>
3807: <col>
3808: </colgroup>
3809: <thead><tr>
3810: <th>Where</th>
3811: <th>Incorrect</th>
3812: <th>Correct</th>
3813: </tr></thead>
3814: <tbody>
3815: <tr>
3816: <td>configure script</td>
3817: <td>
1.100 rillig 3818: <pre class="programlisting">
3819: case ${target_os} in
3820: netbsd*) have_kvm=yes ;;
3821: *) have_kvm=no ;;
3822: esac
3823: </pre>
1.85 jmmv 3824: </td>
3825: <td>
1.100 rillig 3826: <pre class="programlisting">
3827: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
3828: </pre>
1.85 jmmv 3829: </td>
3830: </tr>
3831: <tr>
3832: <td>C source file</td>
3833: <td>
1.100 rillig 3834: <pre class="programlisting">
3835: #if defined(__NetBSD__)
3836: # include <sys/event.h>
3837: #endif
3838: </pre>
1.85 jmmv 3839: </td>
3840: <td>
1.100 rillig 3841: <pre class="programlisting">
3842: #if defined(HAVE_SYS_EVENT_H)
3843: # include <sys/event.h>
3844: #endif
3845: </pre>
1.85 jmmv 3846: </td>
3847: </tr>
3848: <tr>
3849: <td>C source file</td>
3850: <td>
1.100 rillig 3851: <pre class="programlisting">
3852: int
3853: monitor_file(...)
3854: {
3855: #if defined(__NetBSD__)
3856: int fd = kqueue();
3857: ...
3858: #else
3859: ...
3860: #endif
3861: }
3862: </pre>
1.85 jmmv 3863: </td>
3864: <td>
1.100 rillig 3865: <pre class="programlisting">
3866: int
3867: monitor_file(...)
3868: {
3869: #if defined(HAVE_KQUEUE)
3870: int fd = kqueue();
3871: ...
3872: #else
1.223 rillig 3873: ...
1.100 rillig 3874: #endif
3875: }
3876: </pre>
1.85 jmmv 3877: </td>
3878: </tr>
3879: </tbody>
1.91 rillig 3880: </table></div>
1.85 jmmv 3881: </div>
1.254 maya 3882: <br class="table-break">
1.85 jmmv 3883: </div>
1.148 asau 3884: <div class="sect2">
1.85 jmmv 3885: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 3886: <a name="components.patches.feedback"></a>13.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 3887: <p>Always, always, <span class="strong"><strong>always</strong></span>
3888: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3889: improvements you do to a package to the mainstream developers.
3890: This is the only way to get their attention on portability issues
3891: and to ensure that future versions can be built out-of-the box on
3892: NetBSD. Furthermore, any user that gets newer distfiles will get
3893: the fixes straight from the packaged code.</p>
1.93 rillig 3894: <p>This generally involves cleaning up the patches
3895: (because sometimes the patches that are
1.147 wiz 3896: added to pkgsrc are quick hacks), filing bug reports in the
1.85 jmmv 3897: appropriate trackers for the projects and working with the
3898: mainstream authors to accept your changes. It is
3899: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3900: the packages in pkgsrc are kept simple and thus further changes
3901: can be done without much hassle.</p>
1.130 wiz 3902: <p>When you have done this, please add a URL to the upstream
3903: bug report to the patch comment.</p>
1.85 jmmv 3904: <p>Support the idea of free software!</p>
3905: </div>
1.75 rillig 3906: </div>
1.148 asau 3907: <div class="sect1">
1.75 rillig 3908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3909: <a name="other-mandatory-files"></a>13.4. Other mandatory files</h2></div></div></div>
1.148 asau 3910: <div class="variablelist"><dl class="variablelist">
1.76 rillig 3911: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 3912: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 3913: any credits where they are due. Please bear in mind that others do not
3914: share your sense of humour (or spelling idiosyncrasies), and that others
3915: will read everything that you write here.</p></dd>
1.76 rillig 3916: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 3917: <dd><p>This file governs the files that are installed on your
3918: system: all the binaries, manual pages, etc. There are other
3919: directives which may be entered in this file, to control the
3920: creation and deletion of directories, and the location of
1.267 rillig 3921: inserted files. See <a class="xref" href="#plist" title="Chapter 15. PLIST issues">Chapter 15, <i>PLIST issues</i></a> for more
1.87 wiz 3922: information.</p></dd>
1.75 rillig 3923: </dl></div>
3924: </div>
1.148 asau 3925: <div class="sect1">
1.75 rillig 3926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 3927: <a name="components.optional"></a>13.5. Optional files</h2></div></div></div>
1.148 asau 3928: <div class="sect2">
1.78 rillig 3929: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 3930: <a name="components.optional.bin"></a>13.5.1. Files affecting the binary package</h3></div></div></div>
1.148 asau 3931: <div class="variablelist"><dl class="variablelist">
1.76 rillig 3932: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135 wiz 3933: <dd>
1.270 leot 3934: <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.87 wiz 3935: First time after package extraction and before files are
3936: moved in place, the second time after the files to install
3937: are moved in place. This can be used to do any custom
3938: procedures not possible with @exec commands in
1.270 leot 3939: <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
3940: <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.135 wiz 3941: Please note that you can modify variables in it easily by using
3942: <code class="varname">FILES_SUBST</code> in the package's
3943: <code class="filename">Makefile</code>:</p>
3944: <pre class="programlisting">
3945: FILES_SUBST+= SOMEVAR="somevalue"
3946: </pre>
3947: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3948: <code class="filename">INSTALL</code>. By default, substitution is
3949: performed for <code class="varname">PREFIX</code>,
3950: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3951: <code class="varname">VARBASE</code>, and a few others, type
3952: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3953: complete list.</p>
3954: </dd>
1.76 rillig 3955: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 3956: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 3957: this script's responsibility to clean up any additional messy details
3958: around the package's installation, since all pkg_delete knows is how to
3959: delete the files created in the original distribution.
1.270 leot 3960: 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>
3961: 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.135 wiz 3962: The same methods to replace variables can be used as for
3963: the <code class="filename">INSTALL</code> file.</p></dd>
1.76 rillig 3964: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 3965: <dd>
3966: <p>This file is displayed after installation of the package.
1.87 wiz 3967: Useful for things like legal notices on almost-free
3968: software and hints for updating config files after
3969: installing modules for apache, PHP etc.
3970: Please note that you can modify variables in it easily by using
3971: <code class="varname">MESSAGE_SUBST</code> in the package's
3972: <code class="filename">Makefile</code>:</p>
1.75 rillig 3973: <pre class="programlisting">
1.100 rillig 3974: MESSAGE_SUBST+= SOMEVAR="somevalue"
3975: </pre>
1.128 wiz 3976: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.87 wiz 3977: <code class="filename">MESSAGE</code>. By default, substitution is
3978: performed for <code class="varname">PKGNAME</code>,
3979: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.209 sevan 3980: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.87 wiz 3981: <code class="varname">PKG_SYSCONFDIR</code>,
3982: <code class="varname">ROOT_GROUP</code>, and
1.117 jnemeth 3983: <code class="varname">ROOT_USER</code>.</p>
1.87 wiz 3984: <p>You can display a different or additional files by
3985: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
3986: default is <code class="filename">MESSAGE</code>, if the file
3987: exists.</p>
1.75 rillig 3988: </dd>
1.78 rillig 3989: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174 asau 3990: <dd>
3991: <p>This file is used by the alternatives framework.
3992: It creates, configures, and destroys generic wrappers used to
3993: run programs with similar interfaces.
3994: See pkg_alternatives(8) from pkgtools/pkg_alternatives
3995: for more information.</p>
3996: <p>Each line of the file contains two filenames, first
3997: the wrapper and then the alternative provided by the package.
3998: Both paths are relative to <code class="varname">PREFIX</code>.</p>
3999: </dd>
1.78 rillig 4000: </dl></div>
4001: </div>
1.148 asau 4002: <div class="sect2">
1.78 rillig 4003: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 4004: <a name="components.optional.build"></a>13.5.2. Files affecting the build process</h3></div></div></div>
1.148 asau 4005: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4006: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4007: <dd><p>This file contains arbitrary things that could
4008: also go into a <code class="filename">Makefile</code>, but its purpose is
4009: to be used by more than one package. This file should only be
4010: used when the packages that will use the file are known in
4011: advance. For other purposes it is often better to write a
4012: <code class="filename">*.mk</code> file and give it a good name that
4013: describes what it does.</p></dd>
4014: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4015: <dd><p>This file contains the dependency information
1.267 rillig 4016: 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.78 rillig 4017: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4018: <dd><p>This file contains workarounds for compiler bugs
4019: and similar things. It is included automatically by the pkgsrc
4020: infrastructure, so you don't need an extra
4021: <code class="literal">.include</code> line for
4022: it.</p></dd>
4023: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4024: <dd><p>This file contains the code for the
1.267 rillig 4025: 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.78 rillig 4026: selected by the user. If a package has only one or two options,
4027: it is equally acceptable to put the code directly into the
4028: <code class="filename">Makefile</code>.</p></dd>
4029: </dl></div>
4030: </div>
1.148 asau 4031: <div class="sect2">
1.78 rillig 4032: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 4033: <a name="components.optional.none"></a>13.5.3. Files affecting nothing at all</h3></div></div></div>
1.148 asau 4034: <div class="variablelist"><dl class="variablelist">
1.78 rillig 4035: <dt><span class="term"><code class="filename">README*</code></span></dt>
4036: <dd><p>These files do not take place in the creation of
4037: a package and thus are purely informative to the package
4038: developer.</p></dd>
4039: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4040: <dd><p>This file contains things that need to be done
4041: to make the package even
4042: better.</p></dd>
1.75 rillig 4043: </dl></div>
4044: </div>
1.78 rillig 4045: </div>
1.148 asau 4046: <div class="sect1">
1.75 rillig 4047: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4048: <a name="work-dir"></a>13.6. <code class="filename">work*</code>
1.93 rillig 4049: </h2></div></div></div>
1.110 hubertf 4050: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4051: unpacked into the directory denoted by
4052: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4053: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4054: directory is also used to keep various timestamp files.
4055: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4056: The default is <code class="filename">${.CURDIR}/work</code>
4057: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4058: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4059: </div>
1.148 asau 4060: <div class="sect1">
1.75 rillig 4061: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4062: <a name="files-dir"></a>13.7. <code class="filename">files/*</code>
1.93 rillig 4063: </h2></div></div></div>
1.75 rillig 4064: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4065: to configuration or building, you could place these files here and use
1.110 hubertf 4066: a <span class="command"><strong>${CP}</strong></span> command in the
1.128 wiz 4067: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.87 wiz 4068: this. Alternatively, you could simply diff the file against
4069: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4070: the creation of this file.</p>
4071: <p>If you want to share files in this way with other
4072: packages, set the <code class="varname">FILESDIR</code> variable to point
4073: to the other package's <code class="filename">files</code> directory,
4074: e.g.:</p>
4075: <pre class="programlisting">
1.100 rillig 4076: FILESDIR=${.CURDIR}/../xemacs/files
4077: </pre>
1.75 rillig 4078: </div>
4079: </div>
1.148 asau 4080: <div class="chapter">
1.75 rillig 4081: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 4082: <a name="makefile"></a>Chapter 14. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4083: <div class="toc">
4084: <p><b>Table of Contents</b></p>
1.210 leot 4085: <dl class="toc">
1.267 rillig 4086: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
4087: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
4088: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
4089: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
4090: <dd><dl>
4091: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
4092: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
4093: <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>
4094: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.75 rillig 4095: </dl></dd>
4096: </dl>
4097: </div>
1.76 rillig 4098: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4099: each of which forms a well-defined part of the pkgsrc system. Using
1.270 leot 4100: 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.75 rillig 4101: like pkgsrc requires some discipline to keep the code correct and
4102: understandable.</p>
1.76 rillig 4103: <p>The basic ingredients for <code class="filename">Makefile</code>
1.267 rillig 4104: programming are variables and shell
1.75 rillig 4105: commands. Among these shell commands may even be more complex ones
1.270 leot 4106: 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.75 rillig 4107: as intended it is necessary to quote all variables correctly when they
4108: are used.</p>
1.267 rillig 4109: <p>This chapter describes some patterns that appear quite often in
1.76 rillig 4110: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4111: with them.</p>
1.148 asau 4112: <div class="sect1">
1.75 rillig 4113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4114: <a name="makefile.style"></a>14.1. Caveats</h2></div></div></div>
1.148 asau 4115: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97 rillig 4116: <p>When you are creating a file as a
4117: target of a rule, always write the data to a temporary file first
4118: and finally rename that file. Otherwise there might occur an error
4119: in the middle of generating the file, and when the user runs
1.270 leot 4120: <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.97 rillig 4121: regenerated properly. Example:</p>
4122: <pre class="programlisting">
1.100 rillig 4123: wrong:
4124: @echo "line 1" > ${.TARGET}
4125: @echo "line 2" >> ${.TARGET}
4126: @false
4127:
4128: correct:
4129: @echo "line 1" > ${.TARGET}.tmp
4130: @echo "line 2" >> ${.TARGET}.tmp
4131: @false
4132: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4133: </pre>
1.110 hubertf 4134: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4135: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4136: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4137: correct</strong></span> gives an error message twice, as expected.</p>
1.270 leot 4138: <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.97 rillig 4139: <code class="literal">${.TARGET}</code> in case of error, but this only
4140: happens when it is interrupted, for example by pressing
1.267 rillig 4141: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.270 leot 4142: 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.97 rillig 4143: </li></ul></div>
4144: </div>
1.148 asau 4145: <div class="sect1">
1.97 rillig 4146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4147: <a name="makefile.variables"></a>14.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4148: <p><code class="filename">Makefile</code> variables contain strings that
1.267 rillig 4149: can be processed using the five operators <code class="code">=</code>,
4150: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.270 leot 4151: <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.75 rillig 4152: page.</p>
4153: <p>When a variable's value is parsed from a
1.267 rillig 4154: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
4155: the backslash character <code class="code">\</code> are handled specially. If a
4156: backslash is the last character in a line, that backslash is removed
4157: from the line and the line continues with the next line of the file.</p>
4158: <p>The <code class="code">#</code> character starts a comment that reaches
4159: until the end of the line. To get an actual <code class="code">#</code> character,
4160: such as in a URL, write <code class="code">\#</code> instead.</p>
1.219 rillig 4161: <p>The evaluation of variables either happens immediately or lazy.
1.267 rillig 4162: It happens immediately when the variable occurs on the right-hand
4163: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
1.219 rillig 4164: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4165: In the other cases, it is evaluated lazily.</p>
1.75 rillig 4166: <p>Some of the modifiers split the string into words and then
1.267 rillig 4167: operate on the words, others operate on the string as a whole. When a
4168: string is split into words, double quotes and single quotes are
1.270 leot 4169: 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.148 asau 4170: <div class="sect2">
1.75 rillig 4171: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 4172: <a name="makefile.variables.names"></a>14.2.1. Naming conventions</h3></div></div></div>
1.148 asau 4173: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4174: <li class="listitem"><p>All variable names starting with an underscore
1.75 rillig 4175: are reserved for use by the pkgsrc infrastructure. They shall
1.267 rillig 4176: not be used by packages.</p></li>
1.128 wiz 4177: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4178: lowercase variable names for the iteration
4179: variables.</p></li>
1.267 rillig 4180: <li class="listitem"><p>All list variables should have a plural name,
4181: such as <code class="varname">PKG_OPTIONS</code> or
1.75 rillig 4182: <code class="varname">DISTFILES</code>.</p></li>
4183: </ul></div>
4184: </div>
4185: </div>
1.148 asau 4186: <div class="sect1">
1.75 rillig 4187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4188: <a name="makefile.code"></a>14.3. Code snippets</h2></div></div></div>
1.148 asau 4189: <div class="sect2">
1.75 rillig 4190: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 4191: <a name="adding-to-list"></a>14.3.1. Adding things to a list</h3></div></div></div>
1.220 wiz 4192: <p>When adding a string that possibly contains whitespace or quotes to
4193: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4194: modifier.</p>
4195: <p>When adding another list to a list (example 2), it must not be
4196: quoted, since its elements are already quoted.</p>
1.75 rillig 4197: <pre class="programlisting">
1.220 wiz 4198: STRING= foo * bar `date`
4199: LIST= # empty
4200: ANOTHER_LIST= a=b c=d
4201:
4202: LIST+= ${STRING:Q} # 1
4203: LIST+= ${ANOTHER_LIST} # 2
4204: </pre>
1.75 rillig 4205: </div>
1.148 asau 4206: <div class="sect2">
1.75 rillig 4207: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 4208: <a name="echo-literal"></a>14.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.220 wiz 4209: <p>Echoing a string containing special characters needs special
4210: work.</p>
1.75 rillig 4211: <pre class="programlisting">
1.100 rillig 4212: STRING= foo bar < > * `date` $$HOME ' "
1.219 rillig 4213: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 grant 4214:
1.100 rillig 4215: all:
4216: echo ${STRING} # 1
1.219 rillig 4217: echo ${STRING:Q} # 2
4218: printf '%s\n' ${STRING:Q}'' # 3
1.220 wiz 4219: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 grant 4220: </pre>
1.220 wiz 4221: <p>Example 1 leads to a syntax error in the shell, as the characters
4222: are just copied.</p>
4223: <p>Example 2 quotes the string so that the shell interprets it
4224: correctly. But the echo command may additionally interpret strings with a
4225: leading dash or those containing backslashes.</p>
1.270 leot 4226: <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.252 leot 4227: interprets the format string, but not the next argument. The trailing
4228: single quotes handle the case when the string is empty. In that case, the
4229: :Q modifier would result in an empty string too, which would then be
1.270 leot 4230: 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.252 leot 4231: but other programs may care.</p>
1.220 wiz 4232: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4233: need to be quoted because the quoting has already been done
4234: when adding elements to the list.</p>
1.75 rillig 4235: </div>
1.148 asau 4236: <div class="sect2">
1.75 rillig 4237: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 4238: <a name="cflags-gnu-configure"></a>14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
1.220 wiz 4239: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4240: GNU-style configure script (especially those that call other configure
4241: scripts), it must not have leading or trailing whitespace, since
4242: otherwise the configure script gets confused. To trim leading and
4243: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4244: following example:</p>
1.75 rillig 4245: <pre class="programlisting">
1.100 rillig 4246: CPPFLAGS= # empty
1.220 wiz 4247: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.100 rillig 4248: CPPFLAGS+= ${MY_CPPFLAGS}
4249:
4250: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4251:
4252: all:
4253: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.220 wiz 4254: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 grant 4255: </pre>
1.220 wiz 4256: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4257: trailing whitespace because the <code class="code">+=</code> operator always adds a
4258: space.</p>
4259: </div>
4260: <div class="sect2">
4261: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 4262: <a name="empty-variables"></a>14.3.4. Handling possibly empty variables</h3></div></div></div>
1.220 wiz 4263: <p>When a possibly empty variable is used in a shell program, it may
4264: lead to a syntax error.</p>
4265: <pre class="programlisting">
4266: EGFILES= # empty
4267:
4268: install-examples: # produces a syntax error in the shell
4269: for egfile in ${EGFILES}; do \
4270: echo "Installing $$egfile"; \
4271: done
4272: </pre>
4273: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.270 leot 4274: <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.220 wiz 4275: To fix this syntax error, use one of the snippets below.</p>
4276: <pre class="programlisting">
4277: EMPTY= # empty
4278:
4279: install-examples:
4280: for egfile in ${EGFILES} ""; do \
4281: [ -n "$$egfile" ] || continue; \
4282: echo "Installing $$egfile"; \
1.100 rillig 4283: done
1.220 wiz 4284: </pre>
4285: <p>In this case, an empty string is appended to the iteration list (to
4286: prevent the syntax error) and filtered out later.</p>
4287: <pre class="programlisting">
4288: EGFILES= # empty
1.100 rillig 4289:
1.220 wiz 4290: install-examples:
4291: .for egfile in ${EGFILES}
4292: echo "Installing ${egfile}"
1.100 rillig 4293: .endfor
1.1 grant 4294: </pre>
1.267 rillig 4295: <p>If one of the filenames contains special characters, it should be
4296: enclosed in single or double quotes.</p>
1.220 wiz 4297: <p>To have a shell command test whether a make variable is empty, use
4298: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.75 rillig 4299: </div>
4300: </div>
4301: </div>
1.148 asau 4302: <div class="chapter">
1.75 rillig 4303: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 4304: <a name="plist"></a>Chapter 15. PLIST issues</h2></div></div></div>
1.75 rillig 4305: <div class="toc">
4306: <p><b>Table of Contents</b></p>
1.210 leot 4307: <dl class="toc">
1.267 rillig 4308: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
4309: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4310: <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>
4311: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
4312: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
4313: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
4314: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
4315: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
4316: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.75 rillig 4317: </dl>
4318: </div>
1.87 wiz 4319: <p>The <code class="filename">PLIST</code> file contains a package's
1.128 wiz 4320: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.87 wiz 4321: the package (relative to the <code class="filename">${PREFIX}</code>
4322: directory it's been installed in) plus some additional statements
1.270 leot 4323: - 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.87 wiz 4324: This chapter addresses some issues that need attention when
4325: dealing with the <code class="filename">PLIST</code> file (or files, see
4326: below!).</p>
1.148 asau 4327: <div class="sect1">
1.75 rillig 4328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4329: <a name="rcs-id"></a>15.1. RCS ID</h2></div></div></div>
1.87 wiz 4330: <p>Be sure to add a RCS ID line as the first thing in any
4331: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 4332: <pre class="programlisting">
1.233 sevan 4333: @comment $NetBSD $
1.222 sevan 4334: </pre>
1.235 yyamano 4335: <p>An artificial space has been added between NetBSD and $, this is a
1.233 sevan 4336: workaround here to prevent CVS expanding to the filename of the guide. When
1.238 leot 4337: adding the RCS ID the space should be omitted.</p>
1.75 rillig 4338: </div>
1.148 asau 4339: <div class="sect1">
1.75 rillig 4340: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4341: <a name="automatic-plist-generation"></a>15.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 4342: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 4343: to output a PLIST that matches any new files since the package
1.267 rillig 4344: 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.87 wiz 4345: more information on this target.</p>
1.75 rillig 4346: </div>
1.148 asau 4347: <div class="sect1">
1.75 rillig 4348: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4349: <a name="print-PLIST"></a>15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 4350: </h2></div></div></div>
1.87 wiz 4351: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4352: of AWK patterns and actions that are used to filter the output of
4353: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4354: scripting you like to it, but be careful with quoting.</p>
4355: <p>For example, to get all files inside the
4356: <code class="filename">libdata/foo</code> directory removed from the
4357: resulting PLIST:</p>
4358: <pre class="programlisting">
1.100 rillig 4359: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.222 sevan 4360: </pre>
1.75 rillig 4361: </div>
1.148 asau 4362: <div class="sect1">
1.75 rillig 4363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4364: <a name="plist.misc"></a>15.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 4365: <p>A number of variables are substituted automatically in
4366: PLISTs when a package is installed on a system. This includes the
4367: following variables:</p>
1.148 asau 4368: <div class="variablelist"><dl class="variablelist">
1.75 rillig 4369: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4370: <dd>
4371: <p>Some packages like emacs and perl embed information
1.87 wiz 4372: about which architecture they were built on into the
4373: pathnames where they install their files. To handle this
4374: case, PLIST will be preprocessed before actually used, and
4375: the symbol
1.128 wiz 4376: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.110 hubertf 4377: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 4378: same is done if the string
4379: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4380: PLIST somewhere - use this on packages that have GNU
4381: autoconf-created configure scripts.</p>
1.148 asau 4382: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 4383: <h3 class="title">Legacy note</h3>
4384: <p>There used to be a symbol
1.128 wiz 4385: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.110 hubertf 4386: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 4387: -m</strong></span>, but that's no longer supported and has
4388: been removed.</p>
1.75 rillig 4389: </div>
4390: </dd>
4391: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4392: <dd>
4393: <p>Some packages want to embed the OS name and version
1.87 wiz 4394: into some paths. To do this, use these variables in the
4395: <code class="filename">PLIST</code>:
4396: </p>
1.148 asau 4397: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4398: <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>
4399: <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>
4400: <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.75 rillig 4401: </ul></div>
4402: </dd>
4403: </dl></div>
1.199 tnn 4404: <p>For a list of values which are replaced by
4405: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4406: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4407: <code class="varname">PLIST_SUBST</code> should help.</p>
1.87 wiz 4408: <p>If you want to change other variables not listed above, you
4409: can add variables and their expansions to this variable in the
1.267 rillig 4410: 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.75 rillig 4411: <pre class="programlisting">
1.100 rillig 4412: PLIST_SUBST+= SOMEVAR="somevalue"
1.222 sevan 4413: </pre>
1.128 wiz 4414: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.87 wiz 4415: in the <code class="filename">PLIST</code> with
1.128 wiz 4416: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.120 snj 4417: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119 mishka 4418: the common case of conditionally including some
4419: <code class="filename">PLIST</code> entries. It can be done by adding
4420: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120 snj 4421: setting the corresponding <code class="varname">PLIST.foo</code> variable
4422: to <code class="literal">yes</code> if the entry should be included.
1.128 wiz 4423: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.119 mishka 4424: in the <code class="filename">PLIST</code> with either
1.128 wiz 4425: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4426: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.119 mishka 4427: For example, in <code class="filename">Makefile</code>:</p>
4428: <pre class="programlisting">
1.223 rillig 4429: PLIST_VARS+= foo
1.119 mishka 4430: .if <em class="replaceable"><code>condition</code></em>
1.223 rillig 4431: PLIST.foo= yes
1.119 mishka 4432: .else
1.222 sevan 4433: </pre>
1.119 mishka 4434: <p>And then in <code class="filename">PLIST</code>:</p>
4435: <pre class="programlisting">
1.233 sevan 4436: @comment $NetBSD $
1.119 mishka 4437: bin/bar
4438: man/man1/bar.1
4439: ${PLIST.foo}bin/foo
4440: ${PLIST.foo}man/man1/foo.1
4441: ${PLIST.foo}share/bar/foo.data
1.222 sevan 4442: </pre>
1.235 yyamano 4443: <p>An artificial space has been added between NetBSD and $, this is a
1.233 sevan 4444: workaround here to prevent CVS expanding to the filename of the guide. When
4445: adding the RCS ID the space should be ommited.</p>
1.75 rillig 4446: </div>
1.148 asau 4447: <div class="sect1">
1.75 rillig 4448: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4449: <a name="manpage-compression"></a>15.5. Man page compression</h2></div></div></div>
1.75 rillig 4450: <p>Man pages should be installed in compressed form if
1.87 wiz 4451: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4452: and uncompressed otherwise. To handle this in the
1.128 wiz 4453: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.87 wiz 4454: appended/removed automatically for man pages according to
4455: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4456: or not, see above for details. This modification of the
4457: <code class="filename">PLIST</code> file is done on a copy of it, not
4458: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 4459: </div>
1.148 asau 4460: <div class="sect1">
1.75 rillig 4461: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4462: <a name="using-PLIST_SRC"></a>15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 4463: </h2></div></div></div>
1.76 rillig 4464: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 4465: in generating the binary package, set the variable
4466: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.270 leot 4467: 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.87 wiz 4468: important. The default for <code class="varname">PLIST_SRC</code> is
4469: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 4470: </div>
1.148 asau 4471: <div class="sect1">
1.75 rillig 4472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4473: <a name="platform-specific-plist"></a>15.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 4474: <p>Some packages decide to install a different set of files based on
1.87 wiz 4475: the operating system being used. These differences can be
4476: automatically handled by using the following files:</p>
1.148 asau 4477: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4478: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4479: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4480: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4481: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4482: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 4483: </ul></div>
4484: </div>
1.148 asau 4485: <div class="sect1">
1.75 rillig 4486: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4487: <a name="build-plist"></a>15.8. Build-specific PLISTs</h2></div></div></div>
1.197 wiz 4488: <p>Some packages decide to generate hard-to-guess file names
4489: during installation that are hard to wire down.</p>
4490: <p>In such cases, you can set the
4491: <code class="varname">GENERATE_PLIST</code> variable to shell code
4492: terminated (with a semicolon) that will output PLIST entries which
4493: will be appended to the PLIST</p>
4494: <p>You can find one example in editors/xemacs:</p>
4495: <pre class="programlisting">
1.222 sevan 4496: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4497: </pre>
1.197 wiz 4498: <p>which will append something like
4499: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4500: <code class="filename">PLIST</code>.
4501: </p>
4502: </div>
4503: <div class="sect1">
4504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4505: <a name="faq.common-dirs"></a>15.9. Sharing directories between packages</h2></div></div></div>
1.128 wiz 4506: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.87 wiz 4507: multiple (and unrelated) packages install files. These
1.125 wiz 4508: directories were problematic because you had to add special
4509: tricks in the PLIST to conditionally remove them, or have some
1.87 wiz 4510: centralized package handle them.</p>
1.125 wiz 4511: <p>In pkgsrc, it is now easy: Each package should create
4512: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4513: will remove any directories left empty after uninstalling a
4514: package.</p>
4515: <p>If a package needs an empty directory to work, create
4516: the directory during installation as usual, and also add an
4517: entry to the PLIST:
1.222 sevan 4518:
4519: </p>
1.87 wiz 4520: <pre class="programlisting">
1.125 wiz 4521: @pkgdir path/to/empty/directory
1.222 sevan 4522: </pre>
1.125 wiz 4523: <p>
1.222 sevan 4524:
1.197 wiz 4525: or take a look at <code class="varname">MAKE_DIRS</code> and
4526: <code class="varname">OWN_DIRS</code>.
1.125 wiz 4527: </p>
1.75 rillig 4528: </div>
4529: </div>
1.148 asau 4530: <div class="chapter">
1.75 rillig 4531: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 4532: <a name="buildlink"></a>Chapter 16. Buildlink methodology</h2></div></div></div>
1.75 rillig 4533: <div class="toc">
4534: <p><b>Table of Contents</b></p>
1.210 leot 4535: <dl class="toc">
1.267 rillig 4536: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
4537: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 4538: <dd><dl>
1.267 rillig 4539: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
4540: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.133 wiz 4541: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4542: and
4543: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4544: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 4545: </dl></dd>
1.267 rillig 4546: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75 rillig 4547: <dd><dl>
1.267 rillig 4548: <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>
4549: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75 rillig 4550: </dl></dd>
4551: </dl>
4552: </div>
4553: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 4554: are seen by a package's configure and build processes. This is implemented
4555: in a two step process:</p>
1.128 wiz 4556: <div class="orderedlist"><ol class="orderedlist" type="1">
4557: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87 wiz 4558: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4559: of <code class="varname">WRKDIR</code>.</p></li>
1.128 wiz 4560: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 4561: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4562: <code class="option">-L${LOCALBASE}/lib</code> into references to
4563: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4564: native compiler on some operating systems look like GCC, so that
4565: packages that expect GCC won't require modifications to build with
4566: those native compilers.</p></li>
1.75 rillig 4567: </ol></div>
4568: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 4569: package may be built consistently despite what other software may be
4570: installed. Please note that the normal system header and library paths,
4571: e.g. <code class="filename">/usr/include</code>,
4572: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4573: designed to insulate the package build from non-system-supplied
4574: software.</p>
1.148 asau 4575: <div class="sect1">
1.75 rillig 4576: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4577: <a name="converting-to-buildlink3"></a>16.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 4578: <p>The process of converting packages to use the buildlink3
1.128 wiz 4579: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.87 wiz 4580: The things to keep in mind are:</p>
1.128 wiz 4581: <div class="orderedlist"><ol class="orderedlist" type="1">
4582: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87 wiz 4583: instead of the actual toolchain. Some packages are tricky,
4584: and the only way to know for sure is the check
4585: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4586: wrappers are being invoked.</p></li>
1.128 wiz 4587: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87 wiz 4588: the package Makefile, e.g. Java VMs, standalone shells,
4589: etc., because the code to symlink files into
4590: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128 wiz 4591: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.87 wiz 4592: </p></li>
1.128 wiz 4593: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87 wiz 4594: <code class="filename">buildlink3.mk</code> files that you list in a
4595: package's Makefile are added as dependencies for that package.
4596: </p></li>
1.75 rillig 4597: </ol></div>
1.87 wiz 4598: <p>If a dependency on a particular package is required for its libraries and
4599: headers, then we replace:</p>
1.75 rillig 4600: <pre class="programlisting">
1.100 rillig 4601: DEPENDS+= foo>=1.1.0:../../category/foo
4602: </pre>
1.75 rillig 4603: <p>with</p>
4604: <pre class="programlisting">
1.100 rillig 4605: .include "../../category/foo/buildlink3.mk"
4606: </pre>
1.75 rillig 4607: <p>The buildlink3.mk files usually define the required dependencies.
4608: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 4609: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 4610: <pre class="programlisting">
1.100 rillig 4611: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4612: .include "../../category/foo/buildlink3.mk"
4613: </pre>
1.76 rillig 4614: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 4615: files in <code class="filename">pkgsrc/mk</code>
4616: that handle special package issues:</p>
1.148 asau 4617: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4618: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 4619: the native or a pkgsrc Berkeley DB implementation based on
4620: the values of <code class="varname">BDB_ACCEPTED</code> and
4621: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128 wiz 4622: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 4623: comes with neither Curses nor NCurses, this will take care
1.250 leot 4624: 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.128 wiz 4625: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 4626: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4627: adding a dependency on Heimdal or MIT-krb5 for packages that
4628: require a Kerberos 5 implementation.</p></li>
1.128 wiz 4629: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88 wiz 4630: system-provided Motif installation or adds a dependency on
1.250 leot 4631: <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.128 wiz 4632: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.239 leot 4633: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
4634: to choose which Motif version will be used.</p></li>
1.161 ryoon 4635: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162 wiz 4636: system-provided GNU readline or editline (libedit) installation,
1.250 leot 4637: 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>,
4638: <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.161 ryoon 4639: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4640: If your package really needs GNU readline library, its Makefile
4641: should include <code class="filename">devel/readline/buildlink3.mk</code>
4642: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128 wiz 4643: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 4644: variables that may be used by packages that use the
4645: Open Sound System (OSS) API.</p></li>
1.128 wiz 4646: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142 wiz 4647: any of the Postgres versions in the variable
4648: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4649: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87 wiz 4650: the file for more information.</p></li>
1.128 wiz 4651: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 4652: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.250 leot 4653: 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.128 wiz 4654: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 4655: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4656: library.</p></li>
1.75 rillig 4657: </ul></div>
1.76 rillig 4658: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 4659: files provide a more complete
4660: description of how to use them properly.</p>
1.75 rillig 4661: </div>
1.148 asau 4662: <div class="sect1">
1.75 rillig 4663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4664: <a name="creating-buildlink3.mk"></a>16.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 4665: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 4666: included by Makefiles to indicate the need to compile and link
4667: against header files and libraries provided by the package. A
4668: <code class="filename">buildlink3.mk</code> file should always provide
4669: enough information to add the correct type of dependency
4670: relationship and include any other
4671: <code class="filename">buildlink3.mk</code> files that it needs to find
4672: headers and libraries that it needs in turn.</p>
4673: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.250 leot 4674: 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.87 wiz 4675: package is highly recommended. For most packages, the following
4676: command will generate a good starting point for
4677: <code class="filename">buildlink3.mk</code> files:</p>
4678: <pre class="screen">
4679: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4680: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4681: </pre>
1.148 asau 4682: <div class="sect2">
1.75 rillig 4683: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 4684: <a name="anatomy-of-bl3"></a>16.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 4685: <p>The following real-life example
1.87 wiz 4686: <code class="filename">buildlink3.mk</code> is taken
4687: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 4688: <pre class="programlisting">
1.120 snj 4689: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 grant 4690:
1.223 rillig 4691: BUILDLINK_TREE+= tiff
1.1 grant 4692:
1.120 snj 4693: .if !defined(TIFF_BUILDLINK3_MK)
4694: TIFF_BUILDLINK3_MK:=
1.87 wiz 4695:
1.223 rillig 4696: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4697: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
4698: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.87 wiz 4699:
1.100 rillig 4700: .include "../../devel/zlib/buildlink3.mk"
4701: .include "../../graphics/jpeg/buildlink3.mk"
1.120 snj 4702: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 4703:
1.223 rillig 4704: BUILDLINK_TREE+= -tiff
1.100 rillig 4705: </pre>
1.87 wiz 4706: <p>The header and footer manipulate
1.120 snj 4707: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87 wiz 4708: <code class="filename">buildlink3.mk</code> files and is used to track
1.120 snj 4709: the dependency tree.</p>
4710: <p>The main section is protected from multiple inclusion
1.87 wiz 4711: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4712: added. Several important variables are set in the section:</p>
1.148 asau 4713: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4714: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 4715: is the actual dependency recorded in the installed
4716: package; this should always be set using
1.110 hubertf 4717: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 4718: we're appending to any pre-existing list of values. This
4719: variable should be set to the first version of the
1.133 wiz 4720: package that had an backwards-incompatible API change.
1.87 wiz 4721: </p></li>
1.128 wiz 4722: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 4723: is the location of the <em class="replaceable"><code>pkg</code></em>
4724: pkgsrc directory.</p></li>
1.128 wiz 4725: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 4726: (not shown above) controls whether we use
4727: <code class="varname">BUILD_DEPENDS</code> or
4728: <code class="varname">DEPENDS</code> to add the dependency on
4729: <em class="replaceable"><code>pkg</code></em>. The build dependency is
4730: selected by setting
4731: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4732: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.87 wiz 4733: used.</p></li>
1.128 wiz 4734: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4735: and
4736: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
4737: (not shown above) are lists of subdirectories of
1.76 rillig 4738: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 4739: to add to the header and library search paths. These
1.128 wiz 4740: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.87 wiz 4741: respectively.</p></li>
1.128 wiz 4742: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4743: (not shown above) is the list of preprocessor flags to add
4744: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128 wiz 4745: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.75 rillig 4746: should be avoided and instead be handled using
4747: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 4748: above.</p></li>
1.75 rillig 4749: </ul></div>
1.87 wiz 4750: <p>The following variables are all optionally defined within
4751: this second section (protected against multiple inclusion) and
4752: control which package files are symlinked into
4753: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
4754: transformed during the symlinking:</p>
1.148 asau 4755: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 4756: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4757: (not shown above) is a shell glob pattern relative to
1.76 rillig 4758: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 4759: to be symlinked into
1.76 rillig 4760: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 4761: e.g. <code class="filename">include/*.h</code>.</p></li>
1.128 wiz 4762: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87 wiz 4763: (not shown above) is a shell pipeline that
4764: outputs to stdout a list of files relative to
4765: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
4766: The resulting files are to be symlinked
4767: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
4768: this takes the <code class="filename">+CONTENTS</code> of a
4769: <em class="replaceable"><code>pkg</code></em> and filters it through
4770: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128 wiz 4771: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4772: (not shown above) is a filter command that filters
1.76 rillig 4773: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 4774: relative to
1.76 rillig 4775: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194 bsiegert 4776: on stdout. By default,
1.75 rillig 4777: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 4778: outputs the contents of the <code class="filename">include</code>
4779: and <code class="filename">lib</code> directories in the package
1.194 bsiegert 4780: <code class="filename">+CONTENTS</code>.</p></li>
1.128 wiz 4781: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 4782: (not shown above) is a list of sed arguments used to
4783: transform the name of the source filename into a
1.110 hubertf 4784: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 4785: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 4786: </ul></div>
1.120 snj 4787: <p>This section can additionally include any
1.87 wiz 4788: <code class="filename">buildlink3.mk</code> needed for
4789: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
4790: Including these <code class="filename">buildlink3.mk</code> files
4791: means that the headers and libraries for these
4792: dependencies are also symlinked into
4793: <code class="filename">${BUILDLINK_DIR}</code>
4794: whenever the <em class="replaceable"><code>pkg</code></em>
4795: <code class="filename">buildlink3.mk</code>
1.120 snj 4796: file is included. Dependencies are only added for directly
4797: include <code class="filename">buildlink3.mk</code> files.</p>
1.153 wiz 4798: <p>When providing a <code class="filename">buildlink3.mk</code> and
4799: including other <code class="filename">buildlink3.mk</code> files in it,
1.156 wiz 4800: please only add necessary ones, i.e., those whose libraries or
1.153 wiz 4801: header files are automatically exposed when the package is
4802: use.</p>
4803: <p>In particular, if only an executable
4804: (<code class="filename">bin/foo</code>) is linked against a library, that
4805: library does not need to be propagated in the
4806: <code class="filename">buildlink3.mk</code> file.</p>
4807: <p>The following steps should help you decide if a
4808: <code class="filename">buildlink3.mk</code> file needs to be included:
4809: </p>
4810: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4811: <li class="listitem"><p>Look at the installed header files: What
4812: headers do they include? The packages providing these files
4813: must be buildlinked.</p></li>
1.155 wiz 4814: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
4815: libraries and look against what other libraries they link.
4816: Some of the packages providing these probably need to be
4817: buildlinked; however, it's not automatic, since e.g. GTK on
4818: some systems pulls in the X libraries, so they will show up in
4819: the <code class="filename">ldd</code> output, while on others (like OS
1.156 wiz 4820: X) it won't. <code class="filename">ldd</code> output can thus only be
1.155 wiz 4821: used as a hint.</p></li>
1.153 wiz 4822: </ul></div>
4823: <p>
4824: </p>
1.75 rillig 4825: </div>
1.148 asau 4826: <div class="sect2">
1.75 rillig 4827: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 4828: <a name="updating-buildlink-depends"></a>16.2.2. Updating
1.87 wiz 4829: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 4830: and
4831: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4832: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
4833: <p>These two variables differ in that one describes source
4834: compatibility (API) and the other binary compatibility (ABI).
4835: The difference is that a change in the API breaks compilation of
4836: programs while changes in the ABI stop compiled programs from
4837: running.</p>
4838: <p>Changes to the
1.134 wiz 4839: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133 wiz 4840: variable in a <code class="filename">buildlink3.mk</code> file happen
4841: very rarely. One possible reason is that all packages depending
4842: on this already need a newer version. In case it is bumped see
4843: the description below.</p>
4844: <p>The most common example of an ABI change is that the major
4845: version of a shared library is increased. In this case,
4846: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4847: should be adjusted to require at least the new package version.
4848: Then the packages that depend on this package need their
4849: <code class="varname">PKGREVISION</code>s increased and, if they have
4850: <code class="filename">buildlink3.mk</code> files, their
4851: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4852: adjusted, too. This is needed so pkgsrc will require the correct
4853: package dependency and not settle for an older one when building
4854: the source.</p>
1.267 rillig 4855: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for
1.133 wiz 4856: more information about dependencies on other packages,
4857: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 4858: <code class="varname">ABI_DEPENDS</code> definitions.</p>
4859: <p>Please take careful consideration before adjusting
4860: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4861: or
4862: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4863: as we don't want to cause unneeded package deletions and
4864: rebuilds. In many cases, new versions of packages work just
4865: fine with older dependencies.</p>
4866: <p>Also it is not needed to set
1.133 wiz 4867: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4868: when it is identical to
1.87 wiz 4869: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 4870: </div>
4871: </div>
1.148 asau 4872: <div class="sect1">
1.75 rillig 4873: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 4874: <a name="writing-builtin.mk"></a>16.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 4875: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 4876: coincide with headers and libraries present in the base system.
1.76 rillig 4877: Aside from a <code class="filename">buildlink3.mk</code> file, these
4878: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 4879: file that includes the necessary checks to decide whether using
4880: the built-in software or the pkgsrc software is
1.87 wiz 4881: appropriate.</p>
4882: <p>The only requirements of a builtin.mk file for
4883: <em class="replaceable"><code>pkg</code></em> are:</p>
1.128 wiz 4884: <div class="orderedlist"><ol class="orderedlist" type="1">
4885: <li class="listitem"><p>It should set
1.87 wiz 4886: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4887: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.87 wiz 4888: after it is included.</p></li>
1.128 wiz 4889: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87 wiz 4890: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4891: which is already set before the
4892: <code class="filename">builtin.mk</code> file is included.</p></li>
1.128 wiz 4893: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.87 wiz 4894: is <span class="emphasis"><em>very</em></span> important and takes careful
4895: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 4896: </ol></div>
1.148 asau 4897: <div class="sect2">
1.75 rillig 4898: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 4899: <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.75 rillig 4900: <p>The following is the recommended template for builtin.mk
1.87 wiz 4901: files:</p>
1.75 rillig 4902: <pre class="programlisting">
1.100 rillig 4903: .if !defined(IS_BUILTIN.foo)
4904: #
4905: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4906: # genuinely exists in the system or not.
4907: #
4908: IS_BUILTIN.foo?= no
4909:
4910: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4911: # version can be determined.
4912: #
4913: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4914: BUILTIN_PKG.foo?= foo-1.0
4915: . endif
4916: .endif # IS_BUILTIN.foo
4917:
4918: .if !defined(USE_BUILTIN.foo)
4919: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4920: . if defined(BUILTIN_PKG.foo)
4921: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4922: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4923: USE_BUILTIN.foo!= \
4924: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4925: && ${ECHO} "yes" || ${ECHO} "no"
4926: . endif
4927: . endfor
4928: . endif
4929: .endif # USE_BUILTIN.foo
4930:
4931: CHECK_BUILTIN.foo?= no
4932: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4933: #
4934: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4935: # "yes" or "no".
4936: #
4937: .endif # CHECK_BUILTIN.foo
4938: </pre>
1.87 wiz 4939: <p>The first section sets
4940: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4941: depending on if <em class="replaceable"><code>pkg</code></em> really exists
4942: in the base system. This should not be a base system software
4943: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128 wiz 4944: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.87 wiz 4945: included as part of the base system. This variable is only
4946: used internally within the <code class="filename">builtin.mk</code>
4947: file.</p>
4948: <p>The second section sets
4949: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4950: to the version of <em class="replaceable"><code>pkg</code></em> in the base
4951: system if it exists (if
4952: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4953: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.87 wiz 4954: within the <code class="filename">builtin.mk</code> file.</p>
4955: <p>The third section sets
4956: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4957: and is <span class="emphasis"><em>required</em></span> in all
4958: <code class="filename">builtin.mk</code> files. The code in this
4959: section must make the determination whether the built-in
4960: software is adequate to satisfy the dependencies listed in
4961: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4962: This is typically done by comparing
4963: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
4964: against each of the dependencies in
4965: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
4966: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4967: <span class="emphasis"><em>must</em></span> be set to the correct value by the
4968: end of the <code class="filename">builtin.mk</code> file. Note that
4969: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4970: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.87 wiz 4971: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128 wiz 4972: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.87 wiz 4973: that the built-in version of the software is similar enough to
4974: be used as a replacement.</p>
4975: <p>The last section is guarded by
4976: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
4977: and includes code that uses the value of
4978: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
4979: set in the previous section. This typically includes, e.g.,
4980: adding additional dependency restrictions and listing additional
4981: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
4982: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 4983: </div>
1.148 asau 4984: <div class="sect2">
1.75 rillig 4985: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 4986: <a name="native-or-pkgsrc-preference"></a>16.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 4987: <p>When building packages, it's possible to choose whether to set
4988: a global preference for using either the built-in (native)
4989: version or the pkgsrc version of software to satisfy a
4990: dependency. This is controlled by setting
4991: <code class="varname">PREFER_PKGSRC</code> and
4992: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.128 wiz 4993: 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.87 wiz 4994: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
4995: use the pkgsrc versions of software, while
4996: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
4997: built-in versions. Preferences are determined by the most
4998: specific instance of the package in either
4999: <code class="varname">PREFER_PKGSRC</code> or
5000: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5001: in neither or in both variables, then
5002: <code class="varname">PREFER_PKGSRC</code> has precedence over
5003: <code class="varname">PREFER_NATIVE</code>. For example, to require
5004: using pkgsrc versions of software for all but the most basic
5005: bits on a NetBSD system, you can set:</p>
5006: <pre class="programlisting">
1.100 rillig 5007: PREFER_PKGSRC= yes
5008: PREFER_NATIVE= getopt skey tcp_wrappers
5009: </pre>
1.87 wiz 5010: <p>A package <span class="emphasis"><em>must</em></span> have a
5011: <code class="filename">builtin.mk</code>
5012: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5013: otherwise it is simply ignored in that list.</p>
1.229 sevan 5014: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
5015: straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
5016: bootstrap.
5017: Switching between settings globally at a later date can introduce
5018: complications with dependency resolution. This is caused by packages
5019: built with the opposite preference being installed alongside each other.</p>
5020: <pre class="screen">
5021: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
5022: </pre>
1.75 rillig 5023: </div>
5024: </div>
5025: </div>
1.148 asau 5026: <div class="chapter">
1.75 rillig 5027: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 5028: <a name="pkginstall"></a>Chapter 17. The pkginstall framework</h2></div></div></div>
1.75 rillig 5029: <div class="toc">
5030: <p><b>Table of Contents</b></p>
1.210 leot 5031: <dl class="toc">
1.267 rillig 5032: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
1.75 rillig 5033: <dd><dl>
1.267 rillig 5034: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
5035: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
1.75 rillig 5036: </dl></dd>
1.267 rillig 5037: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
1.75 rillig 5038: <dd><dl>
1.267 rillig 5039: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5040: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
5041: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
5042: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
5043: </dl></dd>
5044: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
5045: <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>
5046: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
5047: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
5048: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
5049: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
5050: <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.75 rillig 5051: </dl>
5052: </div>
5053: <p>This chapter describes the framework known as
5054: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148 asau 5055: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5056: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75 rillig 5057: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5058: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75 rillig 5059: provided that packages are correctly designed.</p></li>
1.128 wiz 5060: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5061: <li class="listitem"><p>Registration of system users and groups.</p></li>
5062: <li class="listitem"><p>Registration of system shells.</p></li>
5063: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75 rillig 5064: </ul></div>
5065: <p>The following sections inspect each of the above points in detail.</p>
5066: <p>You may be thinking that many of the things described here could be
5067: easily done with simple code in the package's post-installation target
5068: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5069: as the code in them is only executed when building from source. Machines
5070: using binary packages could not benefit from it at all (as the code itself
5071: could be unavailable). Therefore, the only way to achieve any of the items
5072: described above is by means of the installation scripts, which are
5073: automatically generated by pkginstall.</p>
1.148 asau 5074: <div class="sect1">
1.75 rillig 5075: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5076: <a name="files-and-dirs-outside-prefix"></a>17.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5077: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5078: of files and directories that belong to a package. The names used in it
1.76 rillig 5079: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5080: which means that it cannot register files outside this directory (absolute
5081: path names are not allowed). Despite this restriction, some packages need
5082: to install files outside this location; e.g., under
1.76 rillig 5083: <code class="filename">${VARBASE}</code> or
1.87 wiz 5084: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5085: is to create such files during installation time by using
5086: installation scripts.</p>
5087: <p>The generic installation scripts are shell scripts that can
5088: contain arbitrary code. The list of scripts to execute is taken from
5089: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5090: <code class="filename">INSTALL</code>. A similar variable exists for package
5091: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5092: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5093: commands, so they have the potential to create and manage files
5094: anywhere in the file system.</p>
5095: <p>Using these general installation files is not recommended, but
5096: may be needed in some special cases. One reason for avoiding them is
5097: that the user has to trust the packager that there is no unwanted or
5098: simply erroneous code included in the installation script. Also,
5099: previously there were many similar scripts for the same functionality,
5100: and fixing a common error involved finding and changing all of
5101: them.</p>
5102: <p>The pkginstall framework offers another, standardized way. It
5103: provides generic scripts to abstract the manipulation of such files
5104: and directories based on variables set in the package's
5105: <code class="filename">Makefile</code>. The rest of this section describes
5106: these variables.</p>
1.148 asau 5107: <div class="sect2">
1.75 rillig 5108: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 5109: <a name="dirs-outside-prefix"></a>17.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5110: <p>The following variables can be set to request the creation of
5111: directories anywhere in the file system:</p>
1.148 asau 5112: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.218 rillig 5113: <li class="listitem">
5114: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75 rillig 5115: contain a list of directories that should be created and should attempt
5116: to be destroyed by the installation scripts. The difference between
5117: the two is that the latter prompts the administrator to remove any
5118: directories that may be left after deinstallation (because they were
1.218 rillig 5119: not empty), while the former does not. Example:</p>
5120: <pre class="programlisting">
5121: MAKE_DIRS+= ${VARBASE}/foo/private
5122: </pre>
5123: </li>
1.128 wiz 5124: <li class="listitem">
1.75 rillig 5125: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5126: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5127: which directories should be created and should attempt to be destroyed
5128: by the installation scripts. Each tuple holds the following values,
5129: separated by spaces: the directory name, its owner, its group and its
5130: numerical mode. For example:</p>
5131: <pre class="programlisting">
1.218 rillig 5132: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5133: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 grant 5134: </pre>
1.75 rillig 5135: <p>The difference between the two is exactly the same as their
5136: non-<code class="varname">PERMS</code> counterparts.</p>
5137: </li>
5138: </ul></div>
5139: </div>
1.148 asau 5140: <div class="sect2">
1.75 rillig 5141: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 5142: <a name="files-outside-prefix"></a>17.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5143: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5144: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5145: To overcome this problem, the only solution is to extract the file in the
5146: known place (i.e., inside the installation prefix) and copy it to the
5147: appropriate location during installation (done by the installation scripts
5148: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5149: file</em></span> in the following paragraphs, which describe the variables
5150: that can be used to automatically and consistently handle files outside the
5151: installation prefix:</p>
1.148 asau 5152: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5153: <li class="listitem">
1.75 rillig 5154: <p><code class="varname">CONF_FILES</code> and
1.137 wiz 5155: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75 rillig 5156: During installation time, the master file is copied to the target one
5157: if and only if the latter does not exist. Upon deinstallation, the
5158: target file is removed provided that it was not modified by the
5159: installation.</p>
5160: <p>The difference between the two is that the latter prompts the
5161: administrator to remove any files that may be left after
5162: deinstallation (because they were not empty), while the former does
5163: not.</p>
5164: </li>
1.128 wiz 5165: <li class="listitem">
1.75 rillig 5166: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137 wiz 5167: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75 rillig 5168: files as well as their target locations. For each of them, it also
5169: specifies their owner, their group and their numeric permissions, in
5170: this order. For example:</p>
5171: <pre class="programlisting">
1.218 rillig 5172: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5173: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 grant 5174: </pre>
1.75 rillig 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>
5180: </div>
1.148 asau 5181: <div class="sect1">
1.75 rillig 5182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5183: <a name="conf-files"></a>17.2. Configuration files</h2></div></div></div>
1.75 rillig 5184: <p>Configuration files are special in the sense that they are installed
5185: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5186: need special treatment during installation (most of which is automated by
5187: pkginstall). The main concept you must bear in mind is that files marked
5188: as configuration files are automatically copied to the right place (somewhere
5189: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5190: and only if</em></span> they didn't exist before. Similarly, they will not
5191: be removed if they have local modifications. This ensures that
5192: administrators never lose any custom changes they may have made.</p>
1.148 asau 5193: <div class="sect2">
1.75 rillig 5194: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 5195: <a name="conf-files-sysconfdir"></a>17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75 rillig 5196: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5197: specifies where configuration files shall be installed. Its contents are
5198: set based upon the following variables:</p>
1.148 asau 5199: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5200: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5201: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5202: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5203: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5204: Packages must not use it directly.</p></li>
1.128 wiz 5205: <li class="listitem">
1.75 rillig 5206: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5207: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5208: for the package being built shall be installed. The definition of this
5209: variable only makes sense in the package's
1.76 rillig 5210: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5211: <p>As an example, consider the Apache package,
1.250 leot 5212: <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.75 rillig 5213: configuration files under the
1.76 rillig 5214: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5215: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5216: Makefile.</p>
5217: </li>
1.128 wiz 5218: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75 rillig 5219: variable that holds this package's configuration directory (if
5220: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5221: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5222: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128 wiz 5223: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75 rillig 5224: directory where the configuration files for the package identified by
5225: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5226: </ul></div>
5227: <p>Based on the above variables, pkginstall determines the value of
5228: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5229: variable that can be used within a package to refer to its configuration
5230: directory. The algorithm used to set its value is basically the
5231: following:</p>
1.128 wiz 5232: <div class="orderedlist"><ol class="orderedlist" type="1">
5233: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75 rillig 5234: its value is used.</p></li>
1.128 wiz 5235: <li class="listitem"><p>If the previous variable is not defined but
1.75 rillig 5236: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5237: <code class="filename">Makefile</code>, the resulting value is
5238: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128 wiz 5239: <li class="listitem"><p>Otherwise, it is set to
1.76 rillig 5240: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5241: </ol></div>
1.76 rillig 5242: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.267 rillig 5243: 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.117 jnemeth 5244: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5245: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75 rillig 5246: </div>
1.148 asau 5247: <div class="sect2">
1.75 rillig 5248: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 5249: <a name="conf-files-configure"></a>17.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5250: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5251: known place, you need to teach each package where it shall install its
5252: files. In some cases you will have to patch the package Makefiles to
5253: achieve it. If you are lucky, though, it may be as easy as passing an
5254: extra flag to the configuration script; this is the case of GNU Autoconf-
5255: generated files:</p>
5256: <pre class="programlisting">
1.100 rillig 5257: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5258: </pre>
1.75 rillig 5259: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5260: for</em></span> its configuration files, not where they will be originally
5261: installed (although the difference is never explicit,
5262: unfortunately).</p>
5263: </div>
1.148 asau 5264: <div class="sect2">
1.75 rillig 5265: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 5266: <a name="conf-files-patching"></a>17.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5267: <p>As said before, pkginstall automatically handles configuration files.
5268: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5269: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5270: directly</strong></span>. Bad news is that many software installation scripts
5271: will, out of the box, mess with the contents of that directory. So what is
5272: the correct procedure to fix this issue?</p>
5273: <p>You must teach the package (usually by manually patching it) to
5274: install any configuration files under the examples hierarchy,
1.76 rillig 5275: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5276: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5277: has the original copies available.</p>
5278: <p>Once the required configuration files are in place (i.e., under the
5279: examples hierarchy), the pkginstall framework can use them as master copies
5280: during the package installation to update what is in
1.76 rillig 5281: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5282: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.267 rillig 5283: 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.75 rillig 5284: about their syntax and their purpose. Here is an example, taken from the
1.250 leot 5285: <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.75 rillig 5286: <pre class="programlisting">
1.100 rillig 5287: EGDIR= ${PREFIX}/share/doc/mutt/samples
5288: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 5289: </pre>
1.75 rillig 5290: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5291: package and has no meaning outside it.</p>
5292: </div>
1.148 asau 5293: <div class="sect2">
1.75 rillig 5294: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 5295: <a name="conf-files-disable"></a>17.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 5296: <p>The automatic copying of config files can be toggled by setting the
5297: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5298: installation.</p>
5299: </div>
5300: </div>
1.148 asau 5301: <div class="sect1">
1.75 rillig 5302: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5303: <a name="rcd-scripts"></a>17.3. System startup scripts</h2></div></div></div>
1.75 rillig 5304: <p>System startup scripts are special files because they must be
5305: installed in a place known by the underlying OS, usually outside the
1.267 rillig 5306: 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.75 rillig 5307: can be used. However, pkginstall provides a special mechanism to handle
5308: these files.</p>
5309: <p>In order to provide system startup scripts, the package has
5310: to:</p>
1.128 wiz 5311: <div class="orderedlist"><ol class="orderedlist" type="1">
5312: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 5313: the <code class="literal">.sh</code> suffix appended. Considering the
1.250 leot 5314: <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.76 rillig 5315: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128 wiz 5316: <li class="listitem">
1.75 rillig 5317: <p>Tell pkginstall to handle it, appending the name of the script,
5318: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5319: Continuing the previous example:</p>
5320: <pre class="programlisting">
1.100 rillig 5321: RCD_SCRIPTS+= cupsd
1.1 grant 5322: </pre>
1.75 rillig 5323: </li>
5324: </ol></div>
5325: <p>Once this is done, pkginstall will do the following steps for each
5326: script in an automated fashion:</p>
1.128 wiz 5327: <div class="orderedlist"><ol class="orderedlist" type="1">
5328: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76 rillig 5329: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 5330: variable.</p></li>
1.128 wiz 5331: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76 rillig 5332: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 5333: that this master file must be explicitly registered in the
1.76 rillig 5334: <code class="filename">PLIST</code>.</p></li>
1.128 wiz 5335: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75 rillig 5336: from the examples hierarchy into the system-wide startup scripts
5337: directory.</p></li>
5338: </ol></div>
1.148 asau 5339: <div class="sect2">
1.75 rillig 5340: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 5341: <a name="rcd-scripts-disable"></a>17.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 5342: <p>The automatic copying of config files can be toggled by setting the
5343: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5344: installation. Note that the scripts will be always copied inside the
1.76 rillig 5345: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 5346: matter what the value of this variable is.</p>
5347: </div>
5348: </div>
1.148 asau 5349: <div class="sect1">
1.75 rillig 5350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5351: <a name="users-and-groups"></a>17.4. System users and groups</h2></div></div></div>
1.75 rillig 5352: <p>If a package needs to create special users and/or groups during
5353: installation, it can do so by using the pkginstall framework.</p>
5354: <p>Users can be created by adding entries to the
5355: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5356: syntax:</p>
5357: <pre class="programlisting">
1.100 rillig 5358: user:group
1.1 grant 5359: </pre>
1.87 wiz 5360: <p>Further specification of user details may be done by setting
5361: per-user variables.
5362: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5363: numeric UID for the user.
5364: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5365: user's description or comment.
5366: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5367: user's home directory, and defaults to
5368: <code class="filename">/nonexistent</code> if not specified.
5369: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 5370: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 5371: not specified.</p>
1.75 rillig 5372: <p>Similarly, groups can be created by adding entries to the
5373: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5374: <pre class="programlisting">
1.100 rillig 5375: group
1.1 grant 5376: </pre>
1.93 rillig 5377: <p>The numeric GID of the group may be set by defining
1.75 rillig 5378: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5379: <p>If a package needs to create the users and groups at an earlier
1.227 wiz 5380: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
5381: <code class="literal">configure</code>,<code class="literal">build</code>, or
5382: <code class="literal">pre-install</code> to indicate the phase before which the
5383: users and groups are created. In this case, the numeric UIDs and GIDs
5384: of the created users and groups are automatically hardcoded into the
5385: final installation scripts.</p>
1.75 rillig 5386: </div>
1.148 asau 5387: <div class="sect1">
1.75 rillig 5388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5389: <a name="shells"></a>17.5. System shells</h2></div></div></div>
1.75 rillig 5390: <p>Packages that install system shells should register them in the shell
1.76 rillig 5391: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 5392: administrator. This must be done from the installation scripts to keep
5393: binary packages working on any system. pkginstall provides an easy way to
5394: accomplish this task.</p>
5395: <p>When a package provides a shell interpreter, it has to set the
5396: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5397: add some hooks to the installation scripts to handle it. Consider the
1.250 leot 5398: 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.75 rillig 5399: <pre class="programlisting">
1.100 rillig 5400: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 5401: </pre>
1.148 asau 5402: <div class="sect2">
1.75 rillig 5403: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 5404: <a name="shells-disable"></a>17.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 5405: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 5406: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 5407: environment variable to <code class="literal">NO</code>.</p>
5408: </div>
5409: </div>
1.148 asau 5410: <div class="sect1">
1.75 rillig 5411: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5412: <a name="fonts"></a>17.6. Fonts</h2></div></div></div>
1.75 rillig 5413: <p>Packages that install X11 fonts should update the database files
5414: that index the fonts within each fonts directory. This can easily be
5415: accomplished within the pkginstall framework.</p>
5416: <p>When a package installs X11 fonts, it must list the directories in
5417: which fonts are installed in the
5418: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128 wiz 5419: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5420: <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.75 rillig 5421: installation scripts to run the appropriate commands to update the fonts
5422: database files within each of those directories. For convenience, if the
5423: directory path is relative, it is taken to be relative to the package's
1.250 leot 5424: 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.75 rillig 5425: <pre class="programlisting">
1.175 wiz 5426: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 grant 5427: </pre>
1.148 asau 5428: <div class="sect2">
1.75 rillig 5429: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 5430: <a name="fonts-disable"></a>17.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 5431: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 5432: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 5433: environment variable to <code class="literal">NO</code>.</p>
5434: </div>
5435: </div>
5436: </div>
1.148 asau 5437: <div class="chapter">
1.75 rillig 5438: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 5439: <a name="options"></a>Chapter 18. Options handling</h2></div></div></div>
1.75 rillig 5440: <div class="toc">
5441: <p><b>Table of Contents</b></p>
1.210 leot 5442: <dl class="toc">
1.267 rillig 5443: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
5444: <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>
5445: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
5446: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 5447: </dl>
5448: </div>
5449: <p>Many packages have the ability to be built to support different
1.76 rillig 5450: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 5451: in pkgsrc that provides generic handling of those options that
5452: determine different ways in which the packages can be built. It's
5453: possible for the user to specify exactly which sets of options will be
5454: built into a package or to allow a set of global default options
5455: apply.</p>
1.107 rillig 5456: <p>There are two broad classes of behaviors that one might want to
5457: control via options. One is whether some particular feature is
5458: enabled in a program that will be built anyway, often by including or
5459: not including a dependency on some other package. The other is
5460: whether or not an additional program will be built as part of the
5461: package. Generally, it is better to make a split package for such
5462: additional programs instead of using options, because it enables
5463: binary packages to be built which can then be added separately. For
5464: example, the foo package might have minimal dependencies (those
5465: packages without which foo doesn't make sense), and then the foo-gfoo
5466: package might include the GTK frontend program gfoo. This is better
5467: than including a gtk option to foo that adds gfoo, because either that
5468: option is default, in which case binary users can't get foo without
5469: gfoo, or not default, in which case they can't get gfoo. With split
5470: packages, they can install foo without having GTK, and later decide to
5471: install gfoo (pulling in GTK at that time). This is an advantage to
5472: source users too, avoiding the need for rebuilds.</p>
5473: <p>Plugins with widely varying dependencies should usually be split
5474: instead of options.</p>
5475: <p>It is often more work to maintain split packages, especially if
5476: the upstream package does not support this. The decision of split
5477: vs. option should be made based on the likelihood that users will want
5478: or object to the various pieces, the size of the dependencies that are
5479: included, and the amount of work.</p>
5480: <p>A further consideration is licensing. Non-free parts, or parts
5481: that depend on non-free dependencies (especially plugins) should
5482: almost always be split if feasible.</p>
1.148 asau 5483: <div class="sect1">
1.75 rillig 5484: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5485: <a name="global-default-options"></a>18.1. Global default options</h2></div></div></div>
1.75 rillig 5486: <p>Global default options are listed in
5487: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5488: that should be built into every package if that option is supported.
1.110 hubertf 5489: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 5490: </div>
1.148 asau 5491: <div class="sect1">
1.75 rillig 5492: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5493: <a name="converting-to-options"></a>18.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 5494: </h2></div></div></div>
1.75 rillig 5495: <p>The following example shows how
1.76 rillig 5496: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 5497: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 5498: <code class="filename">Makefile</code>, or in a file,
5499: e.g. <code class="filename">options.mk</code>, that is included by the
5500: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 5501: <pre class="programlisting">
1.100 rillig 5502: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5503: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5504: PKG_OPTIONS_OPTIONAL_GROUPS= database
5505: PKG_OPTIONS_GROUP.database= mysql pgsql
5506: PKG_SUGGESTED_OPTIONS= wibble-foo
5507: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5508: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5509:
5510: .include "../../mk/bsd.prefs.mk"
5511:
5512: # this package was previously named wibble2
5513: .if defined(PKG_OPTIONS.wibble2)
5514: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5515: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5516: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5517: .endif
5518:
5519: .include "../../mk/bsd.options.mk"
5520:
5521: # Package-specific option-handling
5522:
5523: ###
5524: ### FOO support
5525: ###
5526: .if !empty(PKG_OPTIONS:Mwibble-foo)
5527: CONFIGURE_ARGS+= --enable-foo
5528: .endif
5529:
5530: ###
5531: ### LDAP support
5532: ###
5533: .if !empty(PKG_OPTIONS:Mldap)
5534: . include "../../databases/openldap-client/buildlink3.mk"
5535: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5536: .endif
5537:
5538: ###
5539: ### database support
5540: ###
5541: .if !empty(PKG_OPTIONS:Mmysql)
5542: . include "../../mk/mysql.buildlink3.mk"
5543: .endif
5544: .if !empty(PKG_OPTIONS:Mpgsql)
5545: . include "../../mk/pgsql.buildlink3.mk"
5546: .endif
1.75 rillig 5547: </pre>
5548: <p>The first section contains the information about which build
5549: options are supported by the package, and any default options settings
5550: if needed.</p>
1.128 wiz 5551: <div class="orderedlist"><ol class="orderedlist" type="1">
5552: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.270 leot 5553: <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.75 rillig 5554: options. It should be set to
1.78 rillig 5555: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5556: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5557: at the point where the options are processed.</p></li>
1.128 wiz 5558: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75 rillig 5559: build options supported by the package.</p></li>
1.128 wiz 5560: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75 rillig 5561: list of names of groups of mutually exclusive options. The options in
5562: each group are listed in
5563: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5564: The most specific setting of any option from the group takes
5565: precedence over all other options in the group. Options from the
5566: groups will be automatically added to
5567: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128 wiz 5568: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75 rillig 5569: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5570: packages will fail if no option from the group is
5571: selected.</p></li>
1.128 wiz 5572: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75 rillig 5573: of names of sets of options. At least one option from each set must
5574: be selected. The options in each set are listed in
5575: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5576: Options from the sets will be automatically added to
5577: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5578: fail if no option from the set is selected.</p></li>
1.128 wiz 5579: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75 rillig 5580: build options which are enabled by default.</p></li>
1.128 wiz 5581: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75 rillig 5582: of
1.128 wiz 5583: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.110 hubertf 5584: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 5585: their option counterparts. Pairs should be added with
1.128 wiz 5586: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.75 rillig 5587: warning will be issued if the user uses a legacy
5588: variable.</p></li>
1.128 wiz 5589: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75 rillig 5590: of
1.128 wiz 5591: <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.75 rillig 5592: pairs that map options that have been renamed to their new
1.128 wiz 5593: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.75 rillig 5594: the listing of global legacy options. A warning will be issued if
5595: the user uses a legacy option.</p></li>
1.128 wiz 5596: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75 rillig 5597: options implied by deprecated variables used. This can be used for
5598: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5599: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5600: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128 wiz 5601: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75 rillig 5602: a list of warnings about deprecated variables or options used, and
5603: what to use instead.</p></li>
5604: </ol></div>
5605: <p>A package should never modify
5606: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5607: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5608: To suggest a default set of options, use
5609: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5610: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 5611: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 5612: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5613: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5614: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5615: happen with platform-specific options if none of them is supported on
5616: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5617: empty list and the package is otherwise treated as not using the
5618: options framework.</p>
1.76 rillig 5619: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 5620: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5621: build options, properly filtered to remove unsupported and duplicate
5622: options.</p>
5623: <p>The remaining sections contain the logic that is specific to
5624: each option. The correct way to check for an option is to check
5625: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5626: <pre class="programlisting">
1.100 rillig 5627: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 5628: </pre>
5629: </div>
1.148 asau 5630: <div class="sect1">
1.75 rillig 5631: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5632: <a name="option-names"></a>18.3. Option Names</h2></div></div></div>
1.75 rillig 5633: <p>Options that enable similar features in different packages (like
5634: optional support for a library) should use a common name in all
5635: packages that support it (like the name of the library). If another
5636: package already has an option with the same meaning, use the same
5637: name.</p>
5638: <p>Options that enable features specific to one package, where it's
5639: unlikely that another (unrelated) package has the same (or a similar)
5640: optional feature, should use a name prefixed with
5641: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5642: <p>If a group of related packages share an optional feature
5643: specific to that group, prefix it with the name of the
1.128 wiz 5644: <span class="quote">“<span class="quote">main</span>”</span> package
1.75 rillig 5645: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5646: <p>For new options, add a line to
1.76 rillig 5647: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 5648: fields, separated by tab. The first field is the option name, the
5649: second its description. The description should be a whole sentence
5650: (starting with an uppercase letter and ending with a period) that
1.128 wiz 5651: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5652: support.</span>”</span> The file is sorted by option names.</p>
1.75 rillig 5653: </div>
1.148 asau 5654: <div class="sect1">
1.107 rillig 5655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5656: <a name="option-build"></a>18.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 5657: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107 rillig 5658: different dependencies based on the options with which the package was
5659: built. For querying these options, the file
5660: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5661: typical example looks like this:</p>
5662: <pre class="programlisting">
5663: pkgbase := libpurple
5664: .include "../../mk/pkg-build-options.mk"
5665:
5666: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5667: ...
5668: .endif
5669: </pre>
5670: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5671: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5672: options of the libpurple package, which can then be queried like
5673: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5674: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5675: details.</p>
5676: </div>
1.75 rillig 5677: </div>
1.148 asau 5678: <div class="chapter">
1.75 rillig 5679: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 5680: <a name="build"></a>Chapter 19. The build process</h2></div></div></div>
1.75 rillig 5681: <div class="toc">
5682: <p><b>Table of Contents</b></p>
1.210 leot 5683: <dl class="toc">
1.267 rillig 5684: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
5685: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
5686: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
5687: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
5688: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
5689: <dd><dl>
5690: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
5691: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
5692: </dl></dd>
5693: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5694: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5695: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5696: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5697: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5698: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5699: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5700: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5701: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5702: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
5703: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
5704: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
1.75 rillig 5705: </dl>
5706: </div>
1.148 asau 5707: <div class="sect1">
1.75 rillig 5708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5709: <a name="build.intro"></a>19.1. Introduction</h2></div></div></div>
1.75 rillig 5710: <p>This chapter gives a detailed description on how a package is
1.87 wiz 5711: built. Building a package is separated into different
5712: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5713: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120 snj 5714: described in the following sections. Each phase is split into
1.87 wiz 5715: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
5716: containing phase, prefixed by one of <code class="varname">pre-</code>,
5717: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
5718: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
5719: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 5720: <p>Never override the regular targets (like
5721: <code class="varname">fetch</code>), if you have to, override the
5722: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 5723: <p>The basic steps for building a program are always the same. First
1.87 wiz 5724: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
5725: the local system and then extracted. After any pkgsrc-specific patches
5726: to compile properly are applied, the software can be configured, then
5727: built (usually by compiling), and finally the generated binaries, etc.
5728: can be put into place on the system.</p>
1.97 rillig 5729: <p>To get more details about what is happening at each step,
5730: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
5731: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
5732: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 5733: </div>
1.148 asau 5734: <div class="sect1">
1.75 rillig 5735: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5736: <a name="build.prefix"></a>19.2. Program location</h2></div></div></div>
1.75 rillig 5737: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 5738: the next section, here's a brief discussion on where programs are
5739: installed, and which variables influence this.</p>
1.75 rillig 5740: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 5741: where all files of the final program shall be installed. It is
5742: usually set to <code class="varname">LOCALBASE</code>
5743: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 5744: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 5745: <code class="varname">PREFIX</code> needs to be put
5746: into the various places in the program's source where paths to
1.267 rillig 5747: 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.75 rillig 5748: <p>When choosing which of these variables to use,
1.87 wiz 5749: follow the following rules:</p>
1.148 asau 5750: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 5751: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88 wiz 5752: where the current pkg will be installed. When referring to a
5753: pkg's own installation path, use
1.128 wiz 5754: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
5755: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88 wiz 5756: are installed. If you need to construct a -I or -L argument
5757: to the compiler to find includes and libraries installed by
1.128 wiz 5758: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.87 wiz 5759: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
5760: installed all packages in <code class="filename">/usr/local</code>. As
5761: pkgsrc leaves <code class="filename">/usr/local</code> for the system
5762: administrator, this variable is a misnomer.</p></li>
1.128 wiz 5763: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88 wiz 5764: distribution (from xsrc, etc.) is installed. When looking for
5765: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128 wiz 5766: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.209 sevan 5767: <li class="listitem"><p>X11-based packages using imake must set
5768: <code class="varname">USE_IMAKE</code> to be installed correctly under
5769: <code class="varname">LOCALBASE</code>.</p></li>
1.128 wiz 5770: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.270 leot 5771: 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.87 wiz 5772: manual pages go into <code class="filename">${PREFIX}/man</code>, not
5773: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 5774: </ul></div>
5775: </div>
1.148 asau 5776: <div class="sect1">
1.75 rillig 5777: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5778: <a name="build.builddirs"></a>19.3. Directories used during the build process</h2></div></div></div>
1.114 jmcneill 5779: <p>When building a package, various directories are used to store
1.87 wiz 5780: source files, temporary files, pkgsrc-internal files, and so on. These
5781: directories are explained here.</p>
1.75 rillig 5782: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 5783: are two common base directories for these relative directories:
5784: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
5785: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
5786: inside the package itself.</p>
1.148 asau 5787: <div class="variablelist"><dl class="variablelist">
1.75 rillig 5788: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
5789: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 5790: root directory. Generally, you don't need
5791: it.</p></dd>
1.97 rillig 5792: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
5793: <dd><p>This is an absolute pathname that points to the
5794: current package.</p></dd>
1.75 rillig 5795: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
5796: <dd><p>This is a pathname relative to
1.87 wiz 5797: <code class="varname">PKGSRCDIR</code> that points to the current
5798: package.</p></dd>
1.75 rillig 5799: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
5800: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 5801: where all work takes place. The distfiles are extracted to this
1.87 wiz 5802: directory. It also contains temporary directories and log files used by
5803: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
5804: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 5805: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
5806: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 5807: where the distfiles are extracted. It is usually a direct subdirectory
5808: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
5809: that isn't hidden. This variable may be changed by a package
5810: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 5811: </dl></div>
1.114 jmcneill 5812: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
5813: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116 rillig 5814: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114 jmcneill 5815: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
5816: If users would like to have their pkgsrc trees behave in a
5817: read-only manner, then the value of
5818: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
5819: <span class="emphasis"><em>no</em></span>.</p>
1.75 rillig 5820: </div>
1.148 asau 5821: <div class="sect1">
1.75 rillig 5822: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5823: <a name="build.running"></a>19.4. Running a phase</h2></div></div></div>
1.110 hubertf 5824: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 5825: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
5826: phase. This will automatically run all phases that are required for this
5827: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 5828: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 5829: the package will be built, but not installed.</p>
1.75 rillig 5830: </div>
1.148 asau 5831: <div class="sect1">
1.75 rillig 5832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 5833: <a name="build.fetch"></a>19.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 5834: <p>The first step in building a package is to fetch the
1.88 wiz 5835: distribution files (distfiles) from the sites that are providing
5836: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
5837: phase.</p>
1.148 asau 5838: <div class="sect2">
1.81 rillig 5839: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 5840: <a name="build.fetch.what"></a>19.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88 wiz 5841: <p>In simple cases, <code class="varname">MASTER_SITES</code>
5842: defines all URLs from where the distfile, whose name is
5843: derived from the <code class="varname">DISTNAME</code> variable, is
5844: fetched. The more complicated cases are described
5845: below.</p>
5846: <p>The variable <code class="varname">DISTFILES</code> specifies
5847: the list of distfiles that have to be fetched. Its value
1.174 asau 5848: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
5849: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88 wiz 5850: so that most packages don't need to define it at all.
5851: <code class="varname">EXTRACT_SUFX</code> is
5852: <code class="literal">.tar.gz</code> by default, but can be changed
5853: freely. Note that if your package requires additional
5854: distfiles to the default one, you cannot just append the
5855: additional filenames using the <code class="literal">+=</code>
5856: operator, but you have write for example:</p>
1.81 rillig 5857: <pre class="programlisting">
1.174 asau 5858: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100 rillig 5859: </pre>
1.88 wiz 5860: <p>Each distfile is fetched from a list of sites, usually
5861: <code class="varname">MASTER_SITES</code>. If the package has multiple
5862: <code class="varname">DISTFILES</code> or multiple
5863: <code class="varname">PATCHFILES</code> from different sites, you can
5864: set
5865: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
5866: to the list of URLs where the file
5867: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
5868: (including the suffix) can be found.</p>
5869: <pre class="programlisting">
1.100 rillig 5870: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5871: DISTFILES+= foo-file.tar.gz
5872: SITES.foo-file.tar.gz= \
5873: http://www.somewhere.com/somehow/ \
5874: http://www.somewhereelse.com/mirror/somehow/
5875: </pre>
1.81 rillig 5876: <p>When actually fetching the distfiles, each item from
1.88 wiz 5877: <code class="varname">MASTER_SITES</code> or
5878: <code class="varname">SITES.*</code> gets the name of each distfile
5879: appended to it, without an intermediate slash. Therefore,
5880: all site values have to end with a slash or other separator
5881: character. This allows for example to set
5882: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
5883: that gets the name of the distfile as a parameter. In this
5884: case, the definition would look like:</p>
1.81 rillig 5885: <pre class="programlisting">
1.100 rillig 5886: MASTER_SITES= http://www.example.com/download.cgi?file=
5887: </pre>
1.125 wiz 5888: <p> The exception to this rule are URLs starting with a dash.
1.174 asau 5889: In that case the URL is taken as is, fetched and the result
5890: stored under the name of the distfile. You can use this style
5891: for the case when the download URL style does not match the
5892: above common case. For example, if permanent download URL is a
5893: redirector to the real download URL, or the download file name
5894: is offered by an HTTP Content-Disposition header. In the
5895: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
5896: created instead of the default
5897: <code class="filename">v1.0.0.tar.gz</code>.</p>
5898: <pre class="programlisting">
5899: DISTNAME= foo-1.0.0
5900: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
5901: </pre>
1.81 rillig 5902: <p>There are some predefined values for
1.88 wiz 5903: <code class="varname">MASTER_SITES</code>, which can be used in
5904: packages. The names of the variables should speak for
5905: themselves.</p>
1.269 leot 5906: <table border="0" summary="Simple list" class="simplelist">
5907: <tr>
5908: <td>MASTER_SITE_APACHE</td>
5909: <td>MASTER_SITE_BACKUP</td>
5910: </tr>
5911: <tr>
5912: <td>MASTER_SITE_CRATESIO</td>
5913: <td>MASTER_SITE_CYGWIN</td>
5914: </tr>
5915: <tr>
5916: <td>MASTER_SITE_DEBIAN</td>
5917: <td>MASTER_SITE_FREEBSD</td>
5918: </tr>
5919: <tr>
5920: <td>MASTER_SITE_FREEBSD_LOCAL</td>
5921: <td>MASTER_SITE_GENTOO</td>
5922: </tr>
5923: <tr>
5924: <td>MASTER_SITE_GITHUB</td>
5925: <td>MASTER_SITE_GNOME</td>
5926: </tr>
5927: <tr>
5928: <td>MASTER_SITE_GNU</td>
5929: <td>MASTER_SITE_GNUSTEP</td>
5930: </tr>
5931: <tr>
5932: <td>MASTER_SITE_HASKELL_HACKAGE</td>
5933: <td>MASTER_SITE_IFARCHIVE</td>
5934: </tr>
5935: <tr>
5936: <td>MASTER_SITE_KDE</td>
5937: <td>MASTER_SITE_MOZILLA</td>
5938: </tr>
5939: <tr>
5940: <td>MASTER_SITE_MOZILLA_ALL</td>
5941: <td>MASTER_SITE_MYSQL</td>
5942: </tr>
5943: <tr>
5944: <td>MASTER_SITE_NETLIB</td>
5945: <td>MASTER_SITE_OPENBSD</td>
5946: </tr>
5947: <tr>
5948: <td>MASTER_SITE_OPENOFFICE</td>
5949: <td>MASTER_SITE_OSDN</td>
5950: </tr>
5951: <tr>
5952: <td>MASTER_SITE_PERL_CPAN</td>
5953: <td>MASTER_SITE_PGSQL</td>
5954: </tr>
5955: <tr>
5956: <td>MASTER_SITE_PYPI</td>
5957: <td>MASTER_SITE_RUBYGEMS</td>
5958: </tr>
5959: <tr>
5960: <td>MASTER_SITE_R_CRAN</td>
5961: <td>MASTER_SITE_SOURCEFORGE</td>
5962: </tr>
5963: <tr>
5964: <td>MASTER_SITE_SUNSITE</td>
5965: <td>MASTER_SITE_SUSE</td>
5966: </tr>
5967: <tr>
5968: <td>MASTER_SITE_TEX_CTAN</td>
5969: <td>MASTER_SITE_XCONTRIB</td>
5970: </tr>
5971: <tr>
5972: <td>MASTER_SITE_XEMACS</td>
5973: <td>MASTER_SITE_XORG</td>
5974: </tr>
5975: </table>
1.88 wiz 5976: <p>Some explanations for the less self-explaining ones:
5977: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133 wiz 5978: 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.132 spz 5979: 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.88 wiz 5980: <p>If you choose one of these predefined sites, you may
5981: want to specify a subdirectory of that site. Since these
5982: macros may expand to more than one actual site, you
5983: <span class="emphasis"><em>must</em></span> use the following construct to
5984: specify a subdirectory:</p>
1.81 rillig 5985: <pre class="programlisting">
1.100 rillig 5986: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
5987: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
5988: </pre>
1.81 rillig 5989: <p>Note the trailing slash after the subdirectory
1.88 wiz 5990: name.</p>
1.81 rillig 5991: </div>
1.148 asau 5992: <div class="sect2">
1.81 rillig 5993: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 5994: <a name="build.fetch.how"></a>19.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 5995: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
5996: all the distfiles exist in a local directory
1.93 rillig 5997: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 5998: user). If the files do not exist, they are fetched using
5999: commands of the form</p>
1.75 rillig 6000: <pre class="programlisting">
1.100 rillig 6001: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6002: </pre>
1.88 wiz 6003: <p>where <code class="literal">${site}</code> varies through
6004: several possibilities in turn: first,
6005: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6006: sites specified in either <code class="varname">SITES.file</code> if
6007: defined, else <code class="varname">MASTER_SITES</code> or
6008: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6009: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6010: all except the first and the last can be optionally sorted
6011: by the user, via setting either
6012: <code class="varname">MASTER_SORT_RANDOM</code>, and
6013: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6014: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117 jnemeth 6015: <p> The specific command and arguments used depend on the
6016: <code class="varname">FETCH_USING</code> parameter. The example above is
6017: for <code class="literal">FETCH_USING=custom</code>.</p>
1.97 rillig 6018: <p>The distfiles mirror run by the NetBSD Foundation uses the
6019: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6020: distfiles, if they are freely distributable. Packages setting
6021: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128 wiz 6022: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.97 rillig 6023: mirrored.</p>
1.81 rillig 6024: </div>
1.75 rillig 6025: </div>
1.148 asau 6026: <div class="sect1">
1.75 rillig 6027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6028: <a name="build.checksum"></a>19.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6029: <p>After the distfile(s) are fetched, their checksum is
6030: generated and compared with the checksums stored in the
6031: distinfo file. If the checksums don't match, the build is
6032: aborted. This is to ensure the same distfile is used for
6033: building, and that the distfile wasn't changed, e.g. by some
6034: malign force, deliberately changed distfiles on the master
6035: distribution site or network lossage.</p>
1.75 rillig 6036: </div>
1.148 asau 6037: <div class="sect1">
1.75 rillig 6038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6039: <a name="build.extract"></a>19.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6040: <p>When the distfiles are present on the local system, they
1.88 wiz 6041: need to be extracted, as they usually come in the form of some
6042: compressed archive format.</p>
1.75 rillig 6043: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6044: extracted. If you only need some of them, you can set the
6045: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6046: files.</p>
6047: <p>Extracting the files is usually done by a little
1.93 rillig 6048: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6049: already knows how to extract various archive formats, so most
6050: likely you will not need to change anything here. But if you
6051: need, the following variables may help you:</p>
1.148 asau 6052: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6053: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6054: <dd><p>Use these variables to override the default
1.88 wiz 6055: options for an extract command, which are defined in
1.93 rillig 6056: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6057: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6058: <dd><p>This variable can be set to
1.114 jmcneill 6059: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6060: (which is the default value), <code class="literal">pax</code>, or an
1.88 wiz 6061: absolute pathname pointing to the command with which tar
1.114 jmcneill 6062: archives should be extracted. It is preferred to choose bsdtar over gtar
6063: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75 rillig 6064: </dl></div>
1.88 wiz 6065: <p>If the <code class="filename">extract</code> program doesn't
6066: serve your needs, you can also override the
6067: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6068: command used for extracting the files. This command is
6069: executed in the <code class="filename">${WRKSRC}</code>
6070: directory. During execution of this command, the shell
6071: variable <code class="varname">extract_file</code> holds the absolute
6072: pathname of the file that is going to be extracted.</p>
1.75 rillig 6073: <p>And if that still does not suffice, you can override the
1.88 wiz 6074: <code class="varname">do-extract</code> target in the package
6075: Makefile.</p>
1.75 rillig 6076: </div>
1.148 asau 6077: <div class="sect1">
1.75 rillig 6078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6079: <a name="build.patch"></a>19.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6080: <p>After extraction, all the patches named by the
1.88 wiz 6081: <code class="varname">PATCHFILES</code>, those present in the patches
6082: subdirectory of the package as well as in
6083: $LOCALPATCHES/$PKGPATH (e.g.
6084: <code class="filename">/usr/local/patches/graphics/png</code>) are
6085: applied. Patchfiles ending in <code class="filename">.Z</code> or
6086: <code class="filename">.gz</code> are uncompressed before they are
6087: applied, files ending in <code class="filename">.orig</code> or
6088: <code class="filename">.rej</code> are ignored. Any special options to
1.270 leot 6089: <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.267 rillig 6090: <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.270 leot 6091: <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.88 wiz 6092: it fail if the patches apply with some lines of fuzz. Please
6093: fix (regen) the patches so that they apply cleanly. The
6094: rationale behind this is that patches that don't apply cleanly
6095: may end up being applied in the wrong place, and cause severe
6096: harm there.</p>
1.75 rillig 6097: </div>
1.148 asau 6098: <div class="sect1">
1.75 rillig 6099: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6100: <a name="build.tools"></a>19.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6101: <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.88 wiz 6102: </p>
1.75 rillig 6103: </div>
1.148 asau 6104: <div class="sect1">
1.75 rillig 6105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6106: <a name="build.wrapper"></a>19.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6107: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6108: linkers. The following variables can be used to tweak the
6109: wrappers.</p>
1.148 asau 6110: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6111: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6112: <dd><p>The command used to print progress
1.88 wiz 6113: messages. Does nothing by default. Set to
6114: <code class="literal">${ECHO}</code> to see the progress
6115: messages.</p></dd>
1.75 rillig 6116: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6117: <dd><p>This variable can be set to
1.88 wiz 6118: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6119: depending on whether you want additional information in the
6120: wrapper log file.</p></dd>
1.75 rillig 6121: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6122: <dd><p>This variable can be set to
1.88 wiz 6123: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6124: on whether the wrapper should use its cache, which will
6125: improve the speed. The default value is
6126: <code class="literal">yes</code>, but is forced to
6127: <code class="literal">no</code> if the platform does not support
6128: it.</p></dd>
1.75 rillig 6129: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6130: <dd><p>A list of reordering commands. A reordering
6131: command has the form
6132: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6133: It ensures that that
6134: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6135: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6136: </p></dd>
1.75 rillig 6137: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6138: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6139: investigate further]</p></dd>
1.75 rillig 6140: </dl></div>
6141: </div>
1.148 asau 6142: <div class="sect1">
1.75 rillig 6143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6144: <a name="build.configure"></a>19.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6145: <p>Most pieces of software need information on the header
6146: files, system calls, and library routines which are available
6147: on the platform they run on. The process of determining this
6148: information is known as configuration, and is usually
6149: automated. In most cases, a script is supplied with the
6150: distfiles, and its invocation results in generation of header
6151: files, Makefiles, etc.</p>
6152: <p>If the package contains a configure script, this can be
6153: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128 wiz 6154: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.88 wiz 6155: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128 wiz 6156: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.88 wiz 6157: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6158: <pre class="programlisting">
1.100 rillig 6159: .for d in ${CONFIGURE_DIRS}
6160: cd ${WRKSRC} \
6161: && cd ${d} \
6162: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6163: .endfor
6164: </pre>
1.88 wiz 6165: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128 wiz 6166: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6167: <code class="varname">WRKSRC</code>. In each of these directories, the
6168: configure script is run with the environment
6169: <code class="varname">CONFIGURE_ENV</code> and arguments
6170: <code class="varname">CONFIGURE_ARGS</code>. The variables
6171: <code class="varname">CONFIGURE_ENV</code>,
6172: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128 wiz 6173: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.88 wiz 6174: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6175: package.</p>
1.144 wiz 6176: <p>If the program uses the Perl way of configuration (mainly Perl
6177: modules, but not only), i.e. a file called
6178: <code class="filename">Makefile.PL</code>, it should include
6179: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6180: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6181: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88 wiz 6182: <p>If the program uses an <code class="filename">Imakefile</code>
6183: for configuration, the appropriate steps can be invoked by
6184: setting <code class="varname">USE_IMAKE</code> to
1.209 sevan 6185: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6186: You can add variables to xmkmf's environment by adding them to the
1.97 rillig 6187: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6188: <p>If the program uses <code class="filename">cmake</code>
6189: for configuration, the appropriate steps can be invoked by
1.128 wiz 6190: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.111 rillig 6191: You can add variables to cmake's environment by adding them to the
6192: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6193: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6194: The top directory argument is given by the
6195: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128 wiz 6196: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6197: <p>If there is no configure step at all, set
1.128 wiz 6198: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6199: </div>
1.148 asau 6200: <div class="sect1">
1.75 rillig 6201: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6202: <a name="build.build"></a>19.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6203: <p>For building a package, a rough equivalent of the
6204: following code is executed.</p>
1.75 rillig 6205: <pre class="programlisting">
1.100 rillig 6206: .for d in ${BUILD_DIRS}
6207: cd ${WRKSRC} \
6208: && cd ${d} \
6209: && env ${MAKE_ENV} \
6210: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6211: -f ${MAKE_FILE} \
6212: ${BUILD_TARGET}
6213: .endfor
6214: </pre>
1.88 wiz 6215: <p><code class="varname">BUILD_DIRS</code> (default:
1.128 wiz 6216: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.88 wiz 6217: <code class="varname">WRKSRC</code>. In each of these directories,
6218: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6219: <code class="varname">MAKE_ENV</code> and arguments
6220: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6221: <code class="varname">MAKE_ENV</code>,
6222: <code class="varname">BUILD_MAKE_FLAGS</code>,
6223: <code class="varname">MAKE_FILE</code> and
6224: <code class="varname">BUILD_TARGET</code> may all be changed by the
6225: package.</p>
1.75 rillig 6226: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128 wiz 6227: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6228: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.88 wiz 6229: default value of <code class="varname">MAKE_FILE</code> is
1.128 wiz 6230: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6231: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.97 rillig 6232: <p>If there is no build step at all, set
1.128 wiz 6233: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.75 rillig 6234: </div>
1.148 asau 6235: <div class="sect1">
1.75 rillig 6236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6237: <a name="build.test"></a>19.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6238: <p>[TODO]</p>
6239: </div>
1.148 asau 6240: <div class="sect1">
1.75 rillig 6241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6242: <a name="build.install"></a>19.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6243: <p>Once the build stage has completed, the final step is to
1.88 wiz 6244: install the software in public directories, so users can
6245: access the programs and files.</p>
1.75 rillig 6246: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6247: equivalent of the following code is executed. Additionally,
6248: before and after this code, much magic is performed to do
6249: consistency checks, registering the package, and so on.</p>
6250: <pre class="programlisting">
1.100 rillig 6251: .for d in ${INSTALL_DIRS}
6252: cd ${WRKSRC} \
6253: && cd ${d} \
6254: && env ${MAKE_ENV} \
6255: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6256: -f ${MAKE_FILE} \
6257: ${INSTALL_TARGET}
6258: .endfor
6259: </pre>
1.75 rillig 6260: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6261: <span class="emphasis"><em>build</em></span> phase.
6262: <code class="varname">INSTALL_DIRS</code> defaults to
6263: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128 wiz 6264: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6265: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.88 wiz 6266: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6267: defined.</p>
1.75 rillig 6268: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6269: variables are useful. They are all variations of the
1.270 leot 6270: <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.88 wiz 6271: permissions preset. <code class="varname">INSTALL</code> is the plain
6272: install command. The specialized variants, together with their
6273: intended use, are:</p>
1.148 asau 6274: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6275: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6276: <dd><p>directories that contain
6277: binaries</p></dd>
1.75 rillig 6278: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6279: <dd><p>directories that contain
6280: scripts</p></dd>
1.75 rillig 6281: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6282: <dd><p>directories that contain shared and static
6283: libraries</p></dd>
1.75 rillig 6284: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6285: <dd><p>directories that contain data
6286: files</p></dd>
1.75 rillig 6287: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6288: <dd><p>directories that contain man
6289: pages</p></dd>
1.210 leot 6290: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6291: <dd><p>directories that contain data files for games
6292: </p></dd>
1.75 rillig 6293: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6294: <dd><p>binaries that can be stripped from debugging
6295: symbols</p></dd>
1.75 rillig 6296: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6297: <dd><p>binaries that cannot be
6298: stripped</p></dd>
1.75 rillig 6299: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6300: <dd><p>game
6301: binaries</p></dd>
1.75 rillig 6302: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6303: <dd><p>shared and static
6304: libraries</p></dd>
1.75 rillig 6305: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6306: <dd><p>data files</p></dd>
6307: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6308: <dd><p>data files for
6309: games</p></dd>
1.75 rillig 6310: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6311: <dd><p>man pages</p></dd>
6312: </dl></div>
6313: <p>Some other variables are:</p>
1.148 asau 6314: <div class="variablelist"><dl class="variablelist">
1.216 tnn 6315: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.270 leot 6316: <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.216 tnn 6317: when installing binaries. Any debugging sections and symbols present in
6318: binaries will be preserved.
6319: </p></dd>
1.75 rillig 6320: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6321: <dd><p>A list of directories relative to
1.88 wiz 6322: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 6323: beginning of the <span class="emphasis"><em>install</em></span> phase.
6324: The package is supposed to create all needed directories itself
6325: before installing files to it and list all other directories here.
6326: </p></dd>
1.75 rillig 6327: </dl></div>
1.97 rillig 6328: <p>In the rare cases that a package shouldn't install anything,
1.128 wiz 6329: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.97 rillig 6330: mostly relevant for packages in the <code class="filename">regress</code>
6331: category.</p>
1.75 rillig 6332: </div>
1.148 asau 6333: <div class="sect1">
1.75 rillig 6334: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6335: <a name="build.package"></a>19.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6336: <p>Once the install stage has completed, a binary package of
6337: the installed files can be built. These binary packages can be
6338: used for quick installation without previous compilation, e.g. by
1.110 hubertf 6339: the <span class="command"><strong>make bin-install</strong></span> or by using
6340: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 6341: <p>By default, the binary packages are created in
6342: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6343: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6344: one for each category in the <code class="varname">CATEGORIES</code>
6345: variable. <code class="varname">PACKAGES</code> defaults to
6346: <code class="filename">pkgsrc/packages</code>.</p>
6347: </div>
1.148 asau 6348: <div class="sect1">
1.88 wiz 6349: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6350: <a name="build.clean"></a>19.16. Cleaning up</h2></div></div></div>
1.88 wiz 6351: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 6352: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 6353: to clean the work directories of all dependencies too, use
1.110 hubertf 6354: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 6355: </div>
1.148 asau 6356: <div class="sect1">
1.75 rillig 6357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6358: <a name="build.helpful-targets"></a>19.17. Other helpful targets</h2></div></div></div>
1.148 asau 6359: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6360: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 6361: <dd><p>For any of the main targets described in the
6362: previous section, two auxiliary targets exist with
1.128 wiz 6363: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.87 wiz 6364: prefix for the main target's name. These targets are
1.88 wiz 6365: invoked before and after the main target is called,
6366: allowing extra configuration or installation steps be
6367: performed from a package's Makefile, for example, which
6368: a program's configure script or install target
6369: omitted.</p></dd>
1.75 rillig 6370: <dt><span class="term">do-*</span></dt>
1.88 wiz 6371: <dd><p>Should one of the main targets do the wrong thing,
6372: and should there be no variable to fix this, you can
6373: redefine it with the do-* target. (Note that redefining
6374: the target itself instead of the do-* target is a bad
6375: idea, as the pre-* and post-* targets won't be called
6376: anymore, etc.) You will not usually need to do
6377: this.</p></dd>
1.75 rillig 6378: <dt><span class="term">reinstall</span></dt>
1.88 wiz 6379: <dd>
1.110 hubertf 6380: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 6381: you noticed some file was not installed properly, you
6382: can repeat the installation with this target, which will
1.128 wiz 6383: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.88 wiz 6384: <p>This is the default value of
6385: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 6386: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 6387: package</strong></span>, where the defaults are
1.128 wiz 6388: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.88 wiz 6389: respectively.</p>
6390: </dd>
1.75 rillig 6391: <dt><span class="term">deinstall</span></dt>
6392: <dd>
1.270 leot 6393: <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.88 wiz 6394: current directory, effectively de-installing the
6395: package. The following variables can be used to tune the
6396: behaviour:</p>
1.148 asau 6397: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6398: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.270 leot 6399: <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.75 rillig 6400: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 6401: <dd><p>Remove all packages that require (depend on)
6402: the given package. This can be used to remove any
6403: packages that may have been pulled in by a given
1.110 hubertf 6404: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 6405: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 6406: <code class="filename">pkgsrc/x11/kde</code>, this is
6407: likely to remove whole KDE. Works by adding
1.270 leot 6408: <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.88 wiz 6409: command line.</p></dd>
1.75 rillig 6410: </dl></div>
6411: </dd>
1.88 wiz 6412: <dt><span class="term">bin-install</span></dt>
6413: <dd><p>Install a binary package from local disk and via FTP
6414: from a list of sites (see the
6415: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 6416: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 6417: available anywhere. The arguments given to
1.110 hubertf 6418: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 6419: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6420: operation, etc.</p></dd>
1.205 wiz 6421: <dt><span class="term">install-clean</span></dt>
6422: <dd><p>This target removes the state files for the "install" and later
6423: phases so that the "install" target may be re-invoked. This can be
6424: used after editing the PLIST to install the package without
6425: rebuilding it.</p></dd>
6426: <dt><span class="term">build-clean</span></dt>
6427: <dd><p>This target removes the state files for the "build" and later
6428: phases so that the "build" target may be re-invoked.</p></dd>
1.75 rillig 6429: <dt><span class="term">update</span></dt>
6430: <dd>
1.88 wiz 6431: <p>This target causes the current package to be
6432: updated to the latest version. The package and all
6433: depending packages first get de-installed, then current
6434: versions of the corresponding packages get compiled and
6435: installed. This is similar to manually noting which
6436: packages are currently installed, then performing a
1.110 hubertf 6437: series of <span class="command"><strong>make deinstall</strong></span> and
6438: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 6439: <code class="varname">UPDATE_TARGET</code> is set to) for these
6440: packages.</p>
1.128 wiz 6441: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.110 hubertf 6442: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 6443: update</strong></span> was interrupted for some reason.
6444: However, in this case, make sure you don't call
1.110 hubertf 6445: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 6446: list of dependent packages in <code class="varname">WRKDIR</code>.
6447: Otherwise, you lose the ability to automatically update
6448: the current package along with the dependent packages
6449: you have installed.</p>
1.110 hubertf 6450: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 6451: update</strong></span> will only work as long as the package
6452: tree remains unchanged. If the source code for one of
6453: the packages to be updated has been changed, resuming
1.110 hubertf 6454: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 6455: fail!</p>
6456: <p>The following variables can be used either on the
1.110 hubertf 6457: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6458: alter the behaviour of <span class="command"><strong>make
1.88 wiz 6459: update</strong></span>:</p>
1.148 asau 6460: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6461: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 6462: <dd><p>Install target to recursively use for the
6463: updated package and the dependent packages.
6464: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128 wiz 6465: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.110 hubertf 6466: <span class="command"><strong>make update</strong></span>. Other good
1.128 wiz 6467: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6468: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6469: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.88 wiz 6470: endless loop!</p></dd>
1.75 rillig 6471: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 6472: <dd><p>Don't clean up after updating. Useful if
6473: you want to leave the work sources of the updated
6474: packages around for inspection or other purposes.
6475: Be sure you eventually clean up the source tree
1.128 wiz 6476: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.88 wiz 6477: or you may run into troubles with old source code
6478: still lying around on your next
1.110 hubertf 6479: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 6480: update</strong></span>.</p></dd>
1.75 rillig 6481: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 6482: <dd><p>Deinstall each package before installing
6483: (making <code class="varname">DEPENDS_TARGET</code>). This
6484: may be necessary if the
1.128 wiz 6485: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.110 hubertf 6486: called after interrupting a running <span class="command"><strong>make
1.88 wiz 6487: update</strong></span>.</p></dd>
1.75 rillig 6488: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 6489: <dd><p>Allows you to disable recursion and hardcode
6490: the target for packages. The default is
1.128 wiz 6491: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.88 wiz 6492: facilitating a recursive update of prerequisite
6493: packages. Only set
6494: <code class="varname">DEPENDS_TARGET</code> if you want to
6495: disable recursive updates. Use
6496: <code class="varname">UPDATE_TARGET</code> instead to just
6497: set a specific target for each package to be
1.110 hubertf 6498: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 6499: (see above).</p></dd>
1.75 rillig 6500: </dl></div>
6501: </dd>
6502: <dt><span class="term">clean-update</span></dt>
6503: <dd>
1.88 wiz 6504: <p>Clean the source tree for all packages that would
1.110 hubertf 6505: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 6506: from the current directory. This target should not be
6507: used if the current package (or any of its depending
6508: packages) have already been de-installed (e.g., after
1.110 hubertf 6509: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 6510: some packages you intended to update. As a rule of
6511: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 6512: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 6513: and only if you have a dirty package tree (e.g., if you
6514: used <code class="varname">NOCLEAN</code>).</p>
6515: <p>If you are unsure about whether your tree is
1.110 hubertf 6516: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 6517: clean</strong></span> at the top of the tree, or use the
6518: following sequence of commands from the directory of the
6519: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 6520: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 6521: time, otherwise you lose all the packages you wanted to
6522: update!):</p>
1.87 wiz 6523: <pre class="screen">
6524: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 6525: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 6526: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6527: </pre>
1.88 wiz 6528: <p>The following variables can be used either on the
1.110 hubertf 6529: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6530: <span class="command"><strong>make clean-update</strong></span>:</p>
1.148 asau 6531: <div class="variablelist"><dl class="variablelist">
1.75 rillig 6532: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 6533: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 6534: reconstruct the list of directories to update for
1.110 hubertf 6535: this package. Only use this if <span class="command"><strong>make
1.88 wiz 6536: update</strong></span> successfully installed all
6537: packages you wanted to update. Normally, this is
1.110 hubertf 6538: done automatically on <span class="command"><strong>make
1.88 wiz 6539: update</strong></span>, but may have been suppressed by
6540: the <code class="varname">NOCLEAN</code> variable (see
6541: above).</p></dd>
1.75 rillig 6542: </dl></div>
6543: </dd>
1.88 wiz 6544: <dt><span class="term">replace</span></dt>
6545: <dd>
6546: <p>Update the installation of the current package. This
6547: differs from update in that it does not replace dependent
1.250 leot 6548: 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.88 wiz 6549: target to work.</p>
6550: <p><span class="emphasis"><em>Be careful when using this
6551: target!</em></span> There are no guarantees that dependent
6552: packages will still work, in particular they will most
1.110 hubertf 6553: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 6554: library package whose shared library major version changed
6555: between your installed version and the new one. For this
6556: reason, this target is not officially supported and only
6557: recommended for advanced users.</p>
6558: </dd>
1.75 rillig 6559: <dt><span class="term">info</span></dt>
1.270 leot 6560: <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.88 wiz 6561: package. You can use this to check which version of a
6562: package is installed.</p></dd>
6563: <dt><span class="term">index</span></dt>
6564: <dd>
6565: <p>This is a top-level command, i.e. it should be used in
6566: the <code class="filename">pkgsrc</code> directory. It creates a
6567: database of all packages in the local pkgsrc tree, including
6568: dependencies, comment, maintainer, and some other useful
6569: information. Individual entries are created by running
1.110 hubertf 6570: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 6571: directories. This index file is saved as
6572: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 6573: verbose format by running <span class="command"><strong>make
1.88 wiz 6574: print-index</strong></span>. You can search in it with
1.110 hubertf 6575: <span class="command"><strong>make search
1.88 wiz 6576: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6577: extract a list of all packages that depend on a particular
1.110 hubertf 6578: one by running <span class="command"><strong>make show-deps
1.88 wiz 6579: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6580: <p>Running this command takes a very long time, some
6581: hours even on fast machines!</p>
6582: </dd>
1.75 rillig 6583: <dt><span class="term">readme</span></dt>
1.88 wiz 6584: <dd>
6585: <p>This target generates a
6586: <code class="filename">README.html</code> file, which can be
1.250 leot 6587: 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.88 wiz 6588: contain references to any packages which are in the
6589: <code class="varname">PACKAGES</code> directory on the local
6590: host. The generated files can be made to refer to URLs
6591: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6592: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6593: wanted to generate <code class="filename">README.html</code>
6594: files which pointed to binary packages on the local
6595: machine, in the directory
6596: <code class="filename">/usr/packages</code>, set
6597: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6598: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6599: <code class="varname">${PACKAGES}</code> directory and its
6600: subdirectories will be searched for all the binary
6601: packages.</p>
6602: <p>The target can be run at the toplevel or in category
6603: directories, in which case it descends recursively.</p>
6604: </dd>
1.75 rillig 6605: <dt><span class="term">readme-all</span></dt>
1.88 wiz 6606: <dd><p>This is a top-level command, run it in
6607: <code class="filename">pkgsrc</code>. Use this target to create a
6608: file <code class="filename">README-all.html</code> which contains a
6609: list of all packages currently available in the NetBSD
6610: Packages Collection, together with the category they belong
6611: to and a short description. This file is compiled from the
6612: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 6613: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 6614: readme</strong></span>.</p></dd>
1.75 rillig 6615: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 6616: <dd><p>This is very much the same as the
1.128 wiz 6617: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.88 wiz 6618: used when generating a pkgsrc tree to be written to a
6619: CD-ROM. This target also produces
6620: <code class="filename">README.html</code> files, and can be made
6621: to refer to URLs based on
6622: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 6623: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 6624: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 6625: <dd><p>This target shows which distfiles and patchfiles
6626: are needed to build the package
6627: (<code class="varname">ALLFILES</code>, which contains all
6628: <code class="varname">DISTFILES</code> and
1.87 wiz 6629: <code class="varname">PATCHFILES</code>, but not
6630: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 6631: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 6632: <dd><p>This target shows nothing if the package is not
6633: installed. If a version of this package is installed,
6634: but is not the version provided in this version of
6635: pkgsrc, then a warning message is displayed. This target
6636: can be used to show which of your installed packages are
6637: downlevel, and so the old versions can be deleted, and
6638: the current ones added.</p></dd>
1.75 rillig 6639: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 6640: <dd><p>This target shows the directory in the pkgsrc
6641: hierarchy from which the package can be built and
6642: installed. This may not be the same directory as the one
6643: from which the package was installed. This target is
6644: intended to be used by people who may wish to upgrade
6645: many packages on a single host, and can be invoked from
6646: the top-level pkgsrc Makefile by using the
1.128 wiz 6647: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.75 rillig 6648: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 6649: <dd><p>This target shows which installed packages match
6650: the current package's <code class="varname">DEPENDS</code>. Useful
6651: if out of date dependencies are causing build
6652: problems.</p></dd>
1.205 wiz 6653: <dt><span class="term">print-build-depends-list</span></dt>
6654: <dd><p>This target shows the list of packages that the current package
6655: depends on for building.</p></dd>
6656: <dt><span class="term">print-run-depends-list</span></dt>
6657: <dd><p>This target shows the list of packages that the current package
6658: depends on for running.</p></dd>
1.75 rillig 6659: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 6660: <dd><p>After a package is installed, check all its
6661: binaries and (on ELF platforms) shared libraries to see
6662: if they find the shared libs they need. Run by default
1.110 hubertf 6663: 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.75 rillig 6664: <dt><span class="term">print-PLIST</span></dt>
6665: <dd>
1.128 wiz 6666: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.88 wiz 6667: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 6668: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 6669: -newer work/.extract_done</strong></span>. An attempt is made
6670: to care for shared libs etc., but it is
1.87 wiz 6671: <span class="emphasis"><em>strongly</em></span> recommended to review the
6672: result before putting it into
6673: <code class="filename">PLIST</code>. On upgrades, it's useful to
6674: diff the output of this command against an already
6675: existing <code class="filename">PLIST</code> file.</p>
1.270 leot 6676: <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.88 wiz 6677: other methods that don't update file access times, be
6678: sure to add these files manually to your
1.128 wiz 6679: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6680: -newer</span>”</span> command used by this target won't catch
1.87 wiz 6681: them!</p>
1.267 rillig 6682: <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.87 wiz 6683: information on this target.</p>
1.75 rillig 6684: </dd>
6685: <dt><span class="term">bulk-package</span></dt>
6686: <dd>
1.88 wiz 6687: <p>Used to do bulk builds. If an appropriate binary
6688: package already exists, no action is taken. If not, this
6689: target will compile, install and package it (and its
6690: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.267 rillig 6691: 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.174 asau 6692: builds)</i></a>).
1.88 wiz 6693: After creating the binary package, the sources, the
6694: just-installed package and its required packages are
6695: removed, preserving free disk space.</p>
6696: <p><span class="emphasis"><em>Beware that this target may deinstall
6697: all packages installed on a system!</em></span></p>
1.75 rillig 6698: </dd>
6699: <dt><span class="term">bulk-install</span></dt>
6700: <dd>
1.88 wiz 6701: <p>Used during bulk-installs to install required
6702: packages. If an up-to-date binary package is available,
1.270 leot 6703: 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.110 hubertf 6704: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 6705: but the installed binary won't be removed.</p>
1.88 wiz 6706: <p>A binary package is considered
1.128 wiz 6707: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.270 leot 6708: <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.148 asau 6709: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6710: <li class="listitem"><p>None of the package's files
1.88 wiz 6711: (<code class="filename">Makefile</code>, ...) were modified
6712: since it was built.</p></li>
1.128 wiz 6713: <li class="listitem"><p>None of the package's required (binary)
1.88 wiz 6714: packages were modified since it was built.</p></li>
1.75 rillig 6715: </ul></div>
1.88 wiz 6716: <p><span class="emphasis"><em>Beware that this target may deinstall
6717: all packages installed on a system!</em></span></p>
1.75 rillig 6718: </dd>
6719: </dl></div>
6720: </div>
6721: </div>
1.148 asau 6722: <div class="chapter">
1.75 rillig 6723: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 6724: <a name="tools"></a>Chapter 20. Tools needed for building or running</h2></div></div></div>
1.75 rillig 6725: <div class="toc">
6726: <p><b>Table of Contents</b></p>
1.210 leot 6727: <dl class="toc">
1.267 rillig 6728: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
6729: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
6730: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
1.75 rillig 6731: </dl>
6732: </div>
1.87 wiz 6733: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 6734: by pkgsrc and also for individual packages to define what commands
1.269 leot 6735: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
1.75 rillig 6736: or for later run-time of an installed packaged (such as
6737: <code class="varname">DEPENDS</code>).
6738: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 6739: package will not be used.</p>
6740: <p>When building a package, the replacement tools are
1.75 rillig 6741: made available in a directory (as symlinks or wrapper scripts)
6742: that is early in the executable search path. Just like the buildlink
1.87 wiz 6743: system, this helps with consistent builds.</p>
6744: <p>A tool may be needed to help build a specific package. For example,
6745: perl, GNU make (gmake) or yacc may be needed.</p>
6746: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 6747: tool may be inefficient for building a package with pkgsrc.
6748: For example, a package may need GNU awk, bison (instead of
1.87 wiz 6749: yacc) or a better sed.</p>
6750: <p>The tools used by a package can be listed by running
1.110 hubertf 6751: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148 asau 6752: <div class="sect1">
1.75 rillig 6753: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6754: <a name="pkgsrc-tools"></a>20.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 6755: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 6756: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 6757: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6758: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 6759: These can be seen by running:
1.110 hubertf 6760: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 6761: <p>If a package needs a specific program to build
1.75 rillig 6762: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 6763: to define the tools needed.</p>
1.75 rillig 6764: </div>
1.148 asau 6765: <div class="sect1">
1.75 rillig 6766: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6767: <a name="package-tools"></a>20.2. Tools needed by packages</h2></div></div></div>
1.135 wiz 6768: <p>In the following examples, the :run means that it is needed at
6769: run-time (and becomes a DEPENDS).
1.75 rillig 6770: The default is a build dependency which can be set with
6771: :build. (So in this example, it is the same as gmake:build
1.87 wiz 6772: and pkg-config:build.)</p>
1.75 rillig 6773: <pre class="programlisting">
6774: USE_TOOLS+= gmake perl:run pkg-config
6775: </pre>
1.87 wiz 6776: <p>When using the tools framework, a
1.75 rillig 6777: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6778: which contains the full path to the appropriate tool. For example,
1.128 wiz 6779: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.87 wiz 6780: on Linux systems.</p>
6781: <p>If you always need a pkgsrc version of the
1.75 rillig 6782: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6783: </p>
6784: </div>
1.148 asau 6785: <div class="sect1">
1.75 rillig 6786: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6787: <a name="platform-tools"></a>20.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 6788: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 6789: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 6790: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 6791: the name of the common tools. For example:</p>
6792: <pre class="programlisting">
6793: .if exists(/usr/bin/bzcat)
6794: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6795: .elif exists(/usr/bin/bzip2)
6796: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6797: .endif
1.69 rillig 6798:
1.75 rillig 6799: TOOLS_PLATFORM.true?= true # shell builtin
6800: </pre>
6801: </div>
6802: </div>
1.148 asau 6803: <div class="chapter">
1.75 rillig 6804: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 6805: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75 rillig 6806: <div class="toc">
6807: <p><b>Table of Contents</b></p>
1.210 leot 6808: <dl class="toc">
1.267 rillig 6809: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75 rillig 6810: <dd><dl>
1.267 rillig 6811: <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>
6812: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
6813: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
6814: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
6815: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
6816: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
6817: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
6818: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
6819: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
6820: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
6821: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
6822: </dl></dd>
6823: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6824: <dd><dl>
6825: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
6826: <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>
6827: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
6828: </dl></dd>
6829: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6830: <dd><dl>
6831: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
6832: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
6833: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
6834: </dl></dd>
6835: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
6836: <dd><dl>
6837: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
6838: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
6839: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
6840: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
6841: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
6842: </dl></dd>
6843: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6844: <dd><dl>
6845: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
6846: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
6847: <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>
6848: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
6849: </dl></dd>
6850: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6851: <dd><dl>
6852: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
6853: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
6854: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
6855: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
6856: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
6857: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
6858: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
6859: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
6860: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
6861: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
6862: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
6863: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
6864: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
6865: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
6866: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
6867: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
6868: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
6869: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87 wiz 6870: emulation</a></span></dt>
1.267 rillig 6871: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
6872: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 6873: </dl></dd>
1.267 rillig 6874: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75 rillig 6875: </dl>
6876: </div>
1.148 asau 6877: <div class="sect1">
1.75 rillig 6878: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 6879: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78 rillig 6880: <p>One appealing feature of pkgsrc is that it runs on many
1.218 rillig 6881: different platforms. As a result, it is important to ensure,
6882: where possible, that packages in pkgsrc are portable. This
6883: chapter mentions some particular details you should pay
6884: attention to while working on pkgsrc.</p>
1.148 asau 6885: <div class="sect2">
1.78 rillig 6886: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 6887: <a name="pulling-vars-from-etc-mk.conf"></a>21.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93 rillig 6888: </h3></div></div></div>
1.78 rillig 6889: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 6890: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 6891: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 6892: want to use those variables in the preprocessor directives of
1.270 leot 6893: <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.87 wiz 6894: <code class="literal">.for</code>), you need to include the file
6895: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
6896: loads the user preferences.</p>
1.78 rillig 6897: <p>But note that some variables may not be completely defined
1.219 rillig 6898: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
6899: included, as they may contain references to variables that are
6900: not yet defined. In shell commands (the lines in
6901: <code class="filename">Makefile</code> that are indented with a tab) this
6902: is no problem, since variables are only expanded when they are
6903: used. But in the preprocessor directives mentioned above and in
6904: dependency lines (of the form <code class="literal">target:
6905: dependencies</code>) the variables are expanded at load
6906: time.</p>
1.148 asau 6907: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78 rillig 6908: <h3 class="title">Note</h3>
1.218 rillig 6909: <p>To check whether a variable can be used at load time,
6910: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78 rillig 6911: </div>
6912: </div>
1.148 asau 6913: <div class="sect2">
1.78 rillig 6914: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 6915: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88 wiz 6916: <p>Occasionally, packages require interaction from the user,
6917: and this can be in a number of ways:</p>
1.148 asau 6918: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 6919: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87 wiz 6920: interaction such as entering username/password or accepting a
6921: license on a web page.</p></li>
1.128 wiz 6922: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88 wiz 6923: passwords.</p></li>
1.128 wiz 6924: <li class="listitem"><p>help to configure the package before it is built</p></li>
6925: <li class="listitem"><p>help during the build process</p></li>
6926: <li class="listitem"><p>help during the installation of a package</p></li>
1.78 rillig 6927: </ul></div>
1.218 rillig 6928: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
6929: variable to define which stages need interaction. This should be
6930: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 6931: <pre class="programlisting">
1.100 rillig 6932: INTERACTIVE_STAGE= configure install
1.222 sevan 6933: </pre>
1.88 wiz 6934: <p>The user can then decide to skip this package by setting the
1.218 rillig 6935: <code class="varname">BATCH</code> variable. Packages that require interaction
6936: are also excluded from bulk builds.</p>
1.75 rillig 6937: </div>
1.148 asau 6938: <div class="sect2">
1.75 rillig 6939: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 6940: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222 sevan 6941: <p>Authors of software can choose the licence under which software
6942: can be copied. The Free Software Foundation has declared some
6943: licenses "Free", and the Open Source Initiative has a definition of
6944: "Open Source".</p>
6945: <p>By default, pkgsrc allows packages with Free or Open Source
6946: licenses to be built. To allow packages with other licenses to be
6947: built as well, the pkgsrc user needs to add these licenses to the
6948: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
6949: that this variable only affects which packages may be
6950: <span class="emphasis"><em>built</em></span>, while the license terms often also
6951: restrict the actual use of the package and its redistribution.</p>
1.98 wiz 6952: <p>One might want to only install packages with a BSD license,
1.218 rillig 6953: or the GPL, and not the other. The free licenses are added to the
1.222 sevan 6954: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.121 jnemeth 6955: user can override the default by setting the
6956: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222 sevan 6957: of "+=". The licenses accepted by default are defined in the
6958: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
6959: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78 rillig 6960: <p>The license tag mechanism is intended to address
1.87 wiz 6961: copyright-related issues surrounding building, installing and
6962: using a package, and not to address redistribution issues (see
6963: <code class="varname">RESTRICTED</code> and
1.222 sevan 6964: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121 jnemeth 6965: Packages with redistribution restrictions should set these
6966: tags.</p>
1.98 wiz 6967: <p>Denoting that a package may be copied according to a
6968: particular license is done by placing the license in
1.87 wiz 6969: <code class="filename">pkgsrc/licenses</code> and setting the
6970: <code class="varname">LICENSE</code> variable to a string identifying the
1.250 leot 6971: 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.87 wiz 6972: <pre class="programlisting">
1.100 rillig 6973: LICENSE= xv-license
1.222 sevan 6974: </pre>
1.87 wiz 6975: <p>When trying to build, the user will get a notice that the
1.98 wiz 6976: package is covered by a license which has not been placed in the
6977: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 6978: <pre class="programlisting">
1.100 rillig 6979: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
6980: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6981: ===> To view the license, enter "/usr/bin/make show-license".
6982: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6983: ===> ACCEPTABLE_LICENSES+=xv-license
6984: *** Error code 1
1.222 sevan 6985: </pre>
1.110 hubertf 6986: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 6987: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 6988: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 6989: convey to pkgsrc that it should not in the future fail because of
6990: that license:</p>
1.78 rillig 6991: <pre class="programlisting">
1.100 rillig 6992: ACCEPTABLE_LICENSES+=xv-license
1.222 sevan 6993: </pre>
6994: <p>The use of <code class="varname">LICENSE=shareware</code>,
6995: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
6996: is deprecated because it does not crisply refer to a particular
6997: license text. Another problem with such usage is that it does not
6998: enable a user to tell pkgsrc to proceed for a single package
6999: without also telling pkgsrc to proceed for all packages with that
7000: tag.</p>
7001: <div class="sect3">
7002: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7003: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154 rodent 7004: <p>When adding a package with a new license, the following steps
7005: are required:</p>
7006: <div class="orderedlist"><ol class="orderedlist" type="1">
7007: <li class="listitem">
1.222 sevan 7008: <p>Check whether the license qualifies as Free or Open
7009: Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
7010: and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
7011: Open Source Initiative</a>. If this is the case, the filename in
7012: <code class="filename">pkgsrc/licenses/</code> does not need the
7013: <code class="filename">-license</code> suffix, and the license name should be
7014: added to:</p>
1.154 rodent 7015: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7016: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7017: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
7018: </ul></div>
7019: </li>
7020: <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>
7021: </ol></div>
1.222 sevan 7022: </div>
7023: <div class="sect3">
7024: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7025: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98 wiz 7026: <p>When the license changes (in a way other than formatting),
1.222 sevan 7027: make sure that the new license has a different name (e.g.,
1.98 wiz 7028: append the version number if it exists, or the date). Just
7029: because a user told pkgsrc to build programs under a previous
7030: version of a license does not mean that pkgsrc should build
1.99 rillig 7031: programs under the new licenses. The higher-level point is that
1.98 wiz 7032: pkgsrc does not evaluate licenses for reasonableness; the only
7033: test is a mechanistic test of whether a particular text has been
1.222 sevan 7034: approved by either of two bodies (FSF or OSI).</p>
7035: </div>
1.75 rillig 7036: </div>
1.148 asau 7037: <div class="sect2">
1.75 rillig 7038: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7039: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75 rillig 7040: <p>Some licenses restrict how software may be re-distributed.
1.222 sevan 7041: By declaring the restrictions, package tools can
1.98 wiz 7042: automatically refrain from e.g. placing binary packages on FTP
7043: sites.</p>
1.222 sevan 7044: <p>There are four possible restrictions, which are
1.98 wiz 7045: the cross product of sources (distfiles) and binaries not being
7046: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7047: language in any license, and because non-Free licenses tend to be
7048: different from each other, pkgsrc adopts a definition of FTP and
1.222 sevan 7049: CD-ROM.
7050:
7051: "FTP" means making the source or binary file available over the
7052: Internet at no charge.
7053:
7054: "CD-ROM" means making the source or binary available on some kind of
7055: media, together with other source and binary packages, which is sold
7056: for a distribution charge.
1.98 wiz 7057: </p>
7058: <p>In order to encode these restrictions, the package system
1.87 wiz 7059: defines five make variables that can be set to note these
7060: restrictions:</p>
1.148 asau 7061: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7062: <li class="listitem">
1.75 rillig 7063: <p><code class="varname">RESTRICTED</code></p>
7064: <p>This variable should be set whenever a restriction
1.87 wiz 7065: exists (regardless of its kind). Set this variable to a
1.98 wiz 7066: string containing the reason for the restriction. It should
7067: be understood that those wanting to understand the restriction
7068: will have to read the license, and perhaps seek advice of
7069: counsel.</p>
1.75 rillig 7070: </li>
1.128 wiz 7071: <li class="listitem">
1.75 rillig 7072: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7073: <p>Binaries may not be placed on CD-ROM containing other
7074: binary packages, for which a distribution charge may be made.
7075: In this case, set this variable to
7076: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7077: </li>
1.128 wiz 7078: <li class="listitem">
1.75 rillig 7079: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7080: <p>Binaries may not made available on the Internet without
7081: charge. In this case, set this variable to
7082: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7083: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7084: </li>
1.128 wiz 7085: <li class="listitem">
1.75 rillig 7086: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7087: <p>Distfiles may not be placed on CD-ROM, together with
7088: other distfiles, for which a fee may be charged. In this
7089: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7090: </p>
1.75 rillig 7091: </li>
1.128 wiz 7092: <li class="listitem">
1.75 rillig 7093: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7094: <p>Distfiles may not made available via FTP at no charge.
7095: In this case, set this variable to
7096: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7097: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7098: </li>
7099: </ul></div>
1.222 sevan 7100: <p>Please note that packages will be removed from pkgsrc when the
7101: distfiles are not distributable and cannot be obtained for a period
7102: of one full quarter branch. Packages with manual/interactive fetch
7103: must have a maintainer and it is his/her responsibility to ensure
7104: this.</p>
1.75 rillig 7105: </div>
1.148 asau 7106: <div class="sect2">
1.75 rillig 7107: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7108: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.75 rillig 7109: <p>Your package may depend on some other package being present
1.88 wiz 7110: - and there are various ways of expressing this dependency.
7111: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
1.269 leot 7112: <code class="varname">DEPENDS</code> and
7113: <code class="varname">TOOL_DEPENDS</code> definitions, the
1.88 wiz 7114: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7115: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7116: to handle dependencies, and which uses the variables named above.
1.267 rillig 7117: See <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7118: <p>The basic difference between the two variables is as
1.87 wiz 7119: follows: The <code class="varname">DEPENDS</code> definition registers
7120: that pre-requisite in the binary package so it will be pulled in
7121: when the binary package is later installed, whilst the
1.269 leot 7122: <code class="varname">BUILD_DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
7123: definitions does not, marking a dependency that is only needed for
7124: building the package.</p>
1.75 rillig 7125: <p>This means that if you only need a package present whilst
1.87 wiz 7126: you are building, it should be noted as a
1.269 leot 7127: <code class="varname">TOOL_DEPENDS</code> or
7128: <code class="varname">BUILD_DEPENDS</code>. When cross-compiling,
7129: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7130: packages, i.e. packages for the architecture where the package
7131: is built;
7132: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
7133: packages, i.e. packages for the architecture for which the package
7134: is built.</p>
7135: <p>The format for <code class="varname">BUILD_DEPENDS</code>,
7136: <code class="varname">DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
7137: definition is:</p>
1.75 rillig 7138: <pre class="programlisting">
1.100 rillig 7139: <pre-req-package-name>:../../<category>/<pre-req-package>
1.222 sevan 7140: </pre>
1.128 wiz 7141: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.87 wiz 7142: may include any of the wildcard version numbers recognized by
1.270 leot 7143: <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.128 wiz 7144: <div class="orderedlist"><ol class="orderedlist" type="1">
7145: <li class="listitem">
1.75 rillig 7146: <p>If your package needs another package's binaries or
1.160 wiz 7147: libraries to build and run, and if that package has a
1.87 wiz 7148: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7149: <pre class="programlisting">
1.100 rillig 7150: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7151: </pre>
1.75 rillig 7152: </li>
1.128 wiz 7153: <li class="listitem">
1.160 wiz 7154: <p>If your package needs another package's binaries or
7155: libraries only for building, and if that package has a
7156: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7157: <pre class="programlisting">
7158: .include "../../graphics/jpeg/buildlink3.mk"
1.222 sevan 7159: </pre>
1.160 wiz 7160: <p>but set
7161: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7162: to make it a build dependency only. This case is rather
7163: rare.</p>
7164: </li>
7165: <li class="listitem">
1.132 spz 7166: <p>If your package needs binaries from another package to build,
1.269 leot 7167: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75 rillig 7168: <pre class="programlisting">
1.269 leot 7169: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222 sevan 7170: </pre>
1.75 rillig 7171: </li>
1.269 leot 7172: <li class="listitem"><p>If your package needs static libraries to link against, header
7173: files to include, etc. from another package to build,
7174: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132 spz 7175: <li class="listitem"><p>If your package needs a library with which to link and
7176: there is no <code class="filename">buildlink3.mk</code> file
7177: available, create one. Using
7178: <code class="varname">DEPENDS</code> won't be sufficient because the
7179: include files and libraries will be hidden from the compiler.</p></li>
1.128 wiz 7180: <li class="listitem">
1.132 spz 7181: <p>If your package needs some executable to be able to run
7182: correctly and if there's no
7183: <code class="filename">buildlink3.mk</code> file, this is specified
7184: using the <code class="varname">DEPENDS</code> variable. The
1.250 leot 7185: <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.242 wiz 7186: be able to execute the latex binary from the tex-latex-bin package
1.132 spz 7187: when it runs, and that is specified:</p>
1.75 rillig 7188: <pre class="programlisting">
1.242 wiz 7189: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222 sevan 7190: </pre>
1.132 spz 7191: </li>
7192: <li class="listitem">
7193: <p>You can use wildcards in package dependencies. Note that
7194: such wildcard dependencies are retained when creating binary
7195: packages. The dependency is checked when installing the binary
7196: package and any package which matches the pattern will be
7197: used. Wildcard dependencies should be used with care.</p>
1.128 wiz 7198: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7199: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7200: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7201: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7202: <p>Wildcards can also be used to specify that a package
1.87 wiz 7203: will only build against a certain minimum version of a
7204: pre-requisite:</p>
1.75 rillig 7205: <pre class="programlisting">
1.132 spz 7206: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.222 sevan 7207: </pre>
1.132 spz 7208: <p>This means that the package will build using version 6.0
7209: of ImageMagick or newer. Such a dependency may be warranted
7210: if, for example, the command line options of an executable
7211: have changed.</p>
7212: <p>If you need to depend on minimum versions of libraries,
7213: see the buildlink section of the pkgsrc guide.</p>
1.75 rillig 7214: <p>For security fixes, please update the package
1.267 rillig 7215: vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, “Handling packages with security problems”</a> for more
1.87 wiz 7216: information.</p>
1.75 rillig 7217: </li>
7218: </ol></div>
7219: <p>If your package needs files from another package to build,
1.87 wiz 7220: add the relevant distribution files to
7221: <code class="varname">DISTFILES</code>, so they will be extracted
1.250 leot 7222: 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.87 wiz 7223: (It relies on the jpeg sources being present in source form
7224: during the build.)</p>
1.75 rillig 7225: </div>
1.148 asau 7226: <div class="sect2">
1.75 rillig 7227: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7228: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7229: <p>Your package may conflict with other packages a user might
1.87 wiz 7230: already have installed on his system, e.g. if your package
1.88 wiz 7231: installs the same set of files as another package in the pkgsrc
1.190 wiz 7232: tree or has the same <code class="varname">PKGNAME</code>.</p>
1.255 leot 7233: <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>
7234: 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>
7235: install the same shared library, thus you set in
7236: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7237: <pre class="programlisting">
7238: CONFLICTS= Xaw-Xpm-[0-9]*
7239: </pre>
7240: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7241: <pre class="programlisting">
7242: CONFLICTS= libXaw3d-[0-9]*
7243: </pre>
1.270 leot 7244: <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.255 leot 7245: that conflict with existing packages and abort. However, in many
7246: situations this is too late in the process. Binary package managers
7247: will not know about the conflict until they attempt to install the
7248: package after already downloading it and all its dependencies.
7249: Users may also waste time building a package and its dependencies
7250: only to find out at the end that it conflicts with another package
7251: they have installed.</p>
7252: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7253: should be added in all cases where it is known that packages conflict
7254: with each other. These <code class="varname">CONFLICTS</code> entries are
1.270 leot 7255: 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.255 leot 7256: managers to inform users that packages cannot be installed onto
7257: the target system.</p>
1.75 rillig 7258: </div>
1.148 asau 7259: <div class="sect2">
1.75 rillig 7260: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7261: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7262: <p>There are several reasons why a package might be
1.88 wiz 7263: instructed to not build under certain circumstances. If the
1.87 wiz 7264: package builds and runs on most platforms, the exceptions
1.193 dholland 7265: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7266: the package builds and runs on a small handful of platforms,
7267: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7268: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7269: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7270: (OS-version-platform) that can use glob-style
7271: wildcards.</p>
7272: <p>If a package is not appropriate for some platforms (as
1.225 maya 7273: opposed to merely broken), a different set of variables should be
1.193 dholland 7274: used as this affects failure reporting and statistics.
7275: If the package is appropriate for most platforms, the exceptions
1.87 wiz 7276: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.193 dholland 7277: the package is appropriate for only a small handful of platforms
7278: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87 wiz 7279: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7280: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7281: (OS-version-platform) that can use glob-style
7282: wildcards.</p>
1.88 wiz 7283: <p>Some packages are tightly bound to a specific version of an
1.250 leot 7284: 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.88 wiz 7285: backwards compatible with other versions of the OS, and should be
7286: uploaded to a version specific directory on the FTP server. Mark
7287: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128 wiz 7288: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.88 wiz 7289: the package system internals, but may be used in the
7290: future.</p>
1.75 rillig 7291: <p>If the package should be skipped (for example, because it
1.87 wiz 7292: provides functionality already provided by the system), set
1.88 wiz 7293: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7294: the package should fail because some preconditions are not met,
7295: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7296: message.</p>
1.75 rillig 7297: </div>
1.148 asau 7298: <div class="sect2">
1.75 rillig 7299: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7300: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 7301: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 7302: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7303: be set in the package Makefile. This will be carried into any
7304: binary package that is made from this pkgsrc entry. A
1.128 wiz 7305: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.270 leot 7306: 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.128 wiz 7307: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.75 rillig 7308: </div>
1.148 asau 7309: <div class="sect2">
1.75 rillig 7310: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7311: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75 rillig 7312: <p>When a vulnerability is found, this should be noted in
1.87 wiz 7313: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138 wiz 7314: and after committing that file, ask pkgsrc-security@NetBSD.org to
7315: update the file on ftp.NetBSD.org.</p>
1.75 rillig 7316: <p>After fixing the vulnerability by a patch, its
1.138 wiz 7317: <code class="varname">PKGREVISION</code> should be increased (this is of
7318: course not necessary if the problem is fixed by using a newer
7319: release of the software), and the pattern in the
7320: pkg-vulnerabilities file must be updated.</p>
1.75 rillig 7321: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 7322: branch, be sure to submit a pullup request!</p>
1.75 rillig 7323: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 7324: semi-automatically by a weekly cron job.</p>
1.75 rillig 7325: </div>
1.148 asau 7326: <div class="sect2">
1.75 rillig 7327: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7328: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75 rillig 7329: <p>When making fixes to an existing package it can be useful
1.87 wiz 7330: to change the version number in <code class="varname">PKGNAME</code>. To
7331: avoid conflicting with future versions by the original author, a
1.128 wiz 7332: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.87 wiz 7333: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128 wiz 7334: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7335: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.87 wiz 7336: <pre class="programlisting">
1.100 rillig 7337: DISTNAME= foo-17.42
7338: PKGREVISION= 9
1.222 sevan 7339: </pre>
1.75 rillig 7340: <p>will result in a <code class="varname">PKGNAME</code> of
1.128 wiz 7341: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7342: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.87 wiz 7343: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7344: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 7345: <p>When a new release of the package is released, the
1.87 wiz 7346: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7347: minor release of the above package, things should be like:</p>
1.75 rillig 7348: <pre class="programlisting">
1.100 rillig 7349: DISTNAME= foo-17.43
1.222 sevan 7350: </pre>
1.87 wiz 7351: <p><code class="varname">PKGREVISION</code> should be incremented for any
7352: non-trivial change in the resulting binary package. Without a
7353: <code class="varname">PKGREVISION</code> bump, someone with the previous
7354: version installed has no way of knowing that their package is out
7355: of date. Thus, changes without increasing
7356: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7357: trivial that no reasonable person would want to upgrade", and this
7358: is the rough test for when increasing
7359: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7360: changes that do not merit increasing
7361: <code class="varname">PKGREVISION</code> are:</p>
1.148 asau 7362: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7363: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114 jmcneill 7364: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100 rillig 7365: or comments in Makefile.</p></li>
1.128 wiz 7366: <li class="listitem"><p>
1.100 rillig 7367: Changing build variables if the resulting binary package is the same.</p></li>
1.128 wiz 7368: <li class="listitem"><p>
1.100 rillig 7369: Changing <code class="filename">DESCR</code>.</p></li>
1.128 wiz 7370: <li class="listitem"><p>
1.100 rillig 7371: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
7372: </ul></div>
1.87 wiz 7373: <p>Examples of changes that do merit an increase to
7374: <code class="varname">PKGREVISION</code> include:</p>
1.148 asau 7375: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7376: <li class="listitem"><p>
1.100 rillig 7377: Security fixes</p></li>
1.128 wiz 7378: <li class="listitem"><p>
1.100 rillig 7379: Changes or additions to a patch file</p></li>
1.128 wiz 7380: <li class="listitem"><p>
1.100 rillig 7381: Changes to the <code class="filename">PLIST</code></p></li>
1.128 wiz 7382: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100 rillig 7383: </ul></div>
1.78 rillig 7384: <p>PKGREVISION must also be incremented when dependencies have ABI
7385: changes.</p>
1.75 rillig 7386: </div>
1.148 asau 7387: <div class="sect2">
1.79 rillig 7388: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7389: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79 rillig 7390: <p>When you want to replace the same text in multiple files
1.87 wiz 7391: or when the replacement text varies, patches alone cannot help.
7392: This is where the SUBST framework comes in. It provides an
7393: easy-to-use interface for replacing text in files.
7394: Example:</p>
7395: <pre class="programlisting">
1.100 rillig 7396: SUBST_CLASSES+= fix-paths
7397: SUBST_STAGE.fix-paths= pre-configure
7398: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
7399: SUBST_FILES.fix-paths= src/*.c
7400: SUBST_FILES.fix-paths+= scripts/*.sh
7401: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
7402: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.222 sevan 7403: </pre>
1.79 rillig 7404: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 7405: that are used to identify the different SUBST blocks that are
7406: defined. The SUBST framework is heavily used by pkgsrc, so it is
7407: important to always use the <code class="literal">+=</code> operator with
7408: this variable. Otherwise some substitutions may be
7409: skipped.</p>
1.79 rillig 7410: <p>The remaining variables of each SUBST block are
1.87 wiz 7411: parameterized with the identifier from the first line
7412: (<code class="literal">fix-paths</code> in this case.) They can be seen as
7413: parameters to a function call.</p>
1.79 rillig 7414: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 7415: which the replacement will take place. All combinations of
7416: <code class="literal">pre-</code>, <code class="literal">do-</code> and
7417: <code class="literal">post-</code> together with a phase name are
7418: possible, though only few are actually used. Most commonly used
7419: are <code class="literal">post-patch</code> and
7420: <code class="literal">pre-configure</code>. Of these two,
7421: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 7422: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 7423: have the state after applying the patches but before making any
7424: other changes. This is especially useful when you are debugging
7425: a package in order to create new patches for it. Similarly,
7426: <code class="literal">post-build</code> is preferred over
7427: <code class="literal">pre-install</code>, because the install phase should
7428: generally be kept as simple as possible. When you use
7429: <code class="literal">post-build</code>, you have the same files in the
7430: working directory that will be installed later, so you can check
7431: if the substitution has succeeded.</p>
1.79 rillig 7432: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 7433: that is printed just before the substitution is done.</p>
1.79 rillig 7434: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 7435: globbing patterns that specifies the files in which the
7436: substitution will take place. The patterns are interpreted
7437: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 7438: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.270 leot 7439: <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.87 wiz 7440: command should be prefixed with <code class="literal">-e</code>, so that
7441: all SUBST blocks look uniform.</p>
1.79 rillig 7442: <p>There are some more variables, but they are so seldomly
1.87 wiz 7443: used that they are only documented in the
7444: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 7445: </div>
1.75 rillig 7446: </div>
1.148 asau 7447: <div class="sect1">
1.75 rillig 7448: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 7449: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148 asau 7450: <div class="sect2">
1.75 rillig 7451: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7452: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75 rillig 7453: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 7454: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 7455: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7456: with the name of each file to download as an argument, expecting
7457: it to output the URL of the directory from which to download
1.250 leot 7458: 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.87 wiz 7459: example of this usage.</p>
1.75 rillig 7460: <p>If the download can't be automated, because the user must
1.87 wiz 7461: submit personal information to apply for a password, or must pay
7462: for the source, or whatever, you can set
7463: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7464: displayed to the user before aborting the build. Example:</p>
7465: <pre class="programlisting">
1.100 rillig 7466: FETCH_MESSAGE= "Please download the files"
7467: FETCH_MESSAGE+= " "${DISTFILES:Q}
7468: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222 sevan 7469: </pre>
1.75 rillig 7470: </div>
1.148 asau 7471: <div class="sect2">
1.75 rillig 7472: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7473: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75 rillig 7474: <p>Sometimes authors of a software package make some
1.87 wiz 7475: modifications after the software was released, and they put up a
7476: new distfile without changing the package's version number. If a
7477: package is already in pkgsrc at that time, the checksum will
7478: no longer match. The contents of the new distfile should be
7479: compared against the old one before changing anything, to make
7480: sure the distfile was really updated on purpose, and that
7481: no trojan horse or so crept in.
1.97 rillig 7482: Please mention that the distfiles were compared and what was found
1.159 rodent 7483: in your commit message.</p>
1.220 wiz 7484: <p>Then, the correct way to work around this is to set
7485: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7486: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7487: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7488: a variable prefix). All <code class="varname">DISTFILES</code> and
1.93 rillig 7489: <code class="varname">PATCHFILES</code> for this package will be put in that
1.267 rillig 7490: subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="21.1.10. How to handle incrementing versions when fixing an existing package">Section 21.1.10, “How to handle incrementing versions when fixing an existing package”</a> for more details.) In case this
1.87 wiz 7491: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220 wiz 7492: including the <code class="filename">nbX</code> suffix) or a date stamp can
7493: be appended, like
7494: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.159 rodent 7495: <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>
7496: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87 wiz 7497: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7498: path in the filenames.
1.159 rodent 7499: Also, increase the PKGREVISION if the installed package is different.
1.87 wiz 7500: Furthermore, a mail to the package's authors seems appropriate
7501: telling them that changing distfiles after releases without
7502: changing the file names is not good practice.</p>
1.75 rillig 7503: </div>
1.199 tnn 7504: <div class="sect2">
7505: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7506: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.200 tnn 7507: <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:
7508: </p>
1.199 tnn 7509: <div class="sect3">
7510: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7511: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.199 tnn 7512: <p>
7513: 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.
7514: </p>
7515: <pre class="programlisting">
7516: DISTNAME= exampleproject-1.0
1.200 tnn 7517: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7518: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7519: GITHUB_TAG= v${PKGVERSION_NOREV}
1.199 tnn 7520: EXTRACT_SUFX= .zip
7521: </pre>
7522: </div>
7523: <div class="sect3">
7524: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7525: <a name="build.fetch.github.commit"></a>21.2.3.2. Fetch based on a specific commit</h4></div></div></div>
1.199 tnn 7526: <p>
7527: 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.
7528: </p>
7529: <pre class="programlisting">
7530: DISTNAME= example-1.0
1.217 jnemeth 7531: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.200 tnn 7532: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7533: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222 sevan 7534: </pre>
1.199 tnn 7535: </div>
7536: <div class="sect3">
7537: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7538: <a name="build.fetch.github.release"></a>21.2.3.3. Fetch based on release</h4></div></div></div>
1.199 tnn 7539: <p>
7540: 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.
7541: </p>
7542: <pre class="programlisting">
7543: DISTNAME= offensive-1.6
1.200 tnn 7544: PKGNAME= ${DISTNAME:S/offensive/proper/}
7545: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7546: GITHUB_PROJECT= exampleproject
7547: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
7548: EXTRACT_SUFX= .zip
1.222 sevan 7549: </pre>
1.199 tnn 7550: </div>
7551: </div>
1.75 rillig 7552: </div>
1.148 asau 7553: <div class="sect1">
1.75 rillig 7554: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 7555: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148 asau 7556: <div class="sect2">
1.75 rillig 7557: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7558: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 7559: <p>pkgsrc supports many different machines, with different
1.87 wiz 7560: object formats like a.out and ELF, and varying abilities to do
7561: shared library and dynamic loading at all. To accompany this,
7562: varying commands and options have to be passed to the
7563: compiler, linker, etc. to get the Right Thing, which can be
7564: pretty annoying especially if you don't have all the machines
7565: at your hand to test things. The
1.250 leot 7566: <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.128 wiz 7567: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.87 wiz 7568: both static and dynamic libraries from a set of source files,
7569: thus being platform-independent.</p>
7570: <p>Here's how to use libtool in a package in seven simple
7571: steps:</p>
1.128 wiz 7572: <div class="orderedlist"><ol class="orderedlist" type="1">
7573: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 7574: Makefile.</p></li>
1.128 wiz 7575: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
7576: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.87 wiz 7577: add it to the definition of <code class="varname">CC</code>, if only
7578: libraries are being built in a given Makefile. This one command
7579: will build both PIC and non-PIC library objects, so you need not
7580: have separate shared and non-shared library rules.</p></li>
1.128 wiz 7581: <li class="listitem">
1.75 rillig 7582: <p>For the linking of the library, remove any
1.128 wiz 7583: <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
7584: -Bshareable</span>”</span> commands, and instead use:</p>
1.75 rillig 7585: <pre class="programlisting">
1.100 rillig 7586: ${LIBTOOL} --mode=link \
7587: ${CC} -o ${.TARGET:.a=.la} \
7588: ${OBJS:.o=.lo} \
7589: -rpath ${PREFIX}/lib \
7590: -version-info major:minor
1.222 sevan 7591: </pre>
1.75 rillig 7592: <p>Note that the library is changed to have a
1.87 wiz 7593: <code class="filename">.la</code> extension, and the objects are
7594: changed to have a <code class="filename">.lo</code>
7595: extension. Change <code class="varname">OBJS</code> as
7596: necessary. This automatically creates all of the
7597: <code class="filename">.a</code>,
7598: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
7599: necessary) in the build directory. Be sure to include
1.128 wiz 7600: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.87 wiz 7601: minor are zero, as libtool will otherwise strip off the
7602: shared library version.</p>
1.75 rillig 7603: <p>From the libtool manual:</p>
7604: <pre class="programlisting">
1.100 rillig 7605: So, libtool library versions are described by three integers:
1.69 rillig 7606:
1.100 rillig 7607: CURRENT
7608: The most recent interface number that this library implements.
1.69 rillig 7609:
1.100 rillig 7610: REVISION
7611: The implementation number of the CURRENT interface.
1.69 rillig 7612:
1.100 rillig 7613: AGE
7614: The difference between the newest and oldest interfaces that
7615: this library implements. In other words, the library implements
7616: all the interface numbers in the range from number `CURRENT -
7617: AGE' to `CURRENT'.
1.1 grant 7618:
1.100 rillig 7619: If two libraries have identical CURRENT and AGE numbers, then the
7620: dynamic linker chooses the library with the greater REVISION number.
1.222 sevan 7621: </pre>
1.128 wiz 7622: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.87 wiz 7623: different results for a.out and ELF (excluding symlinks)
7624: in only one case. An ELF library of the form
1.128 wiz 7625: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87 wiz 7626: will have a symlink of
1.128 wiz 7627: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.87 wiz 7628: on an a.out platform. This is handled
7629: automatically.</p>
1.128 wiz 7630: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.87 wiz 7631: directory of the library being built.</p>
1.76 rillig 7632: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 7633: <code class="filename">.la</code> file, the other files will be
7634: added automatically.</p>
1.75 rillig 7635: </li>
1.128 wiz 7636: <li class="listitem">
1.76 rillig 7637: <p>When linking shared object (<code class="filename">.so</code>)
1.270 leot 7638: 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.128 wiz 7639: shared libraries, use <span class="quote">“<span class="quote">-module
7640: -avoid-version</span>”</span> to prevent them getting version
1.87 wiz 7641: tacked on.</p>
1.76 rillig 7642: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 7643: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 7644: </li>
1.128 wiz 7645: <li class="listitem">
1.75 rillig 7646: <p>When linking programs that depend on these libraries
1.87 wiz 7647: <span class="emphasis"><em>before</em></span> they are installed, preface
1.270 leot 7648: 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.128 wiz 7649: --mode=link</span>”</span>, and it will find the correct
1.87 wiz 7650: libraries (static or shared), but please be aware that
7651: libtool will not allow you to specify a relative path in
1.128 wiz 7652: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.87 wiz 7653: expects you to change that argument to be the
7654: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 7655: <pre class="programlisting">
1.100 rillig 7656: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222 sevan 7657: </pre>
1.75 rillig 7658: <p>should be changed to:</p>
7659: <pre class="programlisting">
1.100 rillig 7660: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222 sevan 7661: </pre>
1.75 rillig 7662: <p>and it will do the right thing with the libraries.</p>
7663: </li>
1.128 wiz 7664: <li class="listitem">
1.270 leot 7665: <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>
7666: 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.128 wiz 7667: --mode=install</span>”</span>, and change the library name to
1.87 wiz 7668: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 7669: <pre class="programlisting">
1.126 jakllsch 7670: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222 sevan 7671: </pre>
1.76 rillig 7672: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 7673: shared library, any needed symlinks, and run
1.270 leot 7674: <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.75 rillig 7675: </li>
1.128 wiz 7676: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 7677: the <code class="filename">.la</code>
7678: file (this is a change from previous behaviour).</p></li>
1.75 rillig 7679: </ol></div>
7680: </div>
1.148 asau 7681: <div class="sect2">
1.75 rillig 7682: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7683: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 7684: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 7685: package Makefile. This will override the package's own libtool
7686: in most cases. For older libtool using packages, libtool is
7687: made by ltconfig script during the do-configure step; you can
1.110 hubertf 7688: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 7689: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 7690: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 7691: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.128 wiz 7692: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
7693: */*/libtool</span>”</span>. If this does not match the location of the
1.87 wiz 7694: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 7695: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 7696: libraries built and installed, then use
7697: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 7698: <p>If your package makes use of the platform-independent library
1.87 wiz 7699: for loading dynamic shared objects, that comes with libtool
7700: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
7701: <p>Some packages use libtool incorrectly so that the package
7702: may not work or build in some circumstances. Some of the more
7703: common errors are:</p>
1.148 asau 7704: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7705: <li class="listitem">
1.75 rillig 7706: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 7707: executable or library. This in itself isn't a problem if one of two things
7708: has been done:</p>
1.128 wiz 7709: <div class="orderedlist"><ol class="orderedlist" type="1">
7710: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87 wiz 7711: <code class="filename">libfoo.la</code>, not
7712: <code class="filename">foo.la</code></p></li>
1.128 wiz 7713: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75 rillig 7714: </ol></div>
7715: </li>
1.128 wiz 7716: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 7717: The function lt_dlinit() should be called and the macro
7718: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
7719: executables.</p></li>
1.75 rillig 7720: </ul></div>
7721: </div>
1.148 asau 7722: <div class="sect2">
1.75 rillig 7723: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7724: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 7725: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 7726: to regenerate the configure script and Makefile.in makefile
7727: templates, then they should be executed in a pre-configure
7728: target.</p>
1.75 rillig 7729: <p>For packages that need only autoconf:</p>
7730: <pre class="programlisting">
1.100 rillig 7731: AUTOCONF_REQD= 2.50 # if default version is not good enough
7732: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
7733: ...
1.1 grant 7734:
1.100 rillig 7735: pre-configure:
7736: cd ${WRKSRC} && autoconf
1.1 grant 7737:
1.100 rillig 7738: ...
1.222 sevan 7739: </pre>
1.75 rillig 7740: <p>and for packages that need automake and autoconf:</p>
7741: <pre class="programlisting">
1.100 rillig 7742: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
7743: USE_TOOLS+= automake # use "automake14" for automake-1.4
7744: ...
7745:
7746: pre-configure:
7747: set -e; cd ${WRKSRC}; \
7748: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 7749:
1.100 rillig 7750: ...
1.222 sevan 7751: </pre>
1.75 rillig 7752: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 7753: require GNU Make.</p>
1.75 rillig 7754: <p>There are times when the configure process makes
1.87 wiz 7755: additional changes to the generated files, which then causes
7756: the build process to try to re-execute the automake sequence.
7757: This is prevented by touching various files in the configure
7758: stage. If this causes problems with your package you can set
7759: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
7760: Makefile.</p>
1.75 rillig 7761: </div>
7762: </div>
1.148 asau 7763: <div class="sect1">
1.75 rillig 7764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 7765: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148 asau 7766: <div class="sect2">
1.87 wiz 7767: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7768: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 7769: <p>Compilers for the C, C++, and Fortran languages comes with
7770: the NetBSD base system. By default, pkgsrc assumes that a package
7771: is written in C and will hide all other compilers (via the wrapper
1.267 rillig 7772: framework, see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 7773: <p>To declare which language's compiler a package needs, set
7774: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128 wiz 7775: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
7776: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
7777: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.87 wiz 7778: written in C++, usually need a C compiler for the configure
7779: phase.</p>
7780: </div>
1.148 asau 7781: <div class="sect2">
1.87 wiz 7782: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7783: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87 wiz 7784: <p>If a program is written in Java, use the Java framework in
7785: pkgsrc. The package must include
7786: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
7787: provides the following variables:</p>
1.148 asau 7788: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 7789: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87 wiz 7790: dependency on the JDK is added. If
1.128 wiz 7791: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.87 wiz 7792: there is only a runtime dependency on the JDK. The default is
1.128 wiz 7793: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.87 wiz 7794: JDK.</p></li>
1.128 wiz 7795: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87 wiz 7796: a package needs a Java2 implementation. The supported values
1.128 wiz 7797: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
7798: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
7799: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
7800: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.87 wiz 7801: above. This variable is not set by default.</p></li>
1.130 wiz 7802: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
7803: automatically set to the runtime location of the used Java
7804: implementation dependency. It may be used to set
7805: <code class="varname">JAVA_HOME</code> to a good value if the program
7806: needs this variable to be defined.
7807: </p></li>
1.87 wiz 7808: </ul></div>
7809: </div>
1.148 asau 7810: <div class="sect2">
1.87 wiz 7811: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7812: <a name="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 7813: <p>If your package contains interpreted perl scripts, add
1.128 wiz 7814: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.87 wiz 7815: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
7816: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
7817: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183 wiz 7818: that you want adjusted. Every occurrence of
7819: <code class="filename">*/bin/perl</code> in a she-bang line will be
7820: replaced with the full path to the perl executable.</p>
1.87 wiz 7821: <p>If a particular version of perl is needed, set the
7822: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.128 wiz 7823: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.267 rillig 7824: <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.87 wiz 7825: about handling perl modules.</p>
7826: </div>
1.148 asau 7827: <div class="sect2">
1.87 wiz 7828: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7829: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.147 wiz 7830: <p><code class="varname">REPLACE_SH</code>,
7831: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
7832: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
7833: hash bangs in files. Please use the appropriate one, prefering
7834: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183 wiz 7835: Each should contain a list of scripts, relative to
7836: <code class="varname">WRKSRC</code>, that you want adjusted. Every
7837: occurrence of the matching shell in a she-bang line will be
7838: replaced with the full path to the shell executable.
1.147 wiz 7839: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
7840: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
7841: </div>
1.148 asau 7842: <div class="sect2">
1.147 wiz 7843: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7844: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.87 wiz 7845: <p>Currently, there is no special handling for other languages
7846: in pkgsrc. If a compiler package provides a
7847: <code class="filename">buildlink3.mk</code> file, include that, otherwise
7848: just add a (build) dependency on the appropriate compiler
7849: package.</p>
7850: </div>
7851: </div>
1.148 asau 7852: <div class="sect1">
1.87 wiz 7853: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 7854: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 7855: <p>The most common failures when building a package are that
7856: some platforms do not provide certain header files, functions or
7857: libraries, or they provide the functions in a library that the
7858: original package author didn't know. To work around this, you
7859: can rewrite the source code in most cases so that it does not
7860: use the missing functions or provides a replacement function.</p>
1.148 asau 7861: <div class="sect2">
1.77 rillig 7862: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7863: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 7864: <p>If a package already comes with a GNU configure script, the
7865: preferred way to fix the build failure is to change the
7866: configure script, not the code. In the other cases, you can
7867: utilize the C preprocessor, which defines certain macros
7868: depending on the operating system and hardware architecture it
7869: compiles for. These macros can be queried using for example
7870: <code class="varname">#if defined(__i386)</code>. Almost every operating
7871: system, hardware architecture and compiler has its own macro.
7872: For example, if the macros <code class="varname">__GNUC__</code>,
7873: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
7874: are all defined, you know that you are using NetBSD on an i386
7875: compatible CPU, and your compiler is GCC.</p>
7876: <p>The list of the following macros for hardware and
7877: operating system depends on the compiler that is used. For
7878: example, if you want to conditionally compile code on Solaris,
7879: don't use <code class="varname">__sun__</code>, as the SunPro compiler
7880: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148 asau 7881: <div class="sect3">
1.75 rillig 7882: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7883: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75 rillig 7884: <p>To distinguish between 4.4 BSD-derived systems and the
7885: rest of the world, you should use the following code.</p>
7886: <pre class="programlisting">
1.100 rillig 7887: #include <sys/param.h>
7888: #if (defined(BSD) && BSD >= 199306)
7889: /* BSD-specific code goes here */
7890: #else
7891: /* non-BSD-specific code goes here */
7892: #endif
1.75 rillig 7893: </pre>
1.77 rillig 7894: <p>If this distinction is not fine enough, you can also test
7895: for the following macros.</p>
1.75 rillig 7896: <pre class="programlisting">
1.151 obache 7897: Cygwin __CYGWIN__
7898: DragonFly __DragonFly__
1.100 rillig 7899: FreeBSD __FreeBSD__
1.151 obache 7900: Haiku __HAIKU__
1.100 rillig 7901: Interix __INTERIX
7902: IRIX __sgi (TODO: get a definite source for this)
7903: Linux linux, __linux, __linux__
1.193 dholland 7904: Mac OS X __APPLE__
1.151 obache 7905: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7906: Minix3 __minix
1.100 rillig 7907: NetBSD __NetBSD__
7908: OpenBSD __OpenBSD__
7909: Solaris sun, __sun
1.75 rillig 7910: </pre>
7911: </div>
1.148 asau 7912: <div class="sect3">
1.75 rillig 7913: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7914: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75 rillig 7915: <pre class="programlisting">
1.100 rillig 7916: i386 i386, __i386, __i386__
7917: MIPS __mips
7918: SPARC sparc, __sparc
1.75 rillig 7919: </pre>
7920: </div>
1.148 asau 7921: <div class="sect3">
1.75 rillig 7922: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 7923: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75 rillig 7924: <pre class="programlisting">
1.100 rillig 7925: GCC __GNUC__ (major version), __GNUC_MINOR__
7926: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7927: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7928: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 7929: </pre>
7930: </div>
7931: </div>
1.148 asau 7932: <div class="sect2">
1.78 rillig 7933: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7934: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 7935: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 7936: combinations of compiler version and architecture and almost
7937: always relation to optimisation being enabled. Common symptoms
7938: are gcc internal errors or never finishing compiling a
1.78 rillig 7939: file.</p>
7940: <p>Typically, a workaround involves testing the
7941: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
7942: optimisation for that combination of file,
1.198 tnn 7943: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
7944: <p>This used to be a big problem in the past, but is rarely
7945: needed now as compiler technology has matured. If you still need
7946: to add a compiler specific workaround, please do so in the file
7947: <code class="filename">hacks.mk</code> and describe the symptom and
7948: compiler version as detailed as possible.</p>
1.78 rillig 7949: </div>
1.148 asau 7950: <div class="sect2">
1.78 rillig 7951: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 7952: <a name="undefined-reference"></a>21.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.128 wiz 7953: </h3></div></div></div>
1.92 rillig 7954: <p>This error message often means that a package did not
1.78 rillig 7955: link to a shared library it needs. The following functions are
7956: known to cause this error message over and over.</p>
7957: <div class="informaltable">
1.216 tnn 7958: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78 rillig 7959: <colgroup>
7960: <col>
7961: <col>
7962: <col>
7963: </colgroup>
7964: <thead><tr>
7965: <th>Function</th>
7966: <th>Library</th>
7967: <th>Affected platforms</th>
7968: </tr></thead>
7969: <tbody>
7970: <tr>
7971: <td>accept, bind, connect</td>
7972: <td>-lsocket</td>
7973: <td>Solaris</td>
7974: </tr>
7975: <tr>
7976: <td>crypt</td>
7977: <td>-lcrypt</td>
7978: <td>DragonFly, NetBSD</td>
7979: </tr>
7980: <tr>
7981: <td>dlopen, dlsym</td>
7982: <td>-ldl</td>
7983: <td>Linux</td>
7984: </tr>
7985: <tr>
7986: <td>gethost*</td>
7987: <td>-lnsl</td>
7988: <td>Solaris</td>
7989: </tr>
7990: <tr>
7991: <td>inet_aton</td>
7992: <td>-lresolv</td>
7993: <td>Solaris</td>
7994: </tr>
7995: <tr>
7996: <td>nanosleep, sem_*, timer_*</td>
7997: <td>-lrt</td>
7998: <td>Solaris</td>
7999: </tr>
8000: <tr>
8001: <td>openpty</td>
8002: <td>-lutil</td>
8003: <td>Linux</td>
8004: </tr>
8005: </tbody>
8006: </table>
8007: </div>
8008: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8009: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8010: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8011: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8012: bmake</strong></span>.</p>
1.148 asau 8013: <div class="sect3">
1.92 rillig 8014: <div class="titlepage"><div><div><h4 class="title">
1.267 rillig 8015: <a name="undefined-reference-sunpro"></a>21.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8016: <p>When you are using the SunPro compiler, there is another
8017: possibility. That compiler cannot handle the following code:</p>
8018: <pre class="programlisting">
1.100 rillig 8019: extern int extern_func(int);
1.93 rillig 8020:
1.100 rillig 8021: static inline int
8022: inline_func(int x)
8023: {
1.92 rillig 8024: return extern_func(x);
1.100 rillig 8025: }
1.93 rillig 8026:
1.100 rillig 8027: int main(void)
8028: {
1.92 rillig 8029: return 0;
1.100 rillig 8030: }
1.92 rillig 8031: </pre>
8032: <p>It generates the code for <code class="function">inline_func</code> even if
8033: that function is never used. This code then refers to
8034: <code class="function">extern_func</code>, which can usually not be resolved. To
8035: solve this problem you can try to tell the package to disable inlining
8036: of functions.</p>
8037: </div>
1.87 wiz 8038: </div>
1.148 asau 8039: <div class="sect2">
1.87 wiz 8040: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8041: <a name="out-of-memory"></a>21.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8042: <p>Sometimes packages fail to build because the compiler runs
8043: into an operating system specific soft limit. With the
8044: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204 wiz 8045: to unlimit the resources. Currently, the allowed values are any combination of
8046: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8047: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.87 wiz 8048: Setting this variable is similar to running the shell builtin
1.110 hubertf 8049: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8050: segment size or maximum stack size of a process, respectively, to
8051: their hard limits.</p>
1.78 rillig 8052: </div>
1.75 rillig 8053: </div>
1.148 asau 8054: <div class="sect1">
1.75 rillig 8055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8056: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148 asau 8057: <div class="sect2">
1.75 rillig 8058: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8059: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8060: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8061: with some operating systems cannot create more than one
8062: directory at a time. As such, you should call
8063: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8064: <pre class="programlisting">
1.100 rillig 8065: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8066: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222 sevan 8067: </pre>
1.128 wiz 8068: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8069: dir2</code></span>”</span> to the
1.87 wiz 8070: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8071: automatically do the right thing.</p>
1.75 rillig 8072: </div>
1.148 asau 8073: <div class="sect2">
1.75 rillig 8074: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8075: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8076: <p>In general, documentation should be installed into
1.87 wiz 8077: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8078: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8079: includes the version number of the package).</p>
1.84 wiz 8080: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8081: directory where HTML documentation is installed with the
1.128 wiz 8082: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.87 wiz 8083: is needed because otherwise the documentation ends up in
8084: <code class="filename">${PREFIX}/share/doc/html</code> or other
8085: places.</p>
8086: <p>An exception to the above is that library API documentation
1.250 leot 8087: 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.87 wiz 8088: browsers (devhelp) should be left at their default location, which
8089: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8090: documentation can be recognized from files ending in
8091: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8092: (It is also acceptable to install such files in
8093: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8094: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8095: <code class="filename">.devhelp*</code> file must be directly in that
8096: directory then, no additional subdirectory level is allowed in
8097: this case. This is usually achieved by using
1.128 wiz 8098: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.87 wiz 8099: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8100: though.)</p>
1.75 rillig 8101: </div>
1.148 asau 8102: <div class="sect2">
1.75 rillig 8103: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8104: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8105: <p>Certain packages, most of them in the games category, install
1.87 wiz 8106: a score file that allows all users on the system to record their
8107: highscores. In order for this to work, the binaries need to be
8108: installed setgid and the score files owned by the appropriate
1.142 wiz 8109: group and/or owner (traditionally the "games" user/group). Set
8110: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87 wiz 8111: following variables, documented in more detail in
8112: <code class="filename">mk/defaults/mk.conf</code>, control this
1.142 wiz 8113: behaviour: <code class="varname">GAMEDATAMODE</code>,
8114: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210 leot 8115: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8116: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8117: <code class="varname">GAMEDATA_PERMS</code> and
8118: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8119: <p>An example that illustrates some of the variables described above is
8120: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8121: used to properly set directory permissions of the directory where the
8122: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8123: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8124: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8125: binary:</p>
8126: <pre class="programlisting">
1.223 rillig 8127: USE_GAMESGROUP= yes
1.210 leot 8128:
1.223 rillig 8129: BUILD_DEFS+= VARBASE
1.210 leot 8130:
1.223 rillig 8131: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8132: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8133: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222 sevan 8134: </pre>
1.210 leot 8135: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8136: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8137: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8138: needed to be accessed by setgid games and
8139: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114 jmcneill 8140: <p>A package should therefore never hard code file ownership or
1.210 leot 8141: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8142: or alternatively on <code class="varname">INSTALL_GAME</code>,
8143: <code class="varname">INSTALL_GAME_DATA</code> and
8144: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75 rillig 8145: </div>
1.148 asau 8146: <div class="sect2">
1.75 rillig 8147: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8148: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114 jmcneill 8149: <p><code class="varname">DESTDIR</code> support means that a package
8150: installs into a staging directory, not the final location of the
8151: files. Then a binary package is created which can be used for
8152: installation as usual. There are two ways: Either the package must
1.128 wiz 8153: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8154: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.148 asau 8155: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8156: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224 leot 8157: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8158: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145 wiz 8159: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8160: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114 jmcneill 8161: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8162: the inclusion.</p></li>
1.128 wiz 8163: <li class="listitem"><p>All installation operations have to be prefixed with
1.103 wiz 8164: <code class="filename">${DESTDIR}</code>.</p></li>
1.128 wiz 8165: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103 wiz 8166: automatically. Many manual rules and pre/post-install often are
8167: incorrect; fix them.</p></li>
1.128 wiz 8168: <li class="listitem"><p>If files are installed with special owner/group
1.118 imil 8169: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128 wiz 8170: <li class="listitem"><p>In general, packages should support
1.103 wiz 8171: <code class="varname">UNPRIVILEGED</code> to be able to use
8172: DESTDIR.</p></li>
8173: </ul></div>
8174: </div>
1.148 asau 8175: <div class="sect2">
1.103 wiz 8176: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8177: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8178: <p>Your package may also contain scripts with hardcoded paths to
8179: other interpreters besides (or as well as) perl. To correct the
8180: full pathname to the script interpreter, you need to set the
8181: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8182: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8183: <pre class="programlisting">
1.100 rillig 8184: REPLACE_INTERPRETER+= tcl
8185: REPLACE.tcl.old= .*/bin/tclsh
8186: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8187: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8188: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222 sevan 8189: </pre>
1.148 asau 8190: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8191: <h3 class="title">Note</h3>
8192: <p>Before March 2006, these variables were called
1.87 wiz 8193: <code class="varname">_REPLACE.*</code> and
8194: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8195: </div>
8196: </div>
1.148 asau 8197: <div class="sect2">
1.75 rillig 8198: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8199: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8200: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8201: the Makefile fragment
8202: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8203: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8204: configuration for such modules as well as various hooks to tune
8205: this configuration. See comments in this file for
8206: details.</p>
1.75 rillig 8207: <p>Perl5 modules will install into different places depending
1.87 wiz 8208: on the version of perl used during the build process. To
8209: address this, pkgsrc will append lines to the
8210: <code class="filename">PLIST</code> corresponding to the files listed in
8211: the installed <code class="filename">.packlist</code> file generated by
8212: most perl5 modules. This is invoked by defining
8213: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153 wiz 8214: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8215: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8216: e.g.:</p>
1.75 rillig 8217: <pre class="programlisting">
1.153 wiz 8218: PERL5_PACKLIST= auto/Pg/.packlist
1.222 sevan 8219: </pre>
1.153 wiz 8220: <p>The perl5 config variables
8221: <code class="varname">installarchlib</code>,
8222: <code class="varname">installscript</code>,
8223: <code class="varname">installvendorbin</code>,
8224: <code class="varname">installvendorscript</code>,
8225: <code class="varname">installvendorarch</code>,
8226: <code class="varname">installvendorlib</code>,
8227: <code class="varname">installvendorman1dir</code>, and
8228: <code class="varname">installvendorman3dir</code> represent those
8229: locations in which components of perl5 modules may be installed,
8230: provided as variable with uppercase and prefixed with
8231: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8232: and may be used by perl5 packages that don't have a packlist.
8233: These variables are also substituted for in the
8234: <code class="filename">PLIST</code> as uppercase prefixed with
8235: <code class="varname">PERL5_SUB_</code>.</p>
1.75 rillig 8236: </div>
1.148 asau 8237: <div class="sect2">
1.75 rillig 8238: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8239: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8240: <p>Some packages install info files or use the
1.128 wiz 8241: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.87 wiz 8242: commands. <code class="varname">INFO_FILES</code> should be defined in
8243: the package Makefile so that <code class="filename">INSTALL</code> and
8244: <code class="filename">DEINSTALL</code> scripts will be generated to
8245: handle registration of the info files in the Info directory
1.128 wiz 8246: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.87 wiz 8247: files registration is either provided by the system, or by a
8248: special purpose package automatically added as dependency if
8249: needed.</p>
1.75 rillig 8250: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8251: <code class="filename">${PREFIX}</code> where info files are primarily
8252: located. <code class="varname">PKGINFODIR</code> defaults to
1.128 wiz 8253: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.75 rillig 8254: <p>The info files for the package should be listed in the
1.87 wiz 8255: package <code class="filename">PLIST</code>; however any split info files
8256: need not be listed.</p>
1.128 wiz 8257: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8258: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.87 wiz 8259: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128 wiz 8260: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.87 wiz 8261: should be noted with the <code class="varname">TEXINFO_REQD</code>
8262: variable in the package <code class="filename">Makefile</code>. By
8263: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8264: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8265: does not match the required minimum, a build dependency on the
1.250 leot 8266: <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.87 wiz 8267: be added automatically.</p>
1.75 rillig 8268: <p>The build and installation process of the software provided
1.87 wiz 8269: by the package should not use the
1.110 hubertf 8270: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8271: info files is the task of the package
8272: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8273: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8274: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8275: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8276: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8277: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8278: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8279: no effect except the logging of a message. The script overriding
1.110 hubertf 8280: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8281: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8282: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8283: </div>
1.148 asau 8284: <div class="sect2">
1.75 rillig 8285: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8286: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8287: <p>All packages that install manual pages should install them
1.87 wiz 8288: into the same directory, so that there is one common place to look
8289: for them. In pkgsrc, this place is
8290: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8291: should be used in packages. The default for
8292: <code class="varname">PKGMANDIR</code> is
1.128 wiz 8293: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8294: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.148 asau 8295: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8296: <h3 class="title">Note</h3>
1.87 wiz 8297: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8298: is far from complete.</p>
1.75 rillig 8299: </div>
1.81 rillig 8300: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8301: <code class="filename">man/</code> as the top level directory for the man
8302: page file entries, and the pkgsrc framework will convert as
8303: needed. In all other places, the correct
8304: <code class="varname">PKGMANDIR</code> must be used.</p>
8305: <p>Packages that are
8306: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128 wiz 8307: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.87 wiz 8308: <code class="filename">./configure</code>
8309: --mandir switch to set where the man pages should be installed.
8310: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8311: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8312: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8313: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128 wiz 8314: to <span class="quote">“<span class="quote">no</span>”</span>.
1.87 wiz 8315: Or if the <code class="filename">./configure</code> script uses
8316: a non-standard use of --mandir, you can set
8317: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.267 rillig 8318: <p>See <a class="xref" href="#manpage-compression" title="15.5. Man page compression">Section 15.5, “Man page compression”</a> for
1.87 wiz 8319: information on installation of compressed manual pages.</p>
1.75 rillig 8320: </div>
1.148 asau 8321: <div class="sect2">
1.75 rillig 8322: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8323: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8324: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8325: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8326: you need to take some extra steps to make sure they get registered
8327: in the database:</p>
1.128 wiz 8328: <div class="orderedlist"><ol class="orderedlist" type="1">
8329: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8330: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8331: takes care of rebuilding the GConf database at installation and
1.87 wiz 8332: deinstallation time, and tells the package where to install
1.107 rillig 8333: GConf data files using some standard configure arguments. It
1.87 wiz 8334: also disallows any access to the database directly from the
8335: package.</p></li>
1.128 wiz 8336: <li class="listitem"><p>Ensure that the package installs its
1.87 wiz 8337: <code class="filename">.schemas</code> files under
8338: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8339: installed under <code class="filename">${PREFIX}/etc</code>, you will
8340: need to manually patch the package.</p></li>
1.128 wiz 8341: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8342: directory, as they will be handled automatically. See
1.267 rillig 8343: <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.128 wiz 8344: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8345: your <code class="filename">Makefile</code> with a list of all
8346: <code class="filename">.schemas</code> files installed by the package, if
8347: any. Names must not contain any directories in them.</p></li>
1.128 wiz 8348: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 8349: your <code class="filename">Makefile</code> with a
8350: list of all <code class="filename">.entries</code> files installed by the
8351: package, if any. Names must not contain any directories in
8352: them.</p></li>
1.75 rillig 8353: </ol></div>
8354: </div>
1.148 asau 8355: <div class="sect2">
1.75 rillig 8356: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8357: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87 wiz 8358: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119 mishka 8359: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87 wiz 8360: get registered in the database:</p>
1.128 wiz 8361: <div class="orderedlist"><ol class="orderedlist" type="1">
8362: <li class="listitem"><p>Include
1.119 mishka 8363: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8364: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.87 wiz 8365: takes care of rebuilding the scrollkeeper database at
8366: installation and deinstallation time, and disallows any access
8367: to it directly from the package.</p></li>
1.128 wiz 8368: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 8369: <code class="filename">libdata/scrollkeeper</code> directory, as they
8370: will be handled automatically.</p></li>
1.128 wiz 8371: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119 mishka 8372: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8373: print-PLIST</strong></span> does this automatically.)</p></li>
1.75 rillig 8374: </ol></div>
8375: </div>
1.148 asau 8376: <div class="sect2">
1.75 rillig 8377: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8378: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8379: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8380: the fonts database in the directory where they get installed at
8381: installation and deinstallation time. This can be automatically
8382: done by using the pkginstall framework.</p>
1.75 rillig 8383: <p>You can list the directories where fonts are installed in the
1.87 wiz 8384: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8385: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128 wiz 8386: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.87 wiz 8387: Also make sure that the database file
8388: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8389: <p>Note that you should not create new directories for fonts;
1.87 wiz 8390: instead use the standard ones to avoid that the user needs to
8391: manually configure his X server to find them.</p>
1.75 rillig 8392: </div>
1.148 asau 8393: <div class="sect2">
1.75 rillig 8394: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8395: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8396: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8397: take some extra steps to get them registered in the GTK2 database
8398: properly:</p>
1.128 wiz 8399: <div class="orderedlist"><ol class="orderedlist" type="1">
8400: <li class="listitem"><p>Include
1.87 wiz 8401: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8402: <code class="filename">buildlink3.mk</code> file. This takes care of
8403: rebuilding the database at installation and deinstallation time.</p></li>
1.128 wiz 8404: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87 wiz 8405: your package installs GTK2 immodules.</p></li>
1.128 wiz 8406: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87 wiz 8407: GTK2 loaders.</p></li>
1.128 wiz 8408: <li class="listitem">
1.87 wiz 8409: <p>Patch the package to not touch any of the GTK2
8410: databases directly. These are:</p>
1.148 asau 8411: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8412: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8413: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 8414: </ul></div>
8415: </li>
1.128 wiz 8416: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87 wiz 8417: any entries under the <code class="filename">libdata/gtk-2.0</code>
8418: directory, as they will be handled automatically.</p></li>
1.75 rillig 8419: </ol></div>
8420: </div>
1.148 asau 8421: <div class="sect2">
1.75 rillig 8422: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8423: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 8424: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 8425: registered in system-wide catalogs (like DTDs, sub-catalogs,
8426: etc.), you need to take some extra steps:</p>
1.128 wiz 8427: <div class="orderedlist"><ol class="orderedlist" type="1">
8428: <li class="listitem"><p>Include
1.87 wiz 8429: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8430: your <code class="filename">Makefile</code>, which takes care of
8431: registering those files in system-wide catalogs at
8432: installation and deinstallation time.</p></li>
1.128 wiz 8433: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 8434: any SGML catalogs installed by the package.</p></li>
1.128 wiz 8435: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 8436: any XML catalogs installed by the package.</p></li>
1.128 wiz 8437: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 8438: to be added to the SGML catalog. These come in groups of
8439: three strings; see xmlcatmgr(1) for more information
8440: (specifically, arguments recognized by the 'add' action).
8441: Note that you will normally not use this variable.</p></li>
1.128 wiz 8442: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 8443: to be added to the XML catalog. These come in groups of three
8444: strings; see xmlcatmgr(1) for more information (specifically,
8445: arguments recognized by the 'add' action). Note that you will
8446: normally not use this variable.</p></li>
1.75 rillig 8447: </ol></div>
8448: </div>
1.148 asau 8449: <div class="sect2">
1.75 rillig 8450: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8451: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 8452: <p>If a package provides extensions to the MIME database by
1.87 wiz 8453: installing <code class="filename">.xml</code> files inside
8454: <code class="filename">${PREFIX}/share/mime/packages</code>, you
8455: need to take some extra steps to ensure that the database is kept
8456: consistent with respect to these new files:</p>
1.128 wiz 8457: <div class="orderedlist"><ol class="orderedlist" type="1">
8458: <li class="listitem"><p>Include
1.87 wiz 8459: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
8460: (avoid using the <code class="filename">buildlink3.mk</code> file from
8461: this same directory, which is reserved for inclusion from
8462: other <code class="filename">buildlink3.mk</code> files). It takes
8463: care of rebuilding the MIME database at installation and
8464: deinstallation time, and disallows any access to it directly
8465: from the package.</p></li>
1.128 wiz 8466: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87 wiz 8467: <code class="filename">share/mime</code> directory,
8468: <span class="emphasis"><em>except</em></span> for files saved under
8469: <code class="filename">share/mime/packages</code>. The former are
8470: handled automatically by
8471: the update-mime-database program, but the latter are
8472: package-dependent and must be removed by the package that
8473: installed them in the first place.</p></li>
1.128 wiz 8474: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 8475: from the PLIST. They will be handled by the shared-mime-info
8476: package.</p></li>
1.75 rillig 8477: </ol></div>
8478: </div>
1.148 asau 8479: <div class="sect2">
1.75 rillig 8480: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8481: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 8482: <p>If a package uses intltool during its build, add
8483: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 8484: which forces it to use the intltool package provided by pkgsrc,
8485: instead of the one bundled with the distribution file.</p>
1.75 rillig 8486: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 8487: latest available version; this way, the package benefits of any
8488: bug fixes that may have appeared since it was released.</p>
1.75 rillig 8489: </div>
1.148 asau 8490: <div class="sect2">
1.75 rillig 8491: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8492: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 8493: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 8494: the startup directory by default, but you can enable it, by adding
8495: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 8496: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 8497: into <code class="filename">/etc/rc.d</code> when a package is installed, and
8498: it will automatically remove the scripts when the package is
8499: deinstalled.</p>
1.75 rillig 8500: </div>
1.148 asau 8501: <div class="sect2">
1.75 rillig 8502: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8503: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 8504: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 8505: the <code class="filename">ls-R</code> database of the tree needs to be
8506: updated.</p>
1.148 asau 8507: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75 rillig 8508: <h3 class="title">Note</h3>
1.125 wiz 8509: <p>Except the main TeX packages such as kpathsea,
1.87 wiz 8510: packages should install files
1.125 wiz 8511: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
8512: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75 rillig 8513: </div>
1.128 wiz 8514: <div class="orderedlist"><ol class="orderedlist" type="1">
8515: <li class="listitem"><p>Include
1.125 wiz 8516: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.87 wiz 8517: takes care of rebuilding the <code class="filename">ls-R</code>
8518: database at installation and deinstallation time.</p></li>
1.128 wiz 8519: <li class="listitem">
1.75 rillig 8520: <p>If your package installs files into a texmf
1.87 wiz 8521: tree other than the one
1.125 wiz 8522: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
8523: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87 wiz 8524: trees that need database update.</p>
1.75 rillig 8525: <p>If your package also installs font map files that need
1.110 hubertf 8526: to be registered using <span class="command"><strong>updmap</strong></span>,
1.136 dholland 8527: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125 wiz 8528: set <code class="varname">TEX_MAP_FILES</code> and/or
8529: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110 hubertf 8530: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 8531: be run automatically at installation/deinstallation to
8532: enable/disable font map files for TeX output
8533: drivers.</p>
1.75 rillig 8534: </li>
1.128 wiz 8535: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 8536: databases are included in <code class="filename">PLIST</code>, as
1.136 dholland 8537: they will be removed only by the kpathsea package.</p></li>
1.75 rillig 8538: </ol></div>
8539: </div>
1.148 asau 8540: <div class="sect2">
1.85 jmmv 8541: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8542: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.87 wiz 8543: emulation</h3></div></div></div>
8544: <p>There are some packages that provide libraries and
8545: executables for running binaries from a one operating system
8546: on a different one (if the latter supports it). One example
8547: is running Linux binaries on NetBSD.</p>
1.250 leot 8548: <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.87 wiz 8549: helps in extracting and packaging Linux rpm packages.</p>
8550: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 8551: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 8552: if all libraries for each installed executable can be found by
8553: the dynamic linker. Since the standard dynamic linker is run,
8554: this fails for emulation packages, because the libraries used
8555: by the emulation are not in the standard directories.</p>
8556: </div>
1.148 asau 8557: <div class="sect2">
1.87 wiz 8558: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8559: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 8560: <p>If a package installs images under the
1.87 wiz 8561: <code class="filename">share/icons/hicolor</code> and/or updates the
8562: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
8563: database, you need to take some extra steps to make sure that the
8564: shared theme directory is handled appropriately and that the cache
8565: database is rebuilt:</p>
1.128 wiz 8566: <div class="orderedlist"><ol class="orderedlist" type="1">
8567: <li class="listitem"><p>Include
1.87 wiz 8568: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128 wiz 8569: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87 wiz 8570: entry that refers to the theme cache.</p></li>
1.128 wiz 8571: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85 jmmv 8572: directories from the <code class="filename">share/icons/hicolor</code>
8573: hierarchy because they will be handled automatically.</p></li>
8574: </ol></div>
8575: <p>The best way to verify that the PLIST is correct with
8576: respect to the last two points is to regenerate it using
1.110 hubertf 8577: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 8578: </div>
1.148 asau 8579: <div class="sect2">
1.85 jmmv 8580: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 8581: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 8582: <p>If a package installs <code class="filename">.desktop</code> files
8583: under <code class="filename">share/applications</code> and these include
1.159 rodent 8584: MIME information (MimeType key), you need to take extra steps to
8585: ensure that they are registered into the MIME database:</p>
1.128 wiz 8586: <div class="orderedlist"><ol class="orderedlist" type="1">
8587: <li class="listitem"><p>Include
1.85 jmmv 8588: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128 wiz 8589: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85 jmmv 8590: <code class="filename">share/applications/mimeinfo.cache</code> file.
8591: It will be handled automatically.</p></li>
8592: </ol></div>
8593: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 8594: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 8595: print-PLIST</strong></span>.</p>
1.75 rillig 8596: </div>
8597: </div>
1.148 asau 8598: <div class="sect1">
1.87 wiz 8599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8600: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 8601: <p>In some cases one does not have the time to solve a problem
1.125 wiz 8602: immediately. In this case, one can plainly mark a package as broken. For
8603: this, one just sets the variable <code class="varname">BROKEN</code> to the
8604: reason why the package is broken (similar to the
8605: <code class="varname">RESTRICTED</code> variable). A user trying to build
8606: the package will immediately be shown this message, and the build
8607: will not be even tried.</p>
8608: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87 wiz 8609: intervals.</p>
8610: </div>
1.75 rillig 8611: </div>
1.148 asau 8612: <div class="chapter">
1.75 rillig 8613: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 8614: <a name="debug"></a>Chapter 22. Debugging</h2></div></div></div>
1.88 wiz 8615: <p>To check out all the gotchas when building a package, here are
8616: the steps that I do in order to get a package working. Please note
8617: this is basically the same as what was explained in the previous
8618: sections, only with some debugging aids.</p>
1.148 asau 8619: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8620: <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>
8621: <li class="listitem">
1.250 leot 8622: <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.88 wiz 8623: create a directory for a new package, change into it, then run
1.110 hubertf 8624: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 8625: <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>
8626: <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>
8627: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
8628: </li>
1.128 wiz 8629: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
8630: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
8631: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
8632: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 8633: configure step to the package's
8634: <code class="filename">Makefile</code>.</p></li>
1.128 wiz 8635: <li class="listitem">
1.75 rillig 8636: <p>Make the package compile, doing multiple rounds of</p>
8637: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
8638: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
8639: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
8640: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
8641: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
8642: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
8643: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 8644: <p>Doing this step as non-root user will ensure that no files
8645: are modified that shouldn't be, especially during the build
1.110 hubertf 8646: phase. <span class="command"><strong>mkpatches</strong></span>,
8647: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.250 leot 8648: 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.88 wiz 8649: package.</p>
1.75 rillig 8650: </li>
1.128 wiz 8651: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
1.267 rillig 8652: necessary; see <a class="xref" href="#components.Makefile" title="13.1. Makefile">Section 13.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.128 wiz 8653: <li class="listitem">
1.76 rillig 8654: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 8655: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8656: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
8657: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
8658: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
8659: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 8660: <p>You usually need to be <code class="username">root</code> to do
8661: this. Look if there are any files left:</p>
1.75 rillig 8662: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8663: <p>If this reveals any files that are missing in
1.88 wiz 8664: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 8665: </li>
1.128 wiz 8666: <li class="listitem">
1.88 wiz 8667: <p>Now that the <code class="filename">PLIST</code> is OK, install the
8668: package again and make a binary package:</p>
1.75 rillig 8669: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
8670: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
8671: </li>
1.128 wiz 8672: <li class="listitem">
1.75 rillig 8673: <p>Delete the installed package:</p>
1.88 wiz 8674: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75 rillig 8675: </li>
1.128 wiz 8676: <li class="listitem">
1.110 hubertf 8677: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 8678: command, which shouldn't find anything now:</p>
1.75 rillig 8679: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
8680: </li>
1.128 wiz 8681: <li class="listitem">
1.75 rillig 8682: <p>Reinstall the binary package:</p>
1.93 rillig 8683: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75 rillig 8684: </li>
1.128 wiz 8685: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
8686: <li class="listitem">
1.250 leot 8687: <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.88 wiz 8688: reports:</p>
1.75 rillig 8689: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
8690: </li>
1.267 rillig 8691: <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.75 rillig 8692: </ul></div>
8693: </div>
1.148 asau 8694: <div class="chapter">
1.75 rillig 8695: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 8696: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75 rillig 8697: <div class="toc">
8698: <p><b>Table of Contents</b></p>
1.210 leot 8699: <dl class="toc">
1.267 rillig 8700: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
8701: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
8702: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
8703: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
8704: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
8705: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
8706: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
8707: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 8708: </dl>
8709: </div>
1.148 asau 8710: <div class="sect1">
1.75 rillig 8711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8712: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 8713: <p>Our policy is that we accept binaries only from pkgsrc
8714: developers to guarantee that the packages don't contain any
8715: trojan horses etc. This is not to annoy anyone but rather to
8716: protect our users! You're still free to put up your home-made
8717: binary packages and tell the world where to get them. NetBSD
8718: developers doing bulk builds and wanting to upload them please
1.267 rillig 8719: see <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.174 asau 8720: builds)</i></a>.</p>
1.75 rillig 8721: </div>
1.148 asau 8722: <div class="sect1">
1.75 rillig 8723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8724: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 8725: <p>First, check that your package is complete, compiles and
1.267 rillig 8726: runs well; see <a class="xref" href="#debug" title="Chapter 22. Debugging">Chapter 22, <i>Debugging</i></a> and the rest of this
1.270 leot 8727: 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.82 rillig 8728: archive that contains all files that make up the package.
1.87 wiz 8729: Finally, send this package to the pkgsrc bug tracking system,
1.270 leot 8730: 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.87 wiz 8731: that, go to the web page
1.110 hubertf 8732: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.124 snj 8733: which contains some instructions and a link to a form where you
8734: can submit packages. The
1.250 leot 8735: <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.124 snj 8736: also available as a substitute for either of the above two tools.
8737: </p>
1.87 wiz 8738: <p>In the form of the problem report, the category should be
1.128 wiz 8739: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.87 wiz 8740: and version number, and the description field should contain a
8741: short description of your package (contents of the COMMENT
8742: variable or DESCR file are OK). The uuencoded package data should
1.128 wiz 8743: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.75 rillig 8744: <p>If you want to submit several packages, please send a
8745: separate PR for each one, it's easier for us to track things
8746: that way.</p>
8747: <p>Alternatively, you can also import new packages into
1.128 wiz 8748: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.215 wiz 8749: homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.75 rillig 8750: for details.</p>
8751: </div>
1.148 asau 8752: <div class="sect1">
1.75 rillig 8753: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8754: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 8755: <p>Please note all package additions, updates, moves, and
1.93 rillig 8756: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 8757: important to keep this file up to date and conforming to the
8758: existing format, because it will be used by scripts to
1.110 hubertf 8759: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 8760: sites. Additionally, check the
1.76 rillig 8761: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 8762: for the package you updated or removed, in case it was mentioned
8763: there.</p>
8764: <p>When the <code class="varname">PKGREVISION</code> of a package is
8765: bumped, the change should appear in
1.93 rillig 8766: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 8767: related or otherwise relevant. Mass bumps that result from a
8768: dependency being updated should not be mentioned. In all other
8769: cases it's the developer's decision.</p>
8770: <p>There is a make target that helps in creating proper
1.110 hubertf 8771: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 8772: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
8773: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 8774: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 8775: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 8776: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
8777: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 8778: For new packages, or package moves or removals, set the
8779: <code class="varname">CTYPE</code> variable on the command line to "Added",
8780: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 8781: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125 wiz 8782: not the same as your NetBSD login name. The target also automatically
8783: removes possibly existing entries for the package in the
8784: <code class="filename">TODO</code> file. Don't forget to commit
1.174 asau 8785: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126 jakllsch 8786: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125 wiz 8787: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
8788: makes the cvs commands use the main repository.
8789: </p>
1.75 rillig 8790: </div>
1.148 asau 8791: <div class="sect1">
1.75 rillig 8792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8793: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243 wiz 8794: <p>For several years, there have been mirrors of pkgsrc in
8795: fossil, git, and hg. Standard practise when using these tools is to
8796: make the first line of a commit message function as a summary that
8797: can be read without the rest, such as is commonly done with "git log
8798: --oneline". For this reason, we have the following guidelines for
8799: pkgsrc commit messages:</p>
8800: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8801: <li class="listitem"><p>Start the commit message with a line that explains the
1.244 wiz 8802: big picture in 65 characters or less. When a commit is for one
1.243 wiz 8803: package, include the name of the package. For updates, include the
8804: version to which it is updated.</p></li>
8805: <li class="listitem"><p>Leave the next line empty.</p></li>
8806: <li class="listitem"><p>Then come the details for the commit (changes in that
8807: package, reason for a change) and any relevant PRs. Wrap this
8808: section.</p></li>
8809: </ul></div>
8810: <p>Here is an example:
8811: </p>
8812: <pre class="programlisting">
8813: libxslt: update to 1.0.30
8814:
8815: Changes since 1.0.29:
8816: ...
8817: </pre>
8818: <p>
8819: </p>
8820: <p>Here is another example:
8821: </p>
8822: <pre class="programlisting">
8823: mk/bsd.pkg.mk: enable SSP by default on NetBSD
8824:
8825: (rationale)
8826: </pre>
8827: <p>
8828: </p>
8829: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
8830: allowed on the pkgsrc repository to change commit messages.</p>
8831: </div>
8832: <div class="sect1">
8833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8834: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87 wiz 8835: <p>This section is only of interest for pkgsrc developers with write
1.140 wiz 8836: access to the pkgsrc repository.</p>
8837: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
8838: Start by adding the directory and then files in the directory. Don't
8839: forget to add the new package to the category's
8840: <code class="filename">Makefile</code>. Make sure you don't forget any files;
8841: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
8842: <pre class="programlisting">
8843: <code class="prompt">$</code> cd .../pkgsrc/category
8844: <code class="prompt">$</code> cvs add pkgname
8845: <code class="prompt">$</code> cd pkgname
8846: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8847: <code class="prompt">$</code> cvs add patches/p*
8848: <code class="prompt">$</code> cvs status | less
1.141 wiz 8849: <code class="prompt">$</code> cvs commit
1.140 wiz 8850: <code class="prompt">$</code> cd ..
8851: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141 wiz 8852: <code class="prompt">$</code> cvs commit Makefile
1.174 asau 8853: <code class="prompt">$</code> cd pkgname
1.182 jnemeth 8854: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140 wiz 8855: </pre>
1.87 wiz 8856: <p>The commit message of the initial import should include part of the
1.76 rillig 8857: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 8858: what the package is/does.</p>
1.140 wiz 8859: <p>Also mention the new package in
8860: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
8861: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
8862: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.75 rillig 8863: </div>
1.148 asau 8864: <div class="sect1">
1.75 rillig 8865: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8866: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 8867: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 8868: changes between old and new versions into the commit log when updating
1.87 wiz 8869: a package. There are various reasons for this:</p>
1.148 asau 8870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 8871: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87 wiz 8872: or its information may be overwritten by newer information.</p></li>
1.128 wiz 8873: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87 wiz 8874: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128 wiz 8875: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75 rillig 8876: repository is very useful for people who read the pkgsrc-changes mailing
8877: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 8878: the package.</p></li>
1.75 rillig 8879: </ul></div>
1.87 wiz 8880: <p>Please also recognize that, just because a new version of a package
1.75 rillig 8881: has been released, it should not automatically be upgraded in the CVS
8882: repository. We prefer to be conservative in the packages that are
8883: included in pkgsrc - development or beta packages are not really the
8884: best thing for most places in which pkgsrc is used. Please use your
8885: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 8886: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 8887: </div>
1.148 asau 8888: <div class="sect1">
1.75 rillig 8889: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8890: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122 reed 8891: <p>Renaming packages is not recommended.</p>
8892: <p>When renaming packages, be sure to fix any references to old name
8893: in other Makefiles, options, buildlink files, etc.</p>
8894: <p>Also When renaming a package, please define
8895: <code class="varname">SUPERSEDES</code> to the package name and dewey version
8896: pattern(s) of the previous package name.
8897: This may be repeated for multiple renames.
8898: The new package would be an exact replacement.
8899: </p>
1.128 wiz 8900: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.122 reed 8901: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
8902: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
8903: not be an exact replacement but is a suggestion for the replaced
8904: functionality.</p>
8905: </div>
1.148 asau 8906: <div class="sect1">
1.122 reed 8907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 8908: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122 reed 8909: <p>It is preferred that packages are not renamed or moved, but if needed
8910: please follow these steps.
8911: </p>
1.128 wiz 8912: <div class="orderedlist"><ol class="orderedlist" type="1">
8913: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
8914: <li class="listitem">
1.75 rillig 8915: <p>Remove all CVS dirs.</p>
1.87 wiz 8916: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 8917: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87 wiz 8918: <p>and use that for further work.</p>
1.75 rillig 8919: </li>
1.128 wiz 8920: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
8921: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
8922: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
8923: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122 reed 8924: <code class="varname">PREV_PKGPATH</code> to the previous category/package
8925: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
8926: for doing an update using pkgsrc building; for example, it can
1.270 leot 8927: 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.122 reed 8928: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
8929: new <code class="varname">PKGPATH</code> for that moved package. Note that
8930: it may have multiple matches, so the tool should also check on the
8931: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
8932: probably has no value unless <code class="varname">SUPERSEDES</code> is not
8933: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.128 wiz 8934: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 8935: place.</p></li>
1.128 wiz 8936: <li class="listitem">
1.75 rillig 8937: <p>Check if any package depends on it:
8938: </p>
8939: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
8940: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
8941: </li>
1.128 wiz 8942: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
8943: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
8944: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
8945: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
8946: <li class="listitem">
1.75 rillig 8947: <p>Commit the changed and removed files:</p>
8948: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87 wiz 8949: <p>(and any packages from step 5, of course).</p>
1.75 rillig 8950: </li>
8951: </ol></div>
8952: </div>
8953: </div>
1.148 asau 8954: <div class="chapter">
1.75 rillig 8955: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 8956: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 8957: <p>This section contains the answers to questions that may
8958: arise when you are writing a package. If you don't find your
8959: question answered here, first have a look in the other chapters,
8960: and if you still don't have the answer, ask on the
8961: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148 asau 8962: <div class="qandaset">
1.271 ! brook 8963: <a name="idp140534676752072"></a><dl>
1.267 rillig 8964: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 8965: MAKEFLAGS, .MAKEFLAGS and
8966: MAKE_FLAGS?</a>
8967: </dt>
1.267 rillig 8968: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 8969: MAKE, GMAKE and
8970: MAKE_PROGRAM?</a>
8971: </dt>
1.267 rillig 8972: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 8973: CC, PKG_CC and
8974: PKGSRC_COMPILER?</a>
8975: </dt>
1.267 rillig 8976: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 8977: BUILDLINK_LDFLAGS,
8978: BUILDLINK_LDADD and
8979: BUILDLINK_LIBS?</a>
8980: </dt>
1.267 rillig 8981: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 8982: VARNAME=BUILDLINK_PREFIX.foo
8983: say it's empty?</a>
8984: </dt>
1.267 rillig 8985: <dt>24.6. <a href="#devfaq.master_sites">What does
1.78 rillig 8986: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
8987: don't understand the := inside
8988: it.</a>
8989: </dt>
1.267 rillig 8990: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 8991: developers?</a>
8992: </dt>
1.267 rillig 8993: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 8994: documentation?</a>
8995: </dt>
1.267 rillig 8996: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 8997: do?</a>
8998: </dt>
1.75 rillig 8999: </dl>
1.148 asau 9000: <table border="0" style="width: 100%;">
9001: <colgroup>
1.75 rillig 9002: <col align="left" width="1%">
1.128 wiz 9003: <col>
1.148 asau 9004: </colgroup>
1.75 rillig 9005: <tbody>
1.148 asau 9006: <tr class="question">
1.75 rillig 9007: <td align="left" valign="top">
1.271 ! brook 9008: <a name="devfaq.makeflags"></a><a name="idp140534676752744"></a><p><b>24.1.</b></p>
1.75 rillig 9009: </td>
9010: <td align="left" valign="top"><p>What is the difference between
9011: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9012: <code class="varname">MAKE_FLAGS</code>?</p></td>
9013: </tr>
9014: <tr class="answer">
1.91 rillig 9015: <td align="left" valign="top"></td>
1.75 rillig 9016: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.270 leot 9017: 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.75 rillig 9018: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9019: the <code class="varname">MAKE_PROGRAM</code> when building the
9020: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9021: </tr>
1.148 asau 9022: <tr class="question">
1.75 rillig 9023: <td align="left" valign="top">
1.271 ! brook 9024: <a name="devfaq.make"></a><a name="idp140534689356328"></a><p><b>24.2.</b></p>
1.75 rillig 9025: </td>
9026: <td align="left" valign="top"><p>What is the difference between
9027: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9028: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9029: </tr>
9030: <tr class="answer">
1.91 rillig 9031: <td align="left" valign="top"></td>
1.75 rillig 9032: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.270 leot 9033: <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.75 rillig 9034: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9035: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9036: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9037: Make program that is used for building the
9038: package.</p></td>
9039: </tr>
1.148 asau 9040: <tr class="question">
1.75 rillig 9041: <td align="left" valign="top">
1.271 ! brook 9042: <a name="devfaq.cc"></a><a name="idp140534689361384"></a><p><b>24.3.</b></p>
1.75 rillig 9043: </td>
9044: <td align="left" valign="top"><p>What is the difference between
9045: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9046: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9047: </tr>
9048: <tr class="answer">
1.91 rillig 9049: <td align="left" valign="top"></td>
1.75 rillig 9050: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9051: compiler, which can be configured by the pkgsrc user.
9052: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9053: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9054: path to a compiler, but the type of compiler that should be
1.76 rillig 9055: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9056: information about the latter variable.</p></td>
9057: </tr>
1.148 asau 9058: <tr class="question">
1.75 rillig 9059: <td align="left" valign="top">
1.271 ! brook 9060: <a name="devfaq.bl3flags"></a><a name="idp140534689366248"></a><p><b>24.4.</b></p>
1.75 rillig 9061: </td>
9062: <td align="left" valign="top"><p>What is the difference between
9063: <code class="varname">BUILDLINK_LDFLAGS</code>,
9064: <code class="varname">BUILDLINK_LDADD</code> and
9065: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9066: </tr>
9067: <tr class="answer">
1.91 rillig 9068: <td align="left" valign="top"></td>
1.75 rillig 9069: <td align="left" valign="top"><p>[FIXME]</p></td>
9070: </tr>
1.148 asau 9071: <tr class="question">
1.75 rillig 9072: <td align="left" valign="top">
1.271 ! brook 9073: <a name="devfaq.bl3prefix"></a><a name="idp140534689368872"></a><p><b>24.5.</b></p>
1.75 rillig 9074: </td>
1.110 hubertf 9075: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9076: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9077: say it's empty?</p></td>
9078: </tr>
9079: <tr class="answer">
1.91 rillig 9080: <td align="left" valign="top"></td>
1.75 rillig 9081: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128 wiz 9082: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9083: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.110 hubertf 9084: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9085: command.</p></td>
9086: </tr>
1.148 asau 9087: <tr class="question">
1.78 rillig 9088: <td align="left" valign="top">
1.271 ! brook 9089: <a name="devfaq.master_sites"></a><a name="idp140534689372744"></a><p><b>24.6.</b></p>
1.78 rillig 9090: </td>
9091: <td align="left" valign="top"><p>What does
1.220 wiz 9092: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9093: don't understand the <code class="code">:=</code> inside
1.78 rillig 9094: it.</p></td>
9095: </tr>
9096: <tr class="answer">
1.91 rillig 9097: <td align="left" valign="top"></td>
1.220 wiz 9098: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
9099: assignment operator, although it looks like it.
1.78 rillig 9100: Instead, it is a degenerate form of
1.220 wiz 9101: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.270 leot 9102: 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.220 wiz 9103: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78 rillig 9104: case of <code class="varname">MASTER_SITE_*</code>,
9105: <em class="replaceable"><code>old_string</code></em> is the empty string and
9106: <em class="replaceable"><code>new_string</code></em> is
1.220 wiz 9107: <code class="code">package/</code>. That's where the
9108: <code class="code">:</code> and the <code class="code">=</code> fall
1.78 rillig 9109: together.</p></td>
9110: </tr>
1.148 asau 9111: <tr class="question">
1.78 rillig 9112: <td align="left" valign="top">
1.271 ! brook 9113: <a name="devfaq.mailinglists"></a><a name="idp140534689380456"></a><p><b>24.7.</b></p>
1.78 rillig 9114: </td>
9115: <td align="left" valign="top"><p>Which mailing lists are there for package
9116: developers?</p></td>
9117: </tr>
9118: <tr class="answer">
1.91 rillig 9119: <td align="left" valign="top"></td>
1.148 asau 9120: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110 hubertf 9121: <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.78 rillig 9122: <dd><p>This is a list for technical discussions related
9123: to pkgsrc development, e.g. soliciting feedback for changes to
9124: pkgsrc infrastructure, proposed new features, questions related
9125: to porting pkgsrc to a new platform, advice for maintaining a
9126: package, patches that affect many packages, help requests moved
9127: from pkgsrc-users when an infrastructure bug is found,
9128: etc.</p></dd>
1.110 hubertf 9129: <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.78 rillig 9130: <dd><p>All bug reports in category "pkg" sent with
1.270 leot 9131: <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.78 rillig 9132: directly; use one of the other mailing
9133: lists.</p></dd>
9134: </dl></div></td>
9135: </tr>
1.148 asau 9136: <tr class="question">
1.80 rillig 9137: <td align="left" valign="top">
1.271 ! brook 9138: <a name="devfaq.documentation"></a><a name="idp140534689385368"></a><p><b>24.8.</b></p>
1.80 rillig 9139: </td>
9140: <td align="left" valign="top"><p>Where is the pkgsrc
9141: documentation?</p></td>
9142: </tr>
9143: <tr class="answer">
1.91 rillig 9144: <td align="left" valign="top"></td>
1.80 rillig 9145: <td align="left" valign="top">
9146: <p>There are many places where you can find
9147: documentation about pkgsrc:</p>
1.148 asau 9148: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9149: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80 rillig 9150: of chapters that explain large parts of pkgsrc, but some
9151: chapters tend to be outdated. Which ones they are is hard to
9152: say.</p></li>
1.128 wiz 9153: <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.80 rillig 9154: about certain features, announcements of new parts of the pkgsrc
9155: infrastructure and sometimes even announcements that a certain
9156: feature has been marked as obsolete. The benefit here is that
9157: each message has a date appended to it.</p></li>
1.128 wiz 9158: <li class="listitem"><p>Many of the files in the
1.80 rillig 9159: <code class="filename">mk/</code> directory start with a comment that
9160: describes the purpose of the file and how it can be used by the
1.92 rillig 9161: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9162: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9163: help</strong></span>.</p></li>
1.128 wiz 9164: <li class="listitem"><p>The CVS log messages are a rich source of
1.80 rillig 9165: information, but they tend to be highly abbreviated, especially
9166: for actions that occur often. Some contain a detailed
9167: description of what has changed, but they are geared towards the
9168: other pkgsrc developers, not towards an average pkgsrc user.
9169: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9170: don't know what has been before, these messages may not be worth
9171: too much to you.</p></li>
1.128 wiz 9172: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9173: documented</span>”</span>, that is the documentation exists only in the
1.80 rillig 9174: mind of the developer who wrote the code. To get this
1.110 hubertf 9175: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9176: to see who has written it and ask on the
9177: <code class="literal">tech-pkg</code> mailing list, so that others can
9178: find your questions later (see above). To be sure that the
9179: developer in charge reads the mail, you may CC him or
9180: her.</p></li>
9181: </ul></div>
9182: </td>
9183: </tr>
1.148 asau 9184: <tr class="question">
1.92 rillig 9185: <td align="left" valign="top">
1.271 ! brook 9186: <a name="devfaq.too-much-time"></a><a name="idp140534689394200"></a><p><b>24.9.</b></p>
1.92 rillig 9187: </td>
9188: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9189: do?</p></td>
9190: </tr>
9191: <tr class="answer">
9192: <td align="left" valign="top"></td>
9193: <td align="left" valign="top">
1.93 rillig 9194: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9195: anyway.</p>
1.148 asau 9196: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9197: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.250 leot 9198: <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.92 rillig 9199: will tell you about newer versions of installed packages that are
9200: available, but not yet updated in pkgsrc.</p></li>
1.128 wiz 9201: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126 jakllsch 9202: — it contains a list of suggested new packages and a list of
1.92 rillig 9203: cleanups and enhancements for pkgsrc that would be nice to
9204: have.</p></li>
1.128 wiz 9205: <li class="listitem"><p>Review packages for which review was requested on
1.180 wiz 9206: the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92 rillig 9207: mailing list.</p></li>
9208: </ul></div>
9209: </td>
9210: </tr>
1.75 rillig 9211: </tbody>
9212: </table>
9213: </div>
9214: </div>
1.148 asau 9215: <div class="chapter">
1.85 jmmv 9216: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9217: <a name="gnome"></a>Chapter 25. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9218: <div class="toc">
9219: <p><b>Table of Contents</b></p>
1.210 leot 9220: <dl class="toc">
1.267 rillig 9221: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
9222: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
9223: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
9224: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.85 jmmv 9225: </dl>
9226: </div>
1.110 hubertf 9227: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9228: site</a>:</p>
9229: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9230: environment, an intuitive and attractive desktop for users, and the
9231: GNOME development platform, an extensive framework for building
9232: applications that integrate into the rest of the desktop.</p></blockquote></div>
9233: <p>pkgsrc provides a seamless way to automatically build and install
9234: a complete GNOME environment <span class="emphasis"><em>under many different
9235: platforms</em></span>. We can say with confidence that pkgsrc is one of
9236: the most advanced build and packaging systems for GNOME due to its
9237: included technologies buildlink3, the wrappers and tools framework and
9238: automatic configuration file management. Lots of efforts are put into
9239: achieving a completely clean deinstallation of installed software
9240: components.</p>
1.110 hubertf 9241: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9242: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9243: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9244: pkgsrc as its preferred packaging system, contributing lots of
9245: portability fixes to make GNOME build and install under it.</p>
9246: <p>This chapter is aimed at pkgsrc developers and other people
9247: interested in helping our GNOME porting and packaging efforts. It
9248: provides instructions on how to manage the existing packages and some
9249: important information regarding their internals.</p>
1.148 asau 9250: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85 jmmv 9251: <h3 class="title">We need your help!</h3>
9252: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9253: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9254: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9255: work</a> list! There is still a long way to go to get a
9256: fully-functional GNOME desktop under NetBSD and we need your help to
9257: achieve it!</p>
9258: </div>
1.148 asau 9259: <div class="sect1">
1.85 jmmv 9260: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9261: <a name="meta-packages"></a>25.1. Meta packages</h2></div></div></div>
1.85 jmmv 9262: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148 asau 9263: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250 leot 9264: <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.85 jmmv 9265: the core GNOME desktop environment. It only includes the necessary
9266: bits to get it to boot correctly, although it may lack important
9267: functionality for daily operation. The idea behind this package is
9268: to let end users build their own configurations on top of this one,
9269: first installing this meta package to achieve a functional setup and
9270: then adding individual applications.</p></li>
1.250 leot 9271: <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.85 jmmv 9272: complete installation of the GNOME platform and desktop as defined
9273: by the GNOME project; this is based on the components distributed in
9274: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9275: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9276: official FTP server. Developer-only tools found in those
9277: directories are not installed unless required by some other
9278: component to work properly. Similarly, packages from the bindings
9279: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9280: in unless required as a dependency for an end-user component. This
1.250 leot 9281: 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>
9282: <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.85 jmmv 9283: Installs all the tools required to build a GNOME component when
9284: fetched from the CVS repository. These are required to let the
1.110 hubertf 9285: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9286: </ul></div>
9287: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9288: sorted in a way that eases updates: a package may depend on other
9289: packages listed before it but not on any listed after it. It is very
9290: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9291: change it to alphabetical sorting!</em></span></p>
9292: </div>
1.148 asau 9293: <div class="sect1">
1.85 jmmv 9294: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9295: <a name="new-package"></a>25.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9296: <p>Almost all GNOME applications are written in C and use a common
9297: set of tools as their build system. Things get different with the new
9298: bindings to other languages (such as Python), but the following will
9299: give you a general idea on the minimum required tools:</p>
1.148 asau 9300: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9301: <li class="listitem">
1.85 jmmv 9302: <p>Almost all GNOME applications use the GNU Autotools as their
9303: build system. As a general rule you will need to tell this to your
9304: package:</p>
1.100 rillig 9305: <pre class="programlisting">
9306: GNU_CONFIGURE=yes
1.85 jmmv 9307: USE_LIBTOOL=yes
1.100 rillig 9308: USE_TOOLS+=gmake
9309: </pre>
1.85 jmmv 9310: </li>
1.128 wiz 9311: <li class="listitem">
1.85 jmmv 9312: <p>If the package uses pkg-config to detect dependencies, add this
9313: tool to the list of required utilities:</p>
1.222 sevan 9314: <pre class="programlisting">
9315: USE_TOOLS+=pkg-config
9316: </pre>
1.250 leot 9317: <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.85 jmmv 9318: the end of the build process to ensure that you did not miss to
9319: specify any dependency in your package and that the version
9320: requirements are all correct.</p>
9321: </li>
1.128 wiz 9322: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93 rillig 9323: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9324: to handle dependencies and to force the package to use the latest
9325: available version.</p></li>
1.128 wiz 9326: <li class="listitem">
1.85 jmmv 9327: <p>If the package uses gtk-doc (a documentation generation
9328: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9329: tool is rather big and the distfile should come with pregenerated
9330: documentation anyway; if it does not, it is a bug that you ought to
9331: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9332: the default):</p>
1.222 sevan 9333: <pre class="programlisting">
9334: CONFIGURE_ARGS+=--disable-gtk-doc
9335: </pre>
1.89 rillig 9336: <p>The default location of installed HTML files
9337: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9338: and should not be changed unless the package insists on installing
9339: them somewhere else. Otherwise programs as
1.110 hubertf 9340: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9341: do that with an entry similar to:</p>
1.222 sevan 9342: <pre class="programlisting">
9343: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9344: </pre>
1.85 jmmv 9345: </li>
9346: </ul></div>
9347: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9348: files under the installation prefix to maintain databases. In this
9349: context, shared means that those exact same directories and files are
9350: used among several different packages, leading to conflicts in the
9351: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9352: handle the most common cases, so you have to forget about using
9353: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9354: omitting shared files from them. If you find yourself doing those,
9355: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9356: <p>The following table lists the common situations that result in
9357: using shared directories or files. For each of them, the appropriate
9358: solution is given. After applying the solution be sure to
9359: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9360: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9361: <div class="table">
1.267 rillig 9362: <a name="plist-handling"></a><p class="title"><b>Table 25.1. PLIST handling for GNOME packages</b></p>
1.216 tnn 9363: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9364: <colgroup>
9365: <col>
9366: <col>
9367: </colgroup>
9368: <thead><tr>
9369: <th>If the package...</th>
9370: <th>Then...</th>
9371: </tr></thead>
9372: <tbody>
9373: <tr>
9374: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.267 rillig 9375: <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.85 jmmv 9376: </tr>
9377: <tr>
9378: <td>Installs icons under the
9379: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9380: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.267 rillig 9381: <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.85 jmmv 9382: </tr>
9383: <tr>
9384: <td>Installs files under
9385: <code class="filename">share/mime/packages</code>.</td>
1.267 rillig 9386: <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.85 jmmv 9387: </tr>
9388: <tr>
9389: <td>Installs <code class="filename">.desktop</code> files under
9390: <code class="filename">share/applications</code> and these include MIME
9391: information.</td>
1.267 rillig 9392: <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.85 jmmv 9393: </tr>
9394: </tbody>
1.91 rillig 9395: </table></div>
1.85 jmmv 9396: </div>
1.91 rillig 9397: <br class="table-break">
1.85 jmmv 9398: </div>
1.148 asau 9399: <div class="sect1">
1.85 jmmv 9400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9401: <a name="full-update"></a>25.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9402: <p>When seeing GNOME as a whole, there are two kinds of
9403: updates:</p>
1.148 asau 9404: <div class="variablelist"><dl class="variablelist">
1.85 jmmv 9405: <dt><span class="term">Major update</span></dt>
9406: <dd>
9407: <p>Given that there is still a very long way for GNOME 3 (if it
9408: ever appears), we consider a major update one that goes from a
9409: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9410: where <code class="literal">Y</code> is even and greater than
9411: <code class="literal">X</code>. These are hard to achieve because they
9412: introduce lots of changes in the components' code and almost all
9413: GNOME distfiles are updated to newer versions. Some of them can
9414: even break API and ABI compatibility with the previous major
9415: version series. As a result, the update needs to be done all at
9416: once to minimize breakage.</p>
9417: <p>A major update typically consists of around 80 package
9418: updates and the addition of some new ones.</p>
9419: </dd>
9420: <dt><span class="term">Minor update</span></dt>
9421: <dd>
9422: <p>We consider a minor update one that goes from a
9423: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9424: one where <code class="literal">Y</code> is greater than
9425: <code class="literal">X</code>. These are easy to achieve because they do
9426: not update all GNOME components, can be done in an incremental way
9427: and do not break API nor ABI compatibility.</p>
9428: <p>A minor update typically consists of around 50 package
9429: updates, although the numbers here may vary a lot.</p>
9430: </dd>
9431: </dl></div>
9432: <p>In order to update the GNOME components in pkgsrc to a new stable
9433: release (either major or minor), the following steps should be
9434: followed:</p>
1.128 wiz 9435: <div class="orderedlist"><ol class="orderedlist" type="1">
9436: <li class="listitem">
1.85 jmmv 9437: <p>Get a list of all the tarballs that form the new release by
9438: using the following commands. These will leave the full list of the
1.120 snj 9439: components' distfiles into the <code class="filename">list.txt</code>
1.85 jmmv 9440: file:</p>
1.88 wiz 9441: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9442: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9443: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9444: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9445: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9446: awk '{ print $9 }' >>list.txt</code></strong></pre>
9447: </li>
1.128 wiz 9448: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85 jmmv 9449: bump their version to the release you are updating them to. The
9450: three meta packages should be always consistent with versioning.
9451: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9452: in them.</p></li>
1.128 wiz 9453: <li class="listitem">
1.85 jmmv 9454: <p>For each meta package, update all its
9455: <code class="varname">DEPENDS</code> lines to match the latest versions as
9456: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9457: newer version (even if found in the FTP) because the meta packages
9458: are supposed to list the exact versions that form a specific GNOME
9459: release. Exceptions are permitted here if a newer version solves a
9460: serious issue in the overall desktop experience; these typically
9461: come in the form of a revision bump in pkgsrc, not in newer versions
9462: from the developers.</p>
9463: <p>Packages not listed in the <code class="filename">list.txt</code> file
9464: should be updated to the latest version available (if found in
9465: pkgsrc). This is the case, for example, of the dependencies on the
1.250 leot 9466: 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.85 jmmv 9467: </li>
1.128 wiz 9468: <li class="listitem">
1.85 jmmv 9469: <p>Generate a patch from the modified meta packages and extract the
9470: list of "new" lines. This will provide you an outline on what
9471: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 9472: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
1.85 jmmv 9473: </li>
1.128 wiz 9474: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85 jmmv 9475: installed packages and start over from scratch at this point.</p></li>
1.128 wiz 9476: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85 jmmv 9477: of <code class="filename">todo.txt</code> and update the packages listed in
9478: it in order. For major desktop updates none of these should be
1.93 rillig 9479: committed until the entire set is completed because there are chances
1.85 jmmv 9480: of breaking not-yet-updated packages.</p></li>
1.128 wiz 9481: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85 jmmv 9482: the tree one by one with appropriate log messages. At the end,
9483: commit the three meta package updates and all the corresponding
9484: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9485: <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>
9486: </ol></div>
9487: </div>
1.148 asau 9488: <div class="sect1">
1.85 jmmv 9489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9490: <a name="patching"></a>25.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 9491: <p>GNOME is a very big component in pkgsrc which approaches 100
9492: packages. Please, it is very important that you always, always,
9493: <span class="strong"><strong>always</strong></span> feed back any portability
1.267 rillig 9494: 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.85 jmmv 9495: their attention on portability issues and to ensure that future versions
9496: can be built out-of-the box on NetBSD. The less custom patches in
9497: pkgsrc, the easier further updates are. Those developers in charge of
9498: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 9499: <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.85 jmmv 9500: Bugzilla</a>. Not all components use these to track bugs, but most
9501: of them do. Do not be short on your reports: always provide detailed
9502: explanations of the current failure, how it can be improved to achieve
9503: maximum portability and, if at all possible, provide a patch against CVS
9504: head. The more verbose you are, the higher chances of your patch being
9505: accepted.</p>
9506: <p>Also, please avoid using preprocessor magic to fix portability
9507: issues. While the FreeBSD GNOME people are doing a great job in porting
9508: GNOME to their operating system, the official GNOME sources are now
9509: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9510: and similar macros. This hurts portability. Please see our patching
1.267 rillig 9511: guidelines (<a class="xref" href="#components.patches.guidelines" title="13.3.4. Patching guidelines">Section 13.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 9512: details.</p>
9513: </div>
9514: </div>
1.75 rillig 9515: </div>
1.148 asau 9516: <div class="part">
1.75 rillig 9517: <div class="titlepage"><div><div><h1 class="title">
9518: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148 asau 9519: <div class="partintro">
1.75 rillig 9520: <div></div>
9521: <p>This part of the guide deals with everything
9522: from the infrastructure that is behind the interfaces described
9523: in the developer's guide. A casual package maintainer should not
9524: need anything from this part.</p>
9525: <div class="toc">
9526: <p><b>Table of Contents</b></p>
1.210 leot 9527: <dl class="toc">
1.267 rillig 9528: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 9529: <dd><dl>
1.267 rillig 9530: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
9531: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
9532: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.75 rillig 9533: <dd><dl>
1.267 rillig 9534: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
9535: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.75 rillig 9536: </dl></dd>
1.267 rillig 9537: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
9538: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 9539: <dd><dl>
1.267 rillig 9540: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
9541: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81 rillig 9542: </dl></dd>
1.267 rillig 9543: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.81 rillig 9544: <dd><dl>
1.267 rillig 9545: <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>
9546: <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.75 rillig 9547: </dl></dd>
9548: </dl></dd>
1.267 rillig 9549: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.75 rillig 9550: <dd><dl>
1.267 rillig 9551: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
9552: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75 rillig 9553: <dd><dl>
1.267 rillig 9554: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
9555: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75 rillig 9556: </dl></dd>
9557: </dl></dd>
1.267 rillig 9558: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
9559: <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.75 rillig 9560: </dl>
9561: </div>
9562: </div>
1.148 asau 9563: <div class="chapter">
1.75 rillig 9564: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9565: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 9566: <div class="toc">
9567: <p><b>Table of Contents</b></p>
1.210 leot 9568: <dl class="toc">
1.267 rillig 9569: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
9570: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
9571: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.81 rillig 9572: <dd><dl>
1.267 rillig 9573: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
9574: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.81 rillig 9575: </dl></dd>
1.267 rillig 9576: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
9577: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 9578: <dd><dl>
1.267 rillig 9579: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
9580: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 9581: </dl></dd>
1.267 rillig 9582: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.75 rillig 9583: <dd><dl>
1.267 rillig 9584: <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>
9585: <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.75 rillig 9586: </dl></dd>
9587: </dl>
9588: </div>
9589: <p>The pkgsrc infrastructure consists of many small Makefile
9590: fragments. Each such fragment needs a properly specified
9591: interface. This chapter explains how such an interface looks
9592: like.</p>
1.148 asau 9593: <div class="sect1">
1.75 rillig 9594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9595: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 9596: <p>Whenever a variable is defined in the pkgsrc
9597: infrastructure, the location and the way of definition provide
9598: much information about the intended use of that variable.
9599: Additionally, more documentation may be found in a header
9600: comment or in this pkgsrc guide.</p>
9601: <p>A special file is
9602: <code class="filename">mk/defaults/mk.conf</code>, which lists all
9603: variables that are intended to be user-defined. They are either
9604: defined using the <code class="literal">?=</code> operator or they are
9605: left undefined because defining them to anything would
1.128 wiz 9606: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.81 rillig 9607: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
9608: file.</p>
9609: <p>Outside this file, the following conventions apply:
9610: Variables that are defined using the <code class="literal">?=</code>
9611: operator may be overridden by a package.</p>
9612: <p>Variables that are defined using the <code class="literal">=</code>
9613: operator may be used read-only at run-time.</p>
9614: <p>Variables whose name starts with an underscore must not be
9615: accessed outside the pkgsrc infrastructure at all. They may
9616: change without further notice.</p>
1.148 asau 9617: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81 rillig 9618: <h3 class="title">Note</h3>
9619: <p>These conventions are currently not applied
9620: consistently to the complete pkgsrc
9621: infrastructure.</p>
9622: </div>
9623: </div>
1.148 asau 9624: <div class="sect1">
1.81 rillig 9625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9626: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 9627: <p>All variables that contain lists of things should default
9628: to being empty. Two examples that do not follow this rule are
9629: <code class="varname">USE_LANGUAGES</code> and
9630: <code class="varname">DISTFILES</code>. These variables cannot simply be
9631: modified using the <code class="literal">+=</code> operator in package
9632: <code class="filename">Makefile</code>s (or other files included by
9633: them), since there is no guarantee whether the variable is
9634: already set or not, and what its value is. In the case of
1.128 wiz 9635: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.81 rillig 9636: the default value and just define it as in the following
9637: example.</p>
9638: <pre class="programlisting">
1.100 rillig 9639: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 9640: </pre>
9641: <p>Because of the selection of this default value, the same
9642: value appears in many package Makefiles. Similarly for
9643: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128 wiz 9644: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.81 rillig 9645: doesn't stand out. Nevertheless it is mentioned in many
9646: files.</p>
9647: </div>
1.148 asau 9648: <div class="sect1">
1.81 rillig 9649: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9650: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.148 asau 9651: <div class="sect2">
1.75 rillig 9652: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9653: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.75 rillig 9654: <p>Variable evaluation takes place either at load time or at
9655: runtime, depending on the context in which they occur. The
9656: contexts where variables are evaluated at load time are:</p>
1.148 asau 9657: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 9658: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75 rillig 9659: and <code class="literal">!=</code> operators,</p></li>
1.128 wiz 9660: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75 rillig 9661: <code class="literal">.for</code>,</p></li>
1.128 wiz 9662: <li class="listitem"><p>Dependency lines.</p></li>
1.75 rillig 9663: </ul></div>
9664: <p>A special exception are references to the iteration
9665: variables of <code class="literal">.for</code> loops, which are expanded
9666: inline, no matter in which context they appear.</p>
9667: <p>As the values of variables may change during load time,
9668: care must be taken not to evaluate them by accident. Typical
9669: examples for variables that should not be evaluated at load time
9670: are <code class="varname">DEPENDS</code> and
9671: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
9672: clear, here is an example:</p>
9673: <pre class="programlisting">
1.100 rillig 9674: CONFIGURE_ARGS= # none
9675: CFLAGS= -O
9676: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 9677:
1.100 rillig 9678: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 9679:
1.100 rillig 9680: CFLAGS+= -Wall
1.222 sevan 9681: </pre>
1.75 rillig 9682: <p>This code shows how the use of the <code class="literal">:=</code>
9683: operator can quickly lead to unexpected results. The first
9684: paragraph is fairly common code. The second paragraph evaluates
9685: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
9686: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
9687: <code class="literal">-Wall</code> is appended to the
9688: <code class="varname">CFLAGS</code>, but this addition will not appear in
9689: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
9690: paragraphs from above typically occur in completely unrelated
9691: files.</p>
9692: </div>
1.148 asau 9693: <div class="sect2">
1.75 rillig 9694: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9695: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.75 rillig 9696: <p>After all the files have been loaded, the values of the
9697: variables cannot be changed anymore. Variables that are used in
9698: the shell commands are expanded at this point.</p>
9699: </div>
9700: </div>
1.148 asau 9701: <div class="sect1">
1.75 rillig 9702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9703: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 9704: <p>There are many ways in which the definition and use of a
1.218 rillig 9705: variable can be restricted in order to detect bugs and violations
9706: of the (mostly unwritten) policies. A package can be checked with
9707: <code class="literal">pkglint -Wall</code> to see whether it meets these
9708: rules.</p>
1.78 rillig 9709: </div>
1.148 asau 9710: <div class="sect1">
1.78 rillig 9711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9712: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 9713: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 9714: of the following classes. Cases where a file falls into more
9715: than one class should be avoided as it often leads to subtle
9716: bugs.</p>
1.148 asau 9717: <div class="sect2">
1.75 rillig 9718: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9719: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 9720: <p>In a traditional imperative programming language some of
1.76 rillig 9721: the <code class="filename">.mk</code> files could be described as
1.126 jakllsch 9722: procedures. They take some input parameters and—after
9723: inclusion—provide a result in output parameters. Since all
1.76 rillig 9724: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 9725: care must be taken not to use parameter names that have already
9726: another meaning. For example, <code class="varname">PKGNAME</code> is a
9727: bad choice for a parameter name.</p>
9728: <p>Procedures are completely evaluated at preprocessing time.
9729: That is, when calling a procedure all input parameters must be
9730: completely resolvable. For example,
9731: <code class="varname">CONFIGURE_ARGS</code> should never be an input
9732: parameter since it is very likely that further text will be
9733: added after calling the procedure, which would effectively apply
9734: the procedure to only a part of the variable. Also, references
1.218 rillig 9735: to other variables will be modified after calling the
1.75 rillig 9736: procedure.</p>
9737: <p>A procedure can declare its output parameters either as
9738: suitable for use in preprocessing directives or as only
9739: available at runtime. The latter alternative is for variables
9740: that contain references to other runtime variables.</p>
9741: <p>Procedures shall be written such that it is possible to
9742: call the procedure more than once. That is, the file must not
9743: contain multiple-inclusion guards.</p>
9744: <p>Examples for procedures are
1.76 rillig 9745: <code class="filename">mk/bsd.options.mk</code> and
9746: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 9747: that the parameters are evaluated at load time, they should be
9748: assigned using the <code class="literal">:=</code> operator, which should
9749: be used only for this purpose.</p>
9750: </div>
1.148 asau 9751: <div class="sect2">
1.75 rillig 9752: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9753: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 9754: <p>Action files take some input parameters and may define
9755: runtime variables. They shall not define loadtime variables.
9756: There are action files that are included implicitly by the
9757: pkgsrc infrastructure, while other must be included
9758: explicitly.</p>
9759: <p>An example for action files is
1.76 rillig 9760: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 9761: </div>
9762: </div>
1.148 asau 9763: <div class="sect1">
1.81 rillig 9764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9765: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 9766: <p>Package <code class="filename">Makefile</code>s usually consist of
9767: a set of variable definitions, and include the file
9768: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
9769: Before that, they may also include various other
9770: <code class="filename">*.mk</code> files if they need to query the
9771: availability of certain features like the type of compiler or
9772: the X11 implementation. Due to the heavy use of preprocessor
9773: directives like <code class="literal">.if</code> and
9774: <code class="literal">.for</code>, the order in which the files are loaded
9775: matters.</p>
9776: <p>This section describes at which point the various files
9777: are loaded and gives reasons for that order.</p>
1.148 asau 9778: <div class="sect2">
1.81 rillig 9779: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9780: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 9781: </h3></div></div></div>
9782: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 9783: is to define some essential variables like
9784: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
9785: <code class="varname">MACHINE_ARCH</code>.</p>
9786: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 9787: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104 rillig 9788: After that, those variables
1.81 rillig 9789: that have not been overridden by the user are loaded from
9790: <code class="filename">mk/defaults/mk.conf</code>.</p>
9791: <p>After the user settings, the system settings and platform
9792: settings are loaded, which may override the user
9793: settings.</p>
9794: <p>Then, the tool definitions are loaded. The tool wrappers
9795: are not yet in effect. This only happens when building a
9796: package, so the proper variables must be used instead of the
9797: direct tool names.</p>
9798: <p>As the last steps, some essential variables from the
9799: wrapper and the package system flavor are loaded, as well as the
9800: variables that have been cached in earlier phases of a package
9801: build.</p>
9802: </div>
1.148 asau 9803: <div class="sect2">
1.81 rillig 9804: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9805: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 9806: </h3></div></div></div>
1.81 rillig 9807: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
9808: <p>Then, the various <code class="filename">*-vars.mk</code> files are
9809: loaded, which fill default values for those variables that have
1.93 rillig 9810: not been defined by the package. These variables may later
1.81 rillig 9811: be used even in unrelated files.</p>
9812: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
9813: provides the target <code class="literal">error-check</code> that is added
9814: as a special dependency to all other targets that use
9815: <code class="varname">DELAYED_ERROR_MSG</code> or
9816: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
9817: <p>Then, the package-specific hacks from
9818: <code class="filename">hacks.mk</code> are included.</p>
9819: <p>Then, various other files follow. Most of them don't have
9820: any dependencies on what they need to have included before or
9821: after them, though some do.</p>
9822: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
9823: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
9824: restricts the use of these variables to all the files that have
9825: been included before. Appearances in later files will be
9826: silently ignored.</p>
9827: <p>Then, the files for the main targets are included, in the
9828: order of later execution, though the actual order should not
9829: matter.</p>
9830: <p>At last, some more files are included that don't set any
9831: interesting variables but rather just define make targets to be
9832: executed.</p>
9833: </div>
9834: </div>
1.75 rillig 9835: </div>
1.148 asau 9836: <div class="chapter">
1.75 rillig 9837: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9838: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.75 rillig 9839: <div class="toc">
9840: <p><b>Table of Contents</b></p>
1.210 leot 9841: <dl class="toc">
1.267 rillig 9842: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
9843: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75 rillig 9844: <dd><dl>
1.267 rillig 9845: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
9846: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75 rillig 9847: </dl></dd>
9848: </dl>
9849: </div>
9850: <p>The pkgsrc infrastructure consists of a large codebase,
9851: and there are many corners where every little bit of a file is
9852: well thought out, making pkgsrc likely to fail as soon as
9853: anything is changed near those parts. To prevent most changes
9854: from breaking anything, a suite of regression tests should go
9855: along with every important part of the pkgsrc infrastructure.
9856: This chapter describes how regression tests work in pkgsrc and
9857: how you can add new tests.</p>
1.148 asau 9858: <div class="sect1">
1.75 rillig 9859: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9860: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.250 leot 9861: <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.110 hubertf 9862: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 9863: can simply run that command, which will run all tests in the
1.76 rillig 9864: <code class="filename">regress</code> category.</p>
1.75 rillig 9865: </div>
1.148 asau 9866: <div class="sect1">
1.75 rillig 9867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9868: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.76 rillig 9869: <p>Every directory in the <code class="filename">regress</code>
9870: category that contains a file called <code class="filename">spec</code>
1.75 rillig 9871: is considered a regression test. This file is a shell program
1.110 hubertf 9872: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 9873: The following functions can be overridden to suit your
9874: needs.</p>
1.148 asau 9875: <div class="sect2">
1.75 rillig 9876: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9877: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.218 rillig 9878: <p>These functions do not take any parameters. Although they
9879: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
9880: first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
9881: question</a> for details.</p>
1.148 asau 9882: <div class="variablelist"><dl class="variablelist">
1.218 rillig 9883: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75 rillig 9884: <dd><p>This function prepares the environment for the
9885: test. By default it does nothing.</p></dd>
1.218 rillig 9886: <dt><span class="term"><code class="varname">do_test</code></span></dt>
9887: <dd>
9888: <p>This function runs the actual test. By default,
1.75 rillig 9889: it calls <code class="varname">TEST_MAKE</code> with the arguments
9890: <code class="varname">MAKEARGS_TEST</code> and writes its output including
9891: error messages into the file
1.218 rillig 9892: <code class="varname">TEST_OUTFILE</code>.</p>
9893: <p>When defining this function, make sure that all output that
9894: needs to be checked is written to the correct output file.
9895: Example:</p>
9896: <pre class="programlisting">
9897: do_test() {
1.223 rillig 9898: echo "Example output"
1.218 rillig 9899: } 1>$TEST_OUTFILE 2>&1
9900: </pre>
9901: </dd>
9902: <dt><span class="term"><code class="varname">check_result</code></span></dt>
9903: <dd>
9904: <p>This function is run after the test and is
1.75 rillig 9905: typically used to compare the actual output from the one that is
9906: expected. It can make use of the various helper functions from
1.218 rillig 9907: the next section. Example:</p>
9908: <pre class="programlisting">
9909: check_result() {
1.223 rillig 9910: exit_status 0
9911: output_require "Example"
9912: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
9913: output_prohibit "no such file or directory"
1.218 rillig 9914: }
9915: </pre>
9916: </dd>
9917: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75 rillig 9918: <dd><p>This function cleans everything up after the
9919: test has been run. By default it does nothing.</p></dd>
9920: </dl></div>
9921: </div>
1.148 asau 9922: <div class="sect2">
1.75 rillig 9923: <div class="titlepage"><div><div><h3 class="title">
1.267 rillig 9924: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.148 asau 9925: <div class="variablelist"><dl class="variablelist">
1.218 rillig 9926: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75 rillig 9927: <dd><p>This function compares the exitcode of the
1.218 rillig 9928: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75 rillig 9929: If they differ, the test will fail.</p></dd>
1.218 rillig 9930: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
9931: <dd>
9932: <p>This function checks for each of its parameters
9933: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75 rillig 9934: extended regular expression. If it does not, the test will
1.218 rillig 9935: fail. Example:</p>
9936: <pre class="programlisting">
1.219 rillig 9937: output_require "looks fine"
9938: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218 rillig 9939: </pre>
9940: </dd>
1.75 rillig 9941: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
9942: <dd><p>This function checks for each of its parameters
1.110 hubertf 9943: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 9944: <span class="emphasis"><em>not</em></span> match the extended regular expression.
9945: If any of the regular expressions matches, the test will
9946: fail.</p></dd>
9947: </dl></div>
9948: </div>
9949: </div>
9950: </div>
1.148 asau 9951: <div class="chapter">
1.75 rillig 9952: <div class="titlepage"><div><div><h2 class="title">
1.267 rillig 9953: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.75 rillig 9954: <div class="toc">
9955: <p><b>Table of Contents</b></p>
1.267 rillig 9956: <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.75 rillig 9957: </div>
9958: <p>The pkgsrc system has already been ported to many
9959: operating systems, hardware architectures and compilers. This
9960: chapter explains the necessary steps to make pkgsrc even more
9961: portable.</p>
1.148 asau 9962: <div class="sect1">
1.75 rillig 9963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 9964: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 9965: <p>To port pkgsrc to a new operating system (called
9966: <code class="literal">MyOS</code> in this example), you need to touch the
9967: following files:</p>
1.148 asau 9968: <div class="variablelist"><dl class="variablelist">
1.93 rillig 9969: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75 rillig 9970: <dd><p>This file contains some basic definitions, for
9971: example the name of the C
9972: compiler.</p></dd>
1.76 rillig 9973: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 9974: <dd><p>Insert code that defines the variables
9975: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
9976: <code class="varname">LOWER_OS_VERSION</code>,
9977: <code class="varname">LOWER_VENDOR</code>,
9978: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
9979: <code class="varname">APPEND_ELF</code>, and the other variables that
9980: appear in this file.</p></dd>
1.93 rillig 9981: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 9982: <dd><p>This file contains the platform-specific
9983: definitions that are used by pkgsrc. Start by copying one of the
9984: other files and edit it to your
9985: needs.</p></dd>
1.93 rillig 9986: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 9987: <dd><p>This file defines the paths to all the tools
9988: that are needed by one or the other package in pkgsrc, as well
9989: as by pkgsrc itself. Find out where these tools are on your
9990: platform and add them.</p></dd>
9991: </dl></div>
9992: <p>Now, you should be able to build some basic packages, like
1.250 leot 9993: <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.75 rillig 9994: </div>
9995: </div>
9996: </div>
1.148 asau 9997: <div class="appendix">
9998: <div class="titlepage"><div><div><h1 class="title">
9999: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75 rillig 10000: <div class="toc">
10001: <p><b>Table of Contents</b></p>
1.210 leot 10002: <dl class="toc">
1.75 rillig 10003: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10004: <dd><dl>
10005: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10006: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10007: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128 wiz 10008: <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.75 rillig 10009: </dl></dd>
10010: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10011: </dl>
10012: </div>
10013: <p>We checked to find a piece of software that wasn't in the packages
10014: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10015: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10016: present in the tree is beyond us, but it's useful for the purposes of
10017: this exercise.</p>
1.148 asau 10018: <div class="sect1">
1.75 rillig 10019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10020: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148 asau 10021: <div class="sect2">
1.75 rillig 10022: <div class="titlepage"><div><div><h3 class="title">
10023: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10024: <pre class="programlisting">
1.100 rillig 10025: # $NetBSD$
10026: #
1.1 grant 10027:
1.100 rillig 10028: DISTNAME= bison-1.25
10029: CATEGORIES= devel
10030: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10031:
1.136 dholland 10032: MAINTAINER= pkgsrc-users@NetBSD.org
1.100 rillig 10033: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10034: COMMENT= GNU yacc clone
1.1 grant 10035:
1.100 rillig 10036: GNU_CONFIGURE= yes
1.152 wiz 10037: INFO_FILES= yes
1.1 grant 10038:
1.100 rillig 10039: .include "../../mk/bsd.pkg.mk"
1.1 grant 10040: </pre>
1.75 rillig 10041: </div>
1.148 asau 10042: <div class="sect2">
1.75 rillig 10043: <div class="titlepage"><div><div><h3 class="title">
10044: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10045: <pre class="programlisting">
1.100 rillig 10046: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.270 leot 10047: 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.100 rillig 10048: of the NetBSD source tree is beyond me.
1.1 grant 10049: </pre>
1.75 rillig 10050: </div>
1.148 asau 10051: <div class="sect2">
1.75 rillig 10052: <div class="titlepage"><div><div><h3 class="title">
10053: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10054: <pre class="programlisting">
1.100 rillig 10055: @comment $NetBSD$
10056: bin/bison
10057: man/man1/bison.1.gz
10058: share/bison.simple
10059: share/bison.hairy
1.1 grant 10060: </pre>
1.75 rillig 10061: </div>
1.148 asau 10062: <div class="sect2">
1.75 rillig 10063: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10064: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10065: </h3></div></div></div>
1.75 rillig 10066: <p>The NetBSD package system comes with
1.250 leot 10067: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75 rillig 10068: which helps to check the contents of these
10069: files. After installation it is quite easy to use, just change to the
10070: directory of the package you wish to examine and execute
1.110 hubertf 10071: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10072: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10073: looks fine.</pre>
10074: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10075: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10076: -Wall</strong></span> for a very thorough check.</p>
10077: </div>
10078: </div>
1.148 asau 10079: <div class="sect1">
1.75 rillig 10080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10081: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10082: <p>Create the directory where the package lives,
10083: plus any auxiliary directories:</p>
10084: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10085: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10086: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10087: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10088: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.267 rillig 10089: <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.75 rillig 10090: then continue with fetching the distfile:</p>
10091: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10092: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10093: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10094: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10095: ftp: Error retrieving file: 500 Internal error
10096:
10097: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10098: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10099: ftp: Error retrieving file: 500 Internal error
10100:
10101: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10102: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10103: Successfully retrieved file.</pre>
10104: <p>Generate the checksum of the distfile into
1.76 rillig 10105: <code class="filename">distinfo</code>:</p>
1.88 wiz 10106: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10107: <p>Now compile:</p>
10108: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10109: >> Checksum OK for bison-1.25.tar.gz.
10110: ===> Extracting for bison-1.25
10111: ===> Patching for bison-1.25
10112: ===> Ignoring empty patch directory
10113: ===> Configuring for bison-1.25
10114: creating cache ./config.cache
10115: checking for gcc... cc
10116: checking whether we are using GNU C... yes
10117: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10118: checking how to run the C preprocessor... cc -E
10119: checking for minix/config.h... no
10120: checking for POSIXized ISC... no
10121: checking whether cross-compiling... no
10122: checking for ANSI C header files... yes
10123: checking for string.h... yes
10124: checking for stdlib.h... yes
10125: checking for memory.h... yes
10126: checking for working const... yes
10127: checking for working alloca.h... no
10128: checking for alloca... yes
10129: checking for strerror... yes
10130: updating cache ./config.cache
10131: creating ./config.status
10132: creating Makefile
10133: ===> Building for bison-1.25
10134: 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
10135: 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
10136: 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
10137: 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
10138: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 10139: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\" -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -g ./files.c
1.1 grant 10140: 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
10141: 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
10142: 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
10143: 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
10144: 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
10145: 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
10146: 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
10147: 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
10148: 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
10149: 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
10150: 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
10151: 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
10152: 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
10153: 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
10154: 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
10155: 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
10156: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10157: rm -f bison.s1
1.75 rillig 10158: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10159: <p>Everything seems OK, so install the files:</p>
10160: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10161: >> Checksum OK for bison-1.25.tar.gz.
10162: ===> Installing for bison-1.25
10163: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10164: rm -f /usr/pkg/bin/bison
10165: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10166: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10167: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10168: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10169: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10170: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10171: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10172: ===> Registering installation for bison-1.25</pre>
10173: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10174: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10175: binary package, do this now:</p>
10176: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10177: >> Checksum OK for bison-1.25.tar.gz.
10178: ===> Building package for bison-1.25
10179: Creating package bison-1.25.tgz
10180: Registering depends:.
1.75 rillig 10181: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10182: <p>Now that you don't need the source and object files
10183: any more, clean up:</p>
10184: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10185: ===> Cleaning for bison-1.25</pre>
10186: </div>
10187: </div>
1.148 asau 10188: <div class="appendix">
10189: <div class="titlepage"><div><div><h1 class="title">
10190: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75 rillig 10191: <div class="toc">
10192: <p><b>Table of Contents</b></p>
1.210 leot 10193: <dl class="toc">
1.75 rillig 10194: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10195: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10196: </dl>
10197: </div>
1.148 asau 10198: <div class="sect1">
1.75 rillig 10199: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10200: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10201: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10202: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10203: => figlet221.tar.gz doesn't seem to exist on this system.
10204: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10205: => [172219 bytes]
10206: Connected to ftp.plig.net.
10207: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10208: 331 Guest login ok, send your complete e-mail address as password.
10209: 230-You are user #5 of 500 simultaneous users allowed.
10210: 230-
1.68 rillig 10211: 230- ___ _ _ _
10212: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10213: 230- | _| _| . |_| . | | | . |_| . | _| . |
10214: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10215: 230- |_| |_| |___| |___|
10216: 230-
10217: 230-** Welcome to ftp.plig.org **
10218: 230-
10219: 230-Please note that all transfers from this FTP site are logged. If you
10220: 230-do not like this, please disconnect now.
10221: 230-
1.120 snj 10222: 230-This archive is available via
1.1 grant 10223: 230-
10224: 230-HTTP: http://ftp.plig.org/
10225: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10226: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10227: 230-
10228: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10229: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10230: 230-
10231: 230-
10232: 230 Logged in anonymously.
10233: Remote system type is UNIX.
10234: Using binary mode to transfer files.
10235: 200 Type okay.
10236: 250 "/pub" is new cwd.
10237: 250-"/pub/figlet" is new cwd.
10238: 250-
10239: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10240: 250-
1.75 rillig 10241: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10242: 250-
10243: 250-The official FIGlet web page is:
1.75 rillig 10244: 250- http://www.figlet.org/
1.1 grant 10245: 250-
10246: 250-If you have questions, please mailto:info@figlet.org. If you want to
10247: 250-contribute a font or something else, you can email us.
1.68 rillig 10248: 250
1.1 grant 10249: 250 "/pub/figlet/program" is new cwd.
10250: 250 "/pub/figlet/program/unix" is new cwd.
10251: local: figlet221.tar.gz remote: figlet221.tar.gz
10252: 502 Unimplemented command.
10253: 227 Entering Passive Mode (195,40,6,41,246,104)
10254: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10255: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10256: 226 Transfer completed.
10257: 172219 bytes received in 00:02 (75.99 KB/s)
10258: 221 Goodbye.
10259: => Checksum OK for figlet221.tar.gz.
10260: ===> Extracting for figlet-2.2.1nb2
10261: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10262: ===> Patching for figlet-2.2.1nb2
10263: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10264: ===> Overriding tools for figlet-2.2.1nb2
10265: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10266: ===> Configuring for figlet-2.2.1nb2
10267: ===> Building for figlet-2.2.1nb2
10268: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10269: chmod a+x figlet
10270: gcc -O2 -o chkfont chkfont.c
10271: => Unwrapping files-to-be-installed.
1.14 xtraeme 10272: <code class="prompt">#</code>
1.75 rillig 10273: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10274: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10275: ===> Installing for figlet-2.2.1nb2
10276: install -d -o root -g wheel -m 755 /usr/pkg/bin
10277: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10278: mkdir -p /usr/pkg/share/figlet
10279: cp figlet /usr/pkg/bin
10280: cp chkfont /usr/pkg/bin
10281: chmod 555 figlist showfigfonts
10282: cp figlist /usr/pkg/bin
10283: cp showfigfonts /usr/pkg/bin
10284: cp fonts/*.flf /usr/pkg/share/figlet
10285: cp fonts/*.flc /usr/pkg/share/figlet
10286: cp figlet.6 /usr/pkg/man/man6
10287: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10288: <code class="prompt">#</code></pre>
10289: </div>
1.148 asau 10290: <div class="sect1">
1.75 rillig 10291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10292: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10293: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10294: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10295: ===> Packaging figlet-2.2.1nb2
10296: ===> Building binary package for figlet-2.2.1nb2
10297: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10298: Using SrcDir value of /usr/pkg
1.68 rillig 10299: Registering depends:.
1.75 rillig 10300: <code class="prompt">#</code></pre>
10301: </div>
10302: </div>
1.148 asau 10303: <div class="appendix">
10304: <div class="titlepage"><div><div><h1 class="title">
10305: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76 rillig 10306: <div class="toc">
10307: <p><b>Table of Contents</b></p>
1.210 leot 10308: <dl class="toc">
1.128 wiz 10309: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10310: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10311: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10312: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10313: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261 leot 10314: <code class="filename">stable</code>,
1.128 wiz 10315: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10316: source packages</a></span></dt>
10317: </dl>
10318: </div>
10319: <p>As in other big projects, the directory layout of pkgsrc
10320: is quite complex for newbies. This chapter explains where you
10321: find things on the FTP server. The base directory on
1.110 hubertf 10322: <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.89 rillig 10323: On other servers it may be different, but inside this directory,
10324: everything should look the same, no matter on which server you
10325: are. This directory contains some subdirectories, which are
10326: explained below.</p>
1.148 asau 10327: <div class="sect1">
1.76 rillig 10328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10329: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76 rillig 10330: <p>The directory <code class="filename">distfiles</code> contains lots
10331: of archive files from all pkgsrc packages, which are mirrored
10332: here. The subdirectories are called after their package names
10333: and are used when the distributed files have names that don't
10334: explicitly contain a version number or are otherwise too generic
10335: (for example <code class="filename">release.tar.gz</code>).</p>
10336: </div>
1.148 asau 10337: <div class="sect1">
1.76 rillig 10338: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10339: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76 rillig 10340: <p>This directory contains things that individual pkgsrc
10341: developers find worth publishing.</p>
10342: </div>
1.148 asau 10343: <div class="sect1">
1.76 rillig 10344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10345: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102 rillig 10346: <p>This directory contains binary packages for the various
10347: platforms that are supported by pkgsrc.
10348: 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.148 asau 10349: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 10350: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10351: operating system for which the packages have been built. The
1.110 hubertf 10352: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10353: command, so it may differ from the one you are used to
10354: hear.</p></li>
1.128 wiz 10355: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108 rillig 10356: architecture of the platform for which the packages have been
1.110 hubertf 10357: built. It also includes the <code class="varname">ABI</code> (Application
10358: Binary Interface) for platforms that have several of
10359: them.</p></li>
1.128 wiz 10360: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108 rillig 10361: the operating system. For version numbers that change often (for
10362: example NetBSD-current), the often-changing part should be
10363: replaced with an <code class="literal">x</code>, for example
10364: <code class="literal">4.99.x</code>.</p></li>
1.128 wiz 10365: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126 jakllsch 10366: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108 rillig 10367: for a stable branch, or <code class="literal">head</code> for packages
10368: built from the HEAD branch. The latter should only be used when
10369: the packages are updated on a regular basis. Otherwise the date
10370: from checking out pkgsrc should be appended, for example
10371: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10372: </ul></div>
10373: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10374: can quickly click through the directories on the
10375: server and find the best binary packages for their machines. Since they
10376: usually know the operating system and the hardware architecture, OPSYS
10377: and ARCH are placed first. After these choices, they can select the
10378: best combination of OSVERSION and TAG together, since it is usually the
10379: case that packages stay compatible between different version of the
10380: operating system.</p>
10381: <p>In each of these directories, there is a
10382: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10383: <code class="filename">All</code> which contains all binary packages.
10384: Besides that, there are various category directories that
10385: contain symbolic links to the real binary packages.</p>
10386: </div>
1.148 asau 10387: <div class="sect1">
1.76 rillig 10388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10389: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108 rillig 10390: <p>Here are the reports from bulk builds, for those who want
10391: to fix packages that didn't build on some of the platforms. The
1.128 wiz 10392: 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.108 rillig 10393: </div>
1.148 asau 10394: <div class="sect1">
1.108 rillig 10395: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126 jakllsch 10396: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.261 leot 10397: <code class="filename">stable</code>,
1.126 jakllsch 10398: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10399: source packages</h2></div></div></div>
1.128 wiz 10400: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.76 rillig 10401: that is the files that define how to create binary packages from
10402: source archives.</p>
1.262 leot 10403: <p>Each of the <code class="filename">current</code>,
10404: <code class="filename">stable</code> and
10405: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
10406: directories share the same structure. They each contain a
10407: <code class="filename">pkgsrc</code> directory and
10408: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76 rillig 10409: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10410: snapshot of the CVS repository, which is updated regularly. The
1.262 leot 10411: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
10412: as the directory, ready to be downloaded as a whole.</p>
10413: <p>The <code class="filename">current</code> directory contains files
10414: related to the HEAD branch of the CVS repository.
10415: In this directory there is an additional file called
10416: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
10417: all pkgsrc <code class="filename">README</code>s with information about
10418: categories and packages.
10419: </p>
10420: <p>The <code class="filename">stable</code> directory is a symlink to
10421: the latest
10422: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
10423: </p>
10424: <p>The
10425: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
10426: directories contain files related to the
10427: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
10428: stable branch of the CVS repository. In these directories there is
10429: an additional file called
10430: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.{bz,gz,xz}</code>,
1.76 rillig 10431: which contains the state of pkgsrc when it was branched.</p>
10432: </div>
1.75 rillig 10433: </div>
1.148 asau 10434: <div class="appendix">
10435: <div class="titlepage"><div><div><h1 class="title">
1.267 rillig 10436: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
10437: <p>
10438: The following list contains all help topics that are available
10439: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
10440: </p>
1.269 leot 10441: <table border="0" summary="Simple list" class="simplelist">
10442: <tr>
10443: <td>#!</td>
10444: <td>-lintl</td>
10445: </tr>
10446: <tr>
10447: <td>64bit</td>
10448: <td>ABI</td>
10449: </tr>
10450: <tr>
10451: <td>ACCEPTABLE_LICENSES</td>
10452: <td>ACROREAD_FONTPATH</td>
10453: </tr>
10454: <tr>
10455: <td>ADDITIONAL</td>
10456: <td>AFAIK</td>
10457: </tr>
10458: <tr>
10459: <td>AIX</td>
10460: <td>ALLOW_VULNERABLE_PACKAGES</td>
10461: </tr>
10462: <tr>
10463: <td>ALL_ENV</td>
10464: <td>ALSA_PC</td>
10465: </tr>
10466: <tr>
10467: <td>ALTERNATIVES_SRC</td>
10468: <td>AMANDA_TMP</td>
10469: </tr>
10470: <tr>
10471: <td>AMANDA_USER</td>
10472: <td>AMANDA_VAR</td>
10473: </tr>
10474: <tr>
10475: <td>APACHE_GROUP</td>
10476: <td>APACHE_MODULE_NAME</td>
10477: </tr>
10478: <tr>
10479: <td>APACHE_MODULE_SRC</td>
10480: <td>APACHE_MODULE_SRCDIR</td>
10481: </tr>
10482: <tr>
10483: <td>APACHE_PKG_PREFIX</td>
10484: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
10485: </tr>
10486: <tr>
10487: <td>APACHE_SUEXEC_DOCROOT</td>
10488: <td>APACHE_USER</td>
10489: </tr>
10490: <tr>
10491: <td>APPEND_ABI</td>
10492: <td>APPEND_ELF</td>
10493: </tr>
10494: <tr>
10495: <td>ARLA_CACHE</td>
10496: <td>AUDIT_PACKAGES_FLAGS</td>
10497: </tr>
10498: <tr>
10499: <td>AUTOCONF_REQD</td>
10500: <td>AUTOMAKE_OVERRIDE</td>
10501: </tr>
10502: <tr>
10503: <td>AUTOMAKE_REQD</td>
10504: <td>AUTO_MKDIRS</td>
10505: </tr>
10506: <tr>
10507: <td>BDB185_DEFAULT</td>
10508: <td>BDBBASE</td>
10509: </tr>
10510: <tr>
10511: <td>BDB_ACCEPTED</td>
10512: <td>BDB_DEFAULT</td>
10513: </tr>
10514: <tr>
10515: <td>BDB_LIBS</td>
10516: <td>BDB_TYPE</td>
10517: </tr>
10518: <tr>
10519: <td>BIND_DIR</td>
10520: <td>BIND_GROUP</td>
10521: </tr>
10522: <tr>
10523: <td>BIND_USER</td>
10524: <td>BINPKG_SITES</td>
10525: </tr>
10526: <tr>
10527: <td>BIN_INSTALL_FLAGS</td>
10528: <td>BISON_PKGDATADIR</td>
10529: </tr>
10530: <tr>
10531: <td>BLAS_ACCEPTED</td>
10532: <td>BLAS_LIBS</td>
10533: </tr>
10534: <tr>
10535: <td>BLAS_TYPE</td>
10536: <td>BOOTSTRAP_DEPENDS</td>
10537: </tr>
10538: <tr>
10539: <td>BOOTSTRAP_SETUPTOOLS</td>
10540: <td>BROKEN</td>
10541: </tr>
10542: <tr>
10543: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
10544: <td>BROKEN_ON_PLATFORM</td>
10545: </tr>
10546: <tr>
10547: <td>BSDSRCDIR</td>
10548: <td>BSDXSRCDIR</td>
10549: </tr>
10550: <tr>
10551: <td>BSD_MAKE_ENV</td>
10552: <td>BUILDLINK_AUTO_DIRS</td>
10553: </tr>
10554: <tr>
10555: <td>BUILDLINK_AUTO_VARS</td>
10556: <td>BUILDLINK_CFLAGS</td>
10557: </tr>
10558: <tr>
10559: <td>BUILDLINK_CONTENTS_FILTER</td>
10560: <td>BUILDLINK_CPPFLAGS</td>
10561: </tr>
10562: <tr>
10563: <td>BUILDLINK_DEPMETHOD</td>
10564: <td>BUILDLINK_FILES</td>
10565: </tr>
10566: <tr>
10567: <td>BUILDLINK_FILES_CMD</td>
10568: <td>BUILDLINK_FNAME_TRANSFORM</td>
10569: </tr>
10570: <tr>
10571: <td>BUILDLINK_LDFLAGS</td>
10572: <td>BUILDLINK_LIBS</td>
10573: </tr>
10574: <tr>
10575: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
10576: <td>BUILDLINK_PKGNAME</td>
10577: </tr>
10578: <tr>
10579: <td>BUILDLINK_PREFIX</td>
10580: <td>BUILDLINK_RPATHDIRS</td>
10581: </tr>
10582: <tr>
10583: <td>BUILDLINK_TREE</td>
10584: <td>BUILD_DEFS</td>
10585: </tr>
10586: <tr>
10587: <td>BUILD_DEFS_EFFECTS</td>
10588: <td>BUILD_DEPENDS</td>
10589: </tr>
10590: <tr>
10591: <td>BUILD_DIRS</td>
10592: <td>BUILD_ENV_SHELL</td>
10593: </tr>
10594: <tr>
10595: <td>BUILD_MAKE_CMD</td>
10596: <td>BUILD_MAKE_FLAGS</td>
10597: </tr>
10598: <tr>
10599: <td>BUILD_TARGET</td>
10600: <td>BUILTIN_FIND_FILES</td>
10601: </tr>
10602: <tr>
10603: <td>BUILTIN_FIND_FILES_VAR</td>
10604: <td>BUILTIN_FIND_GREP</td>
10605: </tr>
10606: <tr>
10607: <td>BUILTIN_FIND_HEADERS</td>
10608: <td>BUILTIN_FIND_HEADERS_VAR</td>
10609: </tr>
10610: <tr>
10611: <td>BUILTIN_PKG</td>
10612: <td>BUILTIN_TEST_CURSES_DEFINES</td>
10613: </tr>
10614: <tr>
10615: <td>BUILTIN_TEST_CURSES_FUNCS</td>
10616: <td>BUILTIN_VERSION_SCRIPT</td>
10617: </tr>
10618: <tr>
10619: <td>BUILTIN_X11_TYPE</td>
10620: <td>BUILTIN_X11_VERSION</td>
10621: </tr>
10622: <tr>
10623: <td>CACTI_GROUP</td>
10624: <td>CACTI_USER</td>
10625: </tr>
10626: <tr>
10627: <td>CANNA_GROUP</td>
10628: <td>CANNA_USER</td>
10629: </tr>
10630: <tr>
10631: <td>CAT</td>
10632: <td>CCACHE_BASE</td>
10633: </tr>
10634: <tr>
10635: <td>CCACHE_DIR</td>
10636: <td>CCACHE_LOGFILE</td>
10637: </tr>
10638: <tr>
10639: <td>CC_VERSION</td>
10640: <td>CC_VERSION_STRING</td>
10641: </tr>
10642: <tr>
10643: <td>CDRECORD_CONF</td>
10644: <td>CDROM_PKG_URL_DIR</td>
10645: </tr>
10646: <tr>
10647: <td>CDROM_PKG_URL_HOST</td>
10648: <td>CHECKOUT_DATE</td>
10649: </tr>
10650: <tr>
10651: <td>CHECK_FAKEHOME</td>
10652: <td>CHECK_FILES</td>
10653: </tr>
10654: <tr>
10655: <td>CHECK_FILES_SKIP</td>
10656: <td>CHECK_FILES_STRICT</td>
10657: </tr>
10658: <tr>
10659: <td>CHECK_HEADERS</td>
10660: <td>CHECK_HEADERS_SKIP</td>
10661: </tr>
10662: <tr>
10663: <td>CHECK_INTERPRETER</td>
10664: <td>CHECK_INTERPRETER_SKIP</td>
10665: </tr>
10666: <tr>
10667: <td>CHECK_PERMS</td>
10668: <td>CHECK_PERMS_AUTOFIX</td>
10669: </tr>
10670: <tr>
10671: <td>CHECK_PERMS_SKIP</td>
10672: <td>CHECK_PORTABILITY</td>
10673: </tr>
10674: <tr>
10675: <td>CHECK_PORTABILITY_SKIP</td>
10676: <td>CHECK_RELRO</td>
10677: </tr>
10678: <tr>
10679: <td>CHECK_RELRO_SKIP</td>
10680: <td>CHECK_RELRO_SUPPORTED</td>
10681: </tr>
10682: <tr>
10683: <td>CHECK_SHLIBS</td>
10684: <td>CHECK_SHLIBS_BLACKLIST</td>
10685: </tr>
10686: <tr>
10687: <td>CHECK_SHLIBS_SKIP</td>
10688: <td>CHECK_SHLIBS_SUPPORTED</td>
10689: </tr>
10690: <tr>
10691: <td>CHECK_SSP</td>
10692: <td>CHECK_SSP_SKIP</td>
10693: </tr>
10694: <tr>
10695: <td>CHECK_SSP_SUPPORTED</td>
10696: <td>CHECK_STRIPPED</td>
10697: </tr>
10698: <tr>
10699: <td>CHECK_STRIPPED_SKIP</td>
10700: <td>CHECK_WRKREF</td>
10701: </tr>
10702: <tr>
10703: <td>CHECK_WRKREF_EXTRA_DIRS</td>
10704: <td>CHECK_WRKREF_SKIP</td>
10705: </tr>
10706: <tr>
10707: <td>CLAMAV_DBDIR</td>
10708: <td>CLAMAV_GROUP</td>
10709: </tr>
10710: <tr>
10711: <td>CLAMAV_USER</td>
10712: <td>CLANGBASE</td>
10713: </tr>
10714: <tr>
10715: <td>CLEANDEPENDS</td>
10716: <td>CMAKE_DEPENDENCIES_REWRITE</td>
10717: </tr>
10718: <tr>
10719: <td>CMAKE_INSTALL_PREFIX</td>
10720: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
10721: </tr>
10722: <tr>
10723: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
10724: <td>CMAKE_PREFIX_PATH</td>
10725: </tr>
10726: <tr>
10727: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
10728: <td>COMMON_LISP_DOCFILES</td>
10729: </tr>
10730: <tr>
10731: <td>COMMON_LISP_EXAMPLES</td>
10732: <td>COMMON_LISP_EXTRAFILES</td>
10733: </tr>
10734: <tr>
10735: <td>COMMON_LISP_PACKAGES</td>
10736: <td>COMMON_LISP_SYSTEM</td>
10737: </tr>
10738: <tr>
10739: <td>COMPILER_RPATH_FLAG</td>
10740: <td>COMPILER_USE_SYMLINKS</td>
10741: </tr>
10742: <tr>
10743: <td>CONFIGURE_ARGS</td>
10744: <td>CONFIGURE_DIRS</td>
10745: </tr>
10746: <tr>
10747: <td>CONFIGURE_ENV</td>
10748: <td>CONFIGURE_HAS_INFODIR</td>
10749: </tr>
10750: <tr>
10751: <td>CONFIGURE_HAS_MANDIR</td>
10752: <td>CONFIGURE_SCRIPT</td>
10753: </tr>
10754: <tr>
10755: <td>CONFIG_SHELL</td>
10756: <td>CONFIG_SHELL_FLAGS</td>
10757: </tr>
10758: <tr>
10759: <td>CONF_FILES</td>
10760: <td>CONF_FILES_MODE</td>
10761: </tr>
10762: <tr>
10763: <td>CONF_FILES_PERMS</td>
10764: <td>CONSERVER_DEFAULTHOST</td>
10765: </tr>
10766: <tr>
10767: <td>CONSERVER_DEFAULTPORT</td>
10768: <td>CP</td>
10769: </tr>
10770: <tr>
10771: <td>CPP</td>
10772: <td>CPP_PRECOMP_FLAGS</td>
10773: </tr>
10774: <tr>
10775: <td>CREATE_WRKDIR_SYMLINK</td>
10776: <td>CROSSBASE</td>
10777: </tr>
10778: <tr>
10779: <td>CTFCONVERT</td>
10780: <td>CTF_FILES_SKIP</td>
10781: </tr>
10782: <tr>
10783: <td>CTF_SUPPORTED</td>
10784: <td>CTYPE</td>
10785: </tr>
10786: <tr>
10787: <td>CUPS_GROUP</td>
10788: <td>CUPS_SYSTEM_GROUPS</td>
10789: </tr>
10790: <tr>
10791: <td>CUPS_USER</td>
10792: <td>CURSES_DEFAULT</td>
10793: </tr>
10794: <tr>
10795: <td>CURSES_TYPE</td>
10796: <td>CVS_EXTRACTDIR</td>
10797: </tr>
10798: <tr>
10799: <td>CVS_MODULE</td>
10800: <td>CVS_PROJECT</td>
10801: </tr>
10802: <tr>
10803: <td>CVS_REPOSITORIES</td>
10804: <td>CVS_ROOT</td>
10805: </tr>
10806: <tr>
10807: <td>CVS_ROOT_GNU</td>
10808: <td>CVS_ROOT_NONGNU</td>
10809: </tr>
10810: <tr>
10811: <td>CVS_ROOT_SOURCEFORGE</td>
10812: <td>CVS_TAG</td>
10813: </tr>
10814: <tr>
10815: <td>CXX</td>
10816: <td>CYRUS_GROUP</td>
10817: </tr>
10818: <tr>
10819: <td>CYRUS_IDLE</td>
10820: <td>CYRUS_USER</td>
10821: </tr>
10822: <tr>
10823: <td>DAEMONTOOLS_GROUP</td>
10824: <td>DAEMONTOOLS_LOG_USER</td>
10825: </tr>
10826: <tr>
10827: <td>DBUS_GROUP</td>
10828: <td>DBUS_USER</td>
10829: </tr>
10830: <tr>
10831: <td>DEFANG_GROUP</td>
10832: <td>DEFANG_USER</td>
10833: </tr>
10834: <tr>
10835: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
10836: <td>DEFAULT_DISTFILES</td>
10837: </tr>
10838: <tr>
10839: <td>DEFAULT_IRC_SERVER</td>
10840: <td>DEFAULT_SERIAL_DEVICE</td>
10841: </tr>
10842: <tr>
10843: <td>DEF_UMASK</td>
10844: <td>DEINSTALLDEPENDS</td>
10845: </tr>
10846: <tr>
10847: <td>DEINSTALL_SRC</td>
10848: <td>DEINSTALL_TEMPLATES</td>
10849: </tr>
10850: <tr>
10851: <td>DELAYED_ERROR_MSG</td>
10852: <td>DELAYED_WARNING_MSG</td>
10853: </tr>
10854: <tr>
10855: <td>DEPENDS</td>
10856: <td>DEPENDS_TARGET</td>
10857: </tr>
10858: <tr>
10859: <td>DEPENDS_TYPE</td>
10860: <td>DESTDIR</td>
10861: </tr>
10862: <tr>
10863: <td>DESTDIR_VARNAME</td>
10864: <td>DIALER_GROUP</td>
10865: </tr>
10866: <tr>
10867: <td>DIGEST_REQD</td>
10868: <td>DISTDIR</td>
10869: </tr>
10870: <tr>
10871: <td>DISTFILES</td>
10872: <td>DISTINFO_FILE</td>
10873: </tr>
10874: <tr>
10875: <td>DISTNAME</td>
10876: <td>DIST_PATH</td>
10877: </tr>
10878: <tr>
10879: <td>DIST_SUBDIR</td>
10880: <td>DJBDNS_AXFR_USER</td>
10881: </tr>
10882: <tr>
10883: <td>DJBDNS_CACHE_USER</td>
10884: <td>DJBDNS_DJBDNS_GROUP</td>
10885: </tr>
10886: <tr>
10887: <td>DJBDNS_LOG_USER</td>
10888: <td>DJBDNS_RBL_USER</td>
10889: </tr>
10890: <tr>
10891: <td>DJBDNS_TINY_USER</td>
10892: <td>DLOPEN_REQUIRE_PTHREADS</td>
10893: </tr>
10894: <tr>
10895: <td>DL_AUTO_VARS</td>
10896: <td>DL_CFLAGS</td>
10897: </tr>
10898: <tr>
10899: <td>DL_LDFLAGS</td>
10900: <td>DL_LIBS</td>
10901: </tr>
10902: <tr>
10903: <td>DNS</td>
10904: <td>DOWNLOADED_DISTFILE</td>
10905: </tr>
10906: <tr>
10907: <td>DT_LAYOUT</td>
10908: <td>DYNAMIC_SITES_CMD</td>
10909: </tr>
10910: <tr>
10911: <td>DYNAMIC_SITES_SCRIPT</td>
10912: <td>ECHO</td>
10913: </tr>
10914: <tr>
10915: <td>ECHO_N</td>
10916: <td>ELK_GUI</td>
10917: </tr>
10918: <tr>
10919: <td>EMACS_TYPE</td>
10920: <td>EMULDIR</td>
10921: </tr>
10922: <tr>
10923: <td>EMULSUBDIR</td>
10924: <td>EMULSUBDIRSLASH</td>
10925: </tr>
10926: <tr>
10927: <td>EMUL_ARCH</td>
10928: <td>EMUL_DISTRO</td>
10929: </tr>
10930: <tr>
10931: <td>EMUL_EXEC_FMT</td>
10932: <td>EMUL_IS_NATIVE</td>
10933: </tr>
10934: <tr>
10935: <td>EMUL_MODULES</td>
10936: <td>EMUL_OPSYS</td>
10937: </tr>
10938: <tr>
10939: <td>EMUL_PKG_FMT</td>
10940: <td>EMUL_PLATFORM</td>
10941: </tr>
10942: <tr>
10943: <td>EMUL_PLATFORMS</td>
10944: <td>EMUL_PREFER</td>
10945: </tr>
10946: <tr>
10947: <td>EMUL_REQD</td>
10948: <td>EMUL_TYPE</td>
10949: </tr>
10950: <tr>
10951: <td>ERROR_MSG</td>
10952: <td>EXIM_GROUP</td>
10953: </tr>
10954: <tr>
10955: <td>EXIM_USER</td>
10956: <td>EXPORT_SYMBOLS_LDFLAGS</td>
10957: </tr>
10958: <tr>
10959: <td>EXTRACTOR</td>
10960: <td>EXTRACT_CMD</td>
10961: </tr>
10962: <tr>
10963: <td>EXTRACT_CMD_DEFAULT</td>
10964: <td>EXTRACT_DIR</td>
10965: </tr>
10966: <tr>
10967: <td>EXTRACT_ELEMENTS</td>
10968: <td>EXTRACT_ENV</td>
10969: </tr>
10970: <tr>
10971: <td>EXTRACT_ONLY</td>
10972: <td>EXTRACT_OPTS</td>
10973: </tr>
10974: <tr>
10975: <td>EXTRACT_SUFX</td>
10976: <td>EXTRACT_USING</td>
10977: </tr>
10978: <tr>
10979: <td>FAILOVER_FETCH</td>
10980: <td>FAIL_MSG</td>
10981: </tr>
10982: <tr>
10983: <td>FAKE_NCURSES</td>
10984: <td>FAM</td>
10985: </tr>
10986: <tr>
10987: <td>FAM_ACCEPTED</td>
10988: <td>FAM_DEFAULT</td>
10989: </tr>
10990: <tr>
10991: <td>FAM_SERVER</td>
10992: <td>FCPATH</td>
10993: </tr>
10994: <tr>
10995: <td>FEATURE_CPPFLAGS</td>
10996: <td>FEATURE_LDFLAGS</td>
10997: </tr>
10998: <tr>
10999: <td>FEATURE_LIBS</td>
11000: <td>FETCH_AFTER_ARGS</td>
11001: </tr>
11002: <tr>
11003: <td>FETCH_BEFORE_ARGS</td>
11004: <td>FETCH_CMD</td>
11005: </tr>
11006: <tr>
11007: <td>FETCH_OUTPUT_ARGS</td>
11008: <td>FETCH_PROXY</td>
11009: </tr>
11010: <tr>
11011: <td>FETCH_RESUME_ARGS</td>
11012: <td>FETCH_USING</td>
11013: </tr>
11014: <tr>
11015: <td>FILES_SUBST</td>
11016: <td>FILES_SUBST_SED</td>
11017: </tr>
11018: <tr>
11019: <td>FIX_SYSTEM_HEADERS</td>
11020: <td>FLUXBOX_USE_GNOME</td>
11021: </tr>
11022: <tr>
11023: <td>FLUXBOX_USE_KDE</td>
11024: <td>FLUXBOX_USE_XFT</td>
11025: </tr>
11026: <tr>
11027: <td>FLUXBOX_USE_XINERAMA</td>
11028: <td>FONTDIR</td>
11029: </tr>
11030: <tr>
11031: <td>FONTS_DIRS</td>
11032: <td>FONTS_VERBOSE</td>
11033: </tr>
11034: <tr>
11035: <td>FOO_HACKS_MK</td>
11036: <td>FOSSIL_EXTRACTDIR</td>
11037: </tr>
11038: <tr>
11039: <td>FOSSIL_REPO</td>
11040: <td>FOSSIL_REPOSITORIES</td>
11041: </tr>
11042: <tr>
11043: <td>FOSSIL_VERSION</td>
11044: <td>FOX_USE_XUNICODE</td>
11045: </tr>
11046: <tr>
11047: <td>FREEWNN_GROUP</td>
11048: <td>FREEWNN_USER</td>
11049: </tr>
11050: <tr>
11051: <td>FTP_PKG_URL_DIR</td>
11052: <td>FTP_PKG_URL_HOST</td>
11053: </tr>
11054: <tr>
11055: <td>GAMEDATAMODE</td>
11056: <td>GAMEDATA_PERMS</td>
11057: </tr>
11058: <tr>
11059: <td>GAMEDIRMODE</td>
11060: <td>GAMEDIR_PERMS</td>
11061: </tr>
11062: <tr>
11063: <td>GAMEGRP</td>
11064: <td>GAMEMODE</td>
11065: </tr>
11066: <tr>
11067: <td>GAMEOWN</td>
11068: <td>GAMES_GROUP</td>
11069: </tr>
11070: <tr>
11071: <td>GAMES_USER</td>
11072: <td>GCC</td>
11073: </tr>
11074: <tr>
11075: <td>GCCBASE</td>
11076: <td>GCC_REQD</td>
11077: </tr>
11078: <tr>
11079: <td>GCC_VERSION_SUFFIX</td>
11080: <td>GEM_BUILD</td>
11081: </tr>
11082: <tr>
11083: <td>GEM_CLEANBUILD</td>
11084: <td>GEM_CLEANBUILD_EXTENSIONS</td>
11085: </tr>
11086: <tr>
11087: <td>GEM_DOCDIR</td>
11088: <td>GEM_EXTSDIR</td>
11089: </tr>
11090: <tr>
11091: <td>GEM_HOME</td>
11092: <td>GEM_LIBDIR</td>
11093: </tr>
11094: <tr>
11095: <td>GEM_NAME</td>
11096: <td>GEM_PATH</td>
11097: </tr>
11098: <tr>
11099: <td>GEM_SPECFILE</td>
11100: <td>GENERATE_PLIST</td>
11101: </tr>
11102: <tr>
11103: <td>GHOSTSCRIPT_REQD</td>
11104: <td>GITHUB_PROJECT</td>
11105: </tr>
11106: <tr>
11107: <td>GITHUB_RELEASE</td>
11108: <td>GITHUB_TAG</td>
11109: </tr>
11110: <tr>
11111: <td>GITHUB_TYPE</td>
11112: <td>GIT_BRANCH</td>
11113: </tr>
11114: <tr>
11115: <td>GIT_ENV</td>
11116: <td>GIT_EXTRACTDIR</td>
11117: </tr>
11118: <tr>
11119: <td>GIT_REPO</td>
11120: <td>GIT_REPOSITORIES</td>
11121: </tr>
11122: <tr>
11123: <td>GIT_REVISION</td>
11124: <td>GIT_TAG</td>
11125: </tr>
11126: <tr>
11127: <td>GNU</td>
11128: <td>GNU_CONFIGURE</td>
11129: </tr>
11130: <tr>
11131: <td>GNU_CONFIGURE_INFODIR</td>
11132: <td>GNU_CONFIGURE_MANDIR</td>
11133: </tr>
11134: <tr>
11135: <td>GNU_CONFIGURE_STRICT</td>
11136: <td>GODEP_REDIRECTS</td>
11137: </tr>
11138: <tr>
11139: <td>GO_BUILD_PATTERN</td>
11140: <td>GO_DEPS</td>
11141: </tr>
11142: <tr>
11143: <td>GO_DIST_BASE</td>
11144: <td>GO_SRCPATH</td>
11145: </tr>
11146: <tr>
11147: <td>GROUP_SPECIFIC_PKGS</td>
11148: <td>GRUB_NETWORK_CARDS</td>
11149: </tr>
11150: <tr>
11151: <td>GRUB_PRESET_COMMAND</td>
11152: <td>GRUB_SCAN_ARGS</td>
11153: </tr>
11154: <tr>
11155: <td>GZIP</td>
11156: <td>HASKELL_COMPILER</td>
11157: </tr>
11158: <tr>
11159: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
11160: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
11161: </tr>
11162: <tr>
11163: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
11164: <td>HAS_CONFIGURE</td>
11165: </tr>
11166: <tr>
11167: <td>HEADER_TEMPLATES</td>
11168: <td>HG_REPO</td>
11169: </tr>
11170: <tr>
11171: <td>HG_REPOSITORIES</td>
11172: <td>HG_TAG</td>
11173: </tr>
11174: <tr>
11175: <td>HOST_PKGTOOLS_ARGS</td>
11176: <td>HOST_SPECIFIC_PKGS</td>
11177: </tr>
11178: <tr>
11179: <td>HOWL_GROUP</td>
11180: <td>HOWL_USER</td>
11181: </tr>
11182: <tr>
11183: <td>ICCBASE</td>
11184: <td>ICECAST_CHROOTDIR</td>
11185: </tr>
11186: <tr>
11187: <td>ICON_THEMES</td>
11188: <td>IDOBASE</td>
11189: </tr>
11190: <tr>
11191: <td>IGNORE_CCACHE</td>
11192: <td>IGNORE_INFO_DIRS</td>
11193: </tr>
11194: <tr>
11195: <td>IGNORE_INTERACTIVE_FETCH</td>
11196: <td>IMAKE</td>
11197: </tr>
11198: <tr>
11199: <td>IMAKEOPTS</td>
11200: <td>IMAKE_MAKE</td>
11201: </tr>
11202: <tr>
11203: <td>IMAKE_MANINSTALL</td>
11204: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
11205: </tr>
11206: <tr>
11207: <td>IMDICTDIR</td>
11208: <td>INCOMPAT_CURSES</td>
11209: </tr>
11210: <tr>
11211: <td>INFO_DIR</td>
11212: <td>INFO_FILES</td>
11213: </tr>
11214: <tr>
11215: <td>INFO_FILES_VERBOSE</td>
11216: <td>INFO_MSG</td>
11217: </tr>
11218: <tr>
11219: <td>INIT_SYSTEM</td>
11220: <td>INN_DATA_DIR</td>
11221: </tr>
11222: <tr>
11223: <td>INN_GROUP</td>
11224: <td>INN_USER</td>
11225: </tr>
11226: <tr>
11227: <td>INSTALLATION_DIRS</td>
11228: <td>INSTALLATION_DIRS_FROM_PLIST</td>
11229: </tr>
11230: <tr>
11231: <td>INSTALL_ENV</td>
11232: <td>INSTALL_SH_OVERRIDE</td>
11233: </tr>
11234: <tr>
11235: <td>INSTALL_SRC</td>
11236: <td>INSTALL_TEMPLATES</td>
11237: </tr>
11238: <tr>
11239: <td>INSTALL_UNSTRIPPED</td>
11240: <td>IRCD_HYBRID_IRC_GROUP</td>
11241: </tr>
11242: <tr>
11243: <td>IRCD_HYBRID_IRC_USER</td>
11244: <td>IRCD_HYBRID_MAXCONN</td>
11245: </tr>
11246: <tr>
11247: <td>IRCD_HYBRID_NICLEN</td>
11248: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
11249: </tr>
11250: <tr>
11251: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
11252: <td>IRCD_HYBRID_TOPICLEN</td>
11253: </tr>
11254: <tr>
11255: <td>IRIX</td>
11256: <td>IRRD_USE_PGP</td>
11257: </tr>
11258: <tr>
11259: <td>JABBERD_GROUP</td>
11260: <td>JABBERD_LOGDIR</td>
11261: </tr>
11262: <tr>
11263: <td>JABBERD_PIDDIR</td>
11264: <td>JABBERD_SPOOLDIR</td>
11265: </tr>
11266: <tr>
11267: <td>JABBERD_USER</td>
11268: <td>JAKARTA_HOME</td>
11269: </tr>
11270: <tr>
11271: <td>JAVA_APP_PATH</td>
11272: <td>JAVA_APP_TARGETS</td>
11273: </tr>
11274: <tr>
11275: <td>JAVA_BINPREFIX</td>
11276: <td>JAVA_CLASSPATH</td>
11277: </tr>
11278: <tr>
11279: <td>JAVA_HOME</td>
11280: <td>JAVA_LD_LIBRARY_PATH</td>
11281: </tr>
11282: <tr>
11283: <td>JAVA_NAME</td>
11284: <td>JAVA_UNLIMIT</td>
11285: </tr>
11286: <tr>
11287: <td>JAVA_WRAPPERS</td>
11288: <td>JPEG_ACCEPTED</td>
11289: </tr>
11290: <tr>
11291: <td>JPEG_DEFAULT</td>
11292: <td>KERBEROS</td>
11293: </tr>
11294: <tr>
11295: <td>KERMIT_SUID_UUCP</td>
11296: <td>KJS_USE_PCRE</td>
11297: </tr>
11298: <tr>
11299: <td>KNEWS_DOMAIN_FILE</td>
11300: <td>KNEWS_DOMAIN_NAME</td>
11301: </tr>
11302: <tr>
11303: <td>KRB5_ACCEPTED</td>
11304: <td>KRB5_DEFAULT</td>
11305: </tr>
11306: <tr>
11307: <td>LANGUAGES</td>
1.271 ! brook 11308: <td>LAPACK_LIBS</td>
! 11309: </tr>
! 11310: <tr>
1.269 leot 11311: <td>LATEX2HTML_ICONPATH</td>
1.271 ! brook 11312: <td>LDCONFIG_ADD_CMD</td>
1.269 leot 11313: </tr>
11314: <tr>
11315: <td>LDCONFIG_REMOVE_CMD</td>
1.271 ! brook 11316: <td>LEAFNODE_DATA_DIR</td>
1.269 leot 11317: </tr>
11318: <tr>
11319: <td>LEAFNODE_GROUP</td>
1.271 ! brook 11320: <td>LEAFNODE_USER</td>
1.269 leot 11321: </tr>
11322: <tr>
11323: <td>LIBDVDCSS_HOMEPAGE</td>
1.271 ! brook 11324: <td>LIBDVDCSS_MASTER_SITES</td>
1.269 leot 11325: </tr>
11326: <tr>
1.270 leot 11327: <td>LIBRSVG_TYPE</td>
1.271 ! brook 11328: <td>LIBTOOL</td>
1.270 leot 11329: </tr>
11330: <tr>
11331: <td>LIBTOOLIZE_PLIST</td>
1.271 ! brook 11332: <td>LIBTOOL_M4_OVERRIDE</td>
1.269 leot 11333: </tr>
11334: <tr>
1.270 leot 11335: <td>LIBUSB_TYPE</td>
1.271 ! brook 11336: <td>LICENSE</td>
1.269 leot 11337: </tr>
11338: <tr>
1.270 leot 11339: <td>LINKER_RPATH_FLAG</td>
1.271 ! brook 11340: <td>LINK_RPATH_FLAG</td>
1.269 leot 11341: </tr>
11342: <tr>
1.270 leot 11343: <td>LINUX_BASE_NODEPS</td>
1.271 ! brook 11344: <td>LINUX_BASE_PREFERRED</td>
1.269 leot 11345: </tr>
11346: <tr>
1.270 leot 11347: <td>LINUX_BASE_REQUIRED</td>
1.271 ! brook 11348: <td>LINUX_LOCALES</td>
1.269 leot 11349: </tr>
11350: <tr>
1.270 leot 11351: <td>LOCALBASE</td>
1.271 ! brook 11352: <td>LOCALBASE_LOCKTYPE</td>
1.269 leot 11353: </tr>
11354: <tr>
1.270 leot 11355: <td>LOCALPATCHES</td>
1.271 ! brook 11356: <td>LOVE_DATA</td>
1.269 leot 11357: </tr>
11358: <tr>
1.270 leot 11359: <td>LOVE_GAME</td>
1.271 ! brook 11360: <td>LOVE_VERSION</td>
1.269 leot 11361: </tr>
11362: <tr>
1.270 leot 11363: <td>LP64PLATFORMS</td>
1.271 ! brook 11364: <td>MACHINE_PLATFORM</td>
1.269 leot 11365: </tr>
11366: <tr>
1.270 leot 11367: <td>MAILAGENT_DOMAIN</td>
1.271 ! brook 11368: <td>MAILAGENT_EMAIL</td>
1.269 leot 11369: </tr>
11370: <tr>
1.270 leot 11371: <td>MAILAGENT_FQDN</td>
1.271 ! brook 11372: <td>MAILAGENT_ORGANIZATION</td>
1.269 leot 11373: </tr>
11374: <tr>
1.270 leot 11375: <td>MAJORDOMO_HOMEDIR</td>
1.271 ! brook 11376: <td>MAJOR_OS_VERSION</td>
1.269 leot 11377: </tr>
11378: <tr>
1.270 leot 11379: <td>MAKEINFO_ARGS</td>
1.271 ! brook 11380: <td>MAKE_DIRS</td>
1.269 leot 11381: </tr>
11382: <tr>
1.270 leot 11383: <td>MAKE_DIRS_PERMS</td>
1.271 ! brook 11384: <td>MAKE_ENV</td>
1.269 leot 11385: </tr>
11386: <tr>
1.270 leot 11387: <td>MAKE_FILE</td>
1.271 ! brook 11388: <td>MAKE_FLAGS</td>
1.269 leot 11389: </tr>
11390: <tr>
1.270 leot 11391: <td>MAKE_JOBS</td>
1.271 ! brook 11392: <td>MAKE_JOBS_SAFE</td>
1.269 leot 11393: </tr>
11394: <tr>
1.270 leot 11395: <td>MAKE_PROGRAM</td>
1.271 ! brook 11396: <td>MANINSTALL</td>
1.269 leot 11397: </tr>
11398: <tr>
1.270 leot 11399: <td>MANZ</td>
1.271 ! brook 11400: <td>MASTER_SITES</td>
1.269 leot 11401: </tr>
11402: <tr>
1.270 leot 11403: <td>MASTER_SITE_BACKUP</td>
1.271 ! brook 11404: <td>MASTER_SITE_CYGWIN</td>
1.269 leot 11405: </tr>
11406: <tr>
1.270 leot 11407: <td>MASTER_SITE_GNOME</td>
1.271 ! brook 11408: <td>MASTER_SITE_GNU</td>
1.269 leot 11409: </tr>
11410: <tr>
1.270 leot 11411: <td>MASTER_SITE_LOCAL</td>
1.271 ! brook 11412: <td>MASTER_SITE_MOZILLA</td>
1.269 leot 11413: </tr>
11414: <tr>
1.270 leot 11415: <td>MASTER_SITE_OPENOFFICE</td>
1.271 ! brook 11416: <td>MASTER_SITE_OVERRIDE</td>
1.269 leot 11417: </tr>
11418: <tr>
1.270 leot 11419: <td>MASTER_SITE_PERL_CPAN</td>
1.271 ! brook 11420: <td>MASTER_SITE_SUNSITE</td>
1.269 leot 11421: </tr>
11422: <tr>
1.270 leot 11423: <td>MASTER_SITE_SUSE</td>
1.271 ! brook 11424: <td>MASTER_SITE_TEX_CTAN</td>
1.269 leot 11425: </tr>
11426: <tr>
1.270 leot 11427: <td>MASTER_SITE_XCONTRIB</td>
1.271 ! brook 11428: <td>MASTER_SITE_XEMACS</td>
1.269 leot 11429: </tr>
11430: <tr>
1.270 leot 11431: <td>MASTER_SORT</td>
1.271 ! brook 11432: <td>MASTER_SORT_RANDOM</td>
1.269 leot 11433: </tr>
11434: <tr>
1.270 leot 11435: <td>MASTER_SORT_REGEX</td>
1.271 ! brook 11436: <td>MECAB_CHARSET</td>
1.269 leot 11437: </tr>
11438: <tr>
1.270 leot 11439: <td>MEDIATOMB_GROUP</td>
1.271 ! brook 11440: <td>MEDIATOMB_USER</td>
1.269 leot 11441: </tr>
11442: <tr>
1.270 leot 11443: <td>MIPSPROBASE</td>
1.271 ! brook 11444: <td>MIREDO_GROUP</td>
1.269 leot 11445: </tr>
11446: <tr>
1.270 leot 11447: <td>MIREDO_USER</td>
1.271 ! brook 11448: <td>MISSING_FEATURES</td>
1.269 leot 11449: </tr>
11450: <tr>
1.270 leot 11451: <td>MKDIR</td>
1.271 ! brook 11452: <td>MLDONKEY_GROUP</td>
1.269 leot 11453: </tr>
11454: <tr>
1.270 leot 11455: <td>MLDONKEY_HOME</td>
1.271 ! brook 11456: <td>MLDONKEY_USER</td>
1.269 leot 11457: </tr>
11458: <tr>
1.270 leot 11459: <td>MONOTONE_GROUP</td>
1.271 ! brook 11460: <td>MONOTONE_USER</td>
1.269 leot 11461: </tr>
11462: <tr>
1.270 leot 11463: <td>MOTIFBASE</td>
1.271 ! brook 11464: <td>MOTIF_TYPE</td>
1.269 leot 11465: </tr>
11466: <tr>
1.270 leot 11467: <td>MOTIF_TYPE_DEFAULT</td>
1.271 ! brook 11468: <td>MPI_TYPE</td>
1.269 leot 11469: </tr>
11470: <tr>
1.270 leot 11471: <td>MSGFMT_STRIP_MSGCTXT</td>
1.271 ! brook 11472: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.269 leot 11473: </tr>
11474: <tr>
1.270 leot 11475: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.271 ! brook 11476: <td>MUST</td>
1.269 leot 11477: </tr>
11478: <tr>
1.270 leot 11479: <td>MV</td>
1.271 ! brook 11480: <td>MYSQL_CHARSET</td>
1.269 leot 11481: </tr>
11482: <tr>
1.270 leot 11483: <td>MYSQL_DATADIR</td>
1.271 ! brook 11484: <td>MYSQL_EXTRA_CHARSET</td>
1.269 leot 11485: </tr>
11486: <tr>
1.270 leot 11487: <td>MYSQL_GROUP</td>
1.271 ! brook 11488: <td>MYSQL_PKGSRCDIR</td>
1.269 leot 11489: </tr>
11490: <tr>
1.270 leot 11491: <td>MYSQL_USER</td>
1.271 ! brook 11492: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.269 leot 11493: </tr>
11494: <tr>
1.270 leot 11495: <td>MYSQL_VERSION_DEFAULT</td>
1.271 ! brook 11496: <td>NAGIOSCMD_GROUP</td>
1.269 leot 11497: </tr>
11498: <tr>
1.270 leot 11499: <td>NAGIOSDIR</td>
1.271 ! brook 11500: <td>NAGIOS_GROUP</td>
1.269 leot 11501: </tr>
11502: <tr>
1.270 leot 11503: <td>NAGIOS_USER</td>
1.271 ! brook 11504: <td>NATIVE_APPEND_ABI</td>
1.269 leot 11505: </tr>
11506: <tr>
1.270 leot 11507: <td>NATIVE_APPEND_ELF</td>
1.271 ! brook 11508: <td>NATIVE_EXEC_FMT</td>
1.269 leot 11509: </tr>
11510: <tr>
1.270 leot 11511: <td>NATIVE_MACHINE_PLATFORM</td>
1.271 ! brook 11512: <td>NATIVE_OBJECT_FMT</td>
1.269 leot 11513: </tr>
11514: <tr>
1.270 leot 11515: <td>NBPAX_PROGRAM_PREFIX</td>
1.271 ! brook 11516: <td>NETBSD_LOGIN_NAME</td>
1.269 leot 11517: </tr>
11518: <tr>
1.270 leot 11519: <td>NMH_EDITOR</td>
1.271 ! brook 11520: <td>NMH_MTA</td>
1.269 leot 11521: </tr>
11522: <tr>
1.270 leot 11523: <td>NMH_PAGER</td>
1.271 ! brook 11524: <td>NOLOGIN</td>
1.269 leot 11525: </tr>
11526: <tr>
1.270 leot 11527: <td>NONZERO_FILESIZE_P</td>
1.271 ! brook 11528: <td>NOTE</td>
1.269 leot 11529: </tr>
11530: <tr>
1.270 leot 11531: <td>NOT_FOR_PLATFORM</td>
1.271 ! brook 11532: <td>NOT_PAX_ASLR_SAFE</td>
1.269 leot 11533: </tr>
11534: <tr>
1.270 leot 11535: <td>NOT_PAX_MPROTECT_SAFE</td>
1.271 ! brook 11536: <td>NO_BUILD</td>
1.269 leot 11537: </tr>
11538: <tr>
1.270 leot 11539: <td>NO_CHECKSUM</td>
1.271 ! brook 11540: <td>NO_CONFIGURE</td>
1.269 leot 11541: </tr>
11542: <tr>
1.270 leot 11543: <td>NO_SKIP</td>
1.271 ! brook 11544: <td>NS_PREFERRED</td>
1.269 leot 11545: </tr>
11546: <tr>
1.270 leot 11547: <td>NULLMAILER_GROUP</td>
1.271 ! brook 11548: <td>NULLMAILER_USER</td>
1.269 leot 11549: </tr>
11550: <tr>
1.270 leot 11551: <td>OASIS</td>
1.271 ! brook 11552: <td>OASIS_BUILD_ARGS</td>
1.269 leot 11553: </tr>
11554: <tr>
1.270 leot 11555: <td>OBJHOSTNAME</td>
1.271 ! brook 11556: <td>OBJMACHINE</td>
1.269 leot 11557: </tr>
11558: <tr>
1.270 leot 11559: <td>OCAML_FINDLIB_DIRS</td>
1.271 ! brook 11560: <td>OCAML_FINDLIB_REGISTER</td>
1.269 leot 11561: </tr>
11562: <tr>
1.270 leot 11563: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.271 ! brook 11564: <td>OCAML_SITELIBDIR</td>
1.269 leot 11565: </tr>
11566: <tr>
1.270 leot 11567: <td>OCAML_TOPKG_DOCDIR</td>
1.271 ! brook 11568: <td>OCAML_USE_DUNE</td>
1.269 leot 11569: </tr>
11570: <tr>
1.270 leot 11571: <td>OCAML_USE_FINDLIB</td>
1.271 ! brook 11572: <td>OCAML_USE_JBUILDER</td>
1.269 leot 11573: </tr>
11574: <tr>
1.270 leot 11575: <td>OCAML_USE_OASIS</td>
1.271 ! brook 11576: <td>OCAML_USE_OASIS_DYNRUN</td>
1.269 leot 11577: </tr>
11578: <tr>
1.270 leot 11579: <td>OCAML_USE_OPAM</td>
1.271 ! brook 11580: <td>OCAML_USE_OPT_COMPILER</td>
1.269 leot 11581: </tr>
11582: <tr>
1.270 leot 11583: <td>OCAML_USE_TOPKG</td>
1.271 ! brook 11584: <td>OMF</td>
1.269 leot 11585: </tr>
11586: <tr>
1.270 leot 11587: <td>ONLY_FOR_COMPILER</td>
1.271 ! brook 11588: <td>ONLY_FOR_PLATFORM</td>
1.269 leot 11589: </tr>
11590: <tr>
1.270 leot 11591: <td>OPENSSH_CHROOT</td>
1.271 ! brook 11592: <td>OPENSSH_GROUP</td>
1.269 leot 11593: </tr>
11594: <tr>
1.270 leot 11595: <td>OPENSSH_USER</td>
1.271 ! brook 11596: <td>OPSYS</td>
1.269 leot 11597: </tr>
11598: <tr>
1.270 leot 11599: <td>OPSYS_EMULDIR</td>
1.271 ! brook 11600: <td>OSS_TYPE</td>
1.269 leot 11601: </tr>
11602: <tr>
1.270 leot 11603: <td>OSX</td>
1.271 ! brook 11604: <td>OSX_TOLERATE_SDK_SKEW</td>
1.269 leot 11605: </tr>
11606: <tr>
1.270 leot 11607: <td>OS_HAVE_ALSA</td>
1.271 ! brook 11608: <td>OS_HAVE_RCD</td>
1.269 leot 11609: </tr>
11610: <tr>
1.270 leot 11611: <td>OS_VARIANT</td>
1.271 ! brook 11612: <td>OS_VERSION</td>
1.269 leot 11613: </tr>
11614: <tr>
1.270 leot 11615: <td>OTF_FONTS_DIR</td>
1.271 ! brook 11616: <td>OVERRIDE_DIRDEPTH</td>
1.269 leot 11617: </tr>
11618: <tr>
1.270 leot 11619: <td>OVERRIDE_GEMSPEC</td>
1.271 ! brook 11620: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.269 leot 11621: </tr>
11622: <tr>
1.270 leot 11623: <td>OVERRIDE_ROCKSPEC</td>
1.271 ! brook 11624: <td>OWN_DIRS</td>
1.269 leot 11625: </tr>
11626: <tr>
1.270 leot 11627: <td>OWN_DIRS_PERMS</td>
1.271 ! brook 11628: <td>P4GROUP</td>
1.269 leot 11629: </tr>
11630: <tr>
1.270 leot 11631: <td>P4PORT</td>
1.271 ! brook 11632: <td>P4ROOT</td>
1.269 leot 11633: </tr>
11634: <tr>
1.270 leot 11635: <td>P4USER</td>
1.271 ! brook 11636: <td>PACKAGES</td>
1.269 leot 11637: </tr>
11638: <tr>
1.270 leot 11639: <td>PALMOS_DEFAULT_SDK</td>
1.271 ! brook 11640: <td>PAMBASE</td>
1.269 leot 11641: </tr>
11642: <tr>
1.270 leot 11643: <td>PAM_DEFAULT</td>
1.271 ! brook 11644: <td>PAPERSIZE</td>
1.269 leot 11645: </tr>
11646: <tr>
1.270 leot 11647: <td>PASSIVE_FETCH</td>
1.271 ! brook 11648: <td>PATCHDIR</td>
1.269 leot 11649: </tr>
11650: <tr>
1.270 leot 11651: <td>PATCHFILES</td>
1.271 ! brook 11652: <td>PATCH_ARGS</td>
1.269 leot 11653: </tr>
11654: <tr>
1.270 leot 11655: <td>PATCH_DEBUG</td>
1.271 ! brook 11656: <td>PATCH_DIST_ARGS</td>
1.269 leot 11657: </tr>
11658: <tr>
1.270 leot 11659: <td>PATCH_DIST_CAT</td>
1.271 ! brook 11660: <td>PATCH_DIST_STRIP</td>
1.269 leot 11661: </tr>
11662: <tr>
1.270 leot 11663: <td>PATCH_FUZZ_FACTOR</td>
1.271 ! brook 11664: <td>PATCH_STRIP</td>
1.269 leot 11665: </tr>
11666: <tr>
1.270 leot 11667: <td>PATH</td>
1.271 ! brook 11668: <td>PCCBASE</td>
1.269 leot 11669: </tr>
11670: <tr>
1.270 leot 11671: <td>PEAR</td>
1.271 ! brook 11672: <td>PEAR_CHANNEL</td>
1.269 leot 11673: </tr>
11674: <tr>
1.270 leot 11675: <td>PEAR_CHANNEL_ALIAS</td>
1.271 ! brook 11676: <td>PEAR_CHANNEL_VERSION</td>
1.269 leot 11677: </tr>
11678: <tr>
1.270 leot 11679: <td>PEAR_CMD</td>
1.271 ! brook 11680: <td>PEAR_LIB</td>
1.269 leot 11681: </tr>
11682: <tr>
1.270 leot 11683: <td>PEAR_PACKAGE_XML</td>
1.271 ! brook 11684: <td>PERL5</td>
1.269 leot 11685: </tr>
11686: <tr>
1.270 leot 11687: <td>PERL5_CONFIGURE</td>
1.271 ! brook 11688: <td>PERL5_CONFIGURE_DIRS</td>
1.269 leot 11689: </tr>
11690: <tr>
1.270 leot 11691: <td>PERL5_LDFLAGS</td>
1.271 ! brook 11692: <td>PERL5_LICENSE</td>
1.269 leot 11693: </tr>
11694: <tr>
1.270 leot 11695: <td>PERL5_MODULE_TYPE</td>
1.271 ! brook 11696: <td>PERL5_PACKLIST</td>
1.269 leot 11697: </tr>
11698: <tr>
1.270 leot 11699: <td>PERL5_PACKLIST_DIR</td>
1.271 ! brook 11700: <td>PERL5_PERLBASE</td>
1.269 leot 11701: </tr>
11702: <tr>
1.270 leot 11703: <td>PERL5_SITEBASE</td>
1.271 ! brook 11704: <td>PERL5_USE_PACKLIST</td>
1.269 leot 11705: </tr>
11706: <tr>
1.270 leot 11707: <td>PERL5_VENDORBASE</td>
1.271 ! brook 11708: <td>PFCTL</td>
1.269 leot 11709: </tr>
11710: <tr>
1.270 leot 11711: <td>PFVAR_H</td>
1.271 ! brook 11712: <td>PF_VERSION</td>
1.269 leot 11713: </tr>
11714: <tr>
1.270 leot 11715: <td>PGGROUP</td>
1.271 ! brook 11716: <td>PGHOME</td>
1.269 leot 11717: </tr>
11718: <tr>
1.270 leot 11719: <td>PGPKGSRCDIR</td>
1.271 ! brook 11720: <td>PGSQL_TYPE</td>
1.269 leot 11721: </tr>
11722: <tr>
1.270 leot 11723: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.271 ! brook 11724: <td>PGSQL_VERSION_DEFAULT</td>
1.269 leot 11725: </tr>
11726: <tr>
1.270 leot 11727: <td>PGUSER</td>
1.271 ! brook 11728: <td>PG_LIB_EXT</td>
1.269 leot 11729: </tr>
11730: <tr>
1.270 leot 11731: <td>PHP</td>
1.271 ! brook 11732: <td>PHPCOMMON_MK</td>
1.269 leot 11733: </tr>
11734: <tr>
1.270 leot 11735: <td>PHPPKGSRCDIR</td>
1.271 ! brook 11736: <td>PHP_BASE_VERS</td>
1.269 leot 11737: </tr>
11738: <tr>
1.270 leot 11739: <td>PHP_CHECK_INSTALLED</td>
1.271 ! brook 11740: <td>PHP_EXTENSION_DIR</td>
1.269 leot 11741: </tr>
11742: <tr>
1.270 leot 11743: <td>PHP_INITIAL_TEENY</td>
1.271 ! brook 11744: <td>PHP_PKG_PREFIX</td>
1.269 leot 11745: </tr>
11746: <tr>
1.270 leot 11747: <td>PHP_VERSION</td>
1.271 ! brook 11748: <td>PHP_VERSIONS_ACCEPTED</td>
1.269 leot 11749: </tr>
11750: <tr>
1.270 leot 11751: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.271 ! brook 11752: <td>PHP_VERSION_DEFAULT</td>
1.269 leot 11753: </tr>
11754: <tr>
1.270 leot 11755: <td>PHP_VERSION_REQD</td>
1.271 ! brook 11756: <td>PILRC_USE_GTK</td>
1.269 leot 11757: </tr>
11758: <tr>
1.270 leot 11759: <td>PKGCONFIG_BASE</td>
1.271 ! brook 11760: <td>PKGCONFIG_FILE</td>
1.269 leot 11761: </tr>
11762: <tr>
1.270 leot 11763: <td>PKGCONFIG_OVERRIDE</td>
1.271 ! brook 11764: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.269 leot 11765: </tr>
11766: <tr>
1.270 leot 11767: <td>PKGDIR</td>
1.271 ! brook 11768: <td>PKGGNUDIR</td>
1.269 leot 11769: </tr>
11770: <tr>
1.270 leot 11771: <td>PKGINFODIR</td>
1.271 ! brook 11772: <td>PKGLOCALEDIR</td>
1.269 leot 11773: </tr>
11774: <tr>
1.270 leot 11775: <td>PKGMANDIR</td>
1.271 ! brook 11776: <td>PKGNAME</td>
1.269 leot 11777: </tr>
11778: <tr>
1.270 leot 11779: <td>PKGNAME_REQD</td>
1.271 ! brook 11780: <td>PKGPATH</td>
1.269 leot 11781: </tr>
11782: <tr>
1.270 leot 11783: <td>PKGREVISION</td>
1.271 ! brook 11784: <td>PKGSRC_BLAS_TYPES</td>
1.269 leot 11785: </tr>
11786: <tr>
11787: <td>PKGSRC_CHANGES</td>
1.270 leot 11788: <td>PKGSRC_COMPILER</td>
1.269 leot 11789: </tr>
11790: <tr>
11791: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.270 leot 11792: <td>PKGSRC_LOCKTYPE</td>
1.269 leot 11793: </tr>
11794: <tr>
11795: <td>PKGSRC_MAKE_ENV</td>
1.270 leot 11796: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.269 leot 11797: </tr>
11798: <tr>
11799: <td>PKGSRC_MKPIE</td>
1.270 leot 11800: <td>PKGSRC_MKREPRO</td>
1.269 leot 11801: </tr>
11802: <tr>
11803: <td>PKGSRC_RUN_TEST</td>
1.270 leot 11804: <td>PKGSRC_SETENV</td>
1.269 leot 11805: </tr>
11806: <tr>
11807: <td>PKGSRC_SLEEPSECS</td>
1.270 leot 11808: <td>PKGSRC_TODO</td>
1.269 leot 11809: </tr>
11810: <tr>
11811: <td>PKGSRC_USE_CTF</td>
1.270 leot 11812: <td>PKGSRC_USE_FORTIFY</td>
1.269 leot 11813: </tr>
11814: <tr>
11815: <td>PKGSRC_USE_RELRO</td>
1.270 leot 11816: <td>PKGSRC_USE_SSP</td>
1.269 leot 11817: </tr>
11818: <tr>
11819: <td>PKGSRC_USE_STACK_CHECK</td>
1.270 leot 11820: <td>PKGTASKS_DATAFILE</td>
1.269 leot 11821: </tr>
11822: <tr>
11823: <td>PKGTOOLS_ARGS</td>
1.270 leot 11824: <td>PKGTOOLS_ENV</td>
1.269 leot 11825: </tr>
11826: <tr>
11827: <td>PKG_ALTERNATIVES</td>
1.270 leot 11828: <td>PKG_APACHE</td>
1.269 leot 11829: </tr>
11830: <tr>
11831: <td>PKG_APACHE_ACCEPTED</td>
1.270 leot 11832: <td>PKG_APACHE_DEFAULT</td>
1.269 leot 11833: </tr>
11834: <tr>
11835: <td>PKG_BEST_EXISTS</td>
1.270 leot 11836: <td>PKG_BUILD_OPTIONS</td>
1.269 leot 11837: </tr>
11838: <tr>
11839: <td>PKG_COMPRESSION</td>
1.270 leot 11840: <td>PKG_CONFIG</td>
1.269 leot 11841: </tr>
11842: <tr>
11843: <td>PKG_CONFIG_PERMS</td>
1.270 leot 11844: <td>PKG_CREATE_USERGROUP</td>
1.269 leot 11845: </tr>
11846: <tr>
11847: <td>PKG_DB_TMPDIR</td>
1.270 leot 11848: <td>PKG_DEBUG_LEVEL</td>
1.269 leot 11849: </tr>
11850: <tr>
11851: <td>PKG_DEFAULT_OPTIONS</td>
1.270 leot 11852: <td>PKG_DESTDIR_SUPPORT</td>
1.269 leot 11853: </tr>
11854: <tr>
11855: <td>PKG_DEVELOPER</td>
1.270 leot 11856: <td>PKG_DISABLED_OPTIONS</td>
1.269 leot 11857: </tr>
11858: <tr>
11859: <td>PKG_FATAL_ERRORS</td>
1.270 leot 11860: <td>PKG_FC</td>
1.269 leot 11861: </tr>
11862: <tr>
11863: <td>PKG_FILELIST_CMD</td>
1.270 leot 11864: <td>PKG_GECOS</td>
1.269 leot 11865: </tr>
11866: <tr>
11867: <td>PKG_GID</td>
1.270 leot 11868: <td>PKG_GROUPS</td>
1.269 leot 11869: </tr>
11870: <tr>
11871: <td>PKG_GROUPS_VARS</td>
1.270 leot 11872: <td>PKG_HOME</td>
1.269 leot 11873: </tr>
11874: <tr>
11875: <td>PKG_INIT_SCRIPTS</td>
1.270 leot 11876: <td>PKG_JAVA_HOME</td>
1.269 leot 11877: </tr>
11878: <tr>
11879: <td>PKG_JVM</td>
1.270 leot 11880: <td>PKG_JVMS_ACCEPTED</td>
1.269 leot 11881: </tr>
11882: <tr>
11883: <td>PKG_JVM_DEFAULT</td>
1.270 leot 11884: <td>PKG_LEGACY_OPTIONS</td>
1.269 leot 11885: </tr>
11886: <tr>
11887: <td>PKG_LIBTOOL</td>
1.270 leot 11888: <td>PKG_OPTIONS</td>
1.269 leot 11889: </tr>
11890: <tr>
11891: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.270 leot 11892: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.269 leot 11893: </tr>
11894: <tr>
11895: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.270 leot 11896: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.269 leot 11897: </tr>
11898: <tr>
11899: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.270 leot 11900: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.269 leot 11901: </tr>
11902: <tr>
11903: <td>PKG_OPTIONS_VAR</td>
1.270 leot 11904: <td>PKG_PHP</td>
1.269 leot 11905: </tr>
11906: <tr>
11907: <td>PKG_PHP_MAJOR_VERS</td>
1.270 leot 11908: <td>PKG_PHP_VERSION</td>
1.269 leot 11909: </tr>
11910: <tr>
11911: <td>PKG_RCD_SCRIPTS</td>
1.270 leot 11912: <td>PKG_REFCOUNT_DBDIR</td>
1.269 leot 11913: </tr>
11914: <tr>
11915: <td>PKG_REGISTER_SHELLS</td>
1.270 leot 11916: <td>PKG_RESUME_TRANSFERS</td>
1.269 leot 11917: </tr>
11918: <tr>
11919: <td>PKG_SHELL</td>
1.270 leot 11920: <td>PKG_SUGGESTED_OPTIONS</td>
1.269 leot 11921: </tr>
11922: <tr>
11923: <td>PKG_SUPPORTED_OPTIONS</td>
1.270 leot 11924: <td>PKG_SYSCONFBASE</td>
1.269 leot 11925: </tr>
11926: <tr>
11927: <td>PKG_SYSCONFBASEDIR</td>
1.270 leot 11928: <td>PKG_SYSCONFDIR</td>
1.269 leot 11929: </tr>
11930: <tr>
11931: <td>PKG_SYSCONFDIR_PERMS</td>
1.270 leot 11932: <td>PKG_SYSCONFSUBDIR</td>
1.269 leot 11933: </tr>
11934: <tr>
11935: <td>PKG_SYSCONFVAR</td>
1.270 leot 11936: <td>PKG_TOOLS_BIN</td>
1.269 leot 11937: </tr>
11938: <tr>
11939: <td>PKG_UID</td>
1.270 leot 11940: <td>PKG_UPDATE_FONTS_DB</td>
1.269 leot 11941: </tr>
11942: <tr>
11943: <td>PKG_USERS</td>
1.270 leot 11944: <td>PKG_USERS_VARS</td>
1.269 leot 11945: </tr>
11946: <tr>
11947: <td>PKG_VERBOSE</td>
1.270 leot 11948: <td>PLIST</td>
1.269 leot 11949: </tr>
11950: <tr>
11951: <td>PLIST_AWK</td>
1.270 leot 11952: <td>PLIST_AWK_ENV</td>
1.269 leot 11953: </tr>
11954: <tr>
11955: <td>PLIST_SRC</td>
1.270 leot 11956: <td>PLIST_SUBST</td>
1.269 leot 11957: </tr>
11958: <tr>
11959: <td>PLIST_TYPE</td>
1.270 leot 11960: <td>PLIST_VARS</td>
1.269 leot 11961: </tr>
11962: <tr>
11963: <td>POPTOP_USE_MPPE</td>
1.270 leot 11964: <td>POST_FETCH_HOOK</td>
1.269 leot 11965: </tr>
11966: <tr>
11967: <td>PREFER</td>
1.270 leot 11968: <td>PREFER_NATIVE</td>
1.269 leot 11969: </tr>
11970: <tr>
11971: <td>PREFER_NATIVE_PTHREADS</td>
1.270 leot 11972: <td>PREFER_PKGSRC</td>
1.269 leot 11973: </tr>
11974: <tr>
11975: <td>PREFIX</td>
1.270 leot 11976: <td>PREPEND_PATH</td>
1.269 leot 11977: </tr>
11978: <tr>
11979: <td>PRE_ROOT_CMD</td>
1.270 leot 11980: <td>PRIVILEGED_STAGES</td>
1.269 leot 11981: </tr>
11982: <tr>
11983: <td>PS</td>
1.270 leot 11984: <td>PTHREAD_AUTO_VARS</td>
1.269 leot 11985: </tr>
11986: <tr>
11987: <td>PTHREAD_CFLAGS</td>
1.270 leot 11988: <td>PTHREAD_LDFLAGS</td>
1.269 leot 11989: </tr>
11990: <tr>
11991: <td>PTHREAD_LIBS</td>
1.270 leot 11992: <td>PTHREAD_OPTS</td>
1.269 leot 11993: </tr>
11994: <tr>
11995: <td>PTHREAD_TYPE</td>
1.270 leot 11996: <td>PVM_SSH</td>
1.269 leot 11997: </tr>
11998: <tr>
11999: <td>PYPKGPREFIX</td>
1.270 leot 12000: <td>PYTHON_FOR_BUILD_ONLY</td>
1.269 leot 12001: </tr>
12002: <tr>
12003: <td>PYTHON_SELF_CONFLICT</td>
1.270 leot 12004: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.269 leot 12005: </tr>
12006: <tr>
12007: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.270 leot 12008: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.269 leot 12009: </tr>
12010: <tr>
12011: <td>PYTHON_VERSION_DEFAULT</td>
1.270 leot 12012: <td>PYTHON_VERSION_REQD</td>
1.269 leot 12013: </tr>
12014: <tr>
12015: <td>PYVERSSUFFIX</td>
1.270 leot 12016: <td>PY_NO_EGG</td>
1.269 leot 12017: </tr>
12018: <tr>
12019: <td>QMAILDIR</td>
1.270 leot 12020: <td>QMAIL_ALIAS_USER</td>
1.269 leot 12021: </tr>
12022: <tr>
12023: <td>QMAIL_DAEMON_USER</td>
1.270 leot 12024: <td>QMAIL_LOG_USER</td>
1.269 leot 12025: </tr>
12026: <tr>
12027: <td>QMAIL_NOFILES_GROUP</td>
1.270 leot 12028: <td>QMAIL_PASSWD_USER</td>
1.269 leot 12029: </tr>
12030: <tr>
12031: <td>QMAIL_QMAIL_GROUP</td>
1.270 leot 12032: <td>QMAIL_QUEUE_DIR</td>
1.269 leot 12033: </tr>
12034: <tr>
12035: <td>QMAIL_QUEUE_EXTRA</td>
1.270 leot 12036: <td>QMAIL_QUEUE_USER</td>
1.269 leot 12037: </tr>
12038: <tr>
12039: <td>QMAIL_REMOTE_USER</td>
1.270 leot 12040: <td>QMAIL_ROOT_USER</td>
1.269 leot 12041: </tr>
12042: <tr>
12043: <td>QMAIL_SEND_USER</td>
1.270 leot 12044: <td>QPOPPER_FAC</td>
1.269 leot 12045: </tr>
12046: <tr>
12047: <td>QPOPPER_SPOOL_DIR</td>
1.270 leot 12048: <td>QPOPPER_USER</td>
1.269 leot 12049: </tr>
12050: <tr>
12051: <td>RAKE_NAME</td>
1.270 leot 12052: <td>RASMOL_DEPTH</td>
1.269 leot 12053: </tr>
12054: <tr>
12055: <td>RCD_DIR</td>
1.270 leot 12056: <td>RCD_ORDER</td>
1.269 leot 12057: </tr>
12058: <tr>
12059: <td>RCD_SCRIPTS</td>
1.270 leot 12060: <td>RCD_SCRIPTS_DIR</td>
1.269 leot 12061: </tr>
12062: <tr>
12063: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.270 leot 12064: <td>RCD_SCRIPTS_MODE</td>
1.269 leot 12065: </tr>
12066: <tr>
12067: <td>RCD_SCRIPTS_SHELL</td>
1.270 leot 12068: <td>RCD_SCRIPT_SRC</td>
1.269 leot 12069: </tr>
12070: <tr>
12071: <td>RCD_SUBR</td>
1.270 leot 12072: <td>RDOC</td>
1.269 leot 12073: </tr>
12074: <tr>
12075: <td>READLINE_DEFAULT</td>
1.270 leot 12076: <td>READLINE_TYPE</td>
1.269 leot 12077: </tr>
12078: <tr>
12079: <td>REAL_ROOT_GROUP</td>
1.270 leot 12080: <td>REAL_ROOT_USER</td>
1.269 leot 12081: </tr>
12082: <tr>
12083: <td>RECURSIVE_MAKE</td>
1.270 leot 12084: <td>RELAY_CTRL_DIR</td>
1.269 leot 12085: </tr>
12086: <tr>
12087: <td>REPLACE_AWK</td>
1.270 leot 12088: <td>REPLACE_BASH</td>
1.269 leot 12089: </tr>
12090: <tr>
12091: <td>REPLACE_CSH</td>
1.270 leot 12092: <td>REPLACE_KSH</td>
1.269 leot 12093: </tr>
12094: <tr>
12095: <td>REPLACE_PERL</td>
1.270 leot 12096: <td>REPLACE_PERL6</td>
1.269 leot 12097: </tr>
12098: <tr>
12099: <td>REPLACE_PYTHON</td>
1.270 leot 12100: <td>REPLACE_RUBY</td>
1.269 leot 12101: </tr>
12102: <tr>
12103: <td>REPLACE_RUBY_DIRS</td>
1.270 leot 12104: <td>REPLACE_RUBY_PAT</td>
1.269 leot 12105: </tr>
12106: <tr>
12107: <td>REPLACE_SH</td>
1.270 leot 12108: <td>REPLACE_TEXLUA</td>
1.269 leot 12109: </tr>
12110: <tr>
12111: <td>REQD_DIRS</td>
1.270 leot 12112: <td>REQD_DIRS_PERMS</td>
1.269 leot 12113: </tr>
12114: <tr>
12115: <td>REQD_FILES</td>
1.270 leot 12116: <td>REQD_FILES_MODE</td>
1.269 leot 12117: </tr>
12118: <tr>
12119: <td>REQD_FILES_PERMS</td>
1.270 leot 12120: <td>RESOLV_AUTO_VARS</td>
1.269 leot 12121: </tr>
12122: <tr>
12123: <td>RESOLV_LDFLAGS</td>
1.270 leot 12124: <td>RESOLV_LIBS</td>
1.269 leot 12125: </tr>
12126: <tr>
12127: <td>RM</td>
1.270 leot 12128: <td>ROCKSPEC_NAME</td>
1.269 leot 12129: </tr>
12130: <tr>
12131: <td>ROCKSPEC_SPECFILE</td>
1.270 leot 12132: <td>ROOT_CMD</td>
1.269 leot 12133: </tr>
12134: <tr>
12135: <td>ROOT_GROUP</td>
1.270 leot 12136: <td>ROOT_USER</td>
1.269 leot 12137: </tr>
12138: <tr>
12139: <td>RPCGEN</td>
1.270 leot 12140: <td>RPM</td>
1.269 leot 12141: </tr>
12142: <tr>
12143: <td>RPM2PKG_PLIST</td>
1.270 leot 12144: <td>RPM2PKG_PREFIX</td>
1.269 leot 12145: </tr>
12146: <tr>
12147: <td>RPM2PKG_STAGE</td>
1.270 leot 12148: <td>RPM2PKG_STRIP</td>
1.269 leot 12149: </tr>
12150: <tr>
12151: <td>RPM2PKG_SUBPREFIX</td>
1.270 leot 12152: <td>RPMFILES</td>
1.269 leot 12153: </tr>
12154: <tr>
12155: <td>RPMIGNOREPATH</td>
1.270 leot 12156: <td>RPM_DB_PREFIX</td>
1.269 leot 12157: </tr>
12158: <tr>
12159: <td>RSSH_CVS_PATH</td>
1.270 leot 12160: <td>RSSH_RDIST_PATH</td>
1.269 leot 12161: </tr>
12162: <tr>
12163: <td>RSSH_RSYNC_PATH</td>
1.270 leot 12164: <td>RSSH_SCP_PATH</td>
1.269 leot 12165: </tr>
12166: <tr>
12167: <td>RSSH_SFTP_SERVER_PATH</td>
1.270 leot 12168: <td>RUBY</td>
1.269 leot 12169: </tr>
12170: <tr>
12171: <td>RUBYGEM</td>
1.270 leot 12172: <td>RUBYGEM_NAME</td>
1.269 leot 12173: </tr>
12174: <tr>
12175: <td>RUBYGEM_OPTIONS</td>
1.270 leot 12176: <td>RUBY_ABI_VERSION</td>
1.269 leot 12177: </tr>
12178: <tr>
12179: <td>RUBY_ARCH</td>
1.270 leot 12180: <td>RUBY_ARCHINC</td>
1.269 leot 12181: </tr>
12182: <tr>
12183: <td>RUBY_ARCHLIB</td>
1.270 leot 12184: <td>RUBY_BASE</td>
1.269 leot 12185: </tr>
12186: <tr>
12187: <td>RUBY_BASERIDIR</td>
1.270 leot 12188: <td>RUBY_BUILD_RDOC</td>
1.269 leot 12189: </tr>
12190: <tr>
12191: <td>RUBY_BUILD_RI</td>
1.270 leot 12192: <td>RUBY_DLEXT</td>
1.269 leot 12193: </tr>
12194: <tr>
12195: <td>RUBY_DOC</td>
1.270 leot 12196: <td>RUBY_DYNAMIC_DIRS</td>
1.269 leot 12197: </tr>
12198: <tr>
12199: <td>RUBY_EG</td>
1.270 leot 12200: <td>RUBY_ENCODING_ARG</td>
1.269 leot 12201: </tr>
12202: <tr>
12203: <td>RUBY_EXTCONF</td>
1.270 leot 12204: <td>RUBY_EXTCONF_CHECK</td>
1.269 leot 12205: </tr>
12206: <tr>
12207: <td>RUBY_EXTCONF_DEBUG</td>
1.270 leot 12208: <td>RUBY_EXTCONF_MAKEFILE</td>
1.269 leot 12209: </tr>
12210: <tr>
12211: <td>RUBY_GEM_BASE</td>
1.270 leot 12212: <td>RUBY_INC</td>
1.269 leot 12213: </tr>
12214: <tr>
12215: <td>RUBY_LIB</td>
1.270 leot 12216: <td>RUBY_LIB_BASE</td>
1.269 leot 12217: </tr>
12218: <tr>
12219: <td>RUBY_NAME</td>
1.270 leot 12220: <td>RUBY_NOVERSION</td>
1.269 leot 12221: </tr>
12222: <tr>
12223: <td>RUBY_PKGPREFIX</td>
1.270 leot 12224: <td>RUBY_RAILS</td>
1.269 leot 12225: </tr>
12226: <tr>
12227: <td>RUBY_RAILS42_VERSION</td>
1.270 leot 12228: <td>RUBY_RAILS51_VERSION</td>
1.269 leot 12229: </tr>
12230: <tr>
12231: <td>RUBY_RAILS52_VERSION</td>
1.270 leot 12232: <td>RUBY_RAILS_ACCEPTED</td>
1.269 leot 12233: </tr>
12234: <tr>
12235: <td>RUBY_RAILS_DEFAULT</td>
1.270 leot 12236: <td>RUBY_RAILS_REQD</td>
1.269 leot 12237: </tr>
12238: <tr>
12239: <td>RUBY_RAILS_STRICT_DEP</td>
1.270 leot 12240: <td>RUBY_RIDIR</td>
1.269 leot 12241: </tr>
12242: <tr>
12243: <td>RUBY_SETUP</td>
1.270 leot 12244: <td>RUBY_SHLIB</td>
1.269 leot 12245: </tr>
12246: <tr>
12247: <td>RUBY_SHLIBALIAS</td>
1.270 leot 12248: <td>RUBY_SHLIBVER</td>
1.269 leot 12249: </tr>
12250: <tr>
12251: <td>RUBY_SIMPLE_INSTALL</td>
1.270 leot 12252: <td>RUBY_SITEARCHLIB</td>
1.269 leot 12253: </tr>
12254: <tr>
12255: <td>RUBY_SITELIB</td>
1.270 leot 12256: <td>RUBY_SITELIB_BASE</td>
1.269 leot 12257: </tr>
12258: <tr>
12259: <td>RUBY_SITERIDIR</td>
1.270 leot 12260: <td>RUBY_SLEXT</td>
1.269 leot 12261: </tr>
12262: <tr>
12263: <td>RUBY_SRCDIR</td>
1.270 leot 12264: <td>RUBY_STATICLIB</td>
1.269 leot 12265: </tr>
12266: <tr>
12267: <td>RUBY_SUFFIX</td>
1.270 leot 12268: <td>RUBY_SYSRIDIR</td>
1.269 leot 12269: </tr>
12270: <tr>
12271: <td>RUBY_USE_PTHREAD</td>
1.270 leot 12272: <td>RUBY_VENDORARCHLIB</td>
1.269 leot 12273: </tr>
12274: <tr>
12275: <td>RUBY_VENDORLIB</td>
1.270 leot 12276: <td>RUBY_VENDORLIB_BASE</td>
1.269 leot 12277: </tr>
12278: <tr>
12279: <td>RUBY_VER</td>
1.270 leot 12280: <td>RUBY_VERSION</td>
1.269 leot 12281: </tr>
12282: <tr>
12283: <td>RUBY_VERSIONS_ACCEPTED</td>
1.270 leot 12284: <td>RUBY_VERSION_DEFAULT</td>
1.269 leot 12285: </tr>
12286: <tr>
12287: <td>RUBY_VERSION_REQD</td>
1.270 leot 12288: <td>RUBY_VER_DIR</td>
1.269 leot 12289: </tr>
12290: <tr>
12291: <td>RUN</td>
1.270 leot 12292: <td>RUN_LDCONFIG</td>
1.269 leot 12293: </tr>
12294: <tr>
12295: <td>SAWFISH_THEMES</td>
1.270 leot 12296: <td>SCO</td>
1.269 leot 12297: </tr>
12298: <tr>
12299: <td>SCREWS_GROUP</td>
1.270 leot 12300: <td>SCREWS_USER</td>
1.269 leot 12301: </tr>
12302: <tr>
12303: <td>SCRIPTS_ENV</td>
1.270 leot 12304: <td>SCROLLKEEPER_DATADIR</td>
1.269 leot 12305: </tr>
12306: <tr>
12307: <td>SCROLLKEEPER_REBUILDDB</td>
1.270 leot 12308: <td>SCROLLKEEPER_UPDATEDB</td>
1.269 leot 12309: </tr>
12310: <tr>
12311: <td>SDIST_PAWD</td>
1.270 leot 12312: <td>SERIAL_DEVICES</td>
1.269 leot 12313: </tr>
12314: <tr>
12315: <td>SETGIDGAME</td>
1.270 leot 12316: <td>SETGID_GAMES_PERMS</td>
1.269 leot 12317: </tr>
12318: <tr>
12319: <td>SETUID_ROOT_PERMS</td>
1.270 leot 12320: <td>SH</td>
1.269 leot 12321: </tr>
12322: <tr>
12323: <td>SHLIB</td>
1.270 leot 12324: <td>SHORTNAME</td>
1.269 leot 12325: </tr>
12326: <tr>
12327: <td>SIGN_PACKAGES</td>
1.270 leot 12328: <td>SILC_CLIENT_WITH_PERL</td>
1.269 leot 12329: </tr>
12330: <tr>
12331: <td>SITE_SPECIFIC_PKGS</td>
1.270 leot 12332: <td>SKIP_DEPENDS</td>
1.269 leot 12333: </tr>
12334: <tr>
12335: <td>SKIP_PORTABILITY_CHECK</td>
1.270 leot 12336: <td>SMF_INSTANCES</td>
1.269 leot 12337: </tr>
12338: <tr>
12339: <td>SMF_MANIFEST</td>
1.270 leot 12340: <td>SMF_METHODS</td>
1.269 leot 12341: </tr>
12342: <tr>
12343: <td>SMF_METHOD_SHELL</td>
1.270 leot 12344: <td>SMF_METHOD_SRC</td>
1.269 leot 12345: </tr>
12346: <tr>
12347: <td>SMF_NAME</td>
1.270 leot 12348: <td>SMF_PREFIX</td>
1.269 leot 12349: </tr>
12350: <tr>
12351: <td>SMF_SRCDIR</td>
1.270 leot 12352: <td>SNIPROXY_GROUP</td>
1.269 leot 12353: </tr>
12354: <tr>
12355: <td>SNIPROXY_USER</td>
1.270 leot 12356: <td>SOURCE_BUFFSIZE</td>
1.269 leot 12357: </tr>
12358: <tr>
12359: <td>SPECIAL_PERMS</td>
1.270 leot 12360: <td>SPECIFIC_PKGS</td>
1.269 leot 12361: </tr>
12362: <tr>
12363: <td>SSH_SUID</td>
1.270 leot 12364: <td>SSYNC_PAWD</td>
1.269 leot 12365: </tr>
12366: <tr>
12367: <td>STEP_MSG</td>
1.270 leot 12368: <td>STRIP</td>
1.269 leot 12369: </tr>
12370: <tr>
12371: <td>STRIP_DBG</td>
1.270 leot 12372: <td>STRIP_DEBUG</td>
1.269 leot 12373: </tr>
12374: <tr>
12375: <td>STRIP_DEBUG_SUPPORTED</td>
1.270 leot 12376: <td>STRIP_FILES_SKIP</td>
1.269 leot 12377: </tr>
12378: <tr>
12379: <td>SU</td>
1.270 leot 12380: <td>SUBDIR</td>
1.269 leot 12381: </tr>
12382: <tr>
12383: <td>SUBST_CLASSES</td>
1.270 leot 12384: <td>SUBST_FILES</td>
1.269 leot 12385: </tr>
12386: <tr>
12387: <td>SUBST_FILTER_CMD</td>
1.270 leot 12388: <td>SUBST_MESSAGE</td>
1.269 leot 12389: </tr>
12390: <tr>
12391: <td>SUBST_SED</td>
1.270 leot 12392: <td>SUBST_SHOW_DIFF</td>
1.269 leot 12393: </tr>
12394: <tr>
12395: <td>SUBST_SKIP_TEXT_CHECK</td>
1.270 leot 12396: <td>SUBST_STAGE</td>
1.269 leot 12397: </tr>
12398: <tr>
12399: <td>SUBST_VARS</td>
1.270 leot 12400: <td>SUNWSPROBASE</td>
1.269 leot 12401: </tr>
12402: <tr>
12403: <td>SUSE_PREFER</td>
1.270 leot 12404: <td>SU_CMD</td>
1.269 leot 12405: </tr>
12406: <tr>
12407: <td>SVN_EXTRACTDIR</td>
1.270 leot 12408: <td>SVN_REPO</td>
1.269 leot 12409: </tr>
12410: <tr>
12411: <td>SVN_REPOSITORIES</td>
1.270 leot 12412: <td>SVN_REVISION</td>
1.269 leot 12413: </tr>
12414: <tr>
12415: <td>TERMCAP_TYPE</td>
1.270 leot 12416: <td>TERMINFO_DEFAULT</td>
1.269 leot 12417: </tr>
12418: <tr>
12419: <td>TERMINFO_TYPE</td>
1.270 leot 12420: <td>TEST</td>
1.269 leot 12421: </tr>
12422: <tr>
12423: <td>TEST_DEPENDS</td>
1.270 leot 12424: <td>TEST_DIRS</td>
1.269 leot 12425: </tr>
12426: <tr>
12427: <td>TEST_ENV</td>
1.270 leot 12428: <td>TEST_MAKE_CMD</td>
1.269 leot 12429: </tr>
12430: <tr>
12431: <td>TEST_MAKE_FLAGS</td>
1.270 leot 12432: <td>TEST_TARGET</td>
1.269 leot 12433: </tr>
12434: <tr>
12435: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.270 leot 12436: <td>TEXLIVE_REV</td>
1.269 leot 12437: </tr>
12438: <tr>
12439: <td>TEXMFSITE</td>
1.270 leot 12440: <td>TEX_FORMATS</td>
1.269 leot 12441: </tr>
12442: <tr>
12443: <td>TEX_HYPHEN_DAT</td>
1.270 leot 12444: <td>TEX_HYPHEN_DEF</td>
1.269 leot 12445: </tr>
12446: <tr>
12447: <td>TEX_TEXMF_DIRS</td>
1.270 leot 12448: <td>THTTPD_LOG_FACILITY</td>
1.269 leot 12449: </tr>
12450: <tr>
12451: <td>TO</td>
1.270 leot 12452: <td>TOOLS_ALIASES</td>
1.269 leot 12453: </tr>
12454: <tr>
12455: <td>TOOLS_ARGS</td>
1.270 leot 12456: <td>TOOLS_BROKEN</td>
1.269 leot 12457: </tr>
12458: <tr>
12459: <td>TOOLS_CMD</td>
1.270 leot 12460: <td>TOOLS_CREATE</td>
1.269 leot 12461: </tr>
12462: <tr>
12463: <td>TOOLS_DIR</td>
1.270 leot 12464: <td>TOOLS_FAIL</td>
1.269 leot 12465: </tr>
12466: <tr>
12467: <td>TOOLS_GNU_MISSING</td>
1.270 leot 12468: <td>TOOLS_LDCONFIG</td>
1.269 leot 12469: </tr>
12470: <tr>
12471: <td>TOOLS_NOOP</td>
1.270 leot 12472: <td>TOOLS_PATH</td>
1.269 leot 12473: </tr>
12474: <tr>
12475: <td>TOOLS_SCRIPT</td>
1.270 leot 12476: <td>TOOL_DEPENDS</td>
1.269 leot 12477: </tr>
12478: <tr>
12479: <td>TTF_FONTDIR</td>
1.270 leot 12480: <td>TTF_FONTS_DIR</td>
1.269 leot 12481: </tr>
12482: <tr>
12483: <td>TYPE</td>
1.270 leot 12484: <td>UAC_REQD_EXECS</td>
1.269 leot 12485: </tr>
12486: <tr>
12487: <td>UCSPI_SSL_GROUP</td>
1.270 leot 12488: <td>UCSPI_SSL_USER</td>
1.269 leot 12489: </tr>
12490: <tr>
12491: <td>UNLIMIT_RESOURCES</td>
1.270 leot 12492: <td>UNPRIVILEGED</td>
1.269 leot 12493: </tr>
12494: <tr>
12495: <td>UNPRIVILEGED_GROUP</td>
1.270 leot 12496: <td>UNPRIVILEGED_GROUPS</td>
1.269 leot 12497: </tr>
12498: <tr>
12499: <td>UNPRIVILEGED_USER</td>
1.270 leot 12500: <td>UNWRAP_FILES</td>
1.269 leot 12501: </tr>
12502: <tr>
12503: <td>UNWRAP_PATTERNS</td>
1.270 leot 12504: <td>UPDATE_GEMSPEC</td>
1.269 leot 12505: </tr>
12506: <tr>
12507: <td>UPDATE_TARGET</td>
1.270 leot 12508: <td>URI</td>
1.269 leot 12509: </tr>
12510: <tr>
12511: <td>USA</td>
1.270 leot 12512: <td>USERGROUP_PHASE</td>
1.269 leot 12513: </tr>
12514: <tr>
12515: <td>USERPPP_GROUP</td>
1.270 leot 12516: <td>USER_SPECIFIC_PKGS</td>
1.269 leot 12517: </tr>
12518: <tr>
12519: <td>USE_ABI_DEPENDS</td>
1.270 leot 12520: <td>USE_APR</td>
1.269 leot 12521: </tr>
12522: <tr>
12523: <td>USE_BSD_MAKEFILE</td>
1.270 leot 12524: <td>USE_BUILTIN</td>
1.269 leot 12525: </tr>
12526: <tr>
12527: <td>USE_CROSS_COMPILE</td>
1.270 leot 12528: <td>USE_CURSES</td>
1.269 leot 12529: </tr>
12530: <tr>
12531: <td>USE_CWRAPPERS</td>
1.270 leot 12532: <td>USE_DB185</td>
1.269 leot 12533: </tr>
12534: <tr>
12535: <td>USE_FEATURES</td>
1.270 leot 12536: <td>USE_GAMESGROUP</td>
1.269 leot 12537: </tr>
12538: <tr>
12539: <td>USE_GCC_RUNTIME</td>
1.270 leot 12540: <td>USE_IMAKE</td>
1.269 leot 12541: </tr>
12542: <tr>
12543: <td>USE_JAVA</td>
1.270 leot 12544: <td>USE_JAVA2</td>
1.269 leot 12545: </tr>
12546: <tr>
12547: <td>USE_LANGUAGES</td>
1.270 leot 12548: <td>USE_LIBTOOL</td>
1.269 leot 12549: </tr>
12550: <tr>
12551: <td>USE_NATIVE_GCC</td>
1.270 leot 12552: <td>USE_NETBSD_REPO</td>
1.269 leot 12553: </tr>
12554: <tr>
12555: <td>USE_PKGSRC_GCC</td>
1.270 leot 12556: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.269 leot 12557: </tr>
12558: <tr>
12559: <td>USE_PKGTASKS</td>
1.270 leot 12560: <td>USE_RUBY_EXTCONF</td>
1.269 leot 12561: </tr>
12562: <tr>
12563: <td>USE_RUBY_INSTALL</td>
1.270 leot 12564: <td>USE_RUBY_SETUP</td>
1.269 leot 12565: </tr>
12566: <tr>
12567: <td>USE_RUBY_SETUP_PKG</td>
1.270 leot 12568: <td>USE_TOOLS</td>
1.269 leot 12569: </tr>
12570: <tr>
12571: <td>UUCP_GROUP</td>
1.270 leot 12572: <td>UUCP_USER</td>
1.269 leot 12573: </tr>
12574: <tr>
12575: <td>VARBASE</td>
1.270 leot 12576: <td>VARNAME</td>
1.269 leot 12577: </tr>
12578: <tr>
12579: <td>VIM_EXTRA_OPTS</td>
1.270 leot 12580: <td>WARNING_MSG</td>
1.269 leot 12581: </tr>
12582: <tr>
12583: <td>WCALC_CGIDIR</td>
1.270 leot 12584: <td>WCALC_CGIPATH</td>
1.269 leot 12585: </tr>
12586: <tr>
12587: <td>WCALC_HTMLDIR</td>
1.270 leot 12588: <td>WCALC_HTMLPATH</td>
1.269 leot 12589: </tr>
12590: <tr>
12591: <td>WDM_MANAGERS</td>
1.270 leot 12592: <td>WRAPPER_REORDER_CMDS</td>
1.269 leot 12593: </tr>
12594: <tr>
12595: <td>WRKDIR</td>
1.270 leot 12596: <td>WRKDIR_BASENAME</td>
1.269 leot 12597: </tr>
12598: <tr>
12599: <td>WRKDIR_LOCKTYPE</td>
1.270 leot 12600: <td>WRKLOG</td>
1.269 leot 12601: </tr>
12602: <tr>
12603: <td>WRKOBJDIR</td>
1.270 leot 12604: <td>WRKSRC</td>
1.269 leot 12605: </tr>
12606: <tr>
12607: <td>WXGTK_ACCEPTED</td>
1.270 leot 12608: <td>WXGTK_DEFAULT</td>
1.269 leot 12609: </tr>
12610: <tr>
12611: <td>X10_PORT</td>
1.270 leot 12612: <td>X11</td>
1.269 leot 12613: </tr>
12614: <tr>
12615: <td>X11BASE</td>
1.270 leot 12616: <td>X11_PKGSRCDIR</td>
1.269 leot 12617: </tr>
12618: <tr>
12619: <td>X11_TYPE</td>
1.270 leot 12620: <td>X509_CERTIFICATE</td>
1.269 leot 12621: </tr>
12622: <tr>
12623: <td>X509_KEY</td>
1.270 leot 12624: <td>XAW_TYPE</td>
1.269 leot 12625: </tr>
12626: <tr>
12627: <td>XLOCK_DEFAULT_MODE</td>
1.270 leot 12628: <td>XMKMF_FLAGS</td>
1.269 leot 12629: </tr>
12630: <tr>
12631: <td>XXX</td>
1.270 leot 12632: <td>XXXX</td>
1.269 leot 12633: </tr>
12634: <tr>
12635: <td>YES</td>
1.270 leot 12636: <td>ZERO_FILESIZE_P</td>
1.269 leot 12637: </tr>
12638: <tr>
12639: <td>ZSH_STATIC</td>
1.270 leot 12640: <td>__stdc__</td>
1.269 leot 12641: </tr>
12642: <tr>
12643: <td>_vargroups</td>
1.270 leot 12644: <td>add</td>
1.269 leot 12645: </tr>
12646: <tr>
12647: <td>all</td>
1.270 leot 12648: <td>alternatives</td>
1.269 leot 12649: </tr>
12650: <tr>
12651: <td>aslr</td>
1.270 leot 12652: <td>asprintf</td>
1.269 leot 12653: </tr>
12654: <tr>
1.271 ! brook 12655: <td>atlas</td>
1.269 leot 12656: <td>autoconf</td>
1.271 ! brook 12657: </tr>
! 12658: <tr>
1.270 leot 12659: <td>automake</td>
1.271 ! brook 12660: <td>autoreconf</td>
1.269 leot 12661: </tr>
12662: <tr>
1.270 leot 12663: <td>awk</td>
1.271 ! brook 12664: <td>bash</td>
1.269 leot 12665: </tr>
12666: <tr>
1.270 leot 12667: <td>big-endian</td>
1.271 ! brook 12668: <td>bin-install</td>
1.269 leot 12669: </tr>
12670: <tr>
1.270 leot 12671: <td>binpkg-list</td>
1.271 ! brook 12672: <td>blas</td>
1.269 leot 12673: </tr>
12674: <tr>
12675: <td>bootstrap-depends</td>
1.270 leot 12676: <td>broken</td>
1.269 leot 12677: </tr>
12678: <tr>
12679: <td>broken_on_platform</td>
1.270 leot 12680: <td>build</td>
1.269 leot 12681: </tr>
12682: <tr>
12683: <td>build-env</td>
1.270 leot 12684: <td>buildlink-directories</td>
1.269 leot 12685: </tr>
12686: <tr>
12687: <td>buildlink-oss-soundcard-h</td>
1.270 leot 12688: <td>c</td>
1.269 leot 12689: </tr>
12690: <tr>
12691: <td>c++</td>
1.270 leot 12692: <td>ccache</td>
1.269 leot 12693: </tr>
12694: <tr>
12695: <td>cce</td>
1.270 leot 12696: <td>cdefs</td>
1.269 leot 12697: </tr>
12698: <tr>
12699: <td>changes</td>
1.270 leot 12700: <td>changes-entry</td>
1.269 leot 12701: </tr>
12702: <tr>
12703: <td>changes-entry-noupdate</td>
1.270 leot 12704: <td>check</td>
1.269 leot 12705: </tr>
12706: <tr>
12707: <td>check-clean</td>
1.270 leot 12708: <td>check-files</td>
1.269 leot 12709: </tr>
12710: <tr>
12711: <td>check-files-clean</td>
1.270 leot 12712: <td>check-vulnerable</td>
1.269 leot 12713: </tr>
12714: <tr>
12715: <td>checksum</td>
1.270 leot 12716: <td>checksum-phase</td>
1.269 leot 12717: </tr>
12718: <tr>
12719: <td>clean</td>
1.270 leot 12720: <td>clean-depends</td>
1.269 leot 12721: </tr>
12722: <tr>
12723: <td>cleandir</td>
1.270 leot 12724: <td>commit</td>
1.269 leot 12725: </tr>
12726: <tr>
12727: <td>commit-changes-entry</td>
1.270 leot 12728: <td>compact</td>
1.269 leot 12729: </tr>
12730: <tr>
12731: <td>compiler</td>
1.270 leot 12732: <td>conf</td>
1.269 leot 12733: </tr>
12734: <tr>
12735: <td>config.guess</td>
1.270 leot 12736: <td>config.sub</td>
1.269 leot 12737: </tr>
12738: <tr>
12739: <td>configuration</td>
1.270 leot 12740: <td>configure</td>
1.269 leot 12741: </tr>
12742: <tr>
12743: <td>configure-help</td>
1.270 leot 12744: <td>configure_args</td>
1.269 leot 12745: </tr>
12746: <tr>
12747: <td>cputime</td>
1.270 leot 12748: <td>create-usergroup</td>
1.269 leot 12749: </tr>
12750: <tr>
12751: <td>csh</td>
1.270 leot 12752: <td>ctf</td>
1.269 leot 12753: </tr>
12754: <tr>
12755: <td>cvs</td>
1.270 leot 12756: <td>debug</td>
1.269 leot 12757: </tr>
12758: <tr>
12759: <td>declaration</td>
1.270 leot 12760: <td>declare</td>
1.269 leot 12761: </tr>
12762: <tr>
12763: <td>defined</td>
1.270 leot 12764: <td>depend</td>
1.269 leot 12765: </tr>
12766: <tr>
12767: <td>dependencies</td>
1.270 leot 12768: <td>depends</td>
1.269 leot 12769: </tr>
12770: <tr>
12771: <td>depends-checksum</td>
1.270 leot 12772: <td>depends-fetch</td>
1.269 leot 12773: </tr>
12774: <tr>
12775: <td>deps</td>
1.270 leot 12776: <td>describe</td>
1.269 leot 12777: </tr>
12778: <tr>
12779: <td>destdir</td>
1.270 leot 12780: <td>distclean</td>
1.269 leot 12781: </tr>
12782: <tr>
12783: <td>distinfo</td>
1.270 leot 12784: <td>dl</td>
1.269 leot 12785: </tr>
12786: <tr>
12787: <td>dlopen</td>
1.270 leot 12788: <td>do-build</td>
1.269 leot 12789: </tr>
12790: <tr>
12791: <td>do-buildlink</td>
1.270 leot 12792: <td>do-clean</td>
1.269 leot 12793: </tr>
12794: <tr>
12795: <td>do-configure-post-hook</td>
1.270 leot 12796: <td>do-extract</td>
1.269 leot 12797: </tr>
12798: <tr>
12799: <td>do-fetch</td>
1.270 leot 12800: <td>do-install</td>
1.269 leot 12801: </tr>
12802: <tr>
12803: <td>emul</td>
1.270 leot 12804: <td>emulation</td>
1.269 leot 12805: </tr>
12806: <tr>
12807: <td>emulator</td>
1.270 leot 12808: <td>endian</td>
1.269 leot 12809: </tr>
12810: <tr>
12811: <td>enomem</td>
1.270 leot 12812: <td>err</td>
1.269 leot 12813: </tr>
12814: <tr>
12815: <td>errx</td>
1.270 leot 12816: <td>etc</td>
1.269 leot 12817: </tr>
12818: <tr>
12819: <td>feature</td>
1.270 leot 12820: <td>features</td>
1.269 leot 12821: </tr>
12822: <tr>
12823: <td>fetch</td>
1.270 leot 12824: <td>fetch-list</td>
1.269 leot 12825: </tr>
12826: <tr>
12827: <td>follows</td>
1.270 leot 12828: <td>forbids</td>
1.269 leot 12829: </tr>
12830: <tr>
12831: <td>form</td>
1.270 leot 12832: <td>format</td>
1.269 leot 12833: </tr>
12834: <tr>
12835: <td>fortify</td>
1.270 leot 12836: <td>fortify_source</td>
1.269 leot 12837: </tr>
12838: <tr>
12839: <td>fossil</td>
1.270 leot 12840: <td>friend</td>
1.269 leot 12841: </tr>
12842: <tr>
12843: <td>from</td>
1.270 leot 12844: <td>fts</td>
1.269 leot 12845: </tr>
12846: <tr>
12847: <td>fts_close</td>
1.270 leot 12848: <td>fts_open</td>
1.269 leot 12849: </tr>
12850: <tr>
12851: <td>fts_read</td>
1.270 leot 12852: <td>fts_set</td>
1.269 leot 12853: </tr>
12854: <tr>
12855: <td>full</td>
1.270 leot 12856: <td>gcc</td>
1.269 leot 12857: </tr>
12858: <tr>
12859: <td>getopt_long</td>
1.270 leot 12860: <td>getprogname</td>
1.269 leot 12861: </tr>
12862: <tr>
12863: <td>gettext</td>
1.270 leot 12864: <td>git</td>
1.269 leot 12865: </tr>
12866: <tr>
12867: <td>github</td>
1.270 leot 12868: <td>glob</td>
1.269 leot 12869: </tr>
12870: <tr>
12871: <td>gnu</td>
1.270 leot 12872: <td>gnu_configure_strict</td>
1.269 leot 12873: </tr>
12874: <tr>
12875: <td>go</td>
1.270 leot 12876: <td>go-deps</td>
1.269 leot 12877: </tr>
12878: <tr>
12879: <td>golang</td>
1.270 leot 12880: <td>guess-license</td>
1.269 leot 12881: </tr>
12882: <tr>
12883: <td>hashbang</td>
1.270 leot 12884: <td>heimdal</td>
1.269 leot 12885: </tr>
12886: <tr>
12887: <td>help</td>
1.270 leot 12888: <td>hg</td>
1.269 leot 12889: </tr>
12890: <tr>
12891: <td>imake</td>
1.270 leot 12892: <td>increment</td>
1.269 leot 12893: </tr>
12894: <tr>
12895: <td>interp</td>
1.270 leot 12896: <td>interpreter</td>
1.269 leot 12897: </tr>
12898: <tr>
12899: <td>intl</td>
1.270 leot 12900: <td>iso</td>
1.269 leot 12901: </tr>
12902: <tr>
12903: <td>kerberos</td>
1.270 leot 12904: <td>krb</td>
1.269 leot 12905: </tr>
12906: <tr>
12907: <td>krb5</td>
1.270 leot 12908: <td>ksh</td>
1.269 leot 12909: </tr>
12910: <tr>
1.271 ! brook 12911: <td>lapack</td>
1.269 leot 12912: <td>latex</td>
1.271 ! brook 12913: </tr>
! 12914: <tr>
1.270 leot 12915: <td>libnbcompat</td>
1.271 ! brook 12916: <td>libs</td>
1.269 leot 12917: </tr>
12918: <tr>
1.270 leot 12919: <td>libtool</td>
1.271 ! brook 12920: <td>licence</td>
1.269 leot 12921: </tr>
12922: <tr>
1.270 leot 12923: <td>license</td>
1.271 ! brook 12924: <td>lintl</td>
1.269 leot 12925: </tr>
12926: <tr>
1.270 leot 12927: <td>little-endian</td>
1.271 ! brook 12928: <td>lock</td>
1.269 leot 12929: </tr>
12930: <tr>
1.270 leot 12931: <td>locking</td>
1.271 ! brook 12932: <td>lvalue</td>
1.269 leot 12933: </tr>
12934: <tr>
1.270 leot 12935: <td>make</td>
1.271 ! brook 12936: <td>makesum</td>
1.269 leot 12937: </tr>
12938: <tr>
1.270 leot 12939: <td>memory</td>
1.271 ! brook 12940: <td>mercurial</td>
1.269 leot 12941: </tr>
12942: <tr>
1.270 leot 12943: <td>meta</td>
1.271 ! brook 12944: <td>meta-package</td>
1.269 leot 12945: </tr>
12946: <tr>
1.270 leot 12947: <td>meta_package</td>
1.271 ! brook 12948: <td>mit-krb5</td>
1.269 leot 12949: </tr>
12950: <tr>
1.270 leot 12951: <td>mk.conf</td>
1.271 ! brook 12952: <td>mkl</td>
1.269 leot 12953: </tr>
12954: <tr>
12955: <td>mount</td>
1.270 leot 12956: <td>mprotect</td>
1.269 leot 12957: </tr>
12958: <tr>
12959: <td>mremap</td>
1.270 leot 12960: <td>nb</td>
1.269 leot 12961: </tr>
12962: <tr>
12963: <td>nbcompat</td>
1.270 leot 12964: <td>no</td>
1.269 leot 12965: </tr>
12966: <tr>
12967: <td>obstack</td>
1.270 leot 12968: <td>obstack_ptr_grow</td>
1.269 leot 12969: </tr>
12970: <tr>
12971: <td>occurs</td>
1.270 leot 12972: <td>only</td>
1.269 leot 12973: </tr>
12974: <tr>
1.271 ! brook 12975: <td>openblas</td>
1.269 leot 12976: <td>options</td>
1.271 ! brook 12977: </tr>
! 12978: <tr>
1.270 leot 12979: <td>options.mk</td>
1.271 ! brook 12980: <td>order</td>
1.269 leot 12981: </tr>
12982: <tr>
1.270 leot 12983: <td>override</td>
1.271 ! brook 12984: <td>override-intltool</td>
1.269 leot 12985: </tr>
12986: <tr>
1.270 leot 12987: <td>override-message-intltool</td>
1.271 ! brook 12988: <td>package</td>
1.269 leot 12989: </tr>
12990: <tr>
1.270 leot 12991: <td>parallel</td>
1.271 ! brook 12992: <td>partial</td>
1.269 leot 12993: </tr>
12994: <tr>
1.270 leot 12995: <td>path</td>
1.271 ! brook 12996: <td>pax</td>
1.269 leot 12997: </tr>
12998: <tr>
1.270 leot 12999: <td>paxctl</td>
1.271 ! brook 13000: <td>pbulk-index</td>
1.269 leot 13001: </tr>
13002: <tr>
1.270 leot 13003: <td>pc</td>
1.271 ! brook 13004: <td>perl</td>
1.269 leot 13005: </tr>
13006: <tr>
1.270 leot 13007: <td>perl5</td>
1.271 ! brook 13008: <td>perms</td>
1.269 leot 13009: </tr>
13010: <tr>
1.270 leot 13011: <td>php</td>
1.271 ! brook 13012: <td>pkg-build-options</td>
1.269 leot 13013: </tr>
13014: <tr>
1.270 leot 13015: <td>pkg-config</td>
1.271 ! brook 13016: <td>pkg_build_options</td>
1.269 leot 13017: </tr>
13018: <tr>
1.270 leot 13019: <td>platform</td>
1.271 ! brook 13020: <td>plist</td>
1.269 leot 13021: </tr>
13022: <tr>
1.270 leot 13023: <td>post-extract</td>
1.271 ! brook 13024: <td>post-fetch</td>
1.269 leot 13025: </tr>
13026: <tr>
1.270 leot 13027: <td>post-wrapper</td>
1.271 ! brook 13028: <td>pre-configure</td>
1.269 leot 13029: </tr>
13030: <tr>
1.270 leot 13031: <td>pre-extract</td>
1.271 ! brook 13032: <td>pre-fetch</td>
1.269 leot 13033: </tr>
13034: <tr>
1.270 leot 13035: <td>print-go-deps</td>
1.271 ! brook 13036: <td>print-plist</td>
1.269 leot 13037: </tr>
13038: <tr>
1.270 leot 13039: <td>print-summary-data</td>
1.271 ! brook 13040: <td>privileged-install-hook</td>
1.269 leot 13041: </tr>
13042: <tr>
1.270 leot 13043: <td>pypi</td>
1.271 ! brook 13044: <td>python</td>
1.269 leot 13045: </tr>
13046: <tr>
1.270 leot 13047: <td>readme-all</td>
1.271 ! brook 13048: <td>regcomp</td>
1.269 leot 13049: </tr>
13050: <tr>
1.270 leot 13051: <td>relro</td>
1.271 ! brook 13052: <td>rename</td>
1.269 leot 13053: </tr>
13054: <tr>
1.270 leot 13055: <td>reorder</td>
1.271 ! brook 13056: <td>replace</td>
1.269 leot 13057: </tr>
13058: <tr>
1.270 leot 13059: <td>replace_interpreter</td>
1.271 ! brook 13060: <td>reproducible</td>
1.269 leot 13061: </tr>
13062: <tr>
1.270 leot 13063: <td>resolv</td>
1.271 ! brook 13064: <td>root</td>
1.269 leot 13065: </tr>
13066: <tr>
1.270 leot 13067: <td>ruby</td>
1.271 ! brook 13068: <td>setenv</td>
1.269 leot 13069: </tr>
13070: <tr>
1.270 leot 13071: <td>setgid</td>
1.271 ! brook 13072: <td>setprogname</td>
1.269 leot 13073: </tr>
13074: <tr>
1.270 leot 13075: <td>setuid</td>
1.271 ! brook 13076: <td>sh</td>
1.269 leot 13077: </tr>
13078: <tr>
1.270 leot 13079: <td>show</td>
1.271 ! brook 13080: <td>show-all</td>
1.269 leot 13081: </tr>
13082: <tr>
1.270 leot 13083: <td>show-build-defs</td>
1.271 ! brook 13084: <td>show-depends</td>
1.269 leot 13085: </tr>
13086: <tr>
1.270 leot 13087: <td>show-deps</td>
1.271 ! brook 13088: <td>show-distfiles</td>
1.269 leot 13089: </tr>
13090: <tr>
1.270 leot 13091: <td>show-downlevel</td>
1.271 ! brook 13092: <td>show-subdir-var</td>
1.269 leot 13093: </tr>
13094: <tr>
1.270 leot 13095: <td>show-tools</td>
1.271 ! brook 13096: <td>show-var</td>
1.269 leot 13097: </tr>
13098: <tr>
1.270 leot 13099: <td>show-vars</td>
1.271 ! brook 13100: <td>snprintf</td>
1.269 leot 13101: </tr>
13102: <tr>
1.270 leot 13103: <td>ssp</td>
1.271 ! brook 13104: <td>st_mode</td>
1.269 leot 13105: </tr>
13106: <tr>
1.270 leot 13107: <td>stage-install</td>
1.271 ! brook 13108: <td>strip</td>
1.269 leot 13109: </tr>
13110: <tr>
1.271 ! brook 13111: <td>strnlen</td>
1.270 leot 13112: <td>strong</td>
1.269 leot 13113: </tr>
13114: <tr>
13115: <td>subst</td>
1.270 leot 13116: <td>subversion</td>
1.269 leot 13117: </tr>
13118: <tr>
13119: <td>sun</td>
1.270 leot 13120: <td>sunpro</td>
1.269 leot 13121: </tr>
13122: <tr>
13123: <td>sunwspro</td>
1.270 leot 13124: <td>svn</td>
1.269 leot 13125: </tr>
13126: <tr>
13127: <td>test</td>
1.270 leot 13128: <td>tex</td>
1.269 leot 13129: </tr>
13130: <tr>
13131: <td>texlive</td>
1.270 leot 13132: <td>tmp</td>
1.269 leot 13133: </tr>
13134: <tr>
13135: <td>tool</td>
1.270 leot 13136: <td>tools</td>
1.269 leot 13137: </tr>
13138: <tr>
13139: <td>tools-libtool-m4-override</td>
1.270 leot 13140: <td>type</td>
1.269 leot 13141: </tr>
13142: <tr>
13143: <td>ulimit</td>
1.270 leot 13144: <td>undefined</td>
1.269 leot 13145: </tr>
13146: <tr>
13147: <td>undo-replace</td>
1.270 leot 13148: <td>unlimit</td>
1.269 leot 13149: </tr>
13150: <tr>
13151: <td>unprivileged</td>
1.270 leot 13152: <td>unprivileged-install-hook</td>
1.269 leot 13153: </tr>
13154: <tr>
13155: <td>unstripped</td>
1.270 leot 13156: <td>update</td>
1.269 leot 13157: </tr>
13158: <tr>
13159: <td>upload</td>
1.270 leot 13160: <td>upload-distfiles</td>
1.269 leot 13161: </tr>
13162: <tr>
13163: <td>usage</td>
1.270 leot 13164: <td>use_tools</td>
1.269 leot 13165: </tr>
13166: <tr>
13167: <td>user</td>
1.270 leot 13168: <td>utimes</td>
1.269 leot 13169: </tr>
13170: <tr>
13171: <td>vasprintf</td>
1.270 leot 13172: <td>verbose</td>
1.269 leot 13173: </tr>
13174: <tr>
13175: <td>vsnprintf</td>
1.270 leot 13176: <td>warn</td>
1.269 leot 13177: </tr>
13178: <tr>
13179: <td>warning</td>
1.270 leot 13180: <td>warnings</td>
1.269 leot 13181: </tr>
13182: <tr>
13183: <td>warnx</td>
1.270 leot 13184: <td>weak</td>
1.269 leot 13185: </tr>
13186: <tr>
13187: <td>work</td>
1.270 leot 13188: <td>wrapper</td>
1.269 leot 13189: </tr>
13190: <tr>
13191: <td>yes</td>
1.270 leot 13192: <td> </td>
1.269 leot 13193: </tr>
13194: </table>
1.267 rillig 13195: </div>
13196: <div class="appendix">
13197: <div class="titlepage"><div><div><h1 class="title">
13198: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75 rillig 13199: <div class="toc">
13200: <p><b>Table of Contents</b></p>
1.210 leot 13201: <dl class="toc">
1.267 rillig 13202: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
13203: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75 rillig 13204: </dl>
13205: </div>
1.79 rillig 13206: <p>This section contains information on editing the pkgsrc
13207: guide itself.</p>
1.148 asau 13208: <div class="sect1">
1.75 rillig 13209: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 13210: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.79 rillig 13211: <p>The pkgsrc guide's source code is stored in
13212: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
13213: are created from it:</p>
1.148 asau 13214: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128 wiz 13215: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
13216: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
13217: <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>
13218: <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.79 rillig 13219: The PDF version of the pkgsrc guide.</p></li>
1.128 wiz 13220: <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.79 rillig 13221: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 13222: </ul></div>
13223: </div>
1.148 asau 13224: <div class="sect1">
1.75 rillig 13225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267 rillig 13226: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.79 rillig 13227: <p>The procedure to edit the pkgsrc guide is:</p>
1.128 wiz 13228: <div class="procedure"><ol class="procedure" type="1">
1.148 asau 13229: <li class="step"><p>Make sure you have the packages needed to
1.83 wiz 13230: regenerate the pkgsrc guide (and other XML-based NetBSD
1.151 obache 13231: documentation) installed. These are automatically installed when
1.250 leot 13232: 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.148 asau 13233: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 13234: right directory. All further steps will take place
13235: here.</p></li>
1.148 asau 13236: <li class="step"><p>Edit the XML file(s) in
1.79 rillig 13237: <code class="filename">files/</code>.</p></li>
1.148 asau 13238: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 13239: guide for valid XML and to build the final output files. If you
13240: get any errors at this stage, you can just edit the files, as
13241: there are only symbolic links in the working directory, pointing
13242: to the files in <code class="filename">files/</code>.</p></li>
1.148 asau 13243: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.79 rillig 13244: commit)</strong></span></p></li>
1.148 asau 13245: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 13246: regenerate the output files with the proper RCS
13247: Ids.</p></li>
1.148 asau 13248: <li class="step">
1.110 hubertf 13249: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 13250: commit the files in both <code class="filename">pkgsrc/doc</code> and
13251: <code class="filename">htdocs</code>.</p>
1.148 asau 13252: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91 rillig 13253: <h3 class="title">Note</h3>
13254: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 13255: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
13256: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 13257: directory.</p>
13258: </div>
13259: </li>
1.79 rillig 13260: </ol></div>
1.75 rillig 13261: </div>
13262: </div>
13263: </div></body>
1.1 grant 13264: </html>
CVSweb <webmaster@jp.NetBSD.org>